Skip to content

[FLINK-39001][doc][Flink-source]supple NewlyAddTable's doc with mongodb,postgres,oracle connectors#4247

Open
ThorneANN wants to merge 3 commits intoapache:masterfrom
ThorneANN:FLINK-39001-supple-doc-with-newlyaddedtable
Open

[FLINK-39001][doc][Flink-source]supple NewlyAddTable's doc with mongodb,postgres,oracle connectors#4247
ThorneANN wants to merge 3 commits intoapache:masterfrom
ThorneANN:FLINK-39001-supple-doc-with-newlyaddedtable

Conversation

@ThorneANN
Copy link
Contributor

  1. Function Description: Explain the role and usage scenarios of dynamic table addition.
  2. Version Information: Mark that this feature is supported starting from Flink CDC version 3.1.0.
  3. Usage Example: Provide a complete DataStream API code example.
  4. Operation Steps: Detailedly explain the three-step operation process for enabling and using this feature:
    • Step 1: Use savepoint to stop the existing job.
    • Step 2: Update the table/collection list configuration.
    • Step 3: Restore the job from the savepoint.
  5. API Method: Use .scanNewlyAddedTableEnabled(true) to enable this feature
    All documents have referenced the dynamic table-adding document format of the MySQL connector, ensuring consistency in style and structure.

@github-actions github-actions bot added the docs Improvements or additions to documentation label Jan 30, 2026
@ThorneANN ThorneANN changed the title [Flink-39001][doc][Flink-source]supple NewlyAddTable's doc with mongodb,postgres,oracle connectors [FLINK-39001][doc][Flink-source]supple NewlyAddTable's doc with mongodb,postgres,oracle connectors Jan 30, 2026
@lvyanquan lvyanquan requested a review from Copilot January 30, 2026 08:53
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
Copy link

Copilot AI Jan 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The phrase "Please refer the doc" is missing the preposition "to". It should be "Please refer to the doc".

Suggested change
**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.

Copilot uses AI. Check for mistakes.
// 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.
Copy link

Copilot AI Jan 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
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.

Copilot uses AI. Check for mistakes.

**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.
Copy link

Copilot AI Jan 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
.tableList("INVENTORY.PRODUCT", "INVENTORY.USER", "INVENTORY.ADDRESS") // set captured tables
.username("yourUsername")
.password("yourPassword")
.scanNewlyAddedTableEnabled(true) // enable scan the newly added tables feature
Copy link

Copilot AI Jan 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
.scanNewlyAddedTableEnabled(true) // enable scan the newly added tables feature
.scanNewlyAddedTableEnabled(true) // enable scan newly added tables feature

Copilot uses AI. Check for mistakes.
// 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.
Copy link

Copilot AI Jan 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
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.

Copilot uses AI. Check for mistakes.

**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.
Copy link

Copilot AI Jan 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The phrase "for existing running pipeline" is missing an article. It should be "for an existing running pipeline" or "for the existing running pipeline".

Suggested change
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.

Copilot uses AI. Check for mistakes.
.username("yourUsername")
.password("yourPassword")
.slotName("flink")
.scanNewlyAddedTableEnabled(true) // enable scan the newly added tables feature
Copy link

Copilot AI Jan 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
.scanNewlyAddedTableEnabled(true) // enable scan the newly added tables feature
.scanNewlyAddedTableEnabled(true) // enable scan newly added tables feature

Copilot uses AI. Check for mistakes.
.collectionList("db.product", "db.user", "db.address") // set captured collections
.username("yourUsername")
.password("yourPassword")
.scanNewlyAddedTableEnabled(true) // enable scan the newly added tables feature
Copy link

Copilot AI Jan 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
.scanNewlyAddedTableEnabled(true) // enable scan the newly added tables feature
.scanNewlyAddedTableEnabled(true) // enable scan newly added tables feature

Copilot uses AI. Check for mistakes.

**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.
Copy link

Copilot AI Jan 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
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.

Copilot uses AI. Check for mistakes.

**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.
Copy link

Copilot AI Jan 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The phrase "for existing running pipeline" is missing an article. It should be "for an existing running pipeline" or "for the existing running pipeline".

Suggested change
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.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant