Skip to content

Conversation

@qiancai
Copy link
Collaborator

@qiancai qiancai commented Jan 13, 2026

What is changed, added or deleted? (Required)

This PR covers all doc updates for v8.5.5 that have been merged to the feature/preview-v8.5.5 branch.

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.

  • master (the latest development version)
  • v9.0 (TiDB 9.0 versions)
  • v8.5 (TiDB 8.5 versions)
  • v8.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)
  • v6.1 (TiDB 6.1 versions)
  • v5.4 (TiDB 5.4 versions)

What is the related PR or file link(s)?

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

ti-chi-bot and others added 13 commits December 29, 2025 02:20
* Add temp.md

* Delete temp.md

* toc, br: add compact log backup

* Update wording

* Remove example output

* Apply suggestions from code review

Co-authored-by: 山岚 <[email protected]>

* Apply suggestions from code review

Co-authored-by: xixirangrang <[email protected]>

* Apply suggestions from code review

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

* Apply suggestions from code review

---------

Co-authored-by: Lilian Lee <[email protected]>
Co-authored-by: 山岚 <[email protected]>
Co-authored-by: xixirangrang <[email protected]>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
…2168)

* added translation (by Claude 3.7 Sonnet Thinking)

* tweaking some terms

* Refine wording and format

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Update wording

* Update br/br-pitr-manual.md

Co-authored-by: xixirangrang <[email protected]>

* Update version wording

Co-authored-by: Grace Cai <[email protected]>

---------

Co-authored-by: hillium <[email protected]>
Co-authored-by: Lilian Lee <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: xixirangrang <[email protected]>
Co-authored-by: Grace Cai <[email protected]>
@ti-chi-bot ti-chi-bot bot added missing-translation-status This PR does not have translation status info. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Jan 13, 2026
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @qiancai, 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 consolidates and updates the documentation for TiDB v8.5.5, primarily focusing on the Backup & Restore (BR) tool. It introduces comprehensive guides for the new "Compact Log Backup" feature, which optimizes Point-in-Time Recovery (PITR) by converting log backups to SST files. The updates also significantly enhance PITR operations with new capabilities like filtered restores, concurrent execution, and better integration with ongoing log backups. Furthermore, the documentation details improvements to checkpoint restore mechanisms, introduces a physical system table restore option, and describes new system variables related to log backup and circuit breakers, ensuring users have up-to-date information on these critical features.

Highlights

  • New "Compact Log Backup" Feature Documentation: Introduced a new document explaining how to improve Point-in-Time Recovery (PITR) efficiency by compacting log backups into SST format, including its overview, limitations, and manual usage.
  • Enhanced Point-in-Time Recovery (PITR) Capabilities: Documentation updates cover new features for PITR, including restoring data using filters, performing concurrent restore operations, and improved compatibility with ongoing log backup tasks.
  • Checkpoint Restore Mechanism Updates: Detailed explanations for storing checkpoint data, differentiating between downstream cluster and external storage options, and clarifying persistence of pitr_id_map.
  • Physical System Table Restore: Introduced the --fast-load-sys-tables parameter for br restore to enable physical restoration of system tables, offering an alternative to logical restoration.
  • New System Variables: Added documentation for tidb_advancer_check_point_lag_limit (controlling log backup checkpoint lag) and tidb_cb_pd_metadata_error_rate_threshold_ratio (for TiDB circuit breaker).
  • Improved Restore Process Visibility: Updated progress bar outputs for both snapshot and PITR restores to include more detailed metrics like Split&Scatter Region, Download&Ingest SST, and Restore Pipeline.
  • Table Mode During Restore: Clarified that tables are set to restore mode during data restoration, preventing read/write operations until completion.

🧠 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 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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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. 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

  1. 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.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request includes several documentation updates for the v8.5.5 release, primarily focusing on Backup & Restore (BR) features and new system variables. The changes are comprehensive and well-structured. I've added a few minor suggestions to improve clarity, fix grammar, and add helpful links to related documentation. Overall, the updates are clear and will be beneficial for users.

@ti-chi-bot ti-chi-bot bot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Jan 14, 2026
@lilin90 lilin90 added the translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn. label Jan 14, 2026
@ti-chi-bot ti-chi-bot bot removed the missing-translation-status This PR does not have translation status info. label Jan 14, 2026
qiancai and others added 2 commits January 14, 2026 18:51
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: Aolin <[email protected]>
Co-authored-by: Grace Cai <[email protected]>
@ti-chi-bot ti-chi-bot bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Jan 15, 2026
@ti-chi-bot
Copy link

ti-chi-bot bot commented Jan 15, 2026

[LGTM Timeline notifier]

Timeline:

  • 2026-01-15 01:22:29.341759416 +0000 UTC m=+24976.955716272: ☑️ agreed by Oreoxmt.

@qiancai
Copy link
Collaborator Author

qiancai commented Jan 15, 2026

/approve

@qiancai qiancai added the lgtm label Jan 15, 2026
@ti-chi-bot
Copy link

ti-chi-bot bot commented Jan 15, 2026

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: qiancai

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@ti-chi-bot ti-chi-bot bot added the approved label Jan 15, 2026
@qiancai qiancai merged commit 6ae805d into release-8.5 Jan 15, 2026
8 of 9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants