br: add compact log backup (#20342) #22209
Conversation
Co-authored-by: 山岚 <36239017+YuJuncen@users.noreply.github.com>
Co-authored-by: xixirangrang <hfxsd@hotmail.com>
ti-chi-bot
added
lgtm
needs-1-more-lgtm
|
[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. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
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 integrates documentation for the experimental "compact log backup" feature into the TiDB knowledge base. The new document explains how this feature improves Point-in-Time Recovery (PITR) efficiency by compacting log backups into SST files, thereby reducing recovery time and storage consumption. It covers the overview, limitations, and manual steps for utilizing this capability, which is relevant for TiDB v9.0 and master branches. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. 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
|
![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 pull request adds documentation for the new 'compact log backup' feature. My review focuses on improving grammar, spelling, and punctuation for better clarity and readability, in line with the style guide for automated pull requests. I've provided a few suggestions to enhance the document's formality and ease of understanding.
|
|
||
| Traditional log backups store write operations in a highly unstructured manner, which can lead to the following issues: | ||
|
|
||
| - **Reduced recovery performance**: unordered data has to be written to the cluster one by one through the Raft protocol. |
There was a problem hiding this comment.
For better clarity and formality in technical documentation, it's better to use "must be written" instead of "has to be written".
| - **Reduced recovery performance**: unordered data has to be written to the cluster one by one through the Raft protocol. | |
| - **Reduced recovery performance**: unordered data must be written to the cluster one by one through the Raft protocol. |
| Traditional log backups store write operations in a highly unstructured manner, which can lead to the following issues: | ||
|
|
||
| - **Reduced recovery performance**: unordered data has to be written to the cluster one by one through the Raft protocol. | ||
| - **Write amplification**: all writes must be compacted from L0 to the bottommost level by level. |
There was a problem hiding this comment.
Adding a comma here improves readability.
| - **Write amplification**: all writes must be compacted from L0 to the bottommost level by level. | |
| - **Write amplification**: all writes must be compacted from L0 to the bottommost level, level by level. |
|
|
||
| ## Limitations | ||
|
|
||
| - Compact log backup is not a replacement for full backups. It must be used in conjunction with periodical full backups. To ensure PITR capability, the compacting process retains all MVCC versions. Failing to perform full backups for a long time can lead to excessive storage usage and might cause issues when restoring data later. |
There was a problem hiding this comment.
The word "periodic" is more commonly used and suitable in this technical context than "periodical".
| - Compact log backup is not a replacement for full backups. It must be used in conjunction with periodical full backups. To ensure PITR capability, the compacting process retains all MVCC versions. Failing to perform full backups for a long time can lead to excessive storage usage and might cause issues when restoring data later. | |
| - Compact log backup is not a replacement for full backups. It must be used in conjunction with periodic full backups. To ensure PITR capability, the compacting process retains all MVCC versions. Failing to perform full backups for a long time can lead to excessive storage usage and might cause issues when restoring data later. |
|
|
||
| ## Use compact log backup | ||
|
|
||
| Currently, only manual compaction of log backups is supported, and the process is complex. **It is recommended to use the coming TiDB Operator solution for compacting log backups in production environments.** |
There was a problem hiding this comment.
The word "upcoming" is more formal and standard in technical documentation than "coming".
| Currently, only manual compaction of log backups is supported, and the process is complex. **It is recommended to use the coming TiDB Operator solution for compacting log backups in production environments.** | |
| Currently, only manual compaction of log backups is supported, and the process is complex. **It is recommended to use the upcoming TiDB Operator solution for compacting log backups in production environments.** |
|
|
||
| > **Note:** | ||
| > | ||
| > - If the `--load-creds` option is included when you execute the preceding command, the encoded Base64 string contains credential information loaded from the current BR environment. Note to ensure proper security and access control. |
There was a problem hiding this comment.
The phrase "Note to ensure" is grammatically awkward. Using "Be sure to ensure" is clearer and more direct for the user.
| > - If the `--load-creds` option is included when you execute the preceding command, the encoded Base64 string contains credential information loaded from the current BR environment. Note to ensure proper security and access control. | |
| > - If the `--load-creds` option is included when you execute the preceding command, the encoded Base64 string contains credential information loaded from the current BR environment. Be sure to ensure proper security and access control. |
2 participants
This is an automated cherry-pick of #20342
What is changed, added or deleted? (Required)
This PR adds a new document for the new feature "compact log backup". (experimental)
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.
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?