Safe Haskell	None
Language	GHC2021

Database.Bolty.Connection.Type

Description

Internal module. Not part of the public API.

Core types for Neo4j BOLT connections: configuration, errors, and connection handles.

Synopsis

data Config = Config {
- host :: Text
- port :: Word16
- scheme :: Scheme
- use_tls :: Bool
- versions :: [Version]
- timeout :: Int
- routing :: Routing
- user_agent :: UserAgent
- queryLogger :: Maybe (QueryLog -> QueryMeta -> IO ())
- notificationHandler :: Maybe (Notification -> IO ())
}
data ValidatedConfig = ValidatedConfig {
- host :: Text
- port :: Word16
- scheme :: Scheme
- use_tls :: Bool
- versions :: [Word32]
- timeout :: Int
- routing :: Routing
- user_agent :: UserAgent
- queryLogger :: Maybe (QueryLog -> QueryMeta -> IO ())
- notificationHandler :: Maybe (Notification -> IO ())
}
data ServerState
- = Disconnected
- | Connected
- | Defunct
- | Authentication
- | Ready
- | Streaming
- | TXready
- | TXstreaming
- | Failed
- | Interrupted
data Connection = Connection {
- rawConnection :: !Connection
- timeout_milliseconds :: !Int
- version :: Word32
- server_state :: IORef ServerState
- server_agent :: Text
- connection_id :: Text
- lastActivity :: IORef Word64
- telemetry_enabled :: Bool
- serverIdleTimeout :: Maybe Int
- queryLogger :: Maybe (QueryLog -> QueryMeta -> IO ())
- notificationHandler :: Maybe (Notification -> IO ())
}
data Error
data Scheme
- = None
- | Basic !Principal !Credentials
- | Kerberos
- | Bearer !Credentials
type Principal = Text
type Credentials = Text
data Routing
- = NoRouting
- | Routing
- | RoutingSpec !Text !(HashMap Text Text)
data UserAgent = UserAgent {
- name :: !Text
- version :: !Text
}
isTransient :: Error -> Bool
isRoutingError :: Error -> Bool

Documentation

data Config Source #

Connection configuration. Use def for sensible defaults and override the fields you need. Must be validated with validateConfig before use.

Constructors

Config

Fields

host :: Text
Server hostname or IP address. Default: "127.0.0.1".
port :: Word16
Server port. Default: 7687.
scheme :: Scheme
Authentication scheme. Default: None.
use_tls :: Bool
Whether to use TLS. Default: True.
versions :: [Version]
BOLT protocol versions to negotiate, in preference order.
timeout :: Int
Connection timeout in milliseconds. Default: 10000.
routing :: Routing
Routing configuration. Default: NoRouting.
user_agent :: UserAgent
User-agent string sent in HELLO.
queryLogger :: Maybe (QueryLog -> QueryMeta -> IO ())
Optional callback fired after each query completes.
notificationHandler :: Maybe (Notification -> IO ())
Optional callback fired for each server notification (warnings, hints, deprecations).

Instances

Instances details

Default Config Source #
Instance details Defined in Database.Bolty.Connection.Type Methods def :: Config #

data ValidatedConfig Source #

A validated configuration ready for connect. Created via validateConfig.

Constructors

ValidatedConfig
Fields host :: Text port :: Word16 scheme :: Scheme use_tls :: Bool versions :: [Word32] Encoded BOLT version words. timeout :: Int routing :: Routing user_agent :: UserAgent queryLogger :: Maybe (QueryLog -> QueryMeta -> IO ()) notificationHandler :: Maybe (Notification -> IO ())

data ServerState Source #

https://neo4j.com/docs/bolt/current/bolt/server-state/#server-states

Constructors

Disconnected
Connected
Defunct
Authentication
Ready
Streaming
TXready
TXstreaming
Failed
Interrupted

Instances

Instances details

Show ServerState Source #
Instance details Defined in Database.Bolty.Connection.Type Methods showsPrec :: Int -> ServerState -> ShowS # show :: ServerState -> String # showList :: [ServerState] -> ShowS #
Eq ServerState Source #
Instance details Defined in Database.Bolty.Connection.Type Methods (==) :: ServerState -> ServerState -> Bool # (/=) :: ServerState -> ServerState -> Bool #

data Connection Source #

An open connection to a Neo4j server. Obtain via connect.

Constructors

Connection

Fields

rawConnection :: !Connection
timeout_milliseconds :: !Int
version :: Word32
Negotiated BOLT protocol version.
server_state :: IORef ServerState
server_agent :: Text
Server agent string from HELLO response.
connection_id :: Text
Server-assigned connection ID.
lastActivity :: IORef Word64
Monotonic nanosecond timestamp of last successful operation. Used by PingIfIdle validation strategy to skip health checks on recently-used connections.
telemetry_enabled :: Bool
Whether the server supports telemetry (from HELLO SUCCESS hints).
serverIdleTimeout :: Maybe Int
Server-advertised idle timeout in seconds (from connection.recv_timeout_seconds hint). Nothing if the server didn't send this hint (Bolt < 5.x or hint not present).
queryLogger :: Maybe (QueryLog -> QueryMeta -> IO ())
Optional callback fired after each query completes.
notificationHandler :: Maybe (Notification -> IO ())
Optional callback fired for each server notification.

data Error Source #

Errors that can occur during BOLT communication.

Constructors

TimeOut Text	A network operation timed out.
AuthentificationFailed	The server rejected the authentication credentials.
UnsupportedServerVersion Word32	No mutually supported BOLT version could be negotiated.
ResetFailed	A RESET message failed (connection is likely defunct).
CannotReadResponse Text	Failed to parse a response from the server.
NonboltyError SomeException	A non-BOLT exception (e.g. network IO error).
ResponseErrorRecords	Received records when a non-record response was expected.
WrongMessageFormat Text	The server sent an unexpected message type.
ResponseErrorIgnored	The server sent an IGNORED response.
ResponseErrorFailure Text Text	A FAILURE response with Neo4j error code and message.
InvalidState ServerState Text	Attempted an operation in an invalid server state.
RoutingTableError Text	Failed to fetch or parse a routing table.

Instances

Instances details

Exception Error Source #
Instance details Defined in Database.Bolty.Connection.Type Methods toException :: Error -> SomeException # fromException :: SomeException -> Maybe Error # displayException :: Error -> String # backtraceDesired :: Error -> Bool #
Show Error Source #
Instance details Defined in Database.Bolty.Connection.Type Methods showsPrec :: Int -> Error -> ShowS # show :: Error -> String # showList :: [Error] -> ShowS #

data Scheme Source #

Authentication scheme for the HELLO handshake.

Constructors

None	No authentication.
Basic !Principal !Credentials	Basic username/password authentication.
Kerberos	Kerberos authentication (ticket obtained externally).
Bearer !Credentials	Bearer token authentication (e.g. SSO).

Instances

Instances details

Generic Scheme Source #

Instance details

Defined in Database.Bolty.Connection.Type

Associated Types

type Rep Scheme

Instance details

Defined in Database.Bolty.Connection.Type

type Rep Scheme = D1 ('MetaData "Scheme" "Database.Bolty.Connection.Type" "bolty-0.1.0.2-D4CzMg1BY3r5YzeDrGyWz4" 'False) ((C1 ('MetaCons "None" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Basic" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Principal) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Credentials))) :+: (C1 ('MetaCons "Kerberos" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Bearer" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Credentials))))

Methods

from :: Scheme -> Rep Scheme x #

to :: Rep Scheme x -> Scheme #

Eq Scheme Source #

Instance details

Defined in Database.Bolty.Connection.Type

Methods

(==) :: Scheme -> Scheme -> Bool #

(/=) :: Scheme -> Scheme -> Bool #

PackStream Scheme Source #

Instance details

Defined in Database.Bolty.Connection.Instances

Methods

toPs :: Scheme -> Ps #

toBinary :: Scheme -> Put #

fromPs :: Ps -> Result Scheme #

type Rep Scheme Source #

Instance details

Defined in Database.Bolty.Connection.Type

type Rep Scheme = D1 ('MetaData "Scheme" "Database.Bolty.Connection.Type" "bolty-0.1.0.2-D4CzMg1BY3r5YzeDrGyWz4" 'False) ((C1 ('MetaCons "None" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Basic" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Principal) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Credentials))) :+: (C1 ('MetaCons "Kerberos" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Bearer" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Credentials))))

type Principal = Text Source #

Username for authentication.

type Credentials = Text Source #

Password or token for authentication.

data Routing Source #

Routing mode for cluster-aware connections.

Constructors

NoRouting	Direct connection (no routing).
Routing	Use server-side routing with default settings.
RoutingSpec !Text !(HashMap Text Text)	Use server-side routing with explicit address and parameters. Arguments: advertised address (e.g. `"core1:7687"`), additional routing context parameters.

Instances

Instances details

Eq Routing Source #
Instance details Defined in Database.Bolty.Connection.Type Methods (==) :: Routing -> Routing -> Bool # (/=) :: Routing -> Routing -> Bool #
PackStream Routing Source #
Instance details Defined in Database.Bolty.Connection.Instances Methods toPs :: Routing -> Ps # toBinary :: Routing -> Put # fromPs :: Ps -> Result Routing #

data UserAgent Source #

User-agent identifier sent to the server in the HELLO message.

Constructors

UserAgent
Fields name :: !Text Application name. version :: !Text Application version.

Instances

Instances details

Eq UserAgent Source #
Instance details Defined in Database.Bolty.Connection.Type Methods (==) :: UserAgent -> UserAgent -> Bool # (/=) :: UserAgent -> UserAgent -> Bool #
PackStream UserAgent Source #
Instance details Defined in Database.Bolty.Connection.Instances Methods toPs :: UserAgent -> Ps # toBinary :: UserAgent -> Put # fromPs :: Ps -> Result UserAgent #

isTransient :: Error -> Bool Source #

Check if an error is a transient Neo4j failure that can be retried.

isRoutingError :: Error -> Bool Source #

Check if an error indicates stale routing information. These errors mean the driver sent a request to the wrong server (e.g. a write to a read replica). The routing table should be invalidated and the operation retried on a fresh leader.