fix: Document missing pg_replication_bootstrap_batch_size parameter#1744
Merged
Conversation
The PostgreSQL connector accepts pg_replication_bootstrap_batch_size to control rows-per-batch during the initial CDC snapshot (default 8192, max 1048576), but it wasn't documented in either the connector reference or the CDC feature page. ## Reference Verified against spiceai/spiceai trunk at f4a5089df: - ParameterSpec: crates/data-connectors/connector-postgres/src/lib.rs:169-174 - Consumed by: crates/data-connectors/connector-postgres/src/replication.rs:436-441 - Constants: DEFAULT_BOOTSTRAP_BATCH_SIZE=8192, MAX_BOOTSTRAP_BATCH_SIZE=1048576 The parameter was added in source on 2026-05-12 (PR #10789) and is not in any released tag, so only the unversioned vNext docs need updating.
🔍 Pull with Spice FailedPassing checks:
Failed checks:
Please address these issues and update your pull request. |
|
🚀 deployed to https://85453a2a.spiceai-org-website.pages.dev |
lukekim
approved these changes
May 19, 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
2 participants
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
The PostgreSQL data connector accepts
pg_replication_bootstrap_batch_sizeto control rows-per-batch during the initial CDC snapshot, but it was missing from both the connector reference and the CDC feature page.Changes
Add
pg_replication_bootstrap_batch_size(default8192, max1048576) to:website/docs/components/data-connectors/postgres/index.md— replication parameters tablewebsite/docs/features/cdc/postgres-replication.md— full configuration referenceReference
Verified against
spiceai/spiceaitrunk:ParameterSpec:crates/data-connectors/connector-postgres/src/lib.rs(lines 169–174) declares the parameter withdefault("8192")and a 1,048,576 ceiling note.crates/data-connectors/connector-postgres/src/replication.rs:436viaoptional_usize_in_range(...)usingDEFAULT_BOOTSTRAP_BATCH_SIZE = 8192andMAX_BOOTSTRAP_BATCH_SIZE = 1_048_576, then plumbed throughReplicationParams.bootstrap_batch_sizeinto the bootstrap loop atcrates/data_components/src/postgres_replication/bootstrap.rs:78.Version scope
The parameter was added in source on 2026-05-12 (commit
f4a5089df, "Improve CDC ingestion performance"). It is not yet contained in any release tag, so only the unversioned vNext docs need updating — versioned doc sets (1.5.xthrough1.11.x) intentionally untouched.Test plan
ParameterSpecdeclaration andoptional_usize_in_rangeconsumer call site.PARAMETERS, consumed inreplication.rs, used inbootstrap.rs) — not a non-functional name.