| Safe Haskell | None |
|---|---|
| Language | GHC2021 |
Database.Bolty.Message.Request
Description
Internal module. Not part of the public API.
Synopsis
- data Request
- data Hello = Hello {}
- data Logon = Logon {}
- data TelemetryApi
- data RunExplicitTransaction = RunExplicitTransaction {}
- data RunAutoCommitTransaction = RunAutoCommitTransaction {}
- defaultRunAutoCommitTransaction :: RunAutoCommitTransaction
- mkRunAutoCommit :: Text -> HashMap Text Ps -> RunAutoCommitTransaction
- data Discard = Discard {}
- data Begin = Begin {}
- data Pull = Pull {}
- defaultPull :: Pull
- data Route = Route {}
- data RouteExtra = RouteExtra {}
- data RunExtra = RunExtra {}
- defaultRunExtra :: RunExtra
Documentation
A BOLT client request message.
Constructors
Instances
HELLO message payload for initial handshake authentication.
Constructors
| Hello | |
Instances
| Generic Hello Source # | |||||
Defined in Database.Bolty.Message.Request Associated Types
| |||||
| PackStream Hello Source # | |||||
| type Rep Hello Source # | |||||
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)))) | |||||
LOGON message carries authentication credentials (Bolt 5.1+). In 5.1+ HELLO no longer carries credentials; auth moves to LOGON.
Instances
| Generic Logon Source # | |||||
Defined in Database.Bolty.Message.Request Associated Types
| |||||
| PackStream Logon Source # | |||||
| type Rep Logon Source # | |||||
Defined in Database.Bolty.Message.Request | |||||
data TelemetryApi Source #
Telemetry API type indicators (Bolt 5.4+).
Instances
| Show TelemetryApi Source # | |
Defined in Database.Bolty.Message.Request Methods showsPrec :: Int -> TelemetryApi -> ShowS # show :: TelemetryApi -> String # showList :: [TelemetryApi] -> ShowS # | |
| Eq TelemetryApi Source # | |
Defined in Database.Bolty.Message.Request | |
data RunExplicitTransaction Source #
RUN message payload within an explicit transaction.
Constructors
| RunExplicitTransaction | |
Instances
| Generic RunExplicitTransaction Source # | |||||
Defined in Database.Bolty.Message.Request Associated Types
Methods from :: RunExplicitTransaction -> Rep RunExplicitTransaction x # to :: Rep RunExplicitTransaction x -> RunExplicitTransaction # | |||||
| type Rep RunExplicitTransaction Source # | |||||
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.
Constructors
| RunAutoCommitTransaction | |
Instances
| Generic RunAutoCommitTransaction Source # | |||||
Defined in Database.Bolty.Message.Request Associated Types
Methods from :: RunAutoCommitTransaction -> Rep RunAutoCommitTransaction x # to :: Rep RunAutoCommitTransaction x -> RunAutoCommitTransaction # | |||||
| type Rep RunAutoCommitTransaction Source # | |||||
Defined in Database.Bolty.Message.Request type Rep RunAutoCommitTransaction = D1 ('MetaData "RunAutoCommitTransaction" "Database.Bolty.Message.Request" "bolty-0.1.0.2-D4CzMg1BY3r5YzeDrGyWz4" 'False) (C1 ('MetaCons "RunAutoCommitTransaction" '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) :*: S1 ('MetaSel ('Just "bookmarks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (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))))))) | |||||
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.
DISCARD message payload with record count and query ID.
Instances
| Generic Discard Source # | |||||
Defined in Database.Bolty.Message.Request Associated Types
| |||||
| PackStream Discard Source # | |||||
| type Rep Discard Source # | |||||
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))) | |||||
BEGIN message payload for starting an explicit transaction.
Constructors
| Begin | |
Instances
| Generic Begin Source # | |||||
Defined in Database.Bolty.Message.Request Associated Types
| |||||
| PackStream Begin Source # | |||||
| type Rep Begin Source # | |||||
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)))))) | |||||
PULL message payload with record count and optional query ID.
Instances
| Generic Pull Source # | |||||
Defined in Database.Bolty.Message.Request Associated Types
| |||||
| PackStream Pull Source # | |||||
| type Rep Pull Source # | |||||
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.
ROUTE message payload for fetching routing tables.
data RouteExtra Source #
Extra parameters for the ROUTE message (database and impersonated user).
Instances
| PackStream RouteExtra Source # | |
Defined in Database.Bolty.Message.Request | |
Extra parameters for the RUN message (bookmarks, timeout, metadata, mode, db, impersonation).
Constructors
| RunExtra | |
defaultRunExtra :: RunExtra Source #
Default RunExtra with empty bookmarks, no timeout, write mode, and no database.