Database.Bolt

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. Strict version

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

Runs Cypher query and returns list of obtained Records. Strict 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

transact :: (MonadError e m, MonadIO m) => BoltActionT m a -> BoltActionT m a

Runs a sequence of actions as transaction. All queries would be rolled back in case of any exception inside the block.

(=:) :: IsValue a => Text -> a -> (Text, Value)

Wrap key-value pair with Value datatype

props :: [(Text, Value)] -> Map Text Value

Construct properties map from list

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

Defined in Database.Bolt.Connection.Type

Methods

def :: BoltCfg

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

Defined in Database.Bolt.Value.Type

Methods

(==) :: Value -> Value -> Bool

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

Show Value

Defined in Database.Bolt.Value.Type

Methods

showsPrec :: Int -> Value -> ShowS

show :: Value -> String

showList :: [Value] -> ShowS

BoltValue Value

Defined in Database.Bolt.Value.Instances

Methods

pack :: Value -> ByteString

unpackT :: Monad m => UnpackT m Value

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

IsValue (Map Text Value)

Defined in Database.Bolt.Value.Type

Methods

toValue :: Map Text Value -> Value

toValueList :: [Map Text Value] -> Value

RecordValue (Map Text Value)

Defined in Database.Bolt.Record

Methods

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

class IsValue a where

Every datatype that can be represented as BOLT protocol value

Minimal complete definition

toValue

Methods

toValue :: a -> Value

Wraps value with Value constructor

toValueList :: [a] -> Value

How to represent a list of values

Instances

IsValue Char

Defined in Database.Bolt.Value.Type

Methods

toValue :: Char -> Value

toValueList :: [Char] -> Value

IsValue Double

Defined in Database.Bolt.Value.Type

Methods

toValue :: Double -> Value

toValueList :: [Double] -> Value

IsValue Float

Defined in Database.Bolt.Value.Type

Methods

toValue :: Float -> Value

toValueList :: [Float] -> Value

IsValue Int

Defined in Database.Bolt.Value.Type

Methods

toValue :: Int -> Value

toValueList :: [Int] -> Value

IsValue Integer

Defined in Database.Bolt.Value.Type

Methods

toValue :: Integer -> Value

toValueList :: [Integer] -> Value

IsValue ()

Defined in Database.Bolt.Value.Type

Methods

toValue :: () -> Value

toValueList :: [()] -> Value

IsValue Text

Defined in Database.Bolt.Value.Type

Methods

toValue :: Text -> Value

toValueList :: [Text] -> Value

IsValue a => IsValue [a]

Defined in Database.Bolt.Value.Type

Methods

toValue :: [a] -> Value

toValueList :: [[a]] -> Value

IsValue (Map Text Value)

Defined in Database.Bolt.Value.Type

Methods

toValue :: Map Text Value -> Value

toValueList :: [Map Text Value] -> Value

data Structure

The Structure datatype describes Neo4j structure for BOLT protocol

Constructors

Structure

Fields

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

Instances

Eq Structure

Defined in Database.Bolt.Value.Type

Methods

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

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

Show Structure

Defined in Database.Bolt.Value.Type

Methods

showsPrec :: Int -> Structure -> ShowS

show :: Structure -> String

showList :: [Structure] -> ShowS

BoltValue Structure

Defined in Database.Bolt.Value.Instances

Methods

pack :: Structure -> ByteString

unpackT :: Monad m => UnpackT m Structure

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

type Record = Map Text Value

Result type for query requests

class RecordValue a where

Get exact type from Value

Methods

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

Instances

RecordValue Bool

Defined in Database.Bolt.Record

Methods

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

RecordValue Double

Defined in Database.Bolt.Record

Methods

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

RecordValue Int

Defined in Database.Bolt.Record

Methods

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

RecordValue ()

Defined in Database.Bolt.Record

Methods

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

RecordValue Text

Defined in Database.Bolt.Record

Methods

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

RecordValue Path

Defined in Database.Bolt.Record

Methods

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

RecordValue URelationship

Defined in Database.Bolt.Record

Methods

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

RecordValue Relationship

Defined in Database.Bolt.Record

Methods

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

RecordValue Node

Defined in Database.Bolt.Record

Methods

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

RecordValue a => RecordValue [a]

Defined in Database.Bolt.Record

Methods

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

RecordValue a => RecordValue (Maybe a)

Defined in Database.Bolt.Record

Methods

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

RecordValue (Map Text Value)

Defined in Database.Bolt.Record

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

Defined in Database.Bolt.Value.Type

Methods

(==) :: Node -> Node -> Bool

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

Show Node

Defined in Database.Bolt.Value.Type

Methods

showsPrec :: Int -> Node -> ShowS

show :: Node -> String

showList :: [Node] -> ShowS

FromStructure Node

Defined in Database.Bolt.Value.Structure

Methods

fromStructure :: Monad m => Structure -> m Node

RecordValue Node

Defined in Database.Bolt.Record

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

Defined in Database.Bolt.Value.Type

Methods

(==) :: Relationship -> Relationship -> Bool

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

Show Relationship

Defined in Database.Bolt.Value.Type

Methods

showsPrec :: Int -> Relationship -> ShowS

show :: Relationship -> String

showList :: [Relationship] -> ShowS

FromStructure Relationship

Defined in Database.Bolt.Value.Structure

Methods

fromStructure :: Monad m => Structure -> m Relationship

RecordValue Relationship

Defined in Database.Bolt.Record

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

Defined in Database.Bolt.Value.Type

Methods

(==) :: URelationship -> URelationship -> Bool

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

Show URelationship

Defined in Database.Bolt.Value.Type

Methods

showsPrec :: Int -> URelationship -> ShowS

show :: URelationship -> String

showList :: [URelationship] -> ShowS

FromStructure URelationship

Defined in Database.Bolt.Value.Structure

Methods

fromStructure :: Monad m => Structure -> m URelationship

RecordValue URelationship

Defined in Database.Bolt.Record

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

Defined in Database.Bolt.Value.Type

Methods

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

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

Show Path

Defined in Database.Bolt.Value.Type

Methods

showsPrec :: Int -> Path -> ShowS

show :: Path -> String

showList :: [Path] -> ShowS

FromStructure Path

Defined in Database.Bolt.Value.Structure

Methods

fromStructure :: Monad m => Structure -> m Path

RecordValue Path

Defined in Database.Bolt.Record

Methods

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