pingcap
Performance best practice
First-time contributors' checklist
- [x] I've signed Contributor License Agreement that's required for repo owners to accept my contribution.
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.
For details, see tips for choosing the affected versions.
- [x] master (the latest development version)
- [x] v8.4 (TiDB 8.4 versions)
- [ ] v8.3 (TiDB 8.3 versions)
- [ ] v8.2 (TiDB 8.2 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)
- [ ] v5.3 (TiDB 5.3 versions)
What is the related PR or file link(s)?
- This PR is translated from:
- Other reference 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
Hi @dbsid. Thanks for your PR.
I'm waiting for a pingcap member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.
Once the patch is verified, the new status will be reflected by the ok-to-test label.
I understand the commands that are listed here.
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.
![ti-chi-bot[bot] avatar](https://avatars.githubusercontent.com/in/214286?v=4 "Published by a pub.dev verified publisher"){kind=small}
@qw4990: adding LGTM is restricted to approvers and reviewers in OWNERS files.
In response to this:
LGTM for the plan cache part
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.
@shaoxiqian: adding LGTM is restricted to approvers and reviewers in OWNERS files.
In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.
@dbsid I've reviewed the document and found several formatting issues that need to be addressed to meet our documentation standards.
-
Heading Hierarchy
- The document currently contains multiple H1 headings, which violates our single-H1 rule.
- Please restructure all other current H1 headings as H2 or lower
-
System Variable/Configuration Items References Add documentation links for system variables or configuration items. For example:
- | tidb_enable_instance_plan_cache tidb_instance_plan_cache_max_size | Instance Plan Cache is to replace the old session-level plan cache. The instance plan cache allows effective use of the plan cache in scenarios with many prepared statements or many connections | The feature is experimental | + | [`tidb_enable_instance_plan_cache`](/system-variables.md#tidb_enable_instance_plan_cache-new-in-v840), tidb_instance_plan_cache_max_size | Instance Plan Cache is to replace the old session-level plan cache. The instance plan cache allows effective use of the plan cache in scenarios with many prepared statements or many connections | The feature is experimental | -
Markdown Formatting (https://do.pingcap.net/jenkins/blue/organizations/jenkins/pingcap%2Fdocs%2Fpull_verify/detail/pull_verify/8647/pipeline/219)
@dbsid I've reviewed the document and found several formatting issues that need to be addressed to meet our documentation standards.
Heading Hierarchy
- The document currently contains multiple H1 headings, which violates our single-H1 rule.
- Please restructure all other current H1 headings as H2 or lower
System Variable/Configuration Items References Add documentation links for system variables or configuration items. For example:
- | tidb_enable_instance_plan_cache tidb_instance_plan_cache_max_size | Instance Plan Cache is to replace the old session-level plan cache. The instance plan cache allows effective use of the plan cache in scenarios with many prepared statements or many connections | The feature is experimental | + | [`tidb_enable_instance_plan_cache`](/system-variables.md#tidb_enable_instance_plan_cache-new-in-v840), tidb_instance_plan_cache_max_size | Instance Plan Cache is to replace the old session-level plan cache. The instance plan cache allows effective use of the plan cache in scenarios with many prepared statements or many connections | The feature is experimental |Markdown Formatting (https://do.pingcap.net/jenkins/blue/organizations/jenkins/pingcap%2Fdocs%2Fpull_verify/detail/pull_verify/8647/pipeline/219)
I tried to fix the format and link issues, please take a look again.
[LGTM Timeline notifier]
Timeline:
-
2024-12-05 05:42:02.20220984 +0000 UTC m=+1306309.821864350: :ballot_box_with_check: agreed by hfxsd. -
2024-12-05 08:37:03.904681667 +0000 UTC m=+1316811.524336180: :ballot_box_with_check: agreed by Oreoxmt.
[APPROVALNOTIFIER] This PR is APPROVED
This pull-request has been approved by: Oreoxmt
The full list of commands accepted by this bot can be found here.
The pull request process is described here
- ~~OWNERS~~ [Oreoxmt]
Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment
In response to a cherrypick label: new pull request created to branch release-8.5: #19593.
In response to a cherrypick label: new pull request created to branch release-8.4: #19594.