v8.5.5: ticdc: add header line for CSV protocol (#21417) #22140
Conversation
ti-chi-bot
added
area/ticdc
Summary of ChangesHello @ti-chi-bot, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request enhances the TiCDC documentation for the CSV protocol by introducing a new configuration option, Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This PR adds documentation for the new output-field-header CSV option. The changes in ticdc/ticdc-csv.md are a good start. I've provided a suggestion to improve the clarity of the header column descriptions.
A key piece of documentation seems to be missing: the new output-field-header parameter is not documented in ticdc/ticdc-changefeed-config.md. For completeness and to help users discover this new feature, it should be added to the sink.csv section in that file.
| When `output-field-header = true`, the CSV file includes a header row. The column names in the header row are as follows: | ||
|
|
||
| | Column 1 | Column 2 | Column 3 | Column 4 (optional) | Column 5 (optional) | Column 6 | ... | Last column | | ||
| | --- | --- | --- | --- | --- | --- | --- | --- | | ||
| | `ticdc-meta$operation` | `ticdc-meta$table` | `ticdc-meta$schema` | `ticdc-meta$commit-ts` | `ticdc-meta$is-update` | The first column with data changes | ... | The last column with data changes | |
There was a problem hiding this comment.
To improve clarity, I suggest rephrasing this section. The current description of header columns for data fields (columns 6 onwards) is a bit confusing as it mixes literal header names with descriptions. This can mislead the user into thinking "The first column with data changes" is the literal header name. My suggestion clarifies that data columns use the actual column names from the source table as headers, using placeholders for illustration.
| When `output-field-header = true`, the CSV file includes a header row. The column names in the header row are as follows: | |
| | Column 1 | Column 2 | Column 3 | Column 4 (optional) | Column 5 (optional) | Column 6 | ... | Last column | | |
| | --- | --- | --- | --- | --- | --- | --- | --- | | |
| | `ticdc-meta$operation` | `ticdc-meta$table` | `ticdc-meta$schema` | `ticdc-meta$commit-ts` | `ticdc-meta$is-update` | The first column with data changes | ... | The last column with data changes | | |
| When `output-field-header = true`, the CSV file includes a header row. The header names for metadata columns are fixed, while the header names for data columns are the actual column names from your table. The header row is structured as follows: | |
| | Column 1 | Column 2 | Column 3 | Column 4 (optional) | Column 5 (optional) | Column 6 | ... | Last column | | |
| | --- | --- | --- | --- | --- | --- | --- | --- | | |
| | `ticdc-meta$operation` | `ticdc-meta$table` | `ticdc-meta$schema` | `ticdc-meta$commit-ts` | `ticdc-meta$is-update` | {first-data-column-name} | ... | {last-data-column-name} | |
qiancai
changed the title
2 participants
This is an automated cherry-pick of #21417
First-time contributors' checklist
What is changed, added or deleted? (Required)
output-field-headerWhich TiDB version(s) do your changes apply to? (Required)
Tips for choosing the affected version(s):
By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.
For details, see tips for choosing the affected versions (in Chinese).
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?