Database.Bolt.Extras.Template

Documentation

class FromValue a where

FromValue means that something can be converted from Bolt Value.

Minimal complete definition

fromValue

Methods

fromValue :: Value -> a

type Label = Text

Alias for Neo4j label

class Labels a where

Minimal complete definition

getLabels

Methods

getLabels :: a -> [Label]

Instances

Labels Node

Methods

getLabels :: Node -> [Label]

Labels URelationship

Methods

getLabels :: URelationship -> [Label]

data Node :: *

Constructors

Node

Fields

• nodeIdentity :: Int

  Neo4j node identifier

• labels :: [Text]

  Set of node labels (types)

• nodeProps :: Map Text Value

  Dict of node properties

Instances

Eq Node

Methods

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

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

Show Node

Methods

showsPrec :: Int -> Node -> ShowS

show :: Node -> String

showList :: [Node] -> ShowS

RecordValue Node

Methods

exact :: Monad m => Value -> m Node

Properties Node

Methods

getProps :: Node -> Map Text Value

Labels Node

Methods

getLabels :: Node -> [Label]

GetBoltId Node

Methods

getBoltId :: Node -> BoltId

class NodeLike a where

NodeLike class represents convertable into and from Node.

Minimal complete definition

toNode, fromNode

Methods

toNode :: a -> Node

fromNode :: Node -> a

class Properties a where

Minimal complete definition

getProps

Methods

getProps :: a -> Map Text Value

Instances

Properties Node

Methods

getProps :: Node -> Map Text Value

Properties URelationship

Methods

getProps :: URelationship -> Map Text Value

type Property = (Text, Value)

Alias for Neo4j property

data Relationship :: *

Constructors

Relationship

Fields

• relIdentity :: Int

  Neo4j relationship identifier

• startNodeId :: Int

  Identifier of start node

• endNodeId :: Int

  Identifier of end node

• relType :: Text

  Relationship type

• relProps :: Map Text Value

  Dict of relationship properties

Instances

Eq Relationship

Methods

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

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

Show Relationship

Methods

showsPrec :: Int -> Relationship -> ShowS

show :: Relationship -> String

showList :: [Relationship] -> ShowS

RecordValue Relationship

Methods

exact :: Monad m => Value -> m Relationship

GetBoltId Relationship

Methods

getBoltId :: Relationship -> BoltId

class ToValue a where

ToValue means that something can be converted into Bolt Value.

Minimal complete definition

toValue

Methods

toValue :: a -> Value

class URelationLike a where

URelationLike class represents convertable into and from URelationship.

Minimal complete definition

toURelation, fromURelation

Methods

toURelation :: a -> URelationship

fromURelation :: URelationship -> a

data URelationship :: *

Constructors

URelationship

Fields

• urelIdentity :: Int

  Neo4j relationship identifier

• urelType :: Text

  Relationship type

• urelProps :: Map Text Value

  Dict of relationship properties

Instances

Eq URelationship

Methods

(==) :: URelationship -> URelationship -> Bool

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

Show URelationship

Methods

showsPrec :: Int -> URelationship -> ShowS

show :: URelationship -> String

showList :: [URelationship] -> ShowS

RecordValue URelationship

Methods

exact :: Monad m => Value -> m URelationship

Properties URelationship

Methods

getProps :: URelationship -> Map Text Value

Labels URelationship

Methods

getLabels :: URelationship -> [Label]

GetBoltId URelationship

Methods

getBoltId :: URelationship -> BoltId

data Value :: *

The Value datatype generalizes all primitive BoltValues

Constructors

N ()

B Bool

I Int

F Double

T Text

L [Value]

M (Map Text Value)

S Structure

Instances

Eq Value

Methods

(==) :: Value -> Value -> Bool

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

Show Value

Methods

showsPrec :: Int -> Value -> ShowS

show :: Value -> String

showList :: [Value] -> ShowS

ToCypher Value

Convertation for Value into Cypher.

Methods

toCypher :: Value -> Text

ToCypher Property

Converts property with name and value to name:value.

Methods

toCypher :: Property -> Text

ToCypher [Property]

Several properties are formatted with concatenation.

Methods

toCypher :: [Property] -> Text

RecordValue (Map Text Value)

Methods

exact :: Monad m => Value -> m (Map Text Value)

makeNodeLike :: Name -> Q [Dec]

Make an instance of NodeLike class. Only data types with one constructor are currently supported. Each field is transformed into Text key and its value is transformed into a Value. For example, we have a structure

data Foo = Bar { baz  :: Double
               , quux :: Text
               , quuz :: Int
               }

You can make it instance of NodeClass by writing > makeNodeLike ''Foo

Then you may create example and convert it into from from Node:

ghci>:set -XOverloadedStrings
ghci> let foo = Bar 42.0 "Loren ipsum" 7
ghci> toNode foo
Node {nodeIdentity = -1, labels = ["Foo"], nodeProps = fromList [("baz",F 42.0),("quux",T "Loren ipsum"),("quuz",I 7)]}
ghci> fromNode . toNode $ foo :: Foo
Bar {baz = 42.0, quux = "Loren ipsum", quuz = 7}

makeURelationLike :: Name -> Q [Dec]

Make an instance of URelationLike class. Transformations are the same as in NodeLike instance declaration with the only one difference: URelationship holds only one label (or type), but Node holds list of labels.