Skip to content

Commit 5a484b2

Browse files
author
claudespice
committed
fix: Document missing pg_replication_bootstrap_batch_size parameter
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.
1 parent f5762a4 commit 5a484b2

2 files changed

Lines changed: 2 additions & 0 deletions

File tree

website/docs/components/data-connectors/postgres/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,7 @@ The following parameters configure PostgreSQL [logical replication](https://www.
124124
| `pg_replication_initial_snapshot` | Optional. Whether to take an initial snapshot of existing rows before streaming WAL changes. Default: `true`. |
125125
| `pg_replication_temporary_slot` | Optional. If `true`, create a temporary replication slot that is dropped when the Spice process disconnects. Default: `false` (durable slot). |
126126
| `pg_replication_status_interval` | Optional. How often to send StandbyStatusUpdate to Postgres (e.g. `10s`). Default: `10s`. |
127+
| `pg_replication_bootstrap_batch_size` | Optional. Number of rows per emitted batch during the initial replication snapshot. Default: `8192`. Maximum: `1048576`. |
127128

128129
## Types
129130

website/docs/features/cdc/postgres-replication.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,7 @@ All replication-specific parameters live under `params:` on the dataset and star
131131
| `pg_replication_initial_snapshot` | `true` | If `true`, take an initial snapshot of the table's existing rows before streaming. Set to `false` if you are pre-seeding the accelerator yourself. |
132132
| `pg_replication_temporary_slot` | `false` | If `true`, the slot is dropped when Spice disconnects. Every restart re-bootstraps. |
133133
| `pg_replication_status_interval` | `10s` | How often `StandbyStatusUpdate` (LSN acknowledgement) is sent back to Postgres. Lower values free WAL faster; higher values reduce network chatter. Accepts any duration string (`500ms`, `30s`, `2m`). |
134+
| `pg_replication_bootstrap_batch_size` | `8192` | Rows per emitted batch during the initial-snapshot bootstrap. Larger batches reduce per-batch overhead at the cost of more memory per batch. Maximum: `1048576`. |
134135

135136
All existing `pg_host`, `pg_port`, `pg_user`, `pg_pass`, `pg_db`, `pg_sslmode`, `pg_connection_string` parameters continue to apply — see the [PostgreSQL Data Connector](../../components/data-connectors/postgres) reference.
136137

0 commit comments

Comments
 (0)