DanielCarter-stack opened a new pull request, #11728:
URL: https://github.com/apache/seatunnel/pull/11728
## Purpose
Improve the connector documentation for Jdbc, MySQL-CDC, PostgreSQL-CDC,
Oracle-CDC and Kafka by adding the missing task examples and clarifying common
gotchas. The new examples are distilled from the bundled SeaTunnel e2e
configurations so users can find a working starting point directly in the
connector docs.
## Scope of changes
- `docs/en/connectors/source/MySQL-CDC.md` /
`docs/zh/connectors/source/MySQL-CDC.md`
- Added Debezium heartbeat task example with `heartbeat.interval.ms` and a
heartbeat insert query.
- Added a timer-flush example that pairs a low-volume MySQL-CDC source
with a JDBC sink using `sink.flush.interval`, showing how to keep the sink busy
between checkpoints.
- Added a no-primary-key task example that sets `exactly_once = false` and
explains the safety boundary of that mode.
- `docs/en/connectors/source/PostgreSQL-CDC.md` /
`docs/zh/connectors/source/PostgreSQL-CDC.md`
- Added a Debezium heartbeat task example using `inventory.heartbeat` to
keep the logical slot advancing.
- Added a `snapshot-only` task example to document the bounded backfill
mode and the dedicated `slot.name` use case.
- Added a no-primary-key task example with the `exactly_once = false`
caveat.
- `docs/en/connectors/source/Oracle-CDC.md` /
`docs/zh/connectors/source/Oracle-CDC.md`
- Reworded the existing Debezium heartbeat section so the goal (keeping
the Oracle LogMiner SCN moving for low-traffic tables) is explicit and added a
note that the heartbeat table must exist on the server.
- Added a no-primary-key task example using
`table-names-config.primaryKeys` with `exactly_once = false`.
- `docs/zh/connectors/sink/Kafka.md`
- Added the missing "使用 Kafka Headers" (`Using Kafka Headers`) task
example so the Chinese doc covers every pattern the English doc lists.
## Notes
- No code or e2e logic was changed; this PR only updates documentation.
- Config names, defaults and example options match the current connector
implementation.
- I did not bump or edit the supported version metadata for any connector.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
