Safe Haskell	None
Language	Haskell2010

Data.PackStream.Structure

Synopsis

class ToStructure a where
- toStructure :: a -> Structure
class FromStructure a where
- fromStructure :: Structure -> Either PackStreamError a
data Node = Node {
- nodeId :: Int
- labels :: [Text]
- nodeProps :: Map Text Value
}
data Relationship = Relationship {
- relId :: Int
- startNodeId :: Int
- endNodeId :: Int
- relType :: Text
- relProps :: Map Text Value
}
data UnboundRelationship = UnboundRelationship {
- urelId :: Int
- urelType :: Text
- urelProps :: Map Text Value
}
data Path = Path {
- nodes :: [Node]
- rels :: [UnboundRelationship]
- ids :: [Int]
}
newtype Date = Date {
- days :: Int
}
data Time
data LocalTime
data DateTime
data DateTimeZoneId
data LocalDateTime
data Duration
data Point2D
data Point3D

Documentation

class ToStructure a where Source #

The set of types, that can be presented as PackStream Structures

Methods

toStructure :: a -> Structure Source #

Convert object to Structure

Instances

Instances details

ToStructure Date Source #
Instance details Defined in Data.PackStream.Structure Methods toStructure :: Date -> Structure Source #
ToStructure Path Source #
Instance details Defined in Data.PackStream.Structure Methods toStructure :: Path -> Structure Source #
ToStructure UnboundRelationship Source #
Instance details Defined in Data.PackStream.Structure Methods toStructure :: UnboundRelationship -> Structure Source #
ToStructure Relationship Source #
Instance details Defined in Data.PackStream.Structure Methods toStructure :: Relationship -> Structure Source #
ToStructure Node Source #
Instance details Defined in Data.PackStream.Structure Methods toStructure :: Node -> Structure Source #

class FromStructure a where Source #

The set of types, that can be parsed from PackStream Structures

Methods

fromStructure :: Structure -> Either PackStreamError a Source #

Convert Structure to the object of selected type

Instances

Instances details

FromStructure Date Source #
Instance details Defined in Data.PackStream.Structure Methods fromStructure :: Structure -> Either PackStreamError Date Source #
FromStructure Path Source #
Instance details Defined in Data.PackStream.Structure Methods fromStructure :: Structure -> Either PackStreamError Path Source #
FromStructure UnboundRelationship Source #
Instance details Defined in Data.PackStream.Structure Methods fromStructure :: Structure -> Either PackStreamError UnboundRelationship Source #
FromStructure Relationship Source #
Instance details Defined in Data.PackStream.Structure Methods fromStructure :: Structure -> Either PackStreamError Relationship Source #
FromStructure Node Source #
Instance details Defined in Data.PackStream.Structure Methods fromStructure :: Structure -> Either PackStreamError Node Source #

data Node Source #

Snapshot of a node within a graph database

Constructors

Node
Fields nodeId :: Int Node identifier labels :: [Text] List of node labels nodeProps :: Map Text Value Dict of node properties

Instances

Instances details

Eq Node Source #
Instance details Defined in Data.PackStream.Structure Methods (==) :: Node -> Node -> Bool # (/=) :: Node -> Node -> Bool #
Show Node Source #
Instance details Defined in Data.PackStream.Structure Methods showsPrec :: Int -> Node -> ShowS # show :: Node -> String # showList :: [Node] -> ShowS #
FromStructure Node Source #
Instance details Defined in Data.PackStream.Structure Methods fromStructure :: Structure -> Either PackStreamError Node Source #
ToStructure Node Source #
Instance details Defined in Data.PackStream.Structure Methods toStructure :: Node -> Structure Source #

data Relationship Source #

Snapshot of a relationship within a graph database

Constructors

Relationship
Fields relId :: Int Relationship identifier startNodeId :: Int Identifier of the start node endNodeId :: Int Identifier of the end node relType :: Text Relationship type relProps :: Map Text Value Dict of relationship properties

Instances

Instances details

Eq Relationship Source #
Instance details Defined in Data.PackStream.Structure Methods (==) :: Relationship -> Relationship -> Bool # (/=) :: Relationship -> Relationship -> Bool #
Show Relationship Source #
Instance details Defined in Data.PackStream.Structure Methods showsPrec :: Int -> Relationship -> ShowS # show :: Relationship -> String # showList :: [Relationship] -> ShowS #
FromStructure Relationship Source #
Instance details Defined in Data.PackStream.Structure Methods fromStructure :: Structure -> Either PackStreamError Relationship Source #
ToStructure Relationship Source #
Instance details Defined in Data.PackStream.Structure Methods toStructure :: Relationship -> Structure Source #

data UnboundRelationship Source #

Relationship detail without start or end node information

Constructors

UnboundRelationship
Fields urelId :: Int Relationship identifier urelType :: Text Relationship type urelProps :: Map Text Value Dict of relationship properties

Instances

Instances details

Eq UnboundRelationship Source #
Instance details Defined in Data.PackStream.Structure Methods (==) :: UnboundRelationship -> UnboundRelationship -> Bool # (/=) :: UnboundRelationship -> UnboundRelationship -> Bool #
Show UnboundRelationship Source #
Instance details Defined in Data.PackStream.Structure Methods showsPrec :: Int -> UnboundRelationship -> ShowS # show :: UnboundRelationship -> String # showList :: [UnboundRelationship] -> ShowS #
FromStructure UnboundRelationship Source #
Instance details Defined in Data.PackStream.Structure Methods fromStructure :: Structure -> Either PackStreamError UnboundRelationship Source #
ToStructure UnboundRelationship Source #
Instance details Defined in Data.PackStream.Structure Methods toStructure :: UnboundRelationship -> Structure Source #

data Path Source #

Alternating sequence of nodes and relationships

Constructors

Path
Fields nodes :: [Node] Chain of `Node`s in path rels :: [UnboundRelationship] Chain of `UnboundRelationship`s in path ids :: [Int] The ids is a list of relationship id and node id to represent the path

Instances

Instances details

Eq Path Source #
Instance details Defined in Data.PackStream.Structure Methods (==) :: Path -> Path -> Bool # (/=) :: Path -> Path -> Bool #
Show Path Source #
Instance details Defined in Data.PackStream.Structure Methods showsPrec :: Int -> Path -> ShowS # show :: Path -> String # showList :: [Path] -> ShowS #
FromStructure Path Source #
Instance details Defined in Data.PackStream.Structure Methods fromStructure :: Structure -> Either PackStreamError Path Source #
ToStructure Path Source #
Instance details Defined in Data.PackStream.Structure Methods toStructure :: Path -> Structure Source #

newtype Date Source #

The days are days since the Unix epoch

Constructors

Date
Fields days :: Int The days are days since the Unix epoch

Instances

Instances details

Eq Date Source #
Instance details Defined in Data.PackStream.Structure Methods (==) :: Date -> Date -> Bool # (/=) :: Date -> Date -> Bool #
Show Date Source #
Instance details Defined in Data.PackStream.Structure Methods showsPrec :: Int -> Date -> ShowS # show :: Date -> String # showList :: [Date] -> ShowS #
FromStructure Date Source #
Instance details Defined in Data.PackStream.Structure Methods fromStructure :: Structure -> Either PackStreamError Date Source #
ToStructure Date Source #
Instance details Defined in Data.PackStream.Structure Methods toStructure :: Date -> Structure Source #

data Time Source #

data LocalTime Source #

data DateTime Source #

data DateTimeZoneId Source #

data LocalDateTime Source #

data Duration Source #

data Point2D Source #

data Point3D Source #