Database.Bolt.Lazy

Documentation

type BoltActionT = ReaderT Pipe

Monad Transformer to do all BOLT actions in

connect :: MonadIO m => BoltCfg -> m Pipe

Creates new Pipe instance to use all requests through

close :: MonadIO m => Pipe -> m ()

Closes Pipe

reset :: MonadIO m => Pipe -> m ()

Resets current sessions

run :: Pipe -> BoltActionT m a -> m a

Runs BOLT action on selected pipe

queryP :: MonadIO m => Text -> Map Text Value -> BoltActionT m [Record]

Runs Cypher query with parameters and returns list of obtained Records. Lazy version

query :: MonadIO m => Text -> BoltActionT m [Record]

Runs Cypher query and returns list of obtained Records. Lazy version

queryP_ :: MonadIO m => Text -> Map Text Value -> BoltActionT m ()

Runs Cypher query with parameters and ignores response

query_ :: MonadIO m => Text -> BoltActionT m ()

Runs Cypher query and ignores response

data Pipe

data BoltCfg

Configuration of driver connection

Constructors

BoltCfg

Fields

• magic :: Word32

  '6060B017' value

• version :: Word32

  '00000001' value

• userAgent :: Text

  Driver user agent

• maxChunkSize :: Word16

  Maximum chunk size of request

• socketTimeout :: Int

  Driver socket timeout

• host :: String

  Neo4j server hostname

• port :: Int

  Neo4j server port

• user :: Text

  Neo4j user

• password :: Text

  Neo4j password

• secure :: Bool

  Use TLS or not

Instances

Default BoltCfg

Methods

def :: BoltCfg

class BoltValue a where

The BoltValue class describes values, that can be packed and unpacked for BOLT protocol.

Minimal complete definition

pack, unpackT

Methods

pack :: a -> ByteString

Packs a value to ByteString

unpackT :: Monad m => UnpackT m a

Unpacks in a State monad to get values from single ByteString

unpack :: Monad m => ByteString -> m a

Unpacks a ByteString to selected value

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

RecordValue (Map Text Value)

Methods

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

data Structure

The Structure datatype describes Neo4j structure for BOLT protocol

Constructors

Structure

Fields

• signature :: Word8
• fields :: [Value]

Instances

Eq Structure

Methods

(==) :: Structure -> Structure -> Bool

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

Show Structure

Methods

showsPrec :: Int -> Structure -> ShowS

show :: Structure -> String

showList :: [Structure] -> ShowS

type Record = Map Text Value

Result type for query requests

class RecordValue a where

Get exact type from Value

Minimal complete definition

exact

Methods

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

Instances

RecordValue Bool

Methods

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

RecordValue Double

Methods

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

RecordValue Int

Methods

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

RecordValue ()

Methods

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

RecordValue Text

Methods

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

RecordValue Path

Methods

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

RecordValue URelationship

Methods

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

RecordValue Relationship

Methods

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

RecordValue Node

Methods

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

RecordValue a => RecordValue [a]

Methods

exact :: Monad m => Value -> m [a]

RecordValue a => RecordValue (Maybe a)

Methods

exact :: Monad m => Value -> m (Maybe a)

RecordValue (Map Text Value)

Methods

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

at :: Monad m => Record -> Text -> m Value

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

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

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

data Path

Constructors

Path

Fields

• pathNodes :: [Node]

  Chain of Nodes in path

• pathRelationships :: [URelationship]

  Chain of Relationships in path

• pathSequence :: [Int]

  Path sequence

Instances

Eq Path

Methods

(==) :: Path -> Path -> Bool

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

Show Path

Methods

showsPrec :: Int -> Path -> ShowS

show :: Path -> String

showList :: [Path] -> ShowS

RecordValue Path

Methods

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