Skip to content

Commit a8a0223

Browse files
claudespiceClaudelukekim
authored
fix: Document PostgreSQL replication parameters for WAL streaming (#1531)
* fix: Add nanosecond timestamp range limitation to MSSQL and Oracle versioned docs Commit d5341c4 documented the Arrow nanosecond timestamp range limitation (~1677–2262) for MSSQL and Oracle connectors, but only in website/docs/ (vNext). The limitation existed in all prior versions too — in versions 1.5.x–1.11.x, out-of-range timestamps silently returned 1970-01-01 UTC instead of erroring. Propagate the limitation note to all 7 versioned doc directories (14 files total) with version-appropriate wording. * fix: Correct PostgreSQL accelerator connection pool parameter name and defaults The docs listed pg_connection_pool_min_idle (default 1) and connection_pool_size (default 5), but the code uses pg_connection_pool_min (default 5) and connection_pool_size (default 10). * fix: Correct IMAP ssl_mode default from tls to auto The docs stated the default ssl_mode is tls, but the code has always used auto as the default since at least v1.5.0. * fix: Correct DynamoDB default time_format to include milliseconds The docs showed the default time format as 2006-01-02T15:04:05Z07:00 but the code uses 2006-01-02T15:04:05.000Z07:00 (with .000 milliseconds). This matters because Go format strings are exact patterns — without .000, timestamps with millisecond precision would not parse correctly. * fix: Document PostgreSQL replication parameters for WAL streaming The PostgreSQL connector added logical replication (WAL streaming) support in PR #10364 with 5 new parameters (pg_replication_slot, pg_publication, pg_replication_initial_snapshot, pg_replication_temporary_slot, pg_replication_status_interval) that were not yet documented. --------- Co-authored-by: Claude <claude@Claudes-Mini.localdomain> Co-authored-by: lukekim <80174+lukekim@users.noreply.github.com>
1 parent da0a4e3 commit a8a0223

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

  • website/docs/components/data-connectors/postgres

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,18 @@ The connection to PostgreSQL can be configured by providing the following `param
113113
| `pg_connection_pool_min_idle` | Optional. The minimum number of idle connections to keep open in the pool. Default is `1`. |
114114
| `connection_pool_size` | Optional. The maximum number of connections created in the connection pool. Default is `5`. |
115115

116+
#### Replication parameters
117+
118+
The following parameters configure PostgreSQL [logical replication](https://www.postgresql.org/docs/current/logical-replication.html) (WAL streaming) when using `refresh_mode: changes`:
119+
120+
| Parameter Name | Description |
121+
| ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
122+
| `pg_replication_slot` | Optional. Name of the replication slot to create/reuse. Defaults to `spice_<dataset>_<dataset-hash>_<instance-hash>`. Each Spice replica MUST have its own unique slot. |
123+
| `pg_publication` | Optional. Name of the publication to create/reuse. Defaults to `spice_<dataset>_<dataset-hash>_pub`. Shared across replicas for the same dataset. |
124+
| `pg_replication_initial_snapshot` | Optional. Whether to take an initial snapshot of existing rows before streaming WAL changes. Default: `true`. |
125+
| `pg_replication_temporary_slot` | Optional. If `true`, create a temporary replication slot that is dropped when the Spice process disconnects. Default: `false` (durable slot). |
126+
| `pg_replication_status_interval` | Optional. How often to send StandbyStatusUpdate to Postgres (e.g. `10s`). Default: `10s`. |
127+
116128
## Types
117129

118130
The table below shows the PostgreSQL data types supported, along with the type mapping to Apache Arrow types in Spice.

0 commit comments

Comments
 (0)