Database.Neo4j.Traversal

Module to manage traversal operations

Types for configuring the traversal

data Uniqueness

Different types of uniqueness calculations for a traversal

Constructors

NodeGlobal

RelationshipGlobal

NodePathUnique

RelationshipPath

Instances

Eq Uniqueness

Show Uniqueness

ToJSON (Maybe Uniqueness)

How to codify uniqueness values into JSON

data TraversalOrder

Traversal mode

Constructors

BreadthFirst

DepthFirst

Instances

Eq TraversalOrder

Show TraversalOrder

ToJSON TraversalOrder

How to codify traversalDesc values into JSON

data ReturnFilter

Built-in return filters

Constructors

ReturnAll

ReturnAllButStartNode

Instances

Eq ReturnFilter

Show ReturnFilter

ToJSON ReturnFilter

How to codify ReturnFilter values into JSON

type RelFilter = (RelationshipType, Direction)

data TraversalDesc

Type containing all info describing a traversal request

Constructors

TraversalDesc

Fields

travOrder :: TraversalOrder

travRelFilter :: [RelFilter]

travUniqueness :: Maybe Uniqueness

travDepth :: Either Integer Text

travNodeFilter :: Either ReturnFilter Text

Instances

Eq TraversalDesc

Show TraversalDesc

Default TraversalDesc

Additional types for configuring a paged traversal

data TraversalPaging

Description of a traversal paging

Constructors

TraversalPaging

Fields

pageSize :: Integer

pageLeaseSecs :: Integer

Instances

Eq TraversalPaging

Show TraversalPaging

Default TraversalPaging

Types used when returning paths

data ConcreteDirection

Direction without possibility of ambiguity

Constructors

In

Out

Instances

Eq ConcreteDirection

Ord ConcreteDirection

Show ConcreteDirection

FromJSON IdPath

How to decodify an IdPath from JSON

FromJSON ConcreteDirection

data Path a b

Data type to describe a path in a graph, that is a single node or nodes interleaved with relationships

Constructors

PathEnd !a

PathLink !a !b !(Path a b)

Instances

FromJSON FullPath

How to decodify an IdPath from JSON

FromJSON IdPath

How to decodify an IdPath from JSON

(Eq a, Eq b) => Eq (Path a b)

(Ord a, Ord b) => Ord (Path a b)

(Show a, Show b) => Show (Path a b)

type IdPath = Path NodePath (RelPath, ConcreteDirection)

Path that its data are id's

type FullPath = Path Node Relationship

Path that its data are full nodes and relationships, not only their id's

Types used when returning paged results

data PagedTraversal a

Data type that holds a result for a paged traversal with the URI to get the rest of the pages

Instances

Eq a => Eq (PagedTraversal a)

Ord a => Ord (PagedTraversal a)

Show a => Show (PagedTraversal a)

pathNodes :: Path a b -> [a]

Get all the nodes of a path

pathRels :: Path a b -> [b]

Get all the relationships of a path

Traversal operations

traverseGetNodes :: NodeIdentifier a => TraversalDesc -> a -> Neo4j [Node]

Perform a traversal and get the resulting nodes

traverseGetRels :: NodeIdentifier a => TraversalDesc -> a -> Neo4j [Relationship]

Perform a traversal and get the resulting relationship entities

traverseGetPath :: NodeIdentifier a => TraversalDesc -> a -> Neo4j [IdPath]

Perform a traversal and get the resulting node and relationship paths IMPORTANT! In pre 2.2 Neo4j versions the directions in each relationship ID returned have a default value (The API does not provide them)

traverseGetFullPath :: NodeIdentifier a => TraversalDesc -> a -> Neo4j [FullPath]

Perform a traversal and get the resulting node and relationship entities

Paged traversal operations

pagedTraverseGetNodes :: NodeIdentifier a => TraversalDesc -> TraversalPaging -> a -> Neo4j (PagedTraversal Node)

Perform a paged traversal and get the resulting nodes

pagedTraverseGetRels :: NodeIdentifier a => TraversalDesc -> TraversalPaging -> a -> Neo4j (PagedTraversal Relationship)

Perform a paged traversal and get the resulting relationships

pagedTraverseGetPath :: NodeIdentifier a => TraversalDesc -> TraversalPaging -> a -> Neo4j (PagedTraversal IdPath)

Perform a paged traversal and get the resulting id paths, IMPORTANT! In pre 2.2 Neo4j versions the directions in each relationship ID returned have a default value (The API does not provide them)

pagedTraverseGetFullPath :: NodeIdentifier a => TraversalDesc -> TraversalPaging -> a -> Neo4j (PagedTraversal FullPath)

Perform a paged traversal and get the resulting paths with full entities

Operations to handle paged results

getPagedValues :: PagedTraversal a -> [a]

Get the values of a paged traversal result

nextTraversalPage :: FromJSON a => PagedTraversal a -> Neo4j (PagedTraversal a)

Get the next page of values from a traversal result

pagedTraversalDone :: PagedTraversal a -> Bool

Whether a paged traversal is done