Safe Haskell	None
Language	Haskell98

Database.Neo4j.Traversal

Contents

Types for configuring the traversal
Additional types for configuring a paged traversal
Types used when returning paths
Types used when returning paged results
Traversal operations
Paged traversal operations
Operations to handle paged results

Description

Module to manage traversal operations

Synopsis

Types for configuring the traversal

data Uniqueness Source #

Different types of uniqueness calculations for a traversal

Constructors

NodeGlobal
RelationshipGlobal
NodePathUnique
RelationshipPath

Instances

Eq Uniqueness Source #
Methods (==) :: Uniqueness -> Uniqueness -> Bool # (/=) :: Uniqueness -> Uniqueness -> Bool #
Show Uniqueness Source #
Methods showsPrec :: Int -> Uniqueness -> ShowS # show :: Uniqueness -> String # showList :: [Uniqueness] -> ShowS #

data TraversalOrder Source #

Traversal mode

Constructors

BreadthFirst
DepthFirst

Instances

Eq TraversalOrder Source #
Methods (==) :: TraversalOrder -> TraversalOrder -> Bool # (/=) :: TraversalOrder -> TraversalOrder -> Bool #
Show TraversalOrder Source #
Methods showsPrec :: Int -> TraversalOrder -> ShowS # show :: TraversalOrder -> String # showList :: [TraversalOrder] -> ShowS #
ToJSON TraversalOrder Source #	How to codify traversalDesc values into JSON
Methods toJSON :: TraversalOrder -> Value # toEncoding :: TraversalOrder -> Encoding # toJSONList :: [TraversalOrder] -> Value # toEncodingList :: [TraversalOrder] -> Encoding #

data ReturnFilter Source #

Built-in return filters

Constructors

ReturnAll
ReturnAllButStartNode

Instances

Eq ReturnFilter Source #
Methods (==) :: ReturnFilter -> ReturnFilter -> Bool # (/=) :: ReturnFilter -> ReturnFilter -> Bool #
Show ReturnFilter Source #
Methods showsPrec :: Int -> ReturnFilter -> ShowS # show :: ReturnFilter -> String # showList :: [ReturnFilter] -> ShowS #
ToJSON ReturnFilter Source #	How to codify ReturnFilter values into JSON
Methods toJSON :: ReturnFilter -> Value # toEncoding :: ReturnFilter -> Encoding # toJSONList :: [ReturnFilter] -> Value # toEncodingList :: [ReturnFilter] -> Encoding #

type RelFilter = (RelationshipType, Direction) Source #

data TraversalDesc Source #

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 Source #
Methods (==) :: TraversalDesc -> TraversalDesc -> Bool # (/=) :: TraversalDesc -> TraversalDesc -> Bool #
Show TraversalDesc Source #
Methods showsPrec :: Int -> TraversalDesc -> ShowS # show :: TraversalDesc -> String # showList :: [TraversalDesc] -> ShowS #
Default TraversalDesc Source #
Methods def :: TraversalDesc #

Additional types for configuring a paged traversal

data TraversalPaging Source #

Description of a traversal paging

Constructors

TraversalPaging
Fields pageSize :: Integer pageLeaseSecs :: Integer

Instances

Eq TraversalPaging Source #
Methods (==) :: TraversalPaging -> TraversalPaging -> Bool # (/=) :: TraversalPaging -> TraversalPaging -> Bool #
Show TraversalPaging Source #
Methods showsPrec :: Int -> TraversalPaging -> ShowS # show :: TraversalPaging -> String # showList :: [TraversalPaging] -> ShowS #
Default TraversalPaging Source #
Methods def :: TraversalPaging #

Types used when returning paths

data ConcreteDirection Source #

Direction without possibility of ambiguity

Constructors

In
Out

Instances

Eq ConcreteDirection Source #
Methods (==) :: ConcreteDirection -> ConcreteDirection -> Bool # (/=) :: ConcreteDirection -> ConcreteDirection -> Bool #
Ord ConcreteDirection Source #
Methods compare :: ConcreteDirection -> ConcreteDirection -> Ordering # (<) :: ConcreteDirection -> ConcreteDirection -> Bool # (<=) :: ConcreteDirection -> ConcreteDirection -> Bool # (>) :: ConcreteDirection -> ConcreteDirection -> Bool # (>=) :: ConcreteDirection -> ConcreteDirection -> Bool # max :: ConcreteDirection -> ConcreteDirection -> ConcreteDirection # min :: ConcreteDirection -> ConcreteDirection -> ConcreteDirection #
Show ConcreteDirection Source #
Methods showsPrec :: Int -> ConcreteDirection -> ShowS # show :: ConcreteDirection -> String # showList :: [ConcreteDirection] -> ShowS #
FromJSON IdPath Source #	How to decodify an IdPath from JSON
Methods parseJSON :: Value -> Parser IdPath # parseJSONList :: Value -> Parser [IdPath] #
FromJSON ConcreteDirection Source #
Methods parseJSON :: Value -> Parser ConcreteDirection # parseJSONList :: Value -> Parser [ConcreteDirection] #

data Path a b Source #

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 Source #	How to decodify an IdPath from JSON
Methods parseJSON :: Value -> Parser FullPath # parseJSONList :: Value -> Parser [FullPath] #
FromJSON IdPath Source #	How to decodify an IdPath from JSON
Methods parseJSON :: Value -> Parser IdPath # parseJSONList :: Value -> Parser [IdPath] #
(Eq a, Eq b) => Eq (Path a b) Source #
Methods (==) :: Path a b -> Path a b -> Bool # (/=) :: Path a b -> Path a b -> Bool #
(Ord a, Ord b) => Ord (Path a b) Source #
Methods compare :: Path a b -> Path a b -> Ordering # (<) :: Path a b -> Path a b -> Bool # (<=) :: Path a b -> Path a b -> Bool # (>) :: Path a b -> Path a b -> Bool # (>=) :: Path a b -> Path a b -> Bool # max :: Path a b -> Path a b -> Path a b # min :: Path a b -> Path a b -> Path a b #
(Show a, Show b) => Show (Path a b) Source #
Methods showsPrec :: Int -> Path a b -> ShowS # show :: Path a b -> String # showList :: [Path a b] -> ShowS #

type IdPath = Path NodePath (RelPath, ConcreteDirection) Source #

Path that its data are id's

type FullPath = Path Node Relationship Source #

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

Types used when returning paged results

data PagedTraversal a Source #

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) Source #
Methods (==) :: PagedTraversal a -> PagedTraversal a -> Bool # (/=) :: PagedTraversal a -> PagedTraversal a -> Bool #
Ord a => Ord (PagedTraversal a) Source #
Methods compare :: PagedTraversal a -> PagedTraversal a -> Ordering # (<) :: PagedTraversal a -> PagedTraversal a -> Bool # (<=) :: PagedTraversal a -> PagedTraversal a -> Bool # (>) :: PagedTraversal a -> PagedTraversal a -> Bool # (>=) :: PagedTraversal a -> PagedTraversal a -> Bool # max :: PagedTraversal a -> PagedTraversal a -> PagedTraversal a # min :: PagedTraversal a -> PagedTraversal a -> PagedTraversal a #
Show a => Show (PagedTraversal a) Source #
Methods showsPrec :: Int -> PagedTraversal a -> ShowS # show :: PagedTraversal a -> String # showList :: [PagedTraversal a] -> ShowS #

pathNodes :: Path a b -> [a] Source #

Get all the nodes of a path

pathRels :: Path a b -> [b] Source #

Get all the relationships of a path

Traversal operations

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

Perform a traversal and get the resulting nodes

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

Perform a traversal and get the resulting relationship entities

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

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] Source #

Perform a traversal and get the resulting node and relationship entities

Paged traversal operations

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

Perform a paged traversal and get the resulting nodes

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

Perform a paged traversal and get the resulting relationships

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

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) Source #

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

Operations to handle paged results

getPagedValues :: PagedTraversal a -> [a] Source #

Get the values of a paged traversal result

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

Get the next page of values from a traversal result

pagedTraversalDone :: PagedTraversal a -> Bool Source #

Whether a paged traversal is done