docs: document three system parameters on ALTER SYSTEM SET page#37757
Draft
claude[bot] wants to merge 3 commits into
Draft
docs: document three system parameters on ALTER SYSTEM SET page#37757claude[bot] wants to merge 3 commits into
claude[bot] wants to merge 3 commits into
Conversation
Add persist_pg_consensus_read_committed, pg_source_validate_timeline, and sql_server_source_validate_restore_history to the "Key configuration parameters" table on the ALTER SYSTEM SET page. These parameters were previously undocumented. Descriptions are grounded in the flag definitions in src/persist/src/postgres.rs and src/storage-types/src/dyncfgs.rs.
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
1 participant
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.
Requested by Pranshu Maheshwari · Slack thread
Motivation
Three system parameters that can be set via
ALTER SYSTEM SETwere undocumented on the ALTER SYSTEM SET page:persist_pg_consensus_read_committedpg_source_validate_timelinesql_server_source_validate_restore_historyBefore: these three parameters did not appear anywhere in the configuration-parameters tables on that page.
After: they now appear in the "Key configuration parameters" table, matching the existing entry format.
Description
Adds three rows to the "Key configuration parameters" table rendered by
doc/user/content/headless/configuration-parameters.md(included on the ALTER SYSTEM SET page). Entries are inserted in the table's existing alphabetical order and follow the existingName | Default value | Description | Modifiable?column format.Descriptions are grounded in the flag definitions in the codebase, not guessed:
persist_pg_consensus_read_committed(defaultfalse) —src/persist/src/postgres.rs:51. Runs persist consensus connections underREAD COMMITTEDisolation instead ofSERIALIZABLEwhen using a PostgreSQL backend; must be off for CockroachDB backends.pg_source_validate_timeline(defaulttrue) —src/storage-types/src/dyncfgs.rs:230. Treats an upstream PostgreSQL timeline switch as a definite error; disabling it relaxes validation for HA upstreams (e.g. Cloud SQL, AlloyDB) at the cost of putting recreation responsibility on the customer.sql_server_source_validate_restore_history(defaulttrue) —src/storage-types/src/dyncfgs.rs:241. Treats an upstream SQL Server restore-history change as a definite error; disabling it relaxes validation for HA upstreams (e.g. Always On availability groups).Verification
Docs-only change. Verified the markdown table stays well-formed (all rows have 4 columns) and that the
/sql/create-source/postgres/and/sql/create-source/sql-server/link targets exist in the docs tree. No code changes.Generated by Claude Code