Configuration options

This page documents all configuration options for zodb-pgjsonb, including ZConfig directives, Python constructor parameters, S3 deployment modes, and dependencies.

ZConfig <pgjsonb> section

The storage is configured in zope.conf via a <pgjsonb> section after importing the package:

%import zodb_pgjsonb

<zodb_db main>
  <pgjsonb>
    dsn dbname=zodb host=localhost port=5432 user=zodb password=zodb
  </pgjsonb>
</zodb_db>

The factory class is zodb_pgjsonb.config.PGJsonbStorageFactory. It implements ZODB.storage.

Configuration keys

Key	Type	Default	Required	Description
dsn	string	–	yes	PostgreSQL connection string in libpq key=value format or postgresql:// URI format.
name	string	pgjsonb	no	Storage name, used in sort keys.
history-preserving	boolean	false	no	Enable history-preserving mode.
blob-temp-dir	string	(auto-created tempdir)	no	Directory for temporary blob files. Auto-created if omitted.
cache-shared-mb	integer	256	no	Size of the process-wide shared load cache (L2) in megabytes, shared across all connections in the process. Caches load() results (pickle bytes) to avoid repeated PostgreSQL round-trips and JSONB transcoding. Set to 0 to disable. See The cache tiers.
cache-per-connection-mb	integer	16	no	Size of the per-connection L1 load cache in megabytes, a lock-free hot cache ahead of cache-shared-mb. Set to 0 to rely entirely on the shared cache.
cache-local-mb	integer	–	no	Deprecated since 1.12.0. Alias for cache-shared-mb that emits a DeprecationWarning when set. Use cache-shared-mb instead.
pool-size	integer	1	no	Minimum number of connections in the instance connection pool. Set to 0 for on-demand creation.
pool-max-size	integer	10	no	Maximum number of connections in the instance connection pool.
pool-timeout	float	30.0	no	Connection pool acquisition timeout in seconds. Raises StorageError if a connection cannot be acquired within this time. Also the connect_timeout (rounded up, at least 2) of the direct connections that apply startup DDL, unless the DSN or PGCONNECT_TIMEOUT sets one.
cache-warm-pct	integer	10	no	Percentage of cache-shared-mb to pre-warm at startup from the most-accessed objects. Set to 0 to disable warming. See The cache tiers.
cache-warm-decay	float	0.8	no	Per-restart decay factor for historical access scores. 0.8 means scores from 10 restarts ago retain 10% of their weight.
cache-warm-delay	integer	15	no	Baseline delay in seconds before the warmer starts, keeping it out of the pod’s cold-start window. Set to 0 to disable.
cache-warm-jitter	integer	30	no	Additional uniform-random delay (0 to jitter seconds) on top of cache-warm-delay, spreading warmer start across replicas. Set to 0 to disable.
cache-warm-concurrency	integer	2	no	Maximum number of pods warming concurrently cluster-wide, enforced by a PostgreSQL advisory-lock semaphore. Set to a very large value to effectively disable the cap.
cache-warm-wait-max	integer	300	no	Maximum seconds a pod waits for a warming slot before skipping warmup (logs a WARNING).
cache-warm-batch-size	integer	500	no	Number of object ids fetched per warmer SELECT batch.
cache-warm-batch-pause	float	0.5	no	Seconds to pause between warmer batches, lowering per-pod peak query rate. Set to 0 to disable.
blob-threshold	byte-size	100KB	no	Blobs larger than this value are stored in S3 when S3 is configured. Blobs smaller than this remain in PostgreSQL bytea. Set to 0 to send all blobs to S3. Requires s3-bucket-name.
s3-bucket-name	string	–	no	S3 bucket name for large blob storage. If omitted, all blobs are stored in PostgreSQL bytea.
s3-prefix	string	""	no	S3 key prefix for namespace isolation.
s3-endpoint-url	string	–	no	S3 endpoint URL for Garage, Ceph, or other S3-compatible stores.
s3-region	string	–	no	AWS region name.
s3-access-key	string	–	no	AWS access key ID. Uses the boto3 credential chain if omitted.
s3-secret-key	string	–	no	AWS secret access key. Uses the boto3 credential chain if omitted.
s3-use-ssl	boolean	true	no	Enable SSL for S3 connections.
s3-connect-timeout	float	(zodb-s3blobs: 60)	no	Connect timeout in seconds for S3 uploads, deletes and listings.
s3-read-timeout	float	(zodb-s3blobs: 300)	no	Socket read timeout in seconds for S3 uploads, deletes and listings.
s3-download-connect-timeout	float	(zodb-s3blobs: 5)	no	Connect timeout in seconds for S3 blob downloads and HEAD requests.
s3-download-read-timeout	float	(zodb-s3blobs: 10)	no	Socket read timeout in seconds for S3 blob downloads and HEAD requests.
s3-download-max-attempts	integer	(zodb-s3blobs: 2)	no	Total attempts per S3 download and HEAD request.
blob-cache-dir	string	(falls back to blob-temp-dir)	no	Local cache directory for S3 blobs. Recommended for production to avoid repeated S3 downloads.
blob-cache-size	byte-size	1GB	no	Maximum size of the local blob cache directory.

Unset S3 timeout keys are not passed to S3Client, so the zodb-s3blobs defaults shown in parentheses apply. The read timeouts are inactivity timeouts per socket operation, not limits on the total transfer time.

Added in version 1.19: s3-connect-timeout, s3-read-timeout, s3-download-connect-timeout, s3-download-read-timeout and s3-download-max-attempts.

Python constructor

PGJsonbStorage accepts the following parameters:

PGJsonbStorage(
    dsn: str,
    name: str = "pgjsonb",
    history_preserving: bool = False,
    blob_temp_dir: str | None = None,
    cache_local_mb: int = 16,
    pool_size: int = 1,
    pool_max_size: int = 10,
    pool_timeout: float = 30.0,
    s3_client: S3Client | None = None,
    blob_cache: S3BlobCache | None = None,
    blob_threshold: int = 102_400,
)

Parameter	Type	Default	Description
dsn	str	–	PostgreSQL connection string.
name	str	"pgjsonb"	Storage name.
history_preserving	bool	False	Enable history-preserving mode.
blob_temp_dir	str | None	None	Blob temp directory. A temporary directory is auto-created when None.
cache_local_mb	int	16	Per-instance LRU cache size in megabytes.
pool_size	int	1	Minimum pool connections.
pool_max_size	int	10	Maximum pool connections.
pool_timeout	float	30.0	Pool acquisition timeout in seconds. Also the connect_timeout of the startup DDL connections (see pool-timeout).
s3_client	S3Client | None	None	S3 client instance from zodb-s3blobs.
blob_cache	S3BlobCache | None	None	Local S3 blob cache instance from zodb-s3blobs.
blob_threshold	int	102400	Byte threshold for S3 tiering.

The ZConfig factory (PGJsonbStorageFactory) constructs S3Client and S3BlobCache from the ZConfig keys before passing them to the constructor.

S3 deployment modes

Mode	Configuration	Blob behavior
PG-only	s3-bucket-name omitted	All blobs stored as PostgreSQL bytea in blob_state.data.
Tiered	s3-bucket-name set, blob-threshold > 0	Blobs smaller than threshold stored in PG bytea; blobs at or above threshold stored in S3 with key in blob_state.s3_key.
S3-only	s3-bucket-name set, blob-threshold = 0	All blobs stored in S3.

Environment variables

The storage reads these variables from the process environment, not from ZConfig.

Variable	Default	Description
ZODB_PGJSONB_DDL_LOCK_TIMEOUT	15min	lock_timeout applied while acquiring the startup DDL advisory lock. Accepts any PostgreSQL interval literal (for example 30s, 5min). On timeout the pending DDL is requeued and retried on the next transaction.
ZODB_PGJSONB_IDLE_IN_XACT_TIMEOUT_MS	60000	idle_in_transaction_session_timeout in milliseconds, set on every pooled PostgreSQL connection. 0 disables the timeout.
ZODB_PGJSONB_FORCE_DDL	unset	When set to any non-empty value, bypasses the schema-version gate and forces a full deferred-DDL run under the lock. Use it after a manual index drop or to re-apply DDL that the version markers consider current.

Added in version 1.14: ZODB_PGJSONB_FORCE_DDL and the schema-version gate it controls.

Dependencies

Required

Package	Purpose
ZODB>=5.8	ZODB framework.
zodb-json-codec>=1.6.1	Rust/PyO3 pickle-to-JSON transcoder.
psycopg[binary,pool]>=3.1	PostgreSQL adapter with connection pooling.
zope.interface	Interface declarations.
transaction	Transaction management.
ZConfig	Configuration file parsing.

Optional

Package	Extra	Purpose
zodb-s3blobs>=1.2.0	s3	S3 client and blob cache for tiered blob storage.
boto3>=1.26	s3	AWS SDK for S3 access.

Install S3 support with pip install zodb-pgjsonb[s3].