bolty-0.1.0.2: Haskell driver for Neo4j (BOLT protocol 4.4-5.4)
Safe HaskellNone
LanguageGHC2021

Database.Bolty.Message.Request

Description

Internal module. Not part of the public API.

Synopsis

Documentation

data Request Source #

A BOLT client request message.

Instances

Instances details
Generic Request Source # 
Instance details

Defined in Database.Bolty.Message.Request

Associated Types

type Rep Request 
Instance details

Defined in Database.Bolty.Message.Request

type Rep Request = D1 ('MetaData "Request" "Database.Bolty.Message.Request" "bolty-0.1.0.2-D4CzMg1BY3r5YzeDrGyWz4" 'False) (((C1 ('MetaCons "RHello" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Hello)) :+: (C1 ('MetaCons "RGoodbye" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "RReset" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "RRunExplicitTransaction" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 RunExplicitTransaction)) :+: C1 ('MetaCons "RRunAutoCommitTransaction" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 RunAutoCommitTransaction))) :+: (C1 ('MetaCons "RDiscard" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Discard)) :+: C1 ('MetaCons "RPull" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Pull))))) :+: ((C1 ('MetaCons "RBegin" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Begin)) :+: (C1 ('MetaCons "RCommit" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "RRollback" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "RRoute" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Route)) :+: C1 ('MetaCons "RLogon" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Logon))) :+: (C1 ('MetaCons "RLogoff" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "RTelemetry" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TelemetryApi))))))

Methods

from :: Request -> Rep Request x #

to :: Rep Request x -> Request #

PackStream Request Source # 
Instance details

Defined in Database.Bolty.Message.Request

type Rep Request Source # 
Instance details

Defined in Database.Bolty.Message.Request

type Rep Request = D1 ('MetaData "Request" "Database.Bolty.Message.Request" "bolty-0.1.0.2-D4CzMg1BY3r5YzeDrGyWz4" 'False) (((C1 ('MetaCons "RHello" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Hello)) :+: (C1 ('MetaCons "RGoodbye" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "RReset" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "RRunExplicitTransaction" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 RunExplicitTransaction)) :+: C1 ('MetaCons "RRunAutoCommitTransaction" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 RunAutoCommitTransaction))) :+: (C1 ('MetaCons "RDiscard" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Discard)) :+: C1 ('MetaCons "RPull" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Pull))))) :+: ((C1 ('MetaCons "RBegin" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Begin)) :+: (C1 ('MetaCons "RCommit" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "RRollback" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "RRoute" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Route)) :+: C1 ('MetaCons "RLogon" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Logon))) :+: (C1 ('MetaCons "RLogoff" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "RTelemetry" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TelemetryApi))))))

data Hello Source #

HELLO message payload for initial handshake authentication.

Constructors

Hello 

Fields

Instances

Instances details
Generic Hello Source # 
Instance details

Defined in Database.Bolty.Message.Request

Associated Types

type Rep Hello 
Instance details

Defined in Database.Bolty.Message.Request

type Rep Hello = D1 ('MetaData "Hello" "Database.Bolty.Message.Request" "bolty-0.1.0.2-D4CzMg1BY3r5YzeDrGyWz4" 'False) (C1 ('MetaCons "Hello" 'PrefixI 'True) ((S1 ('MetaSel ('Just "user_agent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UserAgent) :*: S1 ('MetaSel ('Just "scheme") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Scheme)) :*: (S1 ('MetaSel ('Just "routing") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Routing) :*: S1 ('MetaSel ('Just "patchBolt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))))

Methods

from :: Hello -> Rep Hello x #

to :: Rep Hello x -> Hello #

PackStream Hello Source # 
Instance details

Defined in Database.Bolty.Message.Request

Methods

toPs :: Hello -> Ps #

toBinary :: Hello -> Put #

fromPs :: Ps -> Result Hello #

type Rep Hello Source # 
Instance details

Defined in Database.Bolty.Message.Request

type Rep Hello = D1 ('MetaData "Hello" "Database.Bolty.Message.Request" "bolty-0.1.0.2-D4CzMg1BY3r5YzeDrGyWz4" 'False) (C1 ('MetaCons "Hello" 'PrefixI 'True) ((S1 ('MetaSel ('Just "user_agent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UserAgent) :*: S1 ('MetaSel ('Just "scheme") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Scheme)) :*: (S1 ('MetaSel ('Just "routing") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Routing) :*: S1 ('MetaSel ('Just "patchBolt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))))

data Logon Source #

LOGON message carries authentication credentials (Bolt 5.1+). In 5.1+ HELLO no longer carries credentials; auth moves to LOGON.

Constructors

Logon 

Fields

Instances

Instances details
Generic Logon Source # 
Instance details

Defined in Database.Bolty.Message.Request

Associated Types

type Rep Logon 
Instance details

Defined in Database.Bolty.Message.Request

type Rep Logon = D1 ('MetaData "Logon" "Database.Bolty.Message.Request" "bolty-0.1.0.2-D4CzMg1BY3r5YzeDrGyWz4" 'False) (C1 ('MetaCons "Logon" 'PrefixI 'True) (S1 ('MetaSel ('Just "scheme") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Scheme)))

Methods

from :: Logon -> Rep Logon x #

to :: Rep Logon x -> Logon #

PackStream Logon Source # 
Instance details

Defined in Database.Bolty.Message.Request

Methods

toPs :: Logon -> Ps #

toBinary :: Logon -> Put #

fromPs :: Ps -> Result Logon #

type Rep Logon Source # 
Instance details

Defined in Database.Bolty.Message.Request

type Rep Logon = D1 ('MetaData "Logon" "Database.Bolty.Message.Request" "bolty-0.1.0.2-D4CzMg1BY3r5YzeDrGyWz4" 'False) (C1 ('MetaCons "Logon" 'PrefixI 'True) (S1 ('MetaSel ('Just "scheme") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Scheme)))

data TelemetryApi Source #

Telemetry API type indicators (Bolt 5.4+).

Instances

Instances details
Show TelemetryApi Source # 
Instance details

Defined in Database.Bolty.Message.Request

Eq TelemetryApi Source # 
Instance details

Defined in Database.Bolty.Message.Request

data RunExplicitTransaction Source #

RUN message payload within an explicit transaction.

Instances

Instances details
Generic RunExplicitTransaction Source # 
Instance details

Defined in Database.Bolty.Message.Request

Associated Types

type Rep RunExplicitTransaction 
Instance details

Defined in Database.Bolty.Message.Request

type Rep RunExplicitTransaction = D1 ('MetaData "RunExplicitTransaction" "Database.Bolty.Message.Request" "bolty-0.1.0.2-D4CzMg1BY3r5YzeDrGyWz4" 'False) (C1 ('MetaCons "RunExplicitTransaction" 'PrefixI 'True) (S1 ('MetaSel ('Just "query") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (HashMap Text Ps)) :*: S1 ('MetaSel ('Just "extra") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 RunExtra))))
type Rep RunExplicitTransaction Source # 
Instance details

Defined in Database.Bolty.Message.Request

type Rep RunExplicitTransaction = D1 ('MetaData "RunExplicitTransaction" "Database.Bolty.Message.Request" "bolty-0.1.0.2-D4CzMg1BY3r5YzeDrGyWz4" 'False) (C1 ('MetaCons "RunExplicitTransaction" 'PrefixI 'True) (S1 ('MetaSel ('Just "query") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (HashMap Text Ps)) :*: S1 ('MetaSel ('Just "extra") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 RunExtra))))

data RunAutoCommitTransaction Source #

RUN message payload for an auto-commit transaction.

Instances

Instances details
Generic RunAutoCommitTransaction Source # 
Instance details

Defined in Database.Bolty.Message.Request

type Rep RunAutoCommitTransaction Source # 
Instance details

Defined in Database.Bolty.Message.Request

defaultRunAutoCommitTransaction :: RunAutoCommitTransaction Source #

Default RunAutoCommitTransaction with empty query, parameters, and bookmarks.

mkRunAutoCommit :: Text -> HashMap Text Ps -> RunAutoCommitTransaction Source #

Build a RunAutoCommitTransaction with the given query and parameters.

data Discard Source #

DISCARD message payload with record count and query ID.

Constructors

Discard 

Fields

Instances

Instances details
Generic Discard Source # 
Instance details

Defined in Database.Bolty.Message.Request

Associated Types

type Rep Discard 
Instance details

Defined in Database.Bolty.Message.Request

type Rep Discard = D1 ('MetaData "Discard" "Database.Bolty.Message.Request" "bolty-0.1.0.2-D4CzMg1BY3r5YzeDrGyWz4" 'False) (C1 ('MetaCons "Discard" 'PrefixI 'True) (S1 ('MetaSel ('Just "n") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64) :*: S1 ('MetaSel ('Just "qid") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64)))

Methods

from :: Discard -> Rep Discard x #

to :: Rep Discard x -> Discard #

PackStream Discard Source # 
Instance details

Defined in Database.Bolty.Message.Request

type Rep Discard Source # 
Instance details

Defined in Database.Bolty.Message.Request

type Rep Discard = D1 ('MetaData "Discard" "Database.Bolty.Message.Request" "bolty-0.1.0.2-D4CzMg1BY3r5YzeDrGyWz4" 'False) (C1 ('MetaCons "Discard" 'PrefixI 'True) (S1 ('MetaSel ('Just "n") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64) :*: S1 ('MetaSel ('Just "qid") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64)))

data Begin Source #

BEGIN message payload for starting an explicit transaction.

Constructors

Begin 

Fields

Instances

Instances details
Generic Begin Source # 
Instance details

Defined in Database.Bolty.Message.Request

Associated Types

type Rep Begin 
Instance details

Defined in Database.Bolty.Message.Request

type Rep Begin = D1 ('MetaData "Begin" "Database.Bolty.Message.Request" "bolty-0.1.0.2-D4CzMg1BY3r5YzeDrGyWz4" 'False) (C1 ('MetaCons "Begin" 'PrefixI 'True) ((S1 ('MetaSel ('Just "bookmarks") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Vector Text)) :*: (S1 ('MetaSel ('Just "tx_timeout") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Int64)) :*: S1 ('MetaSel ('Just "tx_metadata") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (HashMap Text Ps)))) :*: (S1 ('MetaSel ('Just "mode") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Char) :*: (S1 ('MetaSel ('Just "db") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "imp_user") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Text))))))

Methods

from :: Begin -> Rep Begin x #

to :: Rep Begin x -> Begin #

PackStream Begin Source # 
Instance details

Defined in Database.Bolty.Message.Request

Methods

toPs :: Begin -> Ps #

toBinary :: Begin -> Put #

fromPs :: Ps -> Result Begin #

type Rep Begin Source # 
Instance details

Defined in Database.Bolty.Message.Request

type Rep Begin = D1 ('MetaData "Begin" "Database.Bolty.Message.Request" "bolty-0.1.0.2-D4CzMg1BY3r5YzeDrGyWz4" 'False) (C1 ('MetaCons "Begin" 'PrefixI 'True) ((S1 ('MetaSel ('Just "bookmarks") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Vector Text)) :*: (S1 ('MetaSel ('Just "tx_timeout") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Int64)) :*: S1 ('MetaSel ('Just "tx_metadata") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (HashMap Text Ps)))) :*: (S1 ('MetaSel ('Just "mode") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Char) :*: (S1 ('MetaSel ('Just "db") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "imp_user") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Text))))))

data Pull Source #

PULL message payload with record count and optional query ID.

Constructors

Pull 

Fields

Instances

Instances details
Generic Pull Source # 
Instance details

Defined in Database.Bolty.Message.Request

Associated Types

type Rep Pull 
Instance details

Defined in Database.Bolty.Message.Request

type Rep Pull = D1 ('MetaData "Pull" "Database.Bolty.Message.Request" "bolty-0.1.0.2-D4CzMg1BY3r5YzeDrGyWz4" 'False) (C1 ('MetaCons "Pull" 'PrefixI 'True) (S1 ('MetaSel ('Just "n") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64) :*: S1 ('MetaSel ('Just "qid") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int64))))

Methods

from :: Pull -> Rep Pull x #

to :: Rep Pull x -> Pull #

PackStream Pull Source # 
Instance details

Defined in Database.Bolty.Message.Request

Methods

toPs :: Pull -> Ps #

toBinary :: Pull -> Put #

fromPs :: Ps -> Result Pull #

type Rep Pull Source # 
Instance details

Defined in Database.Bolty.Message.Request

type Rep Pull = D1 ('MetaData "Pull" "Database.Bolty.Message.Request" "bolty-0.1.0.2-D4CzMg1BY3r5YzeDrGyWz4" 'False) (C1 ('MetaCons "Pull" 'PrefixI 'True) (S1 ('MetaSel ('Just "n") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64) :*: S1 ('MetaSel ('Just "qid") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int64))))

defaultPull :: Pull Source #

Default Pull requesting all records (n = -1) with no explicit query ID.

data Route Source #

ROUTE message payload for fetching routing tables.

Constructors

Route 

Fields

data RouteExtra Source #

Extra parameters for the ROUTE message (database and impersonated user).

Constructors

RouteExtra 

Fields

Instances

Instances details
PackStream RouteExtra Source # 
Instance details

Defined in Database.Bolty.Message.Request

data RunExtra Source #

Extra parameters for the RUN message (bookmarks, timeout, metadata, mode, db, impersonation).

Constructors

RunExtra 

Fields

Instances

Instances details
PackStream RunExtra Source # 
Instance details

Defined in Database.Bolty.Message.Request

defaultRunExtra :: RunExtra Source #

Default RunExtra with empty bookmarks, no timeout, write mode, and no database.