Skip to content

update SPM doc for SQL plan auto capture #7975

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
ti-chi-bot merged 20 commits into from
Apr 1, 2022
Merged

update SPM doc for SQL plan auto capture #7975

ti-chi-bot merged 20 commits into from
Apr 1, 2022

Conversation

@shichun-0415
Copy link
Contributor

@shichun-0415 shichun-0415 commented Mar 28, 2022 •
edited
Loading

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.

For details, see tips for choosing the affected versions.

  • master (the latest development version)
  • v6.0 (TiDB 6.0 versions)
  • v5.4 (TiDB 5.4 versions)
  • v5.3 (TiDB 5.3 versions)
  • v5.2 (TiDB 5.2 versions)
  • v5.1 (TiDB 5.1 versions)
  • v5.0 (TiDB 5.0 versions)
  • v4.0 (TiDB 4.0 versions)
  • v3.1 (TiDB 3.1 versions)
  • v3.0 (TiDB 3.0 versions)
  • v2.1 (TiDB 2.1 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
Copy link
Member

ti-chi-bot commented Mar 28, 2022 •
edited
Loading

[REVIEW NOTIFICATION]

This pull request has been approved by:

  • qiancai

To complete the pull request process, please ask the reviewers in the list to review by filling /cc @reviewer in the comment.
After your PR has acquired the required number of LGTMs, you can assign this pull request to the committer in the list by filling /assign @committer in the comment to help you merge this pull request.

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

Details

Reviewer can indicate their review by submitting an approval review.
Reviewer can cancel approval by submitting a request changes review.

@ti-chi-bot ti-chi-bot requested a review from TomShawn March 28, 2022 11:50
@ti-chi-bot ti-chi-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 Mar 28, 2022
@shichun-0415 shichun-0415 requested review from Reminiscent and qiancai and removed request for TomShawn March 28, 2022 11:50
@shichun-0415 shichun-0415 added translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. area/sql-infra Indicates that the Issue or PR belongs to the area of sql-infra and sql-metadata. type/compatibility-or-feature-change This PR involves compatibility changes or feature behavior changes. v6.0 This PR/issue applies to TiDB v6.0. translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn. and removed missing-translation-status This PR does not have translation status info. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. labels Mar 28, 2022
shichun-0415
shichun-0415 commented Mar 29, 2022
View reviewed changes
@shichun-0415
Copy link
Contributor Author

shichun-0415 commented Mar 29, 2022 •
edited
Loading

@ran-huang 这个 PR 有一个术语：

自动捕获绑定/Baseline Capturing

ZH：自动绑定会对符合捕获条件的查询进行捕获，为符合条件的查询生成相应的绑定。通常用于升级时的计划回退防护。
EN：Used for preventing rollback of execution plans during an upgrade, this function captures queries that meet capturing conditions and create bindings for them.

也请 @Reminiscent 看看术语解释是否充分，谢谢。

shichun-0415
shichun-0415 commented Mar 29, 2022
View reviewed changes
@ran-huang ran-huang mentioned this pull request Mar 29, 2022
Merged
15 tasks
Reminiscent
Reminiscent reviewed Mar 30, 2022
View reviewed changes
shichun-0415
shichun-0415 commented Mar 30, 2022
View reviewed changes
@shichun-0415 shichun-0415 mentioned this pull request Mar 30, 2022
Merged
16 tasks
Reminiscent
Reminiscent reviewed Mar 31, 2022
View reviewed changes
sql-plan-management.md Outdated
>
> - If the blocklist contains illegal filter content, TiDB returns warning message `[sql-bind] unknown capture filter type, ignore it` in the log.

### Prevent rollback of execution plans during an upgrade
Copy link
Contributor

@Reminiscent Reminiscent Mar 31, 2022

Choose a reason for hiding this comment

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

Suggested change
### Prevent rollback of execution plans during an upgrade
### Prevent regression of execution plans during an upgrade

Reminiscent
Reminiscent reviewed Mar 31, 2022
View reviewed changes
Reminiscent
Reminiscent reviewed Mar 31, 2022
View reviewed changes
sql-plan-management.md Outdated

> **Note:**
>
> Test data shows that long-term working of baseline capturing does not affect performance of the cluster load. Therefore, it is recommended to enable baseline capturing as long as possible.
Copy link
Contributor

@Reminiscent Reminiscent Mar 31, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

最后这里是不是少了半句话 “以确保重要的查询都能被捕获到。”

Reminiscent
Reminiscent reviewed Mar 31, 2022
View reviewed changes
Reminiscent
Reminiscent reviewed Mar 31, 2022
View reviewed changes
@ti-chi-bot ti-chi-bot added the status/LGT1 Indicates that a PR has LGTM 1. label Apr 1, 2022
@shichun-0415
Copy link
Contributor Author

shichun-0415 commented Apr 1, 2022

/remove status LGT1
/status LGT2

@ti-chi-bot ti-chi-bot added the status/LGT2 Indicates that a PR has LGTM 2. label Apr 1, 2022
@shichun-0415
Copy link
Contributor Author

shichun-0415 commented Apr 1, 2022

/merge

@ti-chi-bot
Copy link
Member

ti-chi-bot commented Apr 1, 2022

This pull request has been accepted and is ready to merge.

DetailsCommit hash: 98887e8

@ti-chi-bot ti-chi-bot added the status/can-merge Indicates a PR has been approved by a committer. label Apr 1, 2022
@ti-chi-bot ti-chi-bot mentioned this pull request Apr 1, 2022
Merged
16 tasks
@ti-chi-bot ti-chi-bot merged commit 4d59789 into pingcap:master Apr 1, 2022
@ti-chi-bot ti-chi-bot mentioned this pull request Apr 1, 2022
Closed
16 tasks
@ti-chi-bot
Copy link
Member

ti-chi-bot commented Apr 1, 2022

In response to a cherrypick label: new pull request created: #8037.

@shichun-0415 shichun-0415 deleted the SPM branch April 1, 2022 12:17
@qiancai
Copy link
Collaborator

qiancai commented Apr 2, 2022

/run-cherry-picker

@qiancai
Copy link
Collaborator

qiancai commented Apr 2, 2022

/cherry-pick release-6.0

@ti-chi-bot
Copy link
Member

ti-chi-bot commented Apr 2, 2022

@qiancai: new pull request could not be created: failed to create pull request against pingcap/docs#release-6.0 from head ti-chi-bot:cherry-pick-7975-to-release-6.0: status code 422 not one of [201], body: {"message":"Validation Failed","errors":[{"resource":"PullRequest","code":"custom","message":"A pull request already exists for ti-chi-bot:cherry-pick-7975-to-release-6.0."}],"documentation_url":"https://docs.github.com/rest/reference/pulls#create-a-pull-request"}

Details

In response to this:

/cherry-pick release-6.0

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 ti-community-infra/tichi repository.

ti-chi-bot pushed a commit to ti-chi-bot/docs that referenced this pull request Apr 2, 2022
@shichun-0415 @ti-chi-bot
This is an automated cherry-pick of pingcap#7975
a2bbf20 
Signed-off-by: ti-chi-bot <ti-community-prow-bot@tidb.io>
@qiancai
Copy link
Collaborator

qiancai commented Apr 2, 2022

/cherry-pick release-6.0

ti-chi-bot pushed a commit to ti-chi-bot/docs that referenced this pull request Apr 2, 2022
@shichun-0415 @ti-chi-bot
This is an automated cherry-pick of pingcap#7975
06f60df 
Signed-off-by: ti-chi-bot <ti-community-prow-bot@tidb.io>
@ti-chi-bot ti-chi-bot mentioned this pull request Apr 2, 2022
Closed
16 tasks
@ti-chi-bot
Copy link
Member

ti-chi-bot commented Apr 2, 2022

@qiancai: new pull request created: #8054.

Details

In response to this:

/cherry-pick release-6.0

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 ti-community-infra/tichi repository.

@shichun-0415
Copy link
Contributor Author

shichun-0415 commented Apr 2, 2022

/cherry-pick release-6.0

ti-chi-bot pushed a commit to ti-chi-bot/docs that referenced this pull request Apr 2, 2022
@shichun-0415 @ti-chi-bot
This is an automated cherry-pick of pingcap#7975
f998adf 
Signed-off-by: ti-chi-bot <ti-community-prow-bot@tidb.io>
@ti-chi-bot ti-chi-bot mentioned this pull request Apr 2, 2022
Merged
16 tasks
@ti-chi-bot
Copy link
Member

ti-chi-bot commented Apr 2, 2022

@shichun-0415: new pull request created: #8055.

Details

In response to this:

/cherry-pick release-6.0

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 ti-community-infra/tichi repository.

ti-chi-bot added a commit that referenced this pull request Apr 2, 2022
@ti-chi-bot
update SPM doc for SQL plan auto capture (#7975) (#8055)
cf1fd60
@ti-chi-bot ti-chi-bot mentioned this pull request Apr 6, 2022
Merged
15 tasks
@dveeden dveeden mentioned this pull request Dec 5, 2023
Merged
17 tasks
This was referenced Dec 21, 2023
Merged
Merged
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@qiancai qiancai qiancai approved these changes

+1 more reviewer

@Reminiscent Reminiscent Reminiscent approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

area/sql-infra Indicates that the Issue or PR belongs to the area of sql-infra and sql-metadata. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. status/can-merge Indicates a PR has been approved by a committer. status/LGT1 Indicates that a PR has LGTM 1. status/LGT2 Indicates that a PR has LGTM 2. translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn. type/compatibility-or-feature-change This PR involves compatibility changes or feature behavior changes. v6.0 This PR/issue applies to TiDB v6.0.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@shichun-0415 @ti-chi-bot @qiancai @Reminiscent