Database.Bolt.Extras.Query

Documentation

type GraphGetRequest = Graph NodeName NodeGetter RelGetter

The combinations of Getters to load graph from the database.

type GraphGetResponse = Graph NodeName Node URelationship

type GraphPutRequest = Graph NodeName PutNode URelationship

type GraphPutResponse = Graph NodeName BoltId BoltId

data NodeGetter

Helper to find Nodes. _varQNName is the mark for this Node, which will be used in Cypher queries. For example "MATCH(a)", here _varQNName = "a"

Constructors

NodeGetter

Fields

• boltIdN :: Maybe BoltId
• labelsN :: Maybe [Label]
• propsN :: Maybe [Property]

Instances

Show NodeGetter

Methods

showsPrec :: Int -> NodeGetter -> ShowS

show :: NodeGetter -> String

showList :: [NodeGetter] -> ShowS

type NodeName = Text

data PutNode

For given Node _ labels nodeProps makes query MERGE (n:labels {props}) RETURN ID(n) as n and then return Node with actual ID.

Potentially, if you MERGE some Node and it labels and props are occured in several Nodes, then the result can be not one but several Nodes.

Constructors

BoltId BoltId

Merge Node

Create Node

Instances

Show PutNode

Methods

showsPrec :: Int -> PutNode -> ShowS

show :: PutNode -> String

showList :: [PutNode] -> ShowS

data RelGetter

RelGetter is used for searching using indexes of Nodes in the given graph.

Constructors

RelGetter

Fields

• labelR :: Maybe Label
• propsR :: Maybe [Property]

Instances

Show RelGetter

Methods

showsPrec :: Int -> RelGetter -> ShowS

show :: RelGetter -> String

showList :: [RelGetter] -> ShowS

class ToCypher a where

The class for convertation into Cypher.

Minimal complete definition

toCypher

Methods

toCypher :: a -> Text

Instances

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 Label

Label with name are formatted into :name

Methods

toCypher :: Label -> Text

ToCypher [Property]

Several properties are formatted with concatenation.

Methods

toCypher :: [Property] -> Text

ToCypher [Label]

Several labels are formatted with concatenation.

Methods

toCypher :: [Label] -> Text

getGraph :: MonadIO m => [Text] -> GraphGetRequest -> BoltActionT m [GraphGetResponse]

For the given GraphGetRequest find the graph, which matches it. This function creates single cypher query and performs it.

putGraph :: MonadIO m => GraphPutRequest -> BoltActionT m GraphPutResponse

Create Graph using given GraphU and the list describing Nodes indices (from the given _vertices), which should be connected by the corresponding Relationship. If there were multiple choices while merging given _vertices, the first match is used for connection.