docs: reference pg_durable.database GUC instead of PGDATABASE env var#200
Merged
Conversation
User-facing docs for troubleshooting and the extension lifecycle still claimed the background worker reads its target database from POSTGRES_DB/PGDATABASE. The runtime moved to the pg_durable.database GUC; update USER_GUIDE.md and docs/extension_lifecycle.md to match.
tjgreen42
approved these changes
Jun 2, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Audited references to
PGDATABASE(and related env vars) across the repo. The runtime moved to thepg_durable.databaseGUC a while back, but a few user-facing docs still claimed the background worker reads its target database fromPOSTGRES_DB/PGDATABASE.Changes
USER_GUIDE.md— troubleshooting section now points at thepg_durable.databaseGUC inpostgresql.conf.docs/extension_lifecycle.md— two spots in the lifecycle/known-limitations sections corrected to reference the GUC.Audit notes (no code changes needed)
src/lib.rsregisterspg_durable.database;src/types.rs::get_database()reads it and defaults topostgres.sql/pg_durable--0.1.1.sqlinstall fixture already reference the GUC correctly.PGDATABASEinscripts/pg-common.sh,Makefile,scripts/test-upgrade.sh,scripts/test-e2e-local.sh,docs/TESTING.md, andexamples/azure-http-domains/scripts/run-test.share intentional dev/test ergonomics — they translate the env var into the GUC at cluster-config time.docker-compose.ymlsetsPOSTGRES_DB(postgres image convention) and also passes-c pg_durable.database=pg_durableexplicitly. Correct.Other env vars audited at the same time:
PGHOST— real runtime dependency insrc/types.rsfor the BGW connection string, defaults to127.0.0.1. Already documented indocs/security-review/workbook-data.md.DUROXIDE_PG_POOL_MAX— internal; the worker sets it frompg_durable.max_duroxide_connections.RUST_LOG— documented.PGUSER/PGPORT— not used; worker uses thepg_durable.worker_roleGUC andPostPortNumberfrom the postmaster.