Skip to main content

Module postgres

Module postgres 

Source
Expand description

The PostgreSQL backend, behind the same feature that gates it in fraiseql-db.

PostgresAdapter belongs here, not in the unconditional list above. The blanket pub use fraiseql_db as db; carried each item’s own #[cfg] for free; enumerating the names drops that, so every line above is an assertion that the item is ungated in fraiseql-db — and nothing but a feature-OFF build checks it. make lint-feature-matrix is that build. PostgreSQL database adapter.

Provides connection pooling and query execution for PostgreSQL.

Modules§

test_hooks
Adapter internals the PostgreSQL integration suite drives directly.

Structs§

IndexInfo
One index on a relation, with its key list in declared order (#1307).
PoolPrewarmConfig
Configuration for connection pool construction and pre-warming.
PostgresAdapter
PostgreSQL database adapter with connection pooling.
PostgresIntrospector
PostgreSQL introspector for fact table metadata.
PostgresTlsConfig
Transport security settings for a PostgreSQL connection pool.
ReadReplicaConfig
Read-replica configuration for a PostgreSQL adapter (#407).
ReadReplicaPolicy
ReadReplicaConfig without the URLs: how replica routing behaves, separated from where the replicas are (#957).
SearchPath
A validated PostgreSQL search_path, applied at connection establishment.
VectorScanConfig
pgvector scan settings applied to every connection a pool opens (#1116).

Enums§

HnswIterativeScan
How pgvector’s HNSW index behaves when a filter eliminates the candidates it handed up (#1116).
IvfflatIterativeScan
The same setting for pgvector’s IVFFlat index (#1116).
PostgresConnector
The connector a pool creates connections with.
PostgresSslMode
How much transport security a PostgreSQL connection must have.

Constants§

MINIMUM_SERVER_VERSION_NUM
The lowest supported server_version_num (PostgreSQL 18.0).

Functions§

check_server_version
Refuse a server whose server_version_num is below MINIMUM_SERVER_VERSION_NUM.
require_supported_server
Ask the server behind client its version and refuse it below the floor.

Type Aliases§

PostgresWhereGenerator
PostgreSQL WHERE clause generator.