Skip to main content

Module api

Module api 

Source
Expand description

handler layer and high-level API layer. APIs for building postgresql compatible servers.

Modules§

auth
Authentication handlers for the startup phase.
cancel
Cancel request handling.
copy
COPY protocol handlers.
portal
Portal management for the extended query protocol.
query
Simple and extended query handlers.
results
Query result encoding and formatting.
stmt
Prepared statement management.
store
Portal and prepared statement storage backends.
transaction
Transaction status tracking.

Structs§

ConnectionGuard
RAII guard that unregisters a connection from the ConnectionManager on drop.
ConnectionHandle
Per-connection cancel handle.
ConnectionManager
A registry mapping (pid, secret_key) to per-connection cancel handles.
DefaultClient
Default client implementation holding all per-connection state.
NoopHandler
A noop implementation for ErrorHandler.
RandomPidSecretKeyGenerator
SessionExtensions
Per-connection typed extension store, keyed by TypeId.
Type
A Postgres type.

Enums§

PgWireConnectionState
States of a PostgreSQL connection lifecycle.

Constants§

DEFAULT_NAME
Default name used when no name is provided for prepared statements or portals.
METADATA_APPLICATION_NAME
Metadata key for the application name.
METADATA_CLIENT_ENCODING
Metadata key for the client encoding setting.
METADATA_DATABASE
Metadata key for the target database name.
METADATA_USER
Metadata key for the connected user name.

Traits§

ClientInfo
Describe a client information holder
ClientPortalStore
Client Portal Store
ErrorHandler
A centralized handler for all errors
PgWireServerHandlers
A collection of all handler traits required to serve a PostgreSQL connection.
PidSecretKeyGenerator
Generator for process ID and secret key pairs used to identify connections for cancel requests.