cdc: update description about max-multi-update-row-size #21543
Conversation
|
[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 |
ti-chi-bot
bot
added
the
missing-translation-status
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @lidezhu, 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!
I've updated the TiCDC documentation to improve the clarity of the max-multi-update-row-size parameter. This change aims to provide users with a more accurate understanding of how this parameter influences batch processing for UPDATE ROWS SQL statements, particularly regarding its unit of measurement and behavior when size thresholds are met.
Highlights
- Documentation Clarity: The description for the "max-multi-update-row-size" parameter in
ticdc/ticdc-sink-to-mysql.mdhas been updated to provide a more precise explanation. The new description clarifies that this parameter controls the batch processing size in bytes forUPDATE ROWSSQL statements and specifies that if the average size of a single row exceeds this threshold, each row will be executed as an independent SQL statement.
Using Gemini Code Assist
The 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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.
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 or fill out our survey to provide feedback.
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
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
ti-chi-bot
bot
added
the
size/XS
There was a problem hiding this comment.
Code Review
This pull request improves the documentation for the max-multi-update-row-size parameter, making its behavior clearer. My review includes a suggestion to align the formatting of this updated description with the other parameters in the same table for better consistency.
| @@ -67,7 +67,7 @@ The following are descriptions of sink URI parameters and parameter values that | |||
| | `multi-stmt-enable` | Controls whether the SQL statements executed downstream support multiple SQL statements separated by semicolons (optional, the default value is `true`). If it is set to `false`, each SQL statement is executed as a separate transaction. If it is set to `true`, `cache-prep-stmts` does not take effect. | | |||
| | `max-txn-row` | The batch size of SQL statements executed to the downstream (optional, the default value is `256`, and the maximum value is `2048`). | | |||
| | `max-multi-update-row` | The batch size of `UPDATE ROWS` SQL statements executed to the downstream when batch write (`batch-dml-enable`) is enabled, always less than `max-txn-row` (optional, the default value is `40`, and the maximum value is `256`). | | |||
| | `max-multi-update-row-size` | The size limit of `UPDATE ROWS` SQL statements executed to the downstream when batch write (`batch-dml-enable`) is enabled. If the size exceeds this limit, each row is executed as a separate SQL statement (optional, the default value is `1024`, and the maximum value is `8192`). | | |||
| | `max-multi-update-row-size` | When batch write (`batch-dml-enable`) is enabled, this parameter controls the batch processing size (in bytes) for `UPDATE ROWS` SQL statements executed to the downstream. If the average size of a single row exceeds this threshold, each row will be executed as an independent SQL statement (optional, default value: 1024, maximum value: 8192). | | |||
There was a problem hiding this comment.
Thanks for clarifying the description for max-multi-update-row-size. The new text is much more precise.
To maintain consistency with other parameter descriptions in this table, could you please adjust the formatting of the optional parameters? Also, there appear to be a few non-breaking spaces that should be regular spaces.
For example, other rows use the format (optional, the default value is ..., and the maximum value is ...).
| | `max-multi-update-row-size` | When batch write (`batch-dml-enable`) is enabled, this parameter controls the batch processing size (in bytes) for `UPDATE ROWS` SQL statements executed to the downstream. If the average size of a single row exceeds this threshold, each row will be executed as an independent SQL statement (optional, default value: 1024, maximum value: 8192). | | |
| | `max-multi-update-row-size` | When batch write (`batch-dml-enable`) is enabled, this parameter controls the batch processing size (in bytes) for `UPDATE ROWS` SQL statements executed to the downstream. If the average size of a single row exceeds this threshold, each row is executed as an independent SQL statement (optional, the default value is `1024`, and the maximum value is `8192`). | |
First-time contributors' checklist
What is changed, added or deleted? (Required)
Which 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.
close #21474
For details, see tips for choosing the affected versions.
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?