Database.Bolt.Extras.Graph

Documentation

data Graph n a b

Graph contains vertices, that are parameterized by some type n, and relations, that parameterized by pair of type n. This pair represents vertices, that are connected with this relation.

Constructors

Graph

Fields

• _vertices :: Map n a
• _relations :: Map (n, n) b

Instances

(Show n, Show a, Show b) => Show (Graph n a b)

Defined in Database.Bolt.Extras.Graph.Internal.AbstractGraph

Methods

showsPrec :: Int -> Graph n a b -> ShowS

show :: Graph n a b -> String

showList :: [Graph n a b] -> ShowS

Generic (Graph n a b)

Defined in Database.Bolt.Extras.Graph.Internal.AbstractGraph

Associated Types

type Rep (Graph n a b) :: Type -> Type

Methods

from :: Graph n a b -> Rep (Graph n a b) x

to :: Rep (Graph n a b) x -> Graph n a b

type Rep (Graph n a b)

Defined in Database.Bolt.Extras.Graph.Internal.AbstractGraph

type Rep (Graph n a b) = D1 (MetaData "Graph" "Database.Bolt.Extras.Graph.Internal.AbstractGraph" "hasbolt-extras-0.0.0.15-HDWUrnwpJjRBwu6nqvxe91" False) (C1 (MetaCons "Graph" PrefixI True) (S1 (MetaSel (Just "_vertices") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Map n a)) :*: S1 (MetaSel (Just "_relations") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Map (n, n) b))))

vertices :: forall n a b a. Lens (Graph n a b) (Graph n a b) (Map n a) (Map n a)

relations :: forall n a b b. Lens (Graph n a b) (Graph n a b) (Map (n, n) b) (Map (n, n) b)

emptyGraph :: Ord n => Graph n a b

Creates empty graph.

addNode :: (Show n, Ord n) => n -> a -> Graph n a b -> Graph n a b

Adds node to graph by it's name and node content. If graph already contains vertex with given name, error will be thrown.

addRelation :: (Show n, Ord n) => n -> n -> b -> Graph n a b -> Graph n a b

Adds relation to graph by startName of vertex, endName of vertex, and rel with relation content. If graph already contains relation with given (startName, endName), error will be thrown.

type NodeName = Text

Alias for text node name.

relationName :: (NodeName, NodeName) -> Text

Creates relationship name from the names of its start and end nodes in the way `<startNodeName>0<endNodeName>`.

class Requestable a where

Class describes entity, which can be requested.

Methods

request :: a -> Text

How to convert entity to Cypher.

Instances

Requestable ((NodeName, NodeName), PutRelationship)

Defined in Database.Bolt.Extras.Graph.Internal.Put

Methods

request :: ((NodeName, NodeName), PutRelationship) -> Text

Requestable ((NodeName, NodeName), RelGetter)

Defined in Database.Bolt.Extras.Graph.Internal.Get

Methods

request :: ((NodeName, NodeName), RelGetter) -> Text

Requestable (NodeName, PutNode)

Defined in Database.Bolt.Extras.Graph.Internal.Put

Methods

request :: (NodeName, PutNode) -> Text

Requestable (NodeName, NodeGetter)

Defined in Database.Bolt.Extras.Graph.Internal.Get

Methods

request :: (NodeName, NodeGetter) -> Text

class Returnable a where

Class describes entity, which can be returned.

Methods

isReturned' :: a -> Bool

If the entity should be returned.

return' :: a -> Text

How to return entity in the Cypher.

Instances

Returnable ((NodeName, NodeName), PutRelationship)

Defined in Database.Bolt.Extras.Graph.Internal.Put

Methods

isReturned' :: ((NodeName, NodeName), PutRelationship) -> Bool

return' :: ((NodeName, NodeName), PutRelationship) -> Text

Returnable ((NodeName, NodeName), RelGetter)

Defined in Database.Bolt.Extras.Graph.Internal.Get

Methods

isReturned' :: ((NodeName, NodeName), RelGetter) -> Bool

return' :: ((NodeName, NodeName), RelGetter) -> Text

Returnable (NodeName, PutNode)

Defined in Database.Bolt.Extras.Graph.Internal.Put

Methods

isReturned' :: (NodeName, PutNode) -> Bool

return' :: (NodeName, PutNode) -> Text

Returnable (NodeName, NodeGetter)

Defined in Database.Bolt.Extras.Graph.Internal.Get

Methods

isReturned' :: (NodeName, NodeGetter) -> Bool

return' :: (NodeName, NodeGetter) -> Text

class Extractable a where

Class describes entity, which can be extracted from records by name.

Methods

extract :: MonadIO m => Text -> [Record] -> BoltActionT m [a]

Instances

Extractable Node

BOLT FORMAT

Defined in Database.Bolt.Extras.Graph.Internal.Get

Methods

extract :: MonadIO m => Text -> [Record] -> BoltActionT m [Node]

Extractable URelationship

Defined in Database.Bolt.Extras.Graph.Internal.Get

Methods

extract :: MonadIO m => Text -> [Record] -> BoltActionT m [URelationship]

Extractable BoltId

Defined in Database.Bolt.Extras.Graph.Internal.Put

Methods

extract :: MonadIO m => Text -> [Record] -> BoltActionT m [BoltId]

Extractable RelResult

Defined in Database.Bolt.Extras.Graph.Internal.Get

Methods

extract :: MonadIO m => Text -> [Record] -> BoltActionT m [RelResult]

Extractable NodeResult

Defined in Database.Bolt.Extras.Graph.Internal.Get

Methods

extract :: MonadIO m => Text -> [Record] -> BoltActionT m [NodeResult]

Types for requesting nodes and relationships

data NodeGetter

Helper to find Nodes.

Constructors

NodeGetter

Fields

• ngboltId :: Maybe BoltId

  known boltId

• ngLabels :: [Label]

  known labels

• ngProps :: Map Text Value

  known properties

• ngReturnProps :: [Text]

  names of properties to return

• ngIsReturned :: Bool

  whether return this node or not

Instances

Eq NodeGetter

Defined in Database.Bolt.Extras.Graph.Internal.Get

Methods

(==) :: NodeGetter -> NodeGetter -> Bool

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

Show NodeGetter

Defined in Database.Bolt.Extras.Graph.Internal.Get

Methods

showsPrec :: Int -> NodeGetter -> ShowS

show :: NodeGetter -> String

showList :: [NodeGetter] -> ShowS

GetterLike NodeGetter

Defined in Database.Bolt.Extras.Graph.Internal.Get

Methods

withBoltId :: BoltId -> NodeGetter -> NodeGetter

withLabel :: Label -> NodeGetter -> NodeGetter

withLabelQ :: Name -> NodeGetter -> NodeGetter

withProp :: (Text, Value) -> NodeGetter -> NodeGetter

withReturn :: [Text] -> NodeGetter -> NodeGetter

isReturned :: NodeGetter -> NodeGetter

Returnable (NodeName, NodeGetter)

Defined in Database.Bolt.Extras.Graph.Internal.Get

Methods

isReturned' :: (NodeName, NodeGetter) -> Bool

return' :: (NodeName, NodeGetter) -> Text

Requestable (NodeName, NodeGetter)

Defined in Database.Bolt.Extras.Graph.Internal.Get

Methods

request :: (NodeName, NodeGetter) -> Text

data RelGetter

Helper to find URelationships.

Constructors

RelGetter

Fields

• rgboltId :: Maybe BoltId

  known boltId

• rgLabel :: Maybe Label

  known labels

• rgProps :: Map Text Value

  known properties

• rgReturnProps :: [Text]

  names of properties to return

• rgIsReturned :: Bool

  whether return this relation or not

Instances

Eq RelGetter

Defined in Database.Bolt.Extras.Graph.Internal.Get

Methods

(==) :: RelGetter -> RelGetter -> Bool

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

Show RelGetter

Defined in Database.Bolt.Extras.Graph.Internal.Get

Methods

showsPrec :: Int -> RelGetter -> ShowS

show :: RelGetter -> String

showList :: [RelGetter] -> ShowS

GetterLike RelGetter

Defined in Database.Bolt.Extras.Graph.Internal.Get

Methods

withBoltId :: BoltId -> RelGetter -> RelGetter

withLabel :: Label -> RelGetter -> RelGetter

withLabelQ :: Name -> RelGetter -> RelGetter

withProp :: (Text, Value) -> RelGetter -> RelGetter

withReturn :: [Text] -> RelGetter -> RelGetter

isReturned :: RelGetter -> RelGetter

Returnable ((NodeName, NodeName), RelGetter)

Defined in Database.Bolt.Extras.Graph.Internal.Get

Methods

isReturned' :: ((NodeName, NodeName), RelGetter) -> Bool

return' :: ((NodeName, NodeName), RelGetter) -> Text

Requestable ((NodeName, NodeName), RelGetter)

Defined in Database.Bolt.Extras.Graph.Internal.Get

Methods

request :: ((NodeName, NodeName), RelGetter) -> Text

class GetterLike a where

Helper to work with Getters.

Methods

withBoltId

Arguments

:: BoltId

-> a

-> a

set known boltId

withLabel

Arguments

:: Label

-> a

-> a

set known label

withLabelQ

Arguments

:: Name

-> a

-> a

set known label as Name

withProp

Arguments

:: (Text, Value)

-> a

-> a

add known property

withReturn

Arguments

:: [Text]

-> a

-> a

add list of properties to return

isReturned

Arguments

:: a

-> a

set that current node should be returned

Instances

GetterLike RelGetter

Defined in Database.Bolt.Extras.Graph.Internal.Get

Methods

withBoltId :: BoltId -> RelGetter -> RelGetter

withLabel :: Label -> RelGetter -> RelGetter

withLabelQ :: Name -> RelGetter -> RelGetter

withProp :: (Text, Value) -> RelGetter -> RelGetter

withReturn :: [Text] -> RelGetter -> RelGetter

isReturned :: RelGetter -> RelGetter

GetterLike NodeGetter

Defined in Database.Bolt.Extras.Graph.Internal.Get

Methods

withBoltId :: BoltId -> NodeGetter -> NodeGetter

withLabel :: Label -> NodeGetter -> NodeGetter

withLabelQ :: Name -> NodeGetter -> NodeGetter

withProp :: (Text, Value) -> NodeGetter -> NodeGetter

withReturn :: [Text] -> NodeGetter -> NodeGetter

isReturned :: NodeGetter -> NodeGetter

(#) :: a -> (a -> b) -> b

defaultNode :: Bool -> NodeGetter

defaultRel :: Bool -> RelGetter

defaultNodeReturn :: NodeGetter

defaultNodeNotReturn :: NodeGetter

defaultRelReturn :: RelGetter

defaultRelNotReturn :: RelGetter

requestGetters :: [(NodeName, NodeGetter)] -> [((NodeName, NodeName), RelGetter)] -> (Text, [Text])

Takes all node getters and relationship getters and write them to single query to request. Also return conditions on known boltId-s.

allProps :: [Text]

Types for extracting nodes and relationships

data NodeResult

AESON FORMAT

Result for node in the Aeson like format.

Constructors

NodeResult

Fields

• nresId :: BoltId
• nresLabels :: [Label]
• nresProps :: Map Text Value

Instances

Eq NodeResult

Defined in Database.Bolt.Extras.Graph.Internal.Get

Methods

(==) :: NodeResult -> NodeResult -> Bool

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

Show NodeResult

Defined in Database.Bolt.Extras.Graph.Internal.Get

Methods

showsPrec :: Int -> NodeResult -> ShowS

show :: NodeResult -> String

showList :: [NodeResult] -> ShowS

Generic NodeResult

Defined in Database.Bolt.Extras.Graph.Internal.Get

Associated Types

type Rep NodeResult :: Type -> Type

Methods

from :: NodeResult -> Rep NodeResult x

to :: Rep NodeResult x -> NodeResult

ToJSON NodeResult

Defined in Database.Bolt.Extras.Graph.Internal.Get

Methods

toJSON :: NodeResult -> Value

toEncoding :: NodeResult -> Encoding

toJSONList :: [NodeResult] -> Value

toEncodingList :: [NodeResult] -> Encoding

FromJSON NodeResult

Defined in Database.Bolt.Extras.Graph.Internal.Get

Methods

parseJSON :: Value -> Parser NodeResult

parseJSONList :: Value -> Parser [NodeResult]

Extractable NodeResult

Defined in Database.Bolt.Extras.Graph.Internal.Get

Methods

extract :: MonadIO m => Text -> [Record] -> BoltActionT m [NodeResult]

GetBoltId NodeResult

Defined in Database.Bolt.Extras.Graph.Internal.Get

Methods

getBoltId :: NodeResult -> BoltId

NodeLike NodeResult

Defined in Database.Bolt.Extras.Graph.Internal.Get

Methods

toNode :: NodeResult -> Node

fromNode :: Node -> NodeResult

type Rep NodeResult

Defined in Database.Bolt.Extras.Graph.Internal.Get

type Rep NodeResult = D1 (MetaData "NodeResult" "Database.Bolt.Extras.Graph.Internal.Get" "hasbolt-extras-0.0.0.15-HDWUrnwpJjRBwu6nqvxe91" False) (C1 (MetaCons "NodeResult" PrefixI True) (S1 (MetaSel (Just "nresId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 BoltId) :*: (S1 (MetaSel (Just "nresLabels") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Label]) :*: S1 (MetaSel (Just "nresProps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Map Text Value)))))

data RelResult

Result for relationship in the Aeson like format.

Constructors

RelResult

Fields

• rresId :: BoltId
• rresLabel :: Label
• rresProps :: Map Text Value

Instances

Eq RelResult

Defined in Database.Bolt.Extras.Graph.Internal.Get

Methods

(==) :: RelResult -> RelResult -> Bool

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

Show RelResult

Defined in Database.Bolt.Extras.Graph.Internal.Get

Methods

showsPrec :: Int -> RelResult -> ShowS

show :: RelResult -> String

showList :: [RelResult] -> ShowS

Generic RelResult

Defined in Database.Bolt.Extras.Graph.Internal.Get

Associated Types

type Rep RelResult :: Type -> Type

Methods

from :: RelResult -> Rep RelResult x

to :: Rep RelResult x -> RelResult

ToJSON RelResult

Defined in Database.Bolt.Extras.Graph.Internal.Get

Methods

toJSON :: RelResult -> Value

toEncoding :: RelResult -> Encoding

toJSONList :: [RelResult] -> Value

toEncodingList :: [RelResult] -> Encoding

FromJSON RelResult

Defined in Database.Bolt.Extras.Graph.Internal.Get

Methods

parseJSON :: Value -> Parser RelResult

parseJSONList :: Value -> Parser [RelResult]

Extractable RelResult

Defined in Database.Bolt.Extras.Graph.Internal.Get

Methods

extract :: MonadIO m => Text -> [Record] -> BoltActionT m [RelResult]

GetBoltId RelResult

Defined in Database.Bolt.Extras.Graph.Internal.Get

Methods

getBoltId :: RelResult -> BoltId

URelationLike RelResult

Defined in Database.Bolt.Extras.Graph.Internal.Get

Methods

toURelation :: RelResult -> URelationship

fromURelation :: URelationship -> RelResult

type Rep RelResult

Defined in Database.Bolt.Extras.Graph.Internal.Get

type Rep RelResult = D1 (MetaData "RelResult" "Database.Bolt.Extras.Graph.Internal.Get" "hasbolt-extras-0.0.0.15-HDWUrnwpJjRBwu6nqvxe91" False) (C1 (MetaCons "RelResult" PrefixI True) (S1 (MetaSel (Just "rresId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 BoltId) :*: (S1 (MetaSel (Just "rresLabel") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Label) :*: S1 (MetaSel (Just "rresProps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Map Text Value)))))

relationName :: (NodeName, NodeName) -> Text

Creates relationship name from the names of its start and end nodes in the way `<startNodeName>0<endNodeName>`.

Graph types

type GraphGetRequest = Graph NodeName NodeGetter RelGetter

The combinations of Getters to load graph from the database.

type GraphGetResponseA = Graph NodeName NodeResult RelResult

The graph of Nodes and URelationships which we got from the database using GraphGetRequest, converted to the Aeson Value like.

type GraphGetResponseB = Graph NodeName Node URelationship

The graph of Nodes and URelationships which we got from the database using GraphGetRequest, converted to the Bolt Value like.

class GraphQuery a where

Type family used to perform requests to the Neo4j based on graphs.

Minimal complete definition

requestEntities

Associated Types

type NodeReq a :: *

Type of entity, describing node for request.

type RelReq a :: *

Type of entity, describing relationship for request.

type NodeRes a :: *

Type of node entity, which will be extracted from result.

type RelRes a :: *

Type of relationship entity, which will be extracted from result.

Methods

requestEntities :: (Requestable (NodeName, NodeReq a), Requestable ((NodeName, NodeName), RelReq a)) => [(NodeName, NodeReq a)] -> [((NodeName, NodeName), RelReq a)] -> (Text, [Text])

How to convert requestable entities to text in the query.

formQuery :: (Requestable (NodeName, NodeReq a), Requestable ((NodeName, NodeName), RelReq a), Returnable (NodeName, NodeReq a), Returnable ((NodeName, NodeName), RelReq a)) => [Text] -> Graph NodeName (NodeReq a) (RelReq a) -> Text

Abstract function to form query for request.

extractGraphs :: (Extractable (NodeRes a), Extractable (RelRes a), MonadIO m) => [NodeName] -> [(NodeName, NodeName)] -> [Record] -> BoltActionT m [Graph NodeName (NodeRes a) (RelRes a)]

Abstract function, which exctracts graph from records if nodes and relations can be extracted.

makeRequest :: (Requestable (NodeName, NodeReq a), Requestable ((NodeName, NodeName), RelReq a), Returnable (NodeName, NodeReq a), Returnable ((NodeName, NodeName), RelReq a), Extractable (NodeRes a), Extractable (RelRes a), MonadIO m) => [Text] -> Graph NodeName (NodeReq a) (RelReq a) -> BoltActionT m [Graph NodeName (NodeRes a) (RelRes a)]

For given query graph, perform query and extract results graph.

Instances

GraphQuery PutRequestB

Defined in Database.Bolt.Extras.Graph.Internal.GraphQuery

Associated Types

type NodeReq PutRequestB :: Type

type RelReq PutRequestB :: Type

type NodeRes PutRequestB :: Type

type RelRes PutRequestB :: Type

Methods

requestEntities :: [(NodeName, NodeReq PutRequestB)] -> [((NodeName, NodeName), RelReq PutRequestB)] -> (Text, [Text])

formQuery :: [Text] -> Graph NodeName (NodeReq PutRequestB) (RelReq PutRequestB) -> Text

extractGraphs :: (Extractable (NodeRes PutRequestB), Extractable (RelRes PutRequestB), MonadIO m) => [NodeName] -> [(NodeName, NodeName)] -> [Record] -> BoltActionT m [Graph NodeName (NodeRes PutRequestB) (RelRes PutRequestB)]

makeRequest :: (Requestable (NodeName, NodeReq PutRequestB), Requestable ((NodeName, NodeName), RelReq PutRequestB), Returnable (NodeName, NodeReq PutRequestB), Returnable ((NodeName, NodeName), RelReq PutRequestB), Extractable (NodeRes PutRequestB), Extractable (RelRes PutRequestB), MonadIO m) => [Text] -> Graph NodeName (NodeReq PutRequestB) (RelReq PutRequestB) -> BoltActionT m [Graph NodeName (NodeRes PutRequestB) (RelRes PutRequestB)]

GraphQuery GetRequestB

Defined in Database.Bolt.Extras.Graph.Internal.GraphQuery

Associated Types

type NodeReq GetRequestB :: Type

type RelReq GetRequestB :: Type

type NodeRes GetRequestB :: Type

type RelRes GetRequestB :: Type

Methods

requestEntities :: [(NodeName, NodeReq GetRequestB)] -> [((NodeName, NodeName), RelReq GetRequestB)] -> (Text, [Text])

formQuery :: [Text] -> Graph NodeName (NodeReq GetRequestB) (RelReq GetRequestB) -> Text

extractGraphs :: (Extractable (NodeRes GetRequestB), Extractable (RelRes GetRequestB), MonadIO m) => [NodeName] -> [(NodeName, NodeName)] -> [Record] -> BoltActionT m [Graph NodeName (NodeRes GetRequestB) (RelRes GetRequestB)]

makeRequest :: (Requestable (NodeName, NodeReq GetRequestB), Requestable ((NodeName, NodeName), RelReq GetRequestB), Returnable (NodeName, NodeReq GetRequestB), Returnable ((NodeName, NodeName), RelReq GetRequestB), Extractable (NodeRes GetRequestB), Extractable (RelRes GetRequestB), MonadIO m) => [Text] -> Graph NodeName (NodeReq GetRequestB) (RelReq GetRequestB) -> BoltActionT m [Graph NodeName (NodeRes GetRequestB) (RelRes GetRequestB)]

GraphQuery GetRequestA

Defined in Database.Bolt.Extras.Graph.Internal.GraphQuery

Associated Types

type NodeReq GetRequestA :: Type

type RelReq GetRequestA :: Type

type NodeRes GetRequestA :: Type

type RelRes GetRequestA :: Type

Methods

requestEntities :: [(NodeName, NodeReq GetRequestA)] -> [((NodeName, NodeName), RelReq GetRequestA)] -> (Text, [Text])

formQuery :: [Text] -> Graph NodeName (NodeReq GetRequestA) (RelReq GetRequestA) -> Text

extractGraphs :: (Extractable (NodeRes GetRequestA), Extractable (RelRes GetRequestA), MonadIO m) => [NodeName] -> [(NodeName, NodeName)] -> [Record] -> BoltActionT m [Graph NodeName (NodeRes GetRequestA) (RelRes GetRequestA)]

makeRequest :: (Requestable (NodeName, NodeReq GetRequestA), Requestable ((NodeName, NodeName), RelReq GetRequestA), Returnable (NodeName, NodeReq GetRequestA), Returnable ((NodeName, NodeName), RelReq GetRequestA), Extractable (NodeRes GetRequestA), Extractable (RelRes GetRequestA), MonadIO m) => [Text] -> Graph NodeName (NodeReq GetRequestA) (RelReq GetRequestA) -> BoltActionT m [Graph NodeName (NodeRes GetRequestA) (RelRes GetRequestA)]

data GetRequestA

Get request with result in Aeson format. Easy way to show result graphs.

Constructors

GetRequestA

Instances

GraphQuery GetRequestA

Defined in Database.Bolt.Extras.Graph.Internal.GraphQuery

Associated Types

type NodeReq GetRequestA :: Type

type RelReq GetRequestA :: Type

type NodeRes GetRequestA :: Type

type RelRes GetRequestA :: Type

Methods

requestEntities :: [(NodeName, NodeReq GetRequestA)] -> [((NodeName, NodeName), RelReq GetRequestA)] -> (Text, [Text])

formQuery :: [Text] -> Graph NodeName (NodeReq GetRequestA) (RelReq GetRequestA) -> Text

extractGraphs :: (Extractable (NodeRes GetRequestA), Extractable (RelRes GetRequestA), MonadIO m) => [NodeName] -> [(NodeName, NodeName)] -> [Record] -> BoltActionT m [Graph NodeName (NodeRes GetRequestA) (RelRes GetRequestA)]

makeRequest :: (Requestable (NodeName, NodeReq GetRequestA), Requestable ((NodeName, NodeName), RelReq GetRequestA), Returnable (NodeName, NodeReq GetRequestA), Returnable ((NodeName, NodeName), RelReq GetRequestA), Extractable (NodeRes GetRequestA), Extractable (RelRes GetRequestA), MonadIO m) => [Text] -> Graph NodeName (NodeReq GetRequestA) (RelReq GetRequestA) -> BoltActionT m [Graph NodeName (NodeRes GetRequestA) (RelRes GetRequestA)]

type NodeReq GetRequestA

Defined in Database.Bolt.Extras.Graph.Internal.GraphQuery

type NodeReq GetRequestA = NodeGetter

type RelReq GetRequestA

Defined in Database.Bolt.Extras.Graph.Internal.GraphQuery

type RelReq GetRequestA = RelGetter

type NodeRes GetRequestA

Defined in Database.Bolt.Extras.Graph.Internal.GraphQuery

type NodeRes GetRequestA = NodeResult

type RelRes GetRequestA

Defined in Database.Bolt.Extras.Graph.Internal.GraphQuery

type RelRes GetRequestA = RelResult

data GetRequestB

Get request with result in Bolt format. Easy way to extract results and convert them to another entities (using fromNode).

Constructors

GetRequestB

Instances

GraphQuery GetRequestB

Defined in Database.Bolt.Extras.Graph.Internal.GraphQuery

Associated Types

type NodeReq GetRequestB :: Type

type RelReq GetRequestB :: Type

type NodeRes GetRequestB :: Type

type RelRes GetRequestB :: Type

Methods

requestEntities :: [(NodeName, NodeReq GetRequestB)] -> [((NodeName, NodeName), RelReq GetRequestB)] -> (Text, [Text])

formQuery :: [Text] -> Graph NodeName (NodeReq GetRequestB) (RelReq GetRequestB) -> Text

extractGraphs :: (Extractable (NodeRes GetRequestB), Extractable (RelRes GetRequestB), MonadIO m) => [NodeName] -> [(NodeName, NodeName)] -> [Record] -> BoltActionT m [Graph NodeName (NodeRes GetRequestB) (RelRes GetRequestB)]

makeRequest :: (Requestable (NodeName, NodeReq GetRequestB), Requestable ((NodeName, NodeName), RelReq GetRequestB), Returnable (NodeName, NodeReq GetRequestB), Returnable ((NodeName, NodeName), RelReq GetRequestB), Extractable (NodeRes GetRequestB), Extractable (RelRes GetRequestB), MonadIO m) => [Text] -> Graph NodeName (NodeReq GetRequestB) (RelReq GetRequestB) -> BoltActionT m [Graph NodeName (NodeRes GetRequestB) (RelRes GetRequestB)]

type NodeReq GetRequestB

Defined in Database.Bolt.Extras.Graph.Internal.GraphQuery

type NodeReq GetRequestB = NodeGetter

type RelReq GetRequestB

Defined in Database.Bolt.Extras.Graph.Internal.GraphQuery

type RelReq GetRequestB = RelGetter

type NodeRes GetRequestB

Defined in Database.Bolt.Extras.Graph.Internal.GraphQuery

type NodeRes GetRequestB = Node

type RelRes GetRequestB

Defined in Database.Bolt.Extras.Graph.Internal.GraphQuery

type RelRes GetRequestB = URelationship

data PutRequestB

Put request in Bolt format with BoltIds of uploaded entities as result.

Constructors

PutRequestB

Instances

GraphQuery PutRequestB

Defined in Database.Bolt.Extras.Graph.Internal.GraphQuery

Associated Types

type NodeReq PutRequestB :: Type

type RelReq PutRequestB :: Type

type NodeRes PutRequestB :: Type

type RelRes PutRequestB :: Type

Methods

requestEntities :: [(NodeName, NodeReq PutRequestB)] -> [((NodeName, NodeName), RelReq PutRequestB)] -> (Text, [Text])

formQuery :: [Text] -> Graph NodeName (NodeReq PutRequestB) (RelReq PutRequestB) -> Text

extractGraphs :: (Extractable (NodeRes PutRequestB), Extractable (RelRes PutRequestB), MonadIO m) => [NodeName] -> [(NodeName, NodeName)] -> [Record] -> BoltActionT m [Graph NodeName (NodeRes PutRequestB) (RelRes PutRequestB)]

makeRequest :: (Requestable (NodeName, NodeReq PutRequestB), Requestable ((NodeName, NodeName), RelReq PutRequestB), Returnable (NodeName, NodeReq PutRequestB), Returnable ((NodeName, NodeName), RelReq PutRequestB), Extractable (NodeRes PutRequestB), Extractable (RelRes PutRequestB), MonadIO m) => [Text] -> Graph NodeName (NodeReq PutRequestB) (RelReq PutRequestB) -> BoltActionT m [Graph NodeName (NodeRes PutRequestB) (RelRes PutRequestB)]

type NodeReq PutRequestB

Defined in Database.Bolt.Extras.Graph.Internal.GraphQuery

type NodeReq PutRequestB = PutNode

type RelReq PutRequestB

Defined in Database.Bolt.Extras.Graph.Internal.GraphQuery

type RelReq PutRequestB = PutRelationship

type NodeRes PutRequestB

Defined in Database.Bolt.Extras.Graph.Internal.GraphQuery

type NodeRes PutRequestB = BoltId

type RelRes PutRequestB

Defined in Database.Bolt.Extras.Graph.Internal.GraphQuery

type RelRes PutRequestB = BoltId

mergeGraphs :: GetBoltId a => [Graph NodeName a b] -> Graph NodeName a b

Helper function to merge graphs of results, i.e. if you requested graph A->B->C and in the database there were two B entities connected to the same entity A and four C entities, connected to the same two entities B, cypher query will return four graphs, which satisfy this path, despite the fact that A was presented only once in the database and B was presented only two times in the database. This function will merge these four graphs in one and return nodes by node names with suffixes equal to their BoltId-s.

For example, if there were four graphs: nodes: [A (boltId = 0), B (boltId = 1), C (boltId = 3)], relations: [A -> B, B -> C], nodes: [A (boltId = 0), B (boltId = 1), C (boltId = 4)], relations: [A -> B, B -> C], nodes: [A (boltId = 0), B (boltId = 2), C (boltId = 5)], relations: [A -> B, B -> C], nodes: [A (boltId = 0), B (boltId = 2), C (boltId = 6)], relations: [A -> B, B -> C], this function will merge them into new graph: nodes: [A0 (boltId = 0), B1 (boltId = 1), B2 (boltId = 2), C3 (boltId = 3), C4 (boltId = 4), C5 (boltId = 5), C6 (boltId = 6)], relations: [A0 -> B1, A0 -> B2, B1 -> C3, B1 -> C4, B2 -> C5, B2 -> C6].

data PutNode

BOLT FORMAT

PutNode is the wrapper for Node where we can specify if we want to merge or create it.

Constructors

BoltId BoltId

MergeN Node

CreateN Node

Instances

Show PutNode

Defined in Database.Bolt.Extras.Graph.Internal.Put

Methods

showsPrec :: Int -> PutNode -> ShowS

show :: PutNode -> String

showList :: [PutNode] -> ShowS

Returnable (NodeName, PutNode)

Defined in Database.Bolt.Extras.Graph.Internal.Put

Methods

isReturned' :: (NodeName, PutNode) -> Bool

return' :: (NodeName, PutNode) -> Text

Requestable (NodeName, PutNode)

Defined in Database.Bolt.Extras.Graph.Internal.Put

Methods

request :: (NodeName, PutNode) -> Text

data PutRelationship

PutRelationship is the wrapper for Relationship where we can specify if we want to merge or create it.

Constructors

MergeR URelationship

CreateR URelationship

Instances

Show PutRelationship

Defined in Database.Bolt.Extras.Graph.Internal.Put

Methods

showsPrec :: Int -> PutRelationship -> ShowS

show :: PutRelationship -> String

showList :: [PutRelationship] -> ShowS

Returnable ((NodeName, NodeName), PutRelationship)

Defined in Database.Bolt.Extras.Graph.Internal.Put

Methods

isReturned' :: ((NodeName, NodeName), PutRelationship) -> Bool

return' :: ((NodeName, NodeName), PutRelationship) -> Text

Requestable ((NodeName, NodeName), PutRelationship)

Defined in Database.Bolt.Extras.Graph.Internal.Put

Methods

request :: ((NodeName, NodeName), PutRelationship) -> Text

type GraphPutRequest = Graph NodeName PutNode PutRelationship

The graph of Nodes with specified uploading type and URelationships.

type GraphPutResponse = Graph NodeName BoltId BoltId

The graph of PutNodes corresponding to the nodes and relationships which we get after putting GraphPutRequest.

requestPut :: [(NodeName, PutNode)] -> [((NodeName, NodeName), PutRelationship)] -> (Text, [Text])

Takes all PutNodes and PutRelationships and write them to single query to request. Here WITH is used, because you cannot perform "match", "merge" or "create" at the same query.