[FLINK-35314][cdc] Add Flink CDC pipeline transform user document #3308
Conversation
This file contains 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
yuxiqian
suggested changes
May 10, 2024
| @@ -28,5 +28,245 @@ under the License. | |||
| **Transform** module helps users delete and expand data columns based on the data columns in the table. | |||
| What's more, it also helps users filter some unnecessary data during the synchronization process. | |||
|
|
|||
| # Parameters | |||
| To describe a transform, the follows are required: | |||
There was a problem hiding this comment.
Suggested change
| To describe a transform, the follows are required: | |
| To describe a transform rule, the following parameters can be used: |
Comment on lines
39
to
40
| | primary-keys | Sink table primary keys, it is separated by English commas | optional | | ||
| | partition-keys | Sink table partition keys, it is separated by English commas | optional | |
There was a problem hiding this comment.
Suggested change
| | primary-keys | Sink table primary keys, it is separated by English commas | optional | | |
| | partition-keys | Sink table partition keys, it is separated by English commas | optional | | |
| | primary-keys | Sink table primary keys, separated by commas | optional | | |
| | partition-keys | Sink table partition keys, separated by commas | optional | |
| | filter | Filter rule, supports syntax similar to the where clause in SQL | optional | | ||
| | primary-keys | Sink table primary keys, it is separated by English commas | optional | | ||
| | partition-keys | Sink table partition keys, it is separated by English commas | optional | | ||
| | table-options | Sink table options, when automatically creating a table, it is added to the configuration of the table creation statement | optional | |
There was a problem hiding this comment.
Suggested change
| | table-options | Sink table options, when automatically creating a table, it is added to the configuration of the table creation statement | optional | | |
| | table-options | Sink table options, used to the configure table creation statement when automatically creating tables | optional | |
| | primary-keys | Sink table primary keys, it is separated by English commas | optional | | ||
| | partition-keys | Sink table partition keys, it is separated by English commas | optional | | ||
| | table-options | Sink table options, when automatically creating a table, it is added to the configuration of the table creation statement | optional | | ||
| | description | Transform rule description(a default value provided) | optional | |
There was a problem hiding this comment.
Suggested change
| | description | Transform rule description(a default value provided) | optional | | |
| | description | Transform rule description (a default description will be used if not specified) | optional | |
Does it mean if user didn't specify a transform description, CDC will generate a default one to indicate that transform rule?
|
|
||
| # Metadata Fields | ||
| ## Fields definition | ||
| There are three hidden columns used to describe metadata information. They only take effect when explicitly referenced in the transform rules. |
There was a problem hiding this comment.
Suggested change
| There are three hidden columns used to describe metadata information. They only take effect when explicitly referenced in the transform rules. | |
| There are some hidden columns used to access metadata information. They will only take effect when explicitly referenced in the transform rules. |
|
|
||
| # Problem | ||
| · Transform cannot be used with route in the current version, future versions will support it. |
There was a problem hiding this comment.
Suggested change
| · Transform cannot be used with route in the current version, future versions will support it. | |
| * Currently, transform doesn't work with route rules. It will be supported in future versions. |
| # Problem | ||
| · Transform cannot be used with route in the current version, future versions will support it. | ||
| · The computed column does not support referencing the trimmed original column in the current version, future versions will support it. |
There was a problem hiding this comment.
Suggested change
| · The computed column does not support referencing the trimmed original column in the current version, future versions will support it. | |
| * Computed columns cannot reference trimmed columns that do not present in final projection results. This will be fixed in future versions. |
There was a problem hiding this comment.
Maybe copy this file content to Chinese version documents as well? Seems other docs lacking Chinese translation have English version fallback as well.
| | table-options | Sink table options, when automatically creating a table, it is added to the configuration of the table creation statement | optional | | ||
| | description | Transform rule description(a default value provided) | optional | | ||
|
|
||
| A transform module can contain a list of source-table rules. |
There was a problem hiding this comment.
Suggested change
| A transform module can contain a list of source-table rules. | |
| Multiple rules can be declared in one single pipeline YAML file. |
Comment on lines
52
to
54
| | __namespace_name__ | String | Name of the namespace that contain the row. | | ||
| | __schema_name__ | String | Name of the schema that contain the row. | | ||
| | __table_name__ | String | Name of the table that contain the row. | |
There was a problem hiding this comment.
Suggested change
| | __namespace_name__ | String | Name of the namespace that contain the row. | | |
| | __schema_name__ | String | Name of the schema that contain the row. | | |
| | __table_name__ | String | Name of the table that contain the row. | | |
| | __namespace_name__ | String | Name of the namespace that contains the row. | | |
| | __schema_name__ | String | Name of the schema that contains the row. | | |
| | __table_name__ | String | Name of the table that contains the row. | |
PatrickRen
approved these changes
May 15, 2024
|
@aiwenmo Could you backport the commit to release-3.1? Thanks |
PatrickRen
pushed a commit
to PatrickRen/flink-cdc
that referenced
this pull request
May 17, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This closes FLINK-35314.