Data.PackStream.Structure

Documentation

class ToStructure a where

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

Methods

toStructure :: a -> Structure

Convert object to Structure

Instances

ToStructure Path

Defined in Data.PackStream.Structure

Methods

toStructure :: Path -> Structure

ToStructure UnboundRelationship

Defined in Data.PackStream.Structure

Methods

toStructure :: UnboundRelationship -> Structure

ToStructure Relationship

Defined in Data.PackStream.Structure

Methods

toStructure :: Relationship -> Structure

ToStructure Node

Defined in Data.PackStream.Structure

Methods

toStructure :: Node -> Structure

class FromStructure a where

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

Methods

fromStructure :: Structure -> Either PackStreamError a

Convert Structure to the object of selected type

Instances

FromStructure Path

Defined in Data.PackStream.Structure

Methods

fromStructure :: Structure -> Either PackStreamError Path

FromStructure UnboundRelationship

Defined in Data.PackStream.Structure

Methods

fromStructure :: Structure -> Either PackStreamError UnboundRelationship

FromStructure Relationship

Defined in Data.PackStream.Structure

Methods

fromStructure :: Structure -> Either PackStreamError Relationship

FromStructure Node

Defined in Data.PackStream.Structure

Methods

fromStructure :: Structure -> Either PackStreamError Node

data Node

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

Eq Node

Defined in Data.PackStream.Structure

Methods

(==) :: Node -> Node -> Bool

(/=) :: Node -> Node -> Bool

Show Node

Defined in Data.PackStream.Structure

Methods

showsPrec :: Int -> Node -> ShowS

show :: Node -> String

showList :: [Node] -> ShowS

FromStructure Node

Defined in Data.PackStream.Structure

Methods

fromStructure :: Structure -> Either PackStreamError Node

ToStructure Node

Defined in Data.PackStream.Structure

Methods

toStructure :: Node -> Structure

data Relationship

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

Eq Relationship

Defined in Data.PackStream.Structure

Methods

(==) :: Relationship -> Relationship -> Bool

(/=) :: Relationship -> Relationship -> Bool

Show Relationship

Defined in Data.PackStream.Structure

Methods

showsPrec :: Int -> Relationship -> ShowS

show :: Relationship -> String

showList :: [Relationship] -> ShowS

FromStructure Relationship

Defined in Data.PackStream.Structure

Methods

fromStructure :: Structure -> Either PackStreamError Relationship

ToStructure Relationship

Defined in Data.PackStream.Structure

Methods

toStructure :: Relationship -> Structure

data UnboundRelationship

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

Eq UnboundRelationship

Defined in Data.PackStream.Structure

Methods

(==) :: UnboundRelationship -> UnboundRelationship -> Bool

(/=) :: UnboundRelationship -> UnboundRelationship -> Bool

Show UnboundRelationship

Defined in Data.PackStream.Structure

Methods

showsPrec :: Int -> UnboundRelationship -> ShowS

show :: UnboundRelationship -> String

showList :: [UnboundRelationship] -> ShowS

FromStructure UnboundRelationship

Defined in Data.PackStream.Structure

Methods

fromStructure :: Structure -> Either PackStreamError UnboundRelationship

ToStructure UnboundRelationship

Defined in Data.PackStream.Structure

Methods

toStructure :: UnboundRelationship -> Structure

data Path

Alternating sequence of nodes and relationships

Constructors

Path

Fields

• nodes :: [Node]

  Chain of Nodes in path

• rels :: [UnboundRelationship]

  Chain of UnboundRelationships in path

• ids :: [Int]

  The ids is a list of relationship id and node id to represent the path

Instances

Eq Path

Defined in Data.PackStream.Structure

Methods

(==) :: Path -> Path -> Bool

(/=) :: Path -> Path -> Bool

Show Path

Defined in Data.PackStream.Structure

Methods

showsPrec :: Int -> Path -> ShowS

show :: Path -> String

showList :: [Path] -> ShowS

FromStructure Path

Defined in Data.PackStream.Structure

Methods

fromStructure :: Structure -> Either PackStreamError Path

ToStructure Path

Defined in Data.PackStream.Structure

Methods

toStructure :: Path -> Structure