[FLINK-39001][doc][Flink-source]supple NewlyAddTable's doc with mongodb,postgres,oracle connectors#4247
Conversation
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 6 out of 6 changed files in this pull request and generated 18 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| --from-savepoint /tmp/flink-savepoints/savepoint-cca7bc-bb1e257f0dab \ | ||
| ./FlinkCDCExample.jar | ||
| ``` | ||
| **Note:** Please refer the doc [Restore the job from previous savepoint](https://nightlies.apache.org/flink/flink-docs-release-1.17/docs/deployment/cli/#command-line-interface) for more details. |
There was a problem hiding this comment.
The phrase "Please refer the doc" is missing the preposition "to". It should be "Please refer to the doc".
| **Note:** Please refer the doc [Restore the job from previous savepoint](https://nightlies.apache.org/flink/flink-docs-release-1.17/docs/deployment/cli/#command-line-interface) for more details. | |
| **Note:** Please refer to the doc [Restore the job from previous savepoint](https://nightlies.apache.org/flink/flink-docs-release-1.17/docs/deployment/cli/#command-line-interface) for more details. |
| // your business code | ||
| ``` | ||
|
|
||
| If we would like to add new collections `[order, custom]` to an existing Flink job, just need to update the `collectionList()` value of the job to include `[order, custom]` and restore the job from previous savepoint. |
There was a problem hiding this comment.
This sentence is missing a subject. It should read "we just need to update" instead of "just need to update". The sentence currently reads "If we would like to add new collections... just need to update" which is grammatically incorrect.
| If we would like to add new collections `[order, custom]` to an existing Flink job, just need to update the `collectionList()` value of the job to include `[order, custom]` and restore the job from previous savepoint. | |
| If we would like to add new collections `[order, custom]` to an existing Flink job, we just need to update the `collectionList()` value of the job to include `[order, custom]` and restore the job from previous savepoint. |
|
|
||
| **Note:** This feature is available since Flink CDC 3.1.0. | ||
|
|
||
| Scan Newly Added Tables feature enables you to add new tables to monitor for existing running pipeline. The newly added tables will read their snapshot data firstly and then read their binlog automatically. |
There was a problem hiding this comment.
The description mentions "binlog" which is MySQL-specific terminology. For PostgreSQL, the correct term should be "WAL (Write-Ahead Log)" or "replication slot changes". PostgreSQL doesn't use binlog.
| .tableList("INVENTORY.PRODUCT", "INVENTORY.USER", "INVENTORY.ADDRESS") // set captured tables | ||
| .username("yourUsername") | ||
| .password("yourPassword") | ||
| .scanNewlyAddedTableEnabled(true) // enable scan the newly added tables feature |
There was a problem hiding this comment.
The comment refers to "scan the newly added tables feature" but should be "scan newly added tables feature" (remove the article "the" before "newly") to be consistent with the section title and standard English usage.
| .scanNewlyAddedTableEnabled(true) // enable scan the newly added tables feature | |
| .scanNewlyAddedTableEnabled(true) // enable scan newly added tables feature |
| // your business code | ||
| ``` | ||
|
|
||
| If we would like to add new tables `[INVENTORY.ORDER, INVENTORY.CUSTOM]` to an existing Flink job, just need to update the `tableList()` value of the job to include `[INVENTORY.ORDER, INVENTORY.CUSTOM]` and restore the job from previous savepoint. |
There was a problem hiding this comment.
This sentence is missing a subject. It should read "we just need to update" instead of "just need to update". The sentence currently reads "If we would like to add new tables... just need to update" which is grammatically incorrect.
| If we would like to add new tables `[INVENTORY.ORDER, INVENTORY.CUSTOM]` to an existing Flink job, just need to update the `tableList()` value of the job to include `[INVENTORY.ORDER, INVENTORY.CUSTOM]` and restore the job from previous savepoint. | |
| If we would like to add new tables `[INVENTORY.ORDER, INVENTORY.CUSTOM]` to an existing Flink job, we just need to update the `tableList()` value of the job to include `[INVENTORY.ORDER, INVENTORY.CUSTOM]` and restore the job from previous savepoint. |
|
|
||
| **Note:** This feature is available since Flink CDC 3.1.0. | ||
|
|
||
| Scan Newly Added Tables feature enables you to add new collections to monitor for existing running pipeline. The newly added collections will read their snapshot data firstly and then read their change stream automatically. |
There was a problem hiding this comment.
The phrase "for existing running pipeline" is missing an article. It should be "for an existing running pipeline" or "for the existing running pipeline".
| Scan Newly Added Tables feature enables you to add new collections to monitor for existing running pipeline. The newly added collections will read their snapshot data firstly and then read their change stream automatically. | |
| The Scan Newly Added Tables feature enables you to add new collections to monitor for an existing running pipeline. The newly added collections will read their snapshot data firstly and then read their change stream automatically. |
| .username("yourUsername") | ||
| .password("yourPassword") | ||
| .slotName("flink") | ||
| .scanNewlyAddedTableEnabled(true) // enable scan the newly added tables feature |
There was a problem hiding this comment.
The comment refers to this as "scan the newly added tables feature" but should be more concise as "scan newly added tables feature" (remove the article "the" before "newly") to match standard English usage and be consistent with the section title.
| .scanNewlyAddedTableEnabled(true) // enable scan the newly added tables feature | |
| .scanNewlyAddedTableEnabled(true) // enable scan newly added tables feature |
| .collectionList("db.product", "db.user", "db.address") // set captured collections | ||
| .username("yourUsername") | ||
| .password("yourPassword") | ||
| .scanNewlyAddedTableEnabled(true) // enable scan the newly added tables feature |
There was a problem hiding this comment.
The comment refers to "scan the newly added tables feature" but should be "scan newly added tables feature" (remove the article "the" before "newly") to be consistent with the section title and standard English usage.
| .scanNewlyAddedTableEnabled(true) // enable scan the newly added tables feature | |
| .scanNewlyAddedTableEnabled(true) // enable scan newly added tables feature |
|
|
||
| **Note:** This feature is available since Flink CDC 3.1.0. | ||
|
|
||
| Scan Newly Added Tables feature enables you to add new tables to monitor for existing running pipeline. The newly added tables will read their snapshot data firstly and then read their redo log automatically. |
There was a problem hiding this comment.
The adverb "firstly" should be "first" in standard American English usage. While "firstly" is grammatically correct in British English, the documentation appears to follow American English conventions.
| Scan Newly Added Tables feature enables you to add new tables to monitor for existing running pipeline. The newly added tables will read their snapshot data firstly and then read their redo log automatically. | |
| Scan Newly Added Tables feature enables you to add new tables to monitor for existing running pipeline. The newly added tables will read their snapshot data first and then read their redo log automatically. |
|
|
||
| **Note:** This feature is available since Flink CDC 3.1.0. | ||
|
|
||
| Scan Newly Added Tables feature enables you to add new tables to monitor for existing running pipeline. The newly added tables will read their snapshot data firstly and then read their redo log automatically. |
There was a problem hiding this comment.
The phrase "for existing running pipeline" is missing an article. It should be "for an existing running pipeline" or "for the existing running pipeline".
| Scan Newly Added Tables feature enables you to add new tables to monitor for existing running pipeline. The newly added tables will read their snapshot data firstly and then read their redo log automatically. | |
| Scan Newly Added Tables feature enables you to add new tables to monitor for an existing running pipeline. The newly added tables will read their snapshot data firstly and then read their redo log automatically. |
All documents have referenced the dynamic table-adding document format of the MySQL connector, ensuring consistency in style and structure.