[FLINK-39383][Docs] Improve scan.incremental.snapshot.chunk.key-column documentation for MySQL/PostgreSQL/Oracle/DB2/SQLServer connectors#4405
Open
ThorneANN wants to merge 3 commits into
Conversation
…entation - Document NOT NULL requirement for tables without a primary key across all connectors (MySQL, PostgreSQL, Oracle, DB2, SQLServer flink-sources) - Document multi-table format (<table-pattern>:<column>[;...]) for the MySQL pipeline connector and MySQL flink-source connector - Add missing scan.incremental.snapshot.chunk.key-column option to MySQL and PostgreSQL pipeline connector docs (both EN and ZH) - Add missing Warning link in DB2 flink-source option table entry - Refresh stale option description wording across all five connectors
scan.snapshot.fetch.size <tr> tag was missing after inserting the chunk.key-column row in both EN and ZH postgres pipeline connector docs.
- Remove pipeline connector multi-table format description from flink-source mysql-cdc.md (EN+ZH): the <table-pattern>:<column> format is only supported by the pipeline connector, not the flink-source connector - Fix sentence order in oracle-cdc.md (EN+ZH): put the no-primary-key requirement before the non-PK performance note for logical consistency
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The
scan.incremental.snapshot.chunk.key-columnoption had several gapsand inaccuracies in its documentation across multiple connectors:
NOT NULL / no-primary-key constraint was undocumented.
The option is required when a captured table has no primary key and the chosen column must be NOT NULL. None of the connector docs mentioned this.
Multi-table format was undocumented (MySQL).
The MySQL connector supports
<table-pattern>:<column>[;...]for assigning different chunk key columns to different tables. This was not documented in either the flink-source or pipeline connector docs.Option was entirely missing from PostgreSQL pipeline connector docs.
Stale option description wording across all connectors.