Skip to content

Commit 2968860

Browse files
authored
DOC-1124 Add heartbeat_interval field to postgres_cdc (#202)
1 parent 6b6281b commit 2968860

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

modules/components/pages/inputs/postgres_cdc.adoc

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,12 @@ input:
2525
tables: [] # No default (required)
2626
checkpoint_limit: 1024
2727
temporary_slot: false
28-
slot_name: "" # No default (optional)
28+
slot_name: my_test_slot # No default (required)
2929
pg_standby_timeout: 10s
3030
pg_wal_monitor_interval: 3s
3131
max_parallel_snapshot_tables: 1
3232
unchanged_toast_value: null
33+
heartbeat_interval: 1h
3334
auto_replay_nacks: true
3435
batching:
3536
count: 0
@@ -377,6 +378,26 @@ unchanged_toast_value: __redpanda_connect_unchanged_toast_value__
377378
unchanged_toast_value: {"$": "unchanged_toast_value"}
378379
```
379380

381+
=== `heartbeat_interval`
382+
383+
The interval between heartbeat messages, which Redpanda Connect writes to the WAL using the `pg_logical_emit_message` function.
384+
385+
Heartbeat messages are useful when you subscribe to data changes from tables with low activity, while other tables in the database have higher-frequency updates. Heartbeat messages allow Redpanda Connect to periodically acknowledge new messages even when no data updates occur. Each acknowledgement advances the committed point in the WAL, which ensures that PostgreSQL can safely reclaim older log segments, preventing excessive disk space usage.
386+
387+
Set `heartbeat_interval` to `0s` to disable heartbeats.
388+
389+
*Type*: `string`
390+
391+
*Default*: `1h`
392+
393+
```yml
394+
# Examples
395+
396+
heartbeat_interval: 0s
397+
398+
heartbeat_interval: 24h
399+
```
400+
380401
=== `auto_replay_nacks`
381402

382403
Whether to automatically replay rejected messages (negative acknowledgements) at the output level. If the cause of rejections is persistent, leaving this option enabled can result in back pressure.

0 commit comments

Comments
 (0)