API Reference

Classes

Main classes provided by the package

Connection

A managed database connection drawn from the pool.

Functions

Utility functions

get_connection()

Obtain a connection from the pool.

reinitialize()

Reset the global connection pool.

Constants

Module-level constants and data

BackendName

A supported database backend, as a string literal.

ConnectionId

An opaque handle for a single pooled connection.

Handler

A callable that handles connection lifecycle events.

MAX_CONNECTIONS

Upper bound on simultaneous database connections.

MIN_CONNECTIONS

Lower bound on warm connections kept in the pool.

PoolKey

A unique identifier for a connection pool instance.

SUPPORTED_BACKENDS

Database backends the pool can connect to.

Sortable

A connection type that can be compared for priority ordering.

retry_delay

Seconds to wait between retry attempts after a failed connect.

timeout

Seconds to wait before abandoning a connection attempt.