Skip to content

Commit c46bbe2

Browse files
ClaudeClaude
authored andcommitted
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.
1 parent fb7b1cb commit c46bbe2

5 files changed

Lines changed: 20 additions & 8 deletions

File tree

website/docs/components/data-connectors/dynamodb.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -303,8 +303,8 @@ This parameter uses Go-style time formatting, which uses a reference time of `Mo
303303

304304
| Format Pattern | Example Value | Description |
305305
| ------------------------------- | ------------------------------- | ------------------------------------------ |
306-
| `2006-01-02T15:04:05.000Z07:00` | `2024-03-15T14:30:00.000Z` | ISO8601 / RFC3339 with milliseconds and timezone (default) |
307-
| `2006-01-02T15:04:05.999Z07:00` | `2024-03-15T14:30:00.123-07:00` | ISO8601 with variable-length milliseconds and timezone |
306+
| `2006-01-02T15:04:05Z07:00` | `2024-03-15T14:30:00Z` | ISO8601 / RFC3339 with timezone (default) |
307+
| `2006-01-02T15:04:05.999Z07:00` | `2024-03-15T14:30:00.123-07:00` | ISO8601 with milliseconds and timezone |
308308
| `2006-01-02T15:04:05` | `2024-03-15T14:30:00` | ISO8601 without timezone (naive timestamp) |
309309
| `2006-01-02 15:04:05` | `2024-03-15 14:30:00` | Date and time with space separator |
310310
| `01/02/2006 15:04:05` | `03/15/2024 14:30:00` | US-style date with time |

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.

website/versioned_docs/version-1.10.x/components/data-connectors/dynamodb.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -256,8 +256,8 @@ This parameter uses Go-style time formatting, which uses a reference time of `Mo
256256

257257
| Format Pattern | Example Value | Description |
258258
|---------------------------------|---------------------------------|--------------------------------------------|
259-
| `2006-01-02T15:04:05.000Z07:00` | `2024-03-15T14:30:00.000Z` | ISO8601 / RFC3339 with milliseconds and timezone (default) |
260-
| `2006-01-02T15:04:05.999Z07:00` | `2024-03-15T14:30:00.123-07:00` | ISO8601 with variable-length milliseconds and timezone |
259+
| `2006-01-02T15:04:05Z07:00` | `2024-03-15T14:30:00Z` | ISO8601 / RFC3339 with timezone (default) |
260+
| `2006-01-02T15:04:05.999Z07:00` | `2024-03-15T14:30:00.123-07:00` | ISO8601 with milliseconds and timezone |
261261
| `2006-01-02T15:04:05` | `2024-03-15T14:30:00` | ISO8601 without timezone (naive timestamp) |
262262
| `2006-01-02 15:04:05` | `2024-03-15 14:30:00` | Date and time with space separator |
263263
| `01/02/2006 15:04:05` | `03/15/2024 14:30:00` | US-style date with time |

website/versioned_docs/version-1.11.x/components/data-connectors/dynamodb.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -299,8 +299,8 @@ This parameter uses Go-style time formatting, which uses a reference time of `Mo
299299

300300
| Format Pattern | Example Value | Description |
301301
| ------------------------------- | ------------------------------- | ------------------------------------------ |
302-
| `2006-01-02T15:04:05.000Z07:00` | `2024-03-15T14:30:00.000Z` | ISO8601 / RFC3339 with milliseconds and timezone (default) |
303-
| `2006-01-02T15:04:05.999Z07:00` | `2024-03-15T14:30:00.123-07:00` | ISO8601 with variable-length milliseconds and timezone |
302+
| `2006-01-02T15:04:05Z07:00` | `2024-03-15T14:30:00Z` | ISO8601 / RFC3339 with timezone (default) |
303+
| `2006-01-02T15:04:05.999Z07:00` | `2024-03-15T14:30:00.123-07:00` | ISO8601 with milliseconds and timezone |
304304
| `2006-01-02T15:04:05` | `2024-03-15T14:30:00` | ISO8601 without timezone (naive timestamp) |
305305
| `2006-01-02 15:04:05` | `2024-03-15 14:30:00` | Date and time with space separator |
306306
| `01/02/2006 15:04:05` | `03/15/2024 14:30:00` | US-style date with time |

website/versioned_docs/version-1.9.x/components/data-connectors/dynamodb.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -255,8 +255,8 @@ This parameter uses Go-style time formatting, which uses a reference time of `Mo
255255

256256
| Format Pattern | Example Value | Description |
257257
|---------------------------------|---------------------------------|--------------------------------------------|
258-
| `2006-01-02T15:04:05.000Z07:00` | `2024-03-15T14:30:00.000Z` | ISO8601 / RFC3339 with milliseconds and timezone (default) |
259-
| `2006-01-02T15:04:05.999Z07:00` | `2024-03-15T14:30:00.123-07:00` | ISO8601 with variable-length milliseconds and timezone |
258+
| `2006-01-02T15:04:05Z07:00` | `2024-03-15T14:30:00Z` | ISO8601 / RFC3339 with timezone (default) |
259+
| `2006-01-02T15:04:05.999Z07:00` | `2024-03-15T14:30:00.123-07:00` | ISO8601 with milliseconds and timezone |
260260
| `2006-01-02T15:04:05` | `2024-03-15T14:30:00` | ISO8601 without timezone (naive timestamp) |
261261
| `2006-01-02 15:04:05` | `2024-03-15 14:30:00` | Date and time with space separator |
262262
| `01/02/2006 15:04:05` | `03/15/2024 14:30:00` | US-style date with time |

0 commit comments

Comments
 (0)