premium: add limitations on import and index creation #22026
Conversation
ti-chi-bot
bot
added
contribution
Summary of ChangesHello @Frank945946, 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 delivers a substantial update to the TiDB documentation, focusing on clarity, accuracy, and the introduction of new features across both TiDB Cloud and Self-Managed offerings. Key changes include the addition of specific Table of Contents for different TiDB Cloud tiers, a major overhaul of the overall documentation structure, and detailed guides for new functionalities like advanced index management and batch processing. These updates aim to provide users with more precise and comprehensive resources for developing, deploying, and optimizing their TiDB applications. Highlights
Ignored Files
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 introduces a significant number of updates and refactoring across the documentation for the v8.5 release. Key changes include the introduction of new Table of Contents files, updates to existing ones, widespread use of new template variables for product naming, and the addition of several new guides and best practice documents. Many existing documents have been improved for clarity, accuracy, and consistency, with updated performance metrics, compatibility information, and configuration recommendations. I've found a few minor issues, such as typos and style guide inconsistencies, and one case of duplicated content that should be addressed. Overall, this is a very thorough and valuable update to the documentation.
| #### Obsolete MVCC versions and excessive keys | ||
|
|
||
| A TiKV instance has much outdated data, which needs to be cleaned up for data scan. This impacts the processing speed. | ||
| If too many obsolete MVCC versions exist on TiKV, or if the retention time of historical MVCC data for GC is long, excessive MVCC versions can accumulate. Handling these unnecessary MVCC versions can affect scan performance. |
There was a problem hiding this comment.
The new heading and description are more detailed and technically accurate, which is a great improvement.
ti-chi-bot
bot
added
size/M
system-variables.md
Outdated
| > **Note:** | ||
| > | ||
| > This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential). | ||
| > This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential). For [{{{ .premium }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#premium), modifying this parameter has no effect on index creation. |
There was a problem hiding this comment.
not read-only, it's not working for add-index, for other reorg jobs it still work
Replaced explicit TiDB Cloud Premium links with template variable {{{ .premium }}} and clarified that certain options are auto-tuned and cannot be modified by users. Updated support contact phrasing for consistency and accuracy.
Updated the documentation for the tidb_ddl_disk_quota variable to clarify its behavior across TiDB Cloud cluster tiers. Added custom content blocks for different plans and improved notes for the premium tier, including support contact information and consistent terminology.
ti-chi-bot
bot
removed
the
missing-translation-status
lilin90
added
area/tidb-cloud
lilin90
changed the title
Co-authored-by: xixirangrang <[email protected]>
|
[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 |
Refined documentation for system variables and global sort to clarify read-only status and applicability for different TiDB Cloud plans. Improved content structure by splitting notes for starter, essential, and premium plans, and updated instructions regarding parameter modification and support contact.
| > **Note:** | ||
| > | ||
| > This TiDB variable is not applicable to {{{ .premium }}}. |
4 participants
First-time contributors' checklist
What is changed, added or deleted? (Required)
Add limitations on import and index creation for TiDB X Premium
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.
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?