Database.Bolt

Documentation

data BoltActionT m a

Monad Transformer to do all BOLT actions in

Instances

MonadTrans BoltActionT

Defined in Database.Bolt.Connection.Type

Methods

lift :: Monad m => m a -> BoltActionT m a

Monad m => MonadReader Pipe (BoltActionT m)

Defined in Database.Bolt.Connection.Type

Methods

ask :: BoltActionT m Pipe

local :: (Pipe -> Pipe) -> BoltActionT m a -> BoltActionT m a

reader :: (Pipe -> a) -> BoltActionT m a

Monad m => MonadError BoltError (BoltActionT m)

Defined in Database.Bolt.Connection.Type

Methods

throwError :: BoltError -> BoltActionT m a

catchError :: BoltActionT m a -> (BoltError -> BoltActionT m a) -> BoltActionT m a

Monad m => Monad (BoltActionT m)

Defined in Database.Bolt.Connection.Type

Methods

(>>=) :: BoltActionT m a -> (a -> BoltActionT m b) -> BoltActionT m b

(>>) :: BoltActionT m a -> BoltActionT m b -> BoltActionT m b

return :: a -> BoltActionT m a

Functor m => Functor (BoltActionT m)

Defined in Database.Bolt.Connection.Type

Methods

fmap :: (a -> b) -> BoltActionT m a -> BoltActionT m b

(<$) :: a -> BoltActionT m b -> BoltActionT m a

Monad m => Applicative (BoltActionT m)

Defined in Database.Bolt.Connection.Type

Methods

pure :: a -> BoltActionT m a

(<*>) :: BoltActionT m (a -> b) -> BoltActionT m a -> BoltActionT m b

liftA2 :: (a -> b -> c) -> BoltActionT m a -> BoltActionT m b -> BoltActionT m c

(*>) :: BoltActionT m a -> BoltActionT m b -> BoltActionT m b

(<*) :: BoltActionT m a -> BoltActionT m b -> BoltActionT m a

MonadIO m => MonadIO (BoltActionT m)

Defined in Database.Bolt.Connection.Type

Methods

liftIO :: IO a -> BoltActionT m a

data BoltError

Error that can appear during BoltActionT manipulations

Constructors

UnsupportedServerVersion

AuthentificationFailed

ResetFailed

CannotReadChunk

WrongMessageFormat UnpackError

NoStructureInResponse

ResponseError ResponseError

RecordHasNoKey Text

NonHasboltError SomeException

HasCallStack => TimeOut

Instances

Show BoltError

Defined in Database.Bolt.Connection.Type

Methods

showsPrec :: Int -> BoltError -> ShowS

show :: BoltError -> String

showList :: [BoltError] -> ShowS

Exception BoltError

Defined in Database.Bolt.Connection.Type

Methods

toException :: BoltError -> SomeException

fromException :: SomeException -> Maybe BoltError

displayException :: BoltError -> String

Monad m => MonadError BoltError (BoltActionT m)

Defined in Database.Bolt.Connection.Type

Methods

throwError :: BoltError -> BoltActionT m a

catchError :: BoltActionT m a -> (BoltError -> BoltActionT m a) -> BoltActionT m a

data UnpackError

Error during unpack process

Constructors

NotNull

NotInt

NotFloat

NotString

NotBool

NotList

NotDict

NotStructure

NotValue

BinaryError Text

Not Text

Instances

Eq UnpackError

Defined in Database.Bolt.Value.Type

Methods

(==) :: UnpackError -> UnpackError -> Bool

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

Ord UnpackError

Defined in Database.Bolt.Value.Type

Methods

compare :: UnpackError -> UnpackError -> Ordering

(<) :: UnpackError -> UnpackError -> Bool

(<=) :: UnpackError -> UnpackError -> Bool

(>) :: UnpackError -> UnpackError -> Bool

(>=) :: UnpackError -> UnpackError -> Bool

max :: UnpackError -> UnpackError -> UnpackError

min :: UnpackError -> UnpackError -> UnpackError

Show UnpackError

Defined in Database.Bolt.Value.Type

Methods

showsPrec :: Int -> UnpackError -> ShowS

show :: UnpackError -> String

showList :: [UnpackError] -> ShowS

Monad m => MonadError UnpackError (UnpackT m)

Defined in Database.Bolt.Value.Type

Methods

throwError :: UnpackError -> UnpackT m a

catchError :: UnpackT m a -> (UnpackError -> UnpackT m a) -> UnpackT m a

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

Creates new Pipe instance to use all requests through

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

Closes Pipe

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

Resets current sessions

run :: MonadIO m => HasCallStack => Pipe -> BoltActionT m a -> m a

Runs BOLT action on selected pipe (with errors throw)

runE :: MonadIO m => HasCallStack => Pipe -> BoltActionT m a -> m (Either BoltError a)

Runs BOLT action on selected pipe

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

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

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

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

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

Runs Cypher query with parameters and ignores response

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

Runs Cypher query and ignores response

transact :: 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

Instances

NFData Pipe

Defined in Database.Bolt.Connection.Type

Methods

rnf :: Pipe -> ()

Monad m => MonadReader Pipe (BoltActionT m)

Defined in Database.Bolt.Connection.Type

Methods

ask :: BoltActionT m Pipe

local :: (Pipe -> Pipe) -> BoltActionT m a -> BoltActionT m a

reader :: (Pipe -> a) -> BoltActionT m a

data BoltCfg

Configuration of driver connection

Constructors

BoltCfg

Fields

• magic :: Word32

  '6060B017' value

• version :: Word32

  Major version number (e.g. '00000104' for 4.1)

• userAgent :: Text

  Driver user agent

• maxChunkSize :: Word16

  Maximum chunk size of request

• socketTimeout :: Int

  Driver socket timeout in seconds

• host :: String

  Neo4j server hostname

• port :: Int

  Neo4j server port

• authType :: Text

  Neo4j auth schema

• user :: Text

  Neo4j user

• password :: Text

  Neo4j password

• secure :: Bool

  Use TLS or not

Instances

Eq BoltCfg

Defined in Database.Bolt.Connection.Type

Methods

(==) :: BoltCfg -> BoltCfg -> Bool

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

Read BoltCfg

Defined in Database.Bolt.Connection.Type

Methods

readsPrec :: Int -> ReadS BoltCfg

readList :: ReadS [BoltCfg]

readPrec :: ReadPrec BoltCfg

readListPrec :: ReadPrec [BoltCfg]

Show BoltCfg

Defined in Database.Bolt.Connection.Type

Methods

showsPrec :: Int -> BoltCfg -> ShowS

show :: BoltCfg -> String

showList :: [BoltCfg] -> ShowS

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

Generic Value

Defined in Database.Bolt.Value.Type

Associated Types

type Rep Value :: Type -> Type

Methods

from :: Value -> Rep Value x

to :: Rep Value x -> Value

NFData Value

Defined in Database.Bolt.Value.Type

Methods

rnf :: Value -> ()

BoltValue Value

Defined in Database.Bolt.Value.Instances

Methods

pack :: Value -> Put

unpackT :: Get Value

RecordValue Value

Defined in Database.Bolt.Record

Methods

exactEither :: Value -> Either UnpackError 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

exactEither :: Value -> Either UnpackError (Map Text Value)

type Rep Value

Defined in Database.Bolt.Value.Type

type Rep Value = D1 ('MetaData "Value" "Database.Bolt.Value.Type" "hasbolt-0.1.6.2-7ljyLnyxtNNGAG4kHotGTG" 'False) (((C1 ('MetaCons "N" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ())) :+: C1 ('MetaCons "B" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))) :+: (C1 ('MetaCons "I" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)) :+: C1 ('MetaCons "F" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double)))) :+: ((C1 ('MetaCons "T" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "L" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Value]))) :+: (C1 ('MetaCons "M" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Text Value))) :+: C1 ('MetaCons "S" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Structure)))))

class IsValue a where

Every datatype that can be represented as BOLT protocol value

Minimal complete definition

toValue

Methods

toValue :: HasCallStack => a -> Value

Wraps value with Value constructor

toValueList :: HasCallStack => [a] -> Value

How to represent a list of values

Instances

IsValue Bool

Defined in Database.Bolt.Value.Type

Methods

toValue :: Bool -> Value

toValueList :: [Bool] -> Value

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 a => IsValue (Maybe a)

Defined in Database.Bolt.Value.Type

Methods

toValue :: Maybe a -> Value

toValueList :: [Maybe a] -> Value

IsValue a => IsValue (NonEmpty a)

Defined in Database.Bolt.Value.Type

Methods

toValue :: NonEmpty a -> Value

toValueList :: [NonEmpty 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

Generic Structure

Defined in Database.Bolt.Value.Type

Associated Types

type Rep Structure :: Type -> Type

Methods

from :: Structure -> Rep Structure x

to :: Rep Structure x -> Structure

NFData Structure

Defined in Database.Bolt.Value.Type

Methods

rnf :: Structure -> ()

BoltValue Structure

Defined in Database.Bolt.Value.Instances

Methods

pack :: Structure -> Put

unpackT :: Get Structure

type Rep Structure

Defined in Database.Bolt.Value.Type

type Rep Structure = D1 ('MetaData "Structure" "Database.Bolt.Value.Type" "hasbolt-0.1.6.2-7ljyLnyxtNNGAG4kHotGTG" 'False) (C1 ('MetaCons "Structure" 'PrefixI 'True) (S1 ('MetaSel ('Just "signature") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word8) :*: S1 ('MetaSel ('Just "fields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Value])))

type Record = Map Text Value

Result type for query requests

class RecordValue a where

Get exact type from Value

Methods

exactEither :: Value -> Either UnpackError a

Instances

RecordValue Bool

Defined in Database.Bolt.Record

Methods

exactEither :: Value -> Either UnpackError Bool

RecordValue Double

Defined in Database.Bolt.Record

Methods

exactEither :: Value -> Either UnpackError Double

RecordValue Int

Defined in Database.Bolt.Record

Methods

exactEither :: Value -> Either UnpackError Int

RecordValue ()

Defined in Database.Bolt.Record

Methods

exactEither :: Value -> Either UnpackError ()

RecordValue Text

Defined in Database.Bolt.Record

Methods

exactEither :: Value -> Either UnpackError Text

RecordValue Path

Defined in Database.Bolt.Record

Methods

exactEither :: Value -> Either UnpackError Path

RecordValue URelationship

Defined in Database.Bolt.Record

Methods

exactEither :: Value -> Either UnpackError URelationship

RecordValue Relationship

Defined in Database.Bolt.Record

Methods

exactEither :: Value -> Either UnpackError Relationship

RecordValue Node

Defined in Database.Bolt.Record

Methods

exactEither :: Value -> Either UnpackError Node

RecordValue Value

Defined in Database.Bolt.Record

Methods

exactEither :: Value -> Either UnpackError Value

RecordValue a => RecordValue [a]

Defined in Database.Bolt.Record

Methods

exactEither :: Value -> Either UnpackError [a]

RecordValue a => RecordValue (Maybe a)

Defined in Database.Bolt.Record

Methods

exactEither :: Value -> Either UnpackError (Maybe a)

RecordValue (Map Text Value)

Defined in Database.Bolt.Record

Methods

exactEither :: Value -> Either UnpackError (Map Text Value)

exact :: (MonadError UnpackError m, RecordValue a) => Value -> m a

exactMaybe :: RecordValue a => Value -> Maybe a

at :: (Monad m, RecordValue a) => Record -> Text -> BoltActionT m a

Gets result from obtained record

maybeAt :: (Monad m, RecordValue a) => Record -> Text -> BoltActionT m (Maybe a)

Possibly gets result from obtained record

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.Instances

Methods

fromStructure :: MonadError UnpackError m => Structure -> m Node

RecordValue Node

Defined in Database.Bolt.Record

Methods

exactEither :: Value -> Either UnpackError 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.Instances

Methods

fromStructure :: MonadError UnpackError m => Structure -> m Relationship

RecordValue Relationship

Defined in Database.Bolt.Record

Methods

exactEither :: Value -> Either UnpackError 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.Instances

Methods

fromStructure :: MonadError UnpackError m => Structure -> m URelationship

RecordValue URelationship

Defined in Database.Bolt.Record

Methods

exactEither :: Value -> Either UnpackError 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.Instances

Methods

fromStructure :: MonadError UnpackError m => Structure -> m Path

RecordValue Path

Defined in Database.Bolt.Record

Methods

exactEither :: Value -> Either UnpackError Path