Safe Haskell	None
Language	Haskell2010

Database.Bolt

Synopsis

data BoltActionT m a
data BoltError
- = UnsupportedServerVersion
- | AuthentificationFailed
- | ResetFailed
- | CannotReadChunk
- | WrongMessageFormat UnpackError
- | NoStructureInResponse
- | ResponseError ResponseError
- | RecordHasNoKey Text
- | NonHasboltError SomeException
- | HasCallStack => TimeOut
data UnpackError
- = NotNull
- | NotInt
- | NotFloat
- | NotString
- | NotBool
- | NotList
- | NotDict
- | NotStructure
- | NotValue
- | Not Text
connect :: MonadIO m => HasCallStack => BoltCfg -> m Pipe
close :: MonadIO m => HasCallStack => Pipe -> m ()
reset :: MonadIO m => HasCallStack => Pipe -> m ()
run :: MonadIO m => HasCallStack => Pipe -> BoltActionT m a -> m a
runE :: MonadIO m => HasCallStack => Pipe -> BoltActionT m a -> m (Either BoltError a)
queryP :: MonadIO m => Text -> Map Text Value -> BoltActionT m [Record]
query :: MonadIO m => Text -> BoltActionT m [Record]
queryP_ :: MonadIO m => HasCallStack => Text -> Map Text Value -> BoltActionT m ()
query_ :: MonadIO m => HasCallStack => Text -> BoltActionT m ()
transact :: MonadIO m => BoltActionT m a -> BoltActionT m a
(=:) :: IsValue a => Text -> a -> (Text, Value)
props :: [(Text, Value)] -> Map Text Value
data Pipe
data BoltCfg = BoltCfg {
- magic :: Word32
- version :: Word32
- userAgent :: Text
- maxChunkSize :: Word16
- socketTimeout :: Int
- host :: String
- port :: Int
- user :: Text
- password :: Text
- secure :: Bool
}
data Value
- = N ()
- | B Bool
- | I Int
- | F Double
- | T Text
- | L [Value]
- | M (Map Text Value)
- | S Structure
class IsValue a where
- toValue :: a -> Value
- toValueList :: [a] -> Value
data Structure = Structure {
- signature :: Word8
- fields :: [Value]
}
type Record = Map Text Value
class RecordValue a where
- exactEither :: Value -> Either UnpackError a
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
data Node = Node {
- nodeIdentity :: Int
- labels :: [Text]
- nodeProps :: Map Text Value
}
data Relationship = Relationship {
- relIdentity :: Int
- startNodeId :: Int
- endNodeId :: Int
- relType :: Text
- relProps :: Map Text Value
}
data URelationship = URelationship {
- urelIdentity :: Int
- urelType :: Text
- urelProps :: Map Text Value
}
data Path = Path {
- pathNodes :: [Node]
- pathRelationships :: [URelationship]
- pathSequence :: [Int]
}

Documentation

data BoltActionT m a Source #

Monad Transformer to do all BOLT actions in

Instances

Instances details

MonadTrans BoltActionT Source #
Instance details Defined in Database.Bolt.Connection.Type Methods lift :: Monad m => m a -> BoltActionT m a #
Monad m => MonadReader Pipe (BoltActionT m) Source #
Instance details 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) Source #
Instance details 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) Source #
Instance details 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) Source #
Instance details 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) Source #
Instance details 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) Source #
Instance details Defined in Database.Bolt.Connection.Type Methods liftIO :: IO a -> BoltActionT m a #

data BoltError Source #

Error that can appear during BoltActionT manipulations

Constructors

UnsupportedServerVersion
AuthentificationFailed
ResetFailed
CannotReadChunk
WrongMessageFormat UnpackError
NoStructureInResponse
ResponseError ResponseError
RecordHasNoKey Text
NonHasboltError SomeException
HasCallStack => TimeOut

Instances

Instances details

Show BoltError Source #
Instance details Defined in Database.Bolt.Connection.Type Methods showsPrec :: Int -> BoltError -> ShowS # show :: BoltError -> String # showList :: [BoltError] -> ShowS #
Exception BoltError Source #
Instance details Defined in Database.Bolt.Connection.Type Methods toException :: BoltError -> SomeException # fromException :: SomeException -> Maybe BoltError # displayException :: BoltError -> String #
Monad m => MonadError BoltError (BoltActionT m) Source #
Instance details 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 Source #

Error during unpack process

Constructors

NotNull
NotInt
NotFloat
NotString
NotBool
NotList
NotDict
NotStructure
NotValue
Not Text

Instances

Instances details

Eq UnpackError Source #
Instance details Defined in Database.Bolt.Value.Type Methods (==) :: UnpackError -> UnpackError -> Bool # (/=) :: UnpackError -> UnpackError -> Bool #
Ord UnpackError Source #
Instance details 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 Source #
Instance details Defined in Database.Bolt.Value.Type Methods showsPrec :: Int -> UnpackError -> ShowS # show :: UnpackError -> String # showList :: [UnpackError] -> ShowS #
Monad m => MonadError UnpackError (UnpackT m) Source #
Instance details 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 Source #

Creates new Pipe instance to use all requests through

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

Closes Pipe

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

Resets current sessions

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

Runs BOLT action on selected pipe (with errors throw)

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

Runs BOLT action on selected pipe

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

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

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

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

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

Runs Cypher query with parameters and ignores response

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

Runs Cypher query and ignores response

transact :: MonadIO m => BoltActionT m a -> BoltActionT m a Source #

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

Wrap key-value pair with Value datatype

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

Construct properties map from list

data Pipe Source #

Instances

Instances details

Monad m => MonadReader Pipe (BoltActionT m) Source #
Instance details 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 Source #

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 in seconds 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

Instances details

Eq BoltCfg Source #
Instance details Defined in Database.Bolt.Connection.Type Methods (==) :: BoltCfg -> BoltCfg -> Bool # (/=) :: BoltCfg -> BoltCfg -> Bool #
Read BoltCfg Source #
Instance details Defined in Database.Bolt.Connection.Type Methods readsPrec :: Int -> ReadS BoltCfg # readList :: ReadS [BoltCfg] # readPrec :: ReadPrec BoltCfg # readListPrec :: ReadPrec [BoltCfg] #
Show BoltCfg Source #
Instance details Defined in Database.Bolt.Connection.Type Methods showsPrec :: Int -> BoltCfg -> ShowS # show :: BoltCfg -> String # showList :: [BoltCfg] -> ShowS #
Default BoltCfg Source #
Instance details Defined in Database.Bolt.Connection.Type Methods def :: BoltCfg #

data Value Source #

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

Instances details

Eq Value Source #
Instance details Defined in Database.Bolt.Value.Type Methods (==) :: Value -> Value -> Bool # (/=) :: Value -> Value -> Bool #
Show Value Source #
Instance details Defined in Database.Bolt.Value.Type Methods showsPrec :: Int -> Value -> ShowS # show :: Value -> String # showList :: [Value] -> ShowS #
BoltValue Value Source #
Instance details Defined in Database.Bolt.Value.Instances Methods pack :: Value -> ByteString Source # unpackT :: forall (m :: Type -> Type). Monad m => UnpackT m Value Source #
RecordValue Value Source #
Instance details Defined in Database.Bolt.Record Methods exactEither :: Value -> Either UnpackError Value Source #
IsValue (Map Text Value) Source #
Instance details Defined in Database.Bolt.Value.Type Methods toValue :: Map Text Value -> Value Source # toValueList :: [Map Text Value] -> Value Source #
RecordValue (Map Text Value) Source #
Instance details Defined in Database.Bolt.Record Methods exactEither :: Value -> Either UnpackError (Map Text Value) Source #

class IsValue a where Source #

Every datatype that can be represented as BOLT protocol value

Minimal complete definition

toValue

Methods

toValue :: a -> Value Source #

Wraps value with Value constructor

toValueList :: [a] -> Value Source #

How to represent a list of values

Instances

Instances details

IsValue Bool Source #
Instance details Defined in Database.Bolt.Value.Type Methods toValue :: Bool -> Value Source # toValueList :: [Bool] -> Value Source #
IsValue Char Source #
Instance details Defined in Database.Bolt.Value.Type Methods toValue :: Char -> Value Source # toValueList :: [Char] -> Value Source #
IsValue Double Source #
Instance details Defined in Database.Bolt.Value.Type Methods toValue :: Double -> Value Source # toValueList :: [Double] -> Value Source #
IsValue Float Source #
Instance details Defined in Database.Bolt.Value.Type Methods toValue :: Float -> Value Source # toValueList :: [Float] -> Value Source #
IsValue Int Source #
Instance details Defined in Database.Bolt.Value.Type Methods toValue :: Int -> Value Source # toValueList :: [Int] -> Value Source #
IsValue Integer Source #
Instance details Defined in Database.Bolt.Value.Type Methods toValue :: Integer -> Value Source # toValueList :: [Integer] -> Value Source #
IsValue () Source #
Instance details Defined in Database.Bolt.Value.Type Methods toValue :: () -> Value Source # toValueList :: [()] -> Value Source #
IsValue Text Source #
Instance details Defined in Database.Bolt.Value.Type Methods toValue :: Text -> Value Source # toValueList :: [Text] -> Value Source #
IsValue a => IsValue [a] Source #
Instance details Defined in Database.Bolt.Value.Type Methods toValue :: [a] -> Value Source # toValueList :: [[a]] -> Value Source #
IsValue (Map Text Value) Source #
Instance details Defined in Database.Bolt.Value.Type Methods toValue :: Map Text Value -> Value Source # toValueList :: [Map Text Value] -> Value Source #

data Structure Source #

The Structure datatype describes Neo4j structure for BOLT protocol

Constructors

Structure
Fields signature :: Word8 fields :: [Value]

Instances

Instances details

Eq Structure Source #
Instance details Defined in Database.Bolt.Value.Type Methods (==) :: Structure -> Structure -> Bool # (/=) :: Structure -> Structure -> Bool #
Show Structure Source #
Instance details Defined in Database.Bolt.Value.Type Methods showsPrec :: Int -> Structure -> ShowS # show :: Structure -> String # showList :: [Structure] -> ShowS #
BoltValue Structure Source #
Instance details Defined in Database.Bolt.Value.Instances Methods pack :: Structure -> ByteString Source # unpackT :: forall (m :: Type -> Type). Monad m => UnpackT m Structure Source #

type Record = Map Text Value Source #

Result type for query requests

class RecordValue a where Source #

Get exact type from Value

Methods

exactEither :: Value -> Either UnpackError a Source #

Instances

Instances details

RecordValue Bool Source #
Instance details Defined in Database.Bolt.Record Methods exactEither :: Value -> Either UnpackError Bool Source #
RecordValue Double Source #
Instance details Defined in Database.Bolt.Record Methods exactEither :: Value -> Either UnpackError Double Source #
RecordValue Int Source #
Instance details Defined in Database.Bolt.Record Methods exactEither :: Value -> Either UnpackError Int Source #
RecordValue () Source #
Instance details Defined in Database.Bolt.Record Methods exactEither :: Value -> Either UnpackError () Source #
RecordValue Text Source #
Instance details Defined in Database.Bolt.Record Methods exactEither :: Value -> Either UnpackError Text Source #
RecordValue Path Source #
Instance details Defined in Database.Bolt.Record Methods exactEither :: Value -> Either UnpackError Path Source #
RecordValue URelationship Source #
Instance details Defined in Database.Bolt.Record Methods exactEither :: Value -> Either UnpackError URelationship Source #
RecordValue Relationship Source #
Instance details Defined in Database.Bolt.Record Methods exactEither :: Value -> Either UnpackError Relationship Source #
RecordValue Node Source #
Instance details Defined in Database.Bolt.Record Methods exactEither :: Value -> Either UnpackError Node Source #
RecordValue Value Source #
Instance details Defined in Database.Bolt.Record Methods exactEither :: Value -> Either UnpackError Value Source #
RecordValue a => RecordValue [a] Source #
Instance details Defined in Database.Bolt.Record Methods exactEither :: Value -> Either UnpackError [a] Source #
RecordValue a => RecordValue (Maybe a) Source #
Instance details Defined in Database.Bolt.Record Methods exactEither :: Value -> Either UnpackError (Maybe a) Source #
RecordValue (Map Text Value) Source #
Instance details Defined in Database.Bolt.Record Methods exactEither :: Value -> Either UnpackError (Map Text Value) Source #

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

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

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

Gets result from obtained record

data Node Source #

Constructors

Node
Fields nodeIdentity :: Int Neo4j node identifier labels :: [Text] Set of node labels (types) nodeProps :: Map Text Value Dict of node properties

Instances

Instances details

Eq Node Source #
Instance details Defined in Database.Bolt.Value.Type Methods (==) :: Node -> Node -> Bool # (/=) :: Node -> Node -> Bool #
Show Node Source #
Instance details Defined in Database.Bolt.Value.Type Methods showsPrec :: Int -> Node -> ShowS # show :: Node -> String # showList :: [Node] -> ShowS #
FromStructure Node Source #
Instance details Defined in Database.Bolt.Value.Instances Methods fromStructure :: MonadError UnpackError m => Structure -> m Node Source #
RecordValue Node Source #
Instance details Defined in Database.Bolt.Record Methods exactEither :: Value -> Either UnpackError Node Source #

data Relationship Source #

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

Instances details

Eq Relationship Source #
Instance details Defined in Database.Bolt.Value.Type Methods (==) :: Relationship -> Relationship -> Bool # (/=) :: Relationship -> Relationship -> Bool #
Show Relationship Source #
Instance details Defined in Database.Bolt.Value.Type Methods showsPrec :: Int -> Relationship -> ShowS # show :: Relationship -> String # showList :: [Relationship] -> ShowS #
FromStructure Relationship Source #
Instance details Defined in Database.Bolt.Value.Instances Methods fromStructure :: MonadError UnpackError m => Structure -> m Relationship Source #
RecordValue Relationship Source #
Instance details Defined in Database.Bolt.Record Methods exactEither :: Value -> Either UnpackError Relationship Source #

data URelationship Source #

Constructors

URelationship
Fields urelIdentity :: Int Neo4j relationship identifier urelType :: Text Relationship type urelProps :: Map Text Value Dict of relationship properties

Instances

Instances details

Eq URelationship Source #
Instance details Defined in Database.Bolt.Value.Type Methods (==) :: URelationship -> URelationship -> Bool # (/=) :: URelationship -> URelationship -> Bool #
Show URelationship Source #
Instance details Defined in Database.Bolt.Value.Type Methods showsPrec :: Int -> URelationship -> ShowS # show :: URelationship -> String # showList :: [URelationship] -> ShowS #
FromStructure URelationship Source #
Instance details Defined in Database.Bolt.Value.Instances Methods fromStructure :: MonadError UnpackError m => Structure -> m URelationship Source #
RecordValue URelationship Source #
Instance details Defined in Database.Bolt.Record Methods exactEither :: Value -> Either UnpackError URelationship Source #

data Path Source #

Constructors

Path
Fields pathNodes :: [Node] Chain of `Node`s in path pathRelationships :: [URelationship] Chain of `Relationship`s in path pathSequence :: [Int] Path sequence

Instances

Instances details

Eq Path Source #
Instance details Defined in Database.Bolt.Value.Type Methods (==) :: Path -> Path -> Bool # (/=) :: Path -> Path -> Bool #
Show Path Source #
Instance details Defined in Database.Bolt.Value.Type Methods showsPrec :: Int -> Path -> ShowS # show :: Path -> String # showList :: [Path] -> ShowS #
FromStructure Path Source #
Instance details Defined in Database.Bolt.Value.Instances Methods fromStructure :: MonadError UnpackError m => Structure -> m Path Source #
RecordValue Path Source #
Instance details Defined in Database.Bolt.Record Methods exactEither :: Value -> Either UnpackError Path Source #