Skip to content
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

perf-tuning: add introduction for prepare plan cache #3187

Merged
merged 16 commits into from
May 25, 2020
Merged

perf-tuning: add introduction for prepare plan cache #3187

merged 16 commits into from
May 25, 2020

Conversation

eurekaka
Copy link
Contributor

@eurekaka eurekaka commented May 21, 2020 •
edited
Loading

What is changed, added or deleted? (Required)

Add documentation for prepare plan cache.

Which TiDB version(s) do your changes apply to? (Required)

  • master (the latest development version)
  • 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)?

N/A

@eurekaka eurekaka added needs-cherry-pick-4.0 special-week PR from Document Special Week. labels May 21, 2020
@sre-bot sre-bot added status/PTAL This PR is ready for reviewing. translation/welcome Waits for a contributor to translate this PR and create a PR to the pingcap/docs-cn repository. labels May 21, 2020
@yikeke yikeke requested review from lilin90 and removed request for miaoqingli May 21, 2020 04:02
@lilin90 lilin90 requested review from yikeke and removed request for lilin90 May 21, 2020 06:20
yikeke
yikeke suggested changes May 21, 2020
View reviewed changes
Copy link
Contributor

@yikeke yikeke left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Minor suggestions:

sql-prepare-plan-cache.md Outdated Show resolved Hide resolved
sql-prepare-plan-cache.md Outdated Show resolved Hide resolved
sql-prepare-plan-cache.md Outdated Show resolved Hide resolved
sql-prepare-plan-cache.md Outdated Show resolved Hide resolved
sql-prepare-plan-cache.md Outdated Show resolved Hide resolved
sql-prepare-plan-cache.md Outdated Show resolved Hide resolved
sql-prepare-plan-cache.md Outdated Show resolved Hide resolved
kissmydb
kissmydb reviewed May 22, 2020
View reviewed changes
sql-prepare-plan-cache.md Outdated
关于执行计划缓存和查询性能有两点值得注意：

- 考虑到不同 `Execute` 的参数会不同，执行计划缓存为了保证适配性会禁止一些和具体参数值密切相关的激进查询优化手段，导致对特定的一些参数值，查询计划可能不是最优。比如查询的过滤条件为 `where a > ? and a < ?`，第一次 `Execute` 时参数分别为 2 和 1，考虑到这两个参数下次执行时可能会是 1 和 2，优化器不会生成对当前参数最优的 `TableDual` 执行计划。
- 如果不考虑缓存失效和淘汰，一份执行计划缓存会对应各种不同的参数取值，理论上也会导致某些取值下执行计划非最优。执行计划缓存更适用于查询较为简单（查询编译耗时占比较高）且执行计划较为固定的业务场景。
Copy link
Contributor

Choose a reason for hiding this comment

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

意思是不会考虑取值的统计信息分布？建议举个例子

Copy link
Contributor Author

Choose a reason for hiding this comment

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

在生成 plan 时候会考虑取值的统计信息分布，放入缓存后，后续执行不会重新编译，直接拿缓存 plan 执行，所以后续执行的取值不会考虑。加了例子，PTAL

kissmydb
kissmydb approved these changes May 22, 2020
View reviewed changes
Copy link
Contributor

@kissmydb kissmydb left a comment

Choose a reason for hiding this comment

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

Rest LGTM

eurekaka and others added 9 commits May 22, 2020 11:22
@eurekaka
perf-tuning: add introduction for prepare plan cache
f68a3f1
@eurekaka @yikeke
Update sql-prepare-plan-cache.md
7ef20c8 
Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>
@eurekaka @yikeke
Update sql-prepare-plan-cache.md
b964bae 
Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>
@eurekaka @yikeke
Update sql-prepare-plan-cache.md
6db2c2c 
Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>
@eurekaka @yikeke
Update sql-prepare-plan-cache.md
9618c85 
Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>
@eurekaka @yikeke
Update sql-prepare-plan-cache.md
afc40b4 
Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>
@eurekaka @yikeke
Update sql-prepare-plan-cache.md
9146ed7 
Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>
@eurekaka @yikeke
Update sql-prepare-plan-cache.md
34f9ce4 
Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>
@eurekaka
add example
6a4af7d
@eurekaka eurekaka requested review from yikeke and kissmydb May 22, 2020 03:33
@yikeke
Copy link
Contributor

yikeke commented May 22, 2020 •
edited
Loading

LGTM for now. PTAL @zz-jason @winoros @lzmhhh123

@yikeke yikeke added the status/require-change Needs the author to address comments. label May 24, 2020
@yikeke
Copy link
Contributor

yikeke commented May 24, 2020

No need to add the needs-cherry-pick-4.0 label to this PR. The docs-special-week branch will be merged to master and release-4.0 branches as a whole. FYI @eurekaka

@eurekaka eurekaka requested a review from zz-jason May 25, 2020 03:56
zz-jason
zz-jason reviewed May 25, 2020
View reviewed changes
sql-prepare-plan-cache.md Outdated Show resolved Hide resolved
zz-jason
zz-jason reviewed May 25, 2020
View reviewed changes
sql-prepare-plan-cache.md Outdated Show resolved Hide resolved
@eurekaka eurekaka requested a review from zz-jason May 25, 2020 06:18
zz-jason
zz-jason approved these changes May 25, 2020
View reviewed changes
Copy link
Member

@zz-jason zz-jason left a comment

Choose a reason for hiding this comment

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

LGTM

@zz-jason zz-jason added the status/LGT1 Indicates that a PR has LGTM 1. label May 25, 2020
yikeke
yikeke approved these changes May 25, 2020
View reviewed changes
Copy link
Contributor

@yikeke yikeke left a comment

Choose a reason for hiding this comment

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

LGTM

@yikeke
Copy link
Contributor

yikeke commented May 25, 2020

/merge

1 similar comment
@yikeke
Copy link
Contributor

yikeke commented May 25, 2020

/merge

@sre-bot sre-bot added the status/can-merge Indicates a PR has been approved by a committer. label May 25, 2020
@sre-bot
Copy link
Contributor

sre-bot commented May 25, 2020

/run-all-tests

@sre-bot sre-bot merged commit 2e240aa into pingcap:docs-special-week May 25, 2020
@eurekaka eurekaka deleted the plan_cache branch May 25, 2020 06:36
yikeke added a commit that referenced this pull request May 27, 2020
@yikeke @lilin90
@winoros @nolouch @zanmato1984 @flowbehappy @zimulala @windtalker @3pointer @ran-huang @youjiali1995 @TomShawn @toutdesuite @JaySon-Huang @ethercflow @sre-bot @lidezhu @pepezzzz @tangenta @danmay319 @cfzjywxk @MyonKeminta @Win-Man @jackysp @Reminiscent @rleungx @XuHuaiyu @SunRunAway @hunterlxt @CaitinChen @eurekaka @djshow832 @kissmydb @lzmhhh123 @lonng @yuzhibotao @bb7133 @Little-Wallace @marsishandsome @crazycs520 @miaoqingli @zz-jason @superlzs0476 @wshwsh12 @xiaoyangwang5 @pcqz @freyfl @wentaojin @lysu @tiancaiamao @King-Dylan @LittleFall @disksing @Damon-Guo @KASSADAR @zhenjiaogao @leiysky @hicqu @wjhuang2016 @glkappe @BusyJay @WangXiangUSTC @breezewish @WalterWj @overvenus @YuJuncen @lhy1024 @birdstorm @AndreMouche @winkyao @TaoZhengCN @Connor1996 @zhangjinpeng87 @yilongrong @SE-Bin @together-wang @baurine @HunDunDM @scsldb @qw4990
Merge docs special week branch to master (#3372)
a3c0b95 
* *: udpate part of TOC and create new files

* *: add more topics

* �*: add more topics to toc and create files

* toc: add assignee to two topics

* *: add some issue topics

* *: add some troubleshoot topics

* *: add performance tuning topics

* *: add tutorial topics

* *: add more topics

* *: add more reference topics

* tidb-binlog: create binlogctl file

* perf-tuning：adjust the structure of the `SQL tuning` section (#3149)

* faq, toc: add faq and ui topics

* toc: update troubleshoot and sql tuning

* TOC: add database tools section (#3161)

* TOC: add database tools section

* fix ci

* relocate the section

* add assignees

* add /faq/licensing-faq.md

* modify assignees

* Update command line flags for pd configruation (#3153)

Signed-off-by: nolouch <nolouch@gmail.com>

Co-authored-by: Lilian Lee <lilin@pingcap.com>

* Remove tiflash section in old TOC (commented out) to prevent lint error (#3194)

* toc: remove topics that are commented out

* Remove upgrade-tiflash.md (#3164)

Duplicated with TiDB's upgrade manual.

Co-authored-by: ruoxi <zanmato1984@gmail.com>
Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>

* sql-statements: update "admin" related statements (#3175)

* add tiflash faq (#3167)

* add tiflash faq

* delete original tiflash faq

* fix ci

* address comment

* Revert "fix ci"

This reverts commit 73dff28.

Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>

* toc: remove inapplicable dm topics

* Remove two inapplicable files

* Add lightning faq (#3176)

* .github: add three github action workflows (#3213)

* .github: update workflow to auto assign project (#3229)

* update tikv configuration about pessimistic transaction (#3178)

* update tikv configuration about pessimistic transaction

Signed-off-by: youjiali1995 <zlwgx1023@gmail.com>

* Update tikv-configuration-file.md

Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>

* Update tikv-configuration-file.md

Co-authored-by: toutdesuite <guizhiluo2014@163.com>

Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
Co-authored-by: toutdesuite <guizhiluo2014@163.com>

* Add TiFlash performance tuning to TOC (#3203)

* tuning: add tune-operating-system (#3157)

* tuning: add tune-operating-system

Signed-off-by: Wenbo Zhang <ethercflow@gmail.com>

* refine format and TOC

* Update tune-operating-system.md

Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>

* Update tune-operating-system.md

Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>

* Update tune-operating-system.md

Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>

* Update tune-operating-system.md

Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>

* Update tune-operating-system.md

Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>

* Update tune-operating-system.md

Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>

* Update tune-operating-system.md

Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>

* Update tune-operating-system.md

Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>

Co-authored-by: yikeke <yikeke@pingcap.com>
Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>
Co-authored-by: pingcap-github-bot <sre-bot@pingcap.com>

* add doc about tiflash command line flags (#3205)

* add doc about tiflash command line flags

* Small fix for format

* Try fix link

* Update tiflash/tiflash-command-line-flags.md

Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>
Co-authored-by: pingcap-github-bot <sre-bot@pingcap.com>

* split to DDL DML DQL DCL sections (#3215)

* Add files via upload

* update format

* Update basic-sql-operations.md

Co-authored-by: Ran <huangran@pingcap.com>

* Update command line flags for tikv configruation (#3155)

* update mysql-compatibility.md & add auto-increment.md (#3163)

* perf-tuning: Add document for column prune (#3190)

* *: Update documents and sqlgrams with "alter" prefixed statements (#3235)

* transaction-isolation-levels.md: update txn isolation (#3140)

* Update error-codes.md (#3160)

* Update tidb-specific-system-variables.md (#3159)

* reference: Optimize documents about GC (#3158)

* add troubleshooting-writeconflict (#3209)

* add troubleshooting-writeconflict

* fix syntax

* fix snytax again

* adjust

* fix format

* refine format and wording

Co-authored-by: yikeke <yikeke@pingcap.com>
Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>

* reference: update constraints.md (#3146)

* update literal-values.md (#3236)

* perf-tuning: Update the doc of query-execution-plan (#3201)

* Update configfile pd (#3238)

 *: update PD config file

Signed-off-by: nolouch <nolouch@gmail.com>

* reference: update the pd-ctl docs (#3305)

* update the pd-ctl docs

Signed-off-by: Ryan Leung <rleungx@gmail.com>

* perf-tuning: add document for predicate push down (#3181)

* toc: remove /tidb-index.md (#3258)

* perf-tuning: add docs for DISTINCT optimizations (#3214)

* *: update some statements (#3300)

* update transaction overview (#3165)

* update generate ssl doc (#3260)

* resources: update the Figma link (#3230)

* update generate ssl

Signed-off-by: TXXT <hunterlxt@live.com>

* update generate ssl

Signed-off-by: TXXT <hunterlxt@live.com>

* revert

Signed-off-by: TXXT <hunterlxt@live.com>

* Apply suggestions from code review

Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>

* safe point

Signed-off-by: TXXT <hunterlxt@live.com>

* fix format to pass ci

* update code block format

* address comments

Signed-off-by: TXXT <hunterlxt@live.com>

* Apply suggestions from code review

Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>

Co-authored-by: Caitin <34535727+CaitinChen@users.noreply.github.com>
Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>
Co-authored-by: yikeke <yikeke@pingcap.com>

* perf-tuning: add introduction for prepare plan cache (#3187)

* Fix sql-statement: use, update, truncate, trace (#3255)

* fix use

* fix pic

* fix pic

* update doc

* update doc

Co-authored-by: Lilian Lee <lilin@pingcap.com>

* update document of privilege management (#3202)

* update privilege document

* Apply suggestions from code review

Co-authored-by: Lilian Lee <lilin@pingcap.com>

Co-authored-by: kissmydb <likun@pingcap.com>
Co-authored-by: Lilian Lee <lilin@pingcap.com>
Co-authored-by: Jack Yu <yusp@pingcap.com>

* perf-tuning: add index-choose.md (#3173)

* Add documentations for TiUP (#3197)

* tiup: improve the TiUP related documents

Signed-off-by: Lonng <heng@lonng.org>

* add fag/troubleshoot documents

Signed-off-by: Lonng <heng@lonng.org>

* add TiUP to TOC.md

Signed-off-by: Lonng <heng@lonng.org>

* add aliases to redirect old links

* Apply suggestions from code review

Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>

* address comment

Signed-off-by: Lonng <heng@lonng.org>

* refine TOC and a filename

* fix ci

* Update tiup/tiup-cluster.md

Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>

* fix a dead link

* fix a link

* fix a link

* address comments

Signed-off-by: Lonng <heng@lonng.org>

Co-authored-by: yikeke <yikeke@pingcap.com>
Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>

* update the tidb configuration document (#3148)

* update configure file document

* update command line arguments doc

* update

* update

* update

* update

* update

* update

* update

* update

* update

* fix a typo in tiup doc

Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>
Co-authored-by: yikeke <yikeke@pingcap.com>

* update all the syntax png files (#3322)

* add shutdown statement (#3306)

* reference: update statement summary tables (#3145)

* Add Grafana monitoring content and update images (#3195)

* perf-tuning: add doc for wrong index solution page (#3302)

* add/update several sql statements docs (#3299)

* Add docs for rocksdb (#3198)

* add docs for rocksdb

Signed-off-by: Little-Wallace <bupt2013211450@gmail.com>

* update several sql statements (#3298)

 - sql-statements/sql-statement-set-names.md
 - sql-statements/sql-statement-show-columns-from.md
 - sql-statements/sql-statement-show-create-sequence.md

* add show config statement (#3308)

* add & update several sql statements (#3296)

* *: udpate `begin` and `commit` statements (#3301)

* perf-tuning: update docs for statistics (#3223)

* Update tispark doc (#3257)

* update some syntax diagram (#3312)

Signed-off-by: crazycs520 <crazycs520@gmail.com>

* update several statements (#3309)

* add document of `SHOW PLUGINS` (#3326)

* Add doc about next_row_id and profiles (#3316)

* update comment-syntax.md (#3193)

* update keywords-and-reserved-words.md (#3246)

* update document of tidb-ctl (#3189)

* update the doc of view (#3179)

* update functions-and-operator documents (#3318)

* update some syntax diagram (#3317)

* add syntax diagram for show stats_buckets (#3321)

* perf-tuning: add docs for subquery optimizations (#3191)

* perf-tuning: add docs for some overview pages for sql-tuning (#3170)

* perf-tuning: add docs for some overview pages

* Update query-execution-plan.md

* Apply suggestions from code review

Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>
Co-authored-by: Zhuomin(Charming) Liu <lzmhhh123@gmail.com>

* Update control-execution-plan.md

Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>

* Update sql-tuning-overview.md

* Update control-execution-plan.md

Co-authored-by: Zhang Jian <zjsariel@gmail.com>

Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
Co-authored-by: 苗青利 <51319517+miaoqingli@users.noreply.github.com>
Co-authored-by: Zhang Jian <zjsariel@gmail.com>
Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>
Co-authored-by: Zhuomin(Charming) Liu <lzmhhh123@gmail.com>
Co-authored-by: pingcap-github-bot <sre-bot@pingcap.com>

* update sql-statement-modify-column.md (#3323)

* add topology YAML template (#3279)

* add topology YAML template

* fix topology YAML template

* fix topology YAML template

* update topology YAML template

* sql-statements:add drop-stats.md (#3337)

* sql-statements: update create view and drop view (#3331)

* perf-tuning: add document for partition pruning (#3184)

* docs: add sql statement for load data (#3335)

* Create monitor-deploy.md and tidb-monitoring-api.md (#3196)

* Create monitor-deploy.md

deploy monitor

* Update TOC.md

add monitor deploy

* Update monitor-deploy.md

* Delete monitor-a-tidb-cluster.md

delete

* Update monitor-deploy.md

* Rename monitor-deploy.md to deploy-monitoring-services.md

* Update TOC.md

* add #3186 document

* add alias

* Update mysql-compatibility.md

* Update deploy-monitoring-services.md

* 整理监控报警相关 TOC

* Update deploy-monitoring-services.md

* Update tidb-monitoring-api.md

Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>

* Update tidb-monitoring-api.md

Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
Co-authored-by: kissmydb <likun@pingcap.com>

* Update upgrade-tidb-using-tiup.md (#3212)

* Update upgrade-tidb-using-tiup.md

* Update upgrade-tidb-using-tiup.md

* Update upgrade-tidb-using-tiup.md

Co-authored-by: Lilian Lee <lilin@pingcap.com>

* Update upgrade-tidb-using-tiup.md

Co-authored-by: Lilian Lee <lilin@pingcap.com>

* Update upgrade-tidb-using-tiup.md

Co-authored-by: Lilian Lee <lilin@pingcap.com>

Co-authored-by: kissmydb <likun@pingcap.com>
Co-authored-by: Lilian Lee <lilin@pingcap.com>

* update several document related to privilege sql statement (#3310)

* update create user gramma

* update serveral statment doc

* refine punctuation

* Update sql-statements/sql-statement-grant-privileges.md

Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>

* Update sql-statements/sql-statement-revoke-privileges.md

Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>

Co-authored-by: yikeke <yikeke@pingcap.com>
Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>

* update optimistic transaction (#3171)

* *: update "change column" and some sqlgram (#3304)

* Update three-data-centers-in-two-cities-deployment.md (#3243)

* Add files via upload

* Update three-data-centers-in-two-cities-deployment.md

* fix ci and update format

* Update three-data-centers-in-two-cities-deployment.md

Co-authored-by: Ran <huangran@pingcap.com>

* Update post-installation-check.md (#3297)

* Multi-data-centers-in-one-city-deployment  (#3245)

* sql statements: add create binding, drop binding and show bindings (#3333)

* refine enable tls for client/components (#3325)

* fix hardware-and-software-requirements (#3228)

* update security-compatibility-with-mysql.md (#3311)

* Update scale-tidb-using-tiup.md and production-offline-deployment-using-tiup.md (#3208)

* update several statements (#3289)

* update pessimistic transaction (#3177)

* Add syntax gram of `show stats_meta` (#3338)

* update schema-object-names.md (#3242)

* add sql statement for show analyze status (#3329)

* Update the sql diagram of SHOW TABLES and SHOW INDEXES. (#3346)

* update syntax gram for `kill`, `prepare` and `show stats_healthy` (#3319)

* update expression-syntax.md (#3313)

* Update sql diagrams of show statements (#3277)

* Update the docs of `drop database` (#3332)

* update partition-table.md (#3216)

* update placement rules (#3169)

Signed-off-by: disksing <i@disksing.com>

* add troubleshoot-hot-spot-issues  (#3276)

* picture of troubleshoot-hot-spot-issues

* troubleshoot-hot-spot-issues v1

* Update troubleshoot-hot-spot-issues.md

Co-authored-by: kissmydb <likun@pingcap.com>

* Update troubleshoot-hot-spot-issues.md

* Update troubleshoot-hot-spot-issues.md

* Update troubleshoot-hot-spot-issues.md

* Update troubleshoot-hot-spot-issues.md

* a little fix

Co-authored-by: kissmydb <likun@pingcap.com>
Co-authored-by: pepezzzz <35323945+pepezzzz@users.noreply.github.com>

* Add troubleshooting CPU issues (#3282)

* Create troubleshooting-cpu.md

* Update troubleshoot-cpu-issues.md

* Delete troubleshooting-cpu.md

* Update troubleshoot-cpu-issues.md

Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>

* Update troubleshoot-cpu-issues.md

Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>

* Update troubleshoot-cpu-issues.md

* Update troubleshoot-cpu-issues.md

* Update troubleshoot-cpu-issues.md

* refine format

* Spoken language modified to written language

* Update troubleshoot-cpu-issues.md

Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
Co-authored-by: pepezzzz <35323945+pepezzzz@users.noreply.github.com>
Co-authored-by: kissmydb <likun@pingcap.com>
Co-authored-by: pingcap-github-bot <sre-bot@pingcap.com>

* Docs special week for troubleshoot-lock-conflicts (#3206)

* troubleshoot-lock-conflicts-pictures

add pictures for troubleshoot-lock-conflicts

* add file troubleshoot-lock-conflicts

add file troubleshoot-lock-conflicts

* Update SW troubleshoot-lock-conflicts

Update SW troubleshoot-lock-conflicts

* refine format and content

* Update SW troubleshoot-lock-conflicts

Update SW troubleshoot-lock-conflicts

* Update troubleshoot-lock-conflicts.md

Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>

* Update SW troubleshoot-lock-conflicts

Update SW troubleshoot-lock-conflicts

* Update the ci format for troubleshooting lock conflicts

Update the ci format for troubleshooting lock conflicts

* refine content

* fix indentation

* change category

Co-authored-by: yikeke <yikeke@pingcap.com>
Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>
Co-authored-by: kissmydb <likun@pingcap.com>

* *: update `analyze` statement (#3241)

`

* Move TiFlash troubleshoot part to a new document (#3192)

* update TiDB metrics (#3284)

* add experimental warning (#3330)

* tiny refine cert based authentication (#3328)

* add a dir for config-templates (#3349)

* sql-stmt: modify SelectStmt and add page for `SHOW STATS_HISTOGRAMS` (#3336)

* update tikv-ctl doc (#3254)

* TOC: remove unused pages (#3339)

* Update document for generated column (#3295)

* update the 'Overview' metrics doc for grafana dashboard (#3286)

* add deployment and operation FAQ (#3268)

* best-practice: update massive regions to match 4.0 (#3152)

* Update grafana-monitor-best-practices.md (#3288)

* tools: add data migration route (#3292)

* update user-defined-variables.md (#3271)

* perf-tuning: Add document for topn-limit-push-down (#3307)

* add minimal-deploy-topology.md (#3226)

* add sql statement about pump and drainer (#3324)

* add hybrid-deployment-topology.md (#3227)

* add ticdc-deploy-topology.md (#3281)

* add tiflash-deploy-topology.md (#3285)

* update user-account-management.md (#3211)

* update user-account-management.md

* fix lint?

* Apply suggestions from code review

Co-authored-by: Lilian Lee <lilin@pingcap.com>

* Apply suggestions from code review

* Update user-account-management.md

Co-authored-by: Jack Yu <yusp@pingcap.com>
Co-authored-by: Lilian Lee <lilin@pingcap.com>
Co-authored-by: pingcap-github-bot <sre-bot@pingcap.com>

* add doc for slow-queries in dashboard (#3274)

* add doc for slow-queries in dashboard

Signed-off-by: crazycs520 <crazycs520@gmail.com>

* address comment

Signed-off-by: crazycs520 <crazycs520@gmail.com>

* update format

* Apply suggestions from code review

Co-authored-by: Ran <huangran@pingcap.com>

* update relative paths

* Update list.md

* update alt text and punctuation

* change name and dir

* rename picture

Signed-off-by: crazycs520 <crazycs520@gmail.com>

Co-authored-by: Ran <huangran@pingcap.com>
Co-authored-by: Wenxuan <hi@breeswish.org>

* add check-before-deployment.md (#3225)

* add check-befor-deployment.md

* Update check-before-deployment.md

Co-authored-by: kissmydb <likun@pingcap.com>

* Update check-before-deployment.md

Co-authored-by: Ran <huangran@pingcap.com>

* Update check-before-deployment.md

Co-authored-by: Ran <huangran@pingcap.com>

* Update check-before-deployment.md

Co-authored-by: Ran <huangran@pingcap.com>

* Update check-before-deployment.md

Co-authored-by: Ran <huangran@pingcap.com>

* Update check-before-deployment.md

Co-authored-by: Ran <huangran@pingcap.com>

* Update check-before-deployment.md

* Update check-before-deployment.md

* Update check-before-deployment.md

* Update check-before-deployment.md

* Update check-before-deployment.md

Co-authored-by: Zhang Jian <zjsariel@gmail.com>

* Apply suggestions from code review

Co-authored-by: Lilian Lee <lilin@pingcap.com>

Co-authored-by: kissmydb <likun@pingcap.com>
Co-authored-by: Ran <huangran@pingcap.com>
Co-authored-by: Zhang Jian <zjsariel@gmail.com>
Co-authored-by: Lilian Lee <lilin@pingcap.com>

* Add daily-inspection.md (#3221)

* cdc: update cdc cli doc (#3141)

* add geographic-redundancy-deploy-topology.md (#3283)

* Add tikv overview (#3249)

* add tikv overview

Signed-off-by: Little-Wallace <bupt2013211450@gmail.com>

* add upgrade faq (#3267)

* add tidb-binlog-deploy-topology.md (#3280)

* update character-set-and-collation (#3256)

* update several sql statement docs (#3294)

* Add document of dumpling, the new export tool (#3151)

* Create configure-load-base-split.md (#3168)

* Create configure-load-base-split.md

* TiFlash: Modify scale doc structure (#3341)

Co-authored-by: Flowyi <flowbehappy@gmail.com>
Co-authored-by: kissmydb <likun@pingcap.com>
Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>
Co-authored-by: yikeke <yikeke@pingcap.com>

* update doc credits (#3248)

* update doc credits

Signed-off-by: shirly <AndreMouche@126.com>

* address comments

Signed-off-by: shirly <AndreMouche@126.com>

* Apply suggestions from code review

Co-authored-by: Lilian Lee <lilin@pingcap.com>

* Update credits.md

Co-authored-by: winkyao <golangwink@gmail.com>
Co-authored-by: Lilian Lee <lilin@pingcap.com>
Co-authored-by: pingcap-github-bot <sre-bot@pingcap.com>

* Add FAQ documents to BR (#3344)

* tools: update toc for binlog (#3347)

* update several 'CREATE' related statement: (#3293)

* Update grafana pd dashboard (#3343)

* add scheduling overview from tidb in action (#3180)

* Add some experimental features of br (#3143)

* br: add online restore, raw kv.

* br: warp line of some commands.

* br: fix a dead link.

* Update br/backup-and-restore-tool.md

Co-authored-by: kissmydb <likun@pingcap.com>

* Apply suggestions from code review

Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
Co-authored-by: WangXiangUSTC <wx347249478@gmail.com>

* Update backup-and-restore-tool.md

* refine format

* br: fix incremental backup time range.

* br: add a hint of where the backup stores

* br: add a hint of local storage

* Update backup-and-restore-tool.md

* Update br/backup-and-restore-tool.md

Co-authored-by: Neil Shen <overvenus@gmail.com>

* Update backup-and-restore-tool.md

* Update br/backup-and-restore-tool.md

Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>

* Update backup-and-restore-tool.md

* Update br/backup-and-restore-tool.md

Co-authored-by: kissmydb <likun@pingcap.com>
Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
Co-authored-by: WangXiangUSTC <wx347249478@gmail.com>
Co-authored-by: Neil Shen <overvenus@gmail.com>

* Some optimization configuration for TiKV (#3278)

* add optimize for tikv

Signed-off-by: Little-Wallace <bupt2013211450@gmail.com>

* add blank

Signed-off-by: Little-Wallace <bupt2013211450@gmail.com>

* rename some file

Signed-off-by: Little-Wallace <bupt2013211450@gmail.com>

* fix some link

Signed-off-by: Little-Wallace <bupt2013211450@gmail.com>

* fix blank

Signed-off-by: Little-Wallace <bupt2013211450@gmail.com>

* fix some comment

Signed-off-by: Little-Wallace <bupt2013211450@gmail.com>

* Update tune-tikv-performance-thread.md

Co-authored-by: Lilian Lee <lilin@pingcap.com>

* Update tune-tikv-performance-thread.md

Co-authored-by: Lilian Lee <lilin@pingcap.com>

* Update faq/tidb-faq.md

Co-authored-by: Lilian Lee <lilin@pingcap.com>

* fix grafana

Signed-off-by: Little-Wallace <bupt2013211450@gmail.com>

* Update tune-tikv-performance-thread.md

Co-authored-by: Lilian Lee <lilin@pingcap.com>

* Update tune-tikv-performance-thread.md

Co-authored-by: Lilian Lee <lilin@pingcap.com>

* Update faq/tidb-faq.md

Co-authored-by: Lilian Lee <lilin@pingcap.com>

* rename file

Signed-off-by: Little-Wallace <bupt2013211450@gmail.com>

* add code format

Signed-off-by: Little-Wallace <bupt2013211450@gmail.com>

* address comment

Signed-off-by: Little-Wallace <bupt2013211450@gmail.com>

* Update tune-tikv-thread-performance.md

* Apply suggestions from code review

* Fix format

* Apply suggestions from code review

Co-authored-by: Lilian Lee <lilin@pingcap.com>
Co-authored-by: pingcap-github-bot <sre-bot@pingcap.com>

* add troubleshoot-high-disk-io.md (#3237)

* system-table: update diagnose system table doc (#3154)

* Update tidb-best-practices.md (#3291)

* optimize production-deployment-using-tiup (#3224)

* Update grafana tikv dashboard doc (#3150)

Signed-off-by: TXXT <hunterlxt@live.com>

Co-authored-by: Connor <zbk602423539@gmail.com>
Co-authored-by: Ran <huangran@pingcap.com>
Co-authored-by: Lei Zhao <zlwgx1023@gmail.com>
Co-authored-by: qupeng <onlyqupeng@gmail.com>
Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>
Co-authored-by: zhangjinpeng1987 <zhangjinpeng@pingcap.com>

* Update tiflash usage (#3351)

* Add tiflash intro into TOC (#3355)

* Update sql-faq.md (#3262)

* tools: update toc for cdc (#3352)

* update ticdc

* add link in ticdc overview

* update link

* fix link

* add aliases

* Update TOC.md

Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>

* fix link

* combine deploy ticdc to manage ticdc

* update title

* Update manage-ticdc.md

* Update production-deployment-using-tiup.md

* move ticdc files to ticdc folder

* fix links

* Update manage-ticdc.md

* Update ticdc-overview.md

* fix a link

Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>
Co-authored-by: kissmydb <likun@pingcap.com>
Co-authored-by: yikeke <yikeke@pingcap.com>

* migrate: migrate from mysql files (#3252)

* perf-tuning: add blacklist-control-plan.md (#3253)

* Update benchmark-tidb-using-tpcc.md (#3354)

* Update benchmark-tidb-using-tpcc.md

* Update benchmark-tidb-using-tpcc.md

* Update benchmark/benchmark-tidb-using-tpcc.md

* Update format

Co-authored-by: Lilian Lee <lilin@pingcap.com>
Co-authored-by: pingcap-github-bot <sre-bot@pingcap.com>

* update maintain-tidb-using-tiup.md (#3204)

* architecture: add tidb-architecture, tidb-computing, tidb-storage (#3222)

* dashboard: add docs for cluster info, statement, log search pages (#3247)

* Add Dashboard TOC

Signed-off-by: Breezewish <me@breeswish.org>

* dashboard: add docs about cluster info page

* dashboard: add docs about statement list page

* dashboard: add docs about statement detail page

* dashboard: add docs about log search page

* dashboard: add missed content for statement detail page

* dashboard: fix CI

* dashboard: address the comments

Signed-off-by: baurine <2008.hbl@gmail.com>

* refine

* Update cluster-info.md

* Update log-search.md

* Update detail.md

* Update list.md

* dashboard: add summary meta

* adjust files structure

* fix CI

* fix CI

* fix CI

* Update dashboard/dashboard-statements-list.md

Co-authored-by: 混沌DM <hundundm@gmail.com>

* Update dashboard/dashboard-cluster-info.md

Co-authored-by: 混沌DM <hundundm@gmail.com>

* update file name

Co-authored-by: Breezewish <me@breeswish.org>
Co-authored-by: Wenxuan <hi@breeswish.org>
Co-authored-by: 混沌DM <hundundm@gmail.com>

* Update Dashboard Key-Visualizer Page (#3250)

* Update overview.md (#3166)

* add some note of TiCDC (#3356)

* Add store limit guide (#3353)

* dashboard: update dashboard media files structure (#3359)

* dashboard: update media files structure

* fix link

Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>

* add `SET ROLE` document (#3358)

* Add Dashboard Access, Overview and Profiling Page (#3244)

* Add Dashboard TOC

Signed-off-by: Breezewish <me@breeswish.org>

* Add Access, Overview and Profiling Page

Signed-off-by: Breezewish <me@breeswish.org>

* Fix lint

Signed-off-by: Breezewish <me@breeswish.org>

* Address comments

Signed-off-by: Breezewish <me@breeswish.org>

* Update some doc styles

Signed-off-by: Breezewish <me@breeswish.org>

* Rename files

Signed-off-by: Breezewish <me@breeswish.org>

* Rename

Signed-off-by: Breezewish <me@breeswish.org>

* Make CI happy

Signed-off-by: Breezewish <me@breeswish.org>

* Update dashboard/dashboard-profiling.md

Co-authored-by: 混沌DM <hundundm@gmail.com>

* Update dashboard/dashboard-access.md

Co-authored-by: 混沌DM <hundundm@gmail.com>

* Move images

Signed-off-by: Breezewish <me@breeswish.org>

* Fix deadlink

Signed-off-by: Breezewish <me@breeswish.org>

Co-authored-by: 混沌DM <hundundm@gmail.com>

* combine duplicate doc (#3361)

* combine duplicate doc:

 - sql-statements/sql-statement-show-table-next-row-id.md
 - sql-statements/sql-statement-show-table-next-rowid.md

* fix link

Co-authored-by: yikeke <yikeke@pingcap.com>
Co-authored-by: pingcap-github-bot <sre-bot@pingcap.com>

* Add syntax gram of `load stats`  (#3362)

* resources: update the Figma link (#3230)

* load stats

* add png

* make linter happy

* Update sql-statements/sql-statement-load-stats.md

Co-authored-by: Lynn <zimu_xia@126.com>

* update

Co-authored-by: Caitin <34535727+CaitinChen@users.noreply.github.com>
Co-authored-by: Lynn <zimu_xia@126.com>
Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>

* Add new sql statements to TOC.md (#3357)

* Add doc for cluster diagnose in dashboard (#3273)

* architecture: fix link (#3365)

* architecture: fix link

* Update tidb-computing.md

Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>

Co-authored-by: pingcap-github-bot <sre-bot@pingcap.com>
Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>

* tools: update toc for data migration (#3363)

* add migration by sql

* update toc

* Update data-migration-route.md

Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Lilian Lee <lilin@pingcap.com>
Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>

* remove duplicate content

Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>
Co-authored-by: Lilian Lee <lilin@pingcap.com>
Co-authored-by: pingcap-github-bot <sre-bot@pingcap.com>

* delete extra aliases (#3367)

* delete extra aliases

* Update sql-statement-alter-index.md

* Update sql-statement-change-column.md

* update dashboard diagnostics pickture name (#3366)

* update dashboard diagnostics pickture name

Signed-off-by: crazycs520 <crazycs520@gmail.com>

* update link

Signed-off-by: crazycs520 <crazycs520@gmail.com>

* fix typos

Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>

* add plan_from_cache in slow_query document (#3369)

* add plan_from_cache in slow_query document

* Update identify-slow-queries.md

Co-authored-by: Lilian Lee <lilin@pingcap.com>

* improve location-awareness (#3174)

* improve location-awareness

Signed-off-by: disksing <i@disksing.com>

* Update location-awareness.md

Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>

* Update location-awareness.md

Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>

* Update location-awareness.md

Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>

* Update location-awareness.md

Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>

* Update location-awareness.md

Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>

* Update location-awareness.md

Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>

* Update location-awareness.md

Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>

* Update location-awareness.md

Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>

* Update location-awareness.md

Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>

* Update location-awareness.md

Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>

* Update location-awareness.md

Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>

* rename the file and add an alias

* update title

* fix CI

* fix 2 links

* Update TOC.md

Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>
Co-authored-by: yikeke <yikeke@pingcap.com>

* tidy up docs-special-week branch (#3368)

* remove names and refs

* tidy up TOC; add draft attribute; fix minor issues

* draft:true -> draft: true

* refine TOC

* rename a file; delete extra empty files

* fix 4 dead links due to renaming

* rename a file; add an alias

* <br> -> <br/>

* Update descriptions and format (#3370)

* 修改一些描述的层次格式

* 修改缩进

* Update troubleshoot-high-disk-io.md

* Update troubleshoot-high-disk-io.md

* Update indentation

* Update troubleshoot-high-disk-io.md

* Update troubleshoot-high-disk-io.md

update 一些段落格式

Co-authored-by: Lilian Lee <lilin@pingcap.com>

* add backticks to fix build issues (#3371)

* add backticks to fix build issues

* remove extra slash

* revert frontmatter changes

* Update tune-tiflash-performance.md

* delete extra assignee names

* fix two build issues

Co-authored-by: lilin90 <lilin@pingcap.com>
Co-authored-by: Yiding Cui <winoros@gmail.com>
Co-authored-by: ShuNing <nolouch@gmail.com>
Co-authored-by: ruoxi <zanmato1984@gmail.com>
Co-authored-by: Flowyi <flowbehappy@gmail.com>
Co-authored-by: Lynn <zimu_xia@126.com>
Co-authored-by: xufei <xufei@pingcap.com>
Co-authored-by: 3pointer <luancheng@pingcap.com>
Co-authored-by: Ran <huangran@pingcap.com>
Co-authored-by: Lei Zhao <zlwgx1023@gmail.com>
Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
Co-authored-by: toutdesuite <guizhiluo2014@163.com>
Co-authored-by: JaySon <tshent@qq.com>
Co-authored-by: Zwb <ethercflow@gmail.com>
Co-authored-by: pingcap-github-bot <sre-bot@pingcap.com>
Co-authored-by: lidezhu <47731263+lidezhu@users.noreply.github.com>
Co-authored-by: pepezzzz <35323945+pepezzzz@users.noreply.github.com>
Co-authored-by: tangenta <tangenta@126.com>
Co-authored-by: lawyerphx <pheqx@qq.com>
Co-authored-by: cfzjywxk <lsswxr@163.com>
Co-authored-by: Zejun Li <lizejun@pingcap.com>
Co-authored-by: MyonKeminta <9948422+MyonKeminta@users.noreply.github.com>
Co-authored-by: Win-Man <825895587@qq.com>
Co-authored-by: Jack Yu <yusp@pingcap.com>
Co-authored-by: Chengpeng Yan <41809508+Reminiscent@users.noreply.github.com>
Co-authored-by: Ryan Leung <rleungx@gmail.com>
Co-authored-by: HuaiyuXu <391585975@qq.com>
Co-authored-by: Feng Liyuan <darktemplar.f@gmail.com>
Co-authored-by: Xintao <hunterlxt@live.com>
Co-authored-by: Caitin <34535727+CaitinChen@users.noreply.github.com>
Co-authored-by: Kenan Yao <cauchy1992@gmail.com>
Co-authored-by: djshow832 <873581766@qq.com>
Co-authored-by: Lingyu Song <songlingyu@pingcap.com>
Co-authored-by: kissmydb <likun@pingcap.com>
Co-authored-by: Zhuomin(Charming) Liu <lzmhhh123@gmail.com>
Co-authored-by: Lonng <heng@lonng.org>
Co-authored-by: yuzhibotao <52073478+yuzhibotao@users.noreply.github.com>
Co-authored-by: bb7133 <bb7133@gmail.com>
Co-authored-by: Wallace <bupt2013211450@gmail.com>
Co-authored-by: Liangliang Gu <marsishandsome@gmail.com>
Co-authored-by: crazycs <crazycs520@gmail.com>
Co-authored-by: 苗青利 <51319517+miaoqingli@users.noreply.github.com>
Co-authored-by: Zhang Jian <zjsariel@gmail.com>
Co-authored-by: lzs <43946384+superlzs0476@users.noreply.github.com>
Co-authored-by: Shenghui Wu <793703860@qq.com>
Co-authored-by: xiaoyangwang5 <49518579+xiaoyangwang5@users.noreply.github.com>
Co-authored-by: pcqz <45614653+pcqz@users.noreply.github.com>
Co-authored-by: freyfl <48233548+freyfl@users.noreply.github.com>
Co-authored-by: wentaojin <34805682+WentaoJin@users.noreply.github.com>
Co-authored-by: lysu <sulifx@gmail.com>
Co-authored-by: tiancaiamao <tiancaiamao@gmail.com>
Co-authored-by: King-Dylan <50897894+King-Dylan@users.noreply.github.com>
Co-authored-by: Zhi Qi <30543181+LittleFall@users.noreply.github.com>
Co-authored-by: disksing <i@disksing.com>
Co-authored-by: DamonGuo@PingCAP <50732087+Damon-PingCap@users.noreply.github.com>
Co-authored-by: KASSADAR <KASSADAR@ALIYUN.COM>
Co-authored-by: zhenjiao gao <26379799+zhenjiaogao@users.noreply.github.com>
Co-authored-by: lei yu <leiysky@outlook.com>
Co-authored-by: qupeng <onlyqupeng@gmail.com>
Co-authored-by: wjHuang <huangwenjun1997@gmail.com>
Co-authored-by: glkappe <qihang.li@pingcap.com>
Co-authored-by: Jay <BusyJay@users.noreply.github.com>
Co-authored-by: WangXiangUSTC <wx347249478@gmail.com>
Co-authored-by: Wenxuan <hi@breeswish.org>
Co-authored-by: Wang Jun <277372664@qq.com>
Co-authored-by: Neil Shen <overvenus@gmail.com>
Co-authored-by: 山岚 <36239017+YuJuncen@users.noreply.github.com>
Co-authored-by: lhy1024 <liuhanyang@pingcap.com>
Co-authored-by: birdstorm <samuelwyf@hotmail.com>
Co-authored-by: Shirly <wuxuelian@pingcap.com>
Co-authored-by: winkyao <golangwink@gmail.com>
Co-authored-by: TaoZhengCN <taozheng@pingcap.com>
Co-authored-by: Connor <zbk602423539@gmail.com>
Co-authored-by: zhangjinpeng1987 <zhangjinpeng@pingcap.com>
Co-authored-by: yilongrong <55389305+yilongrong@users.noreply.github.com>
Co-authored-by: Se-L <Seiferbb@126.com>
Co-authored-by: wangxj <44355590+together-wang@users.noreply.github.com>
Co-authored-by: Sparkle <1284531+baurine@users.noreply.github.com>
Co-authored-by: Breezewish <me@breeswish.org>
Co-authored-by: 混沌DM <hundundm@gmail.com>
Co-authored-by: ruofly0425 <ruofly0425@gmail.com>
Co-authored-by: leoppro <zhaoyilin@pingcap.com>
Co-authored-by: Yuanjia Zhang <zhangyuanjia@pingcap.com>
@yikeke yikeke added translation/doing This PR’s assignee is translating this PR. and removed status/require-change Needs the author to address comments. translation/welcome Waits for a contributor to translate this PR and create a PR to the pingcap/docs-cn repository. labels Jun 22, 2020
cofyc
cofyc reviewed Jun 30, 2020
View reviewed changes
TOC.md
@@ -134,6 +134,7 @@
+ [统计信息介绍](/statistics-intro.md)
+ [错误索引的解决方案](/wrong-index-solution.md)
+ [Distinct 优化](/agg-distinct-optimization.md)
+ [执行计划缓存](/sql-prepare-plan-cache.md)
Copy link
Contributor

@cofyc cofyc Jun 30, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

@eurekaka
这里的 "执行计划" 与下面的 "控制执行计划" 中的 "执行计划" 应该是同一个事物吧。英文文档中，“执行计划” 似乎是翻译成 "Execution Plan"，比如 https://github.com/pingcap/docs/blob/master/sql-plan-management.md 。文件名中 "prepare-plan-cache" 统一为 "execution-plan-cache" 是否更恰当一点？

Copy link
Contributor

Choose a reason for hiding this comment

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

我在做这个 PR 的翻译，直译 "执行计划缓存" 为 "Execution Plan Cache" ，但文件名中为 "prepare plan cache" ，感觉有点奇怪。

Copy link
Contributor Author

Choose a reason for hiding this comment

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

执行计划直译确实是 execution plan ，但这个功能是针对 prepare 语句的执行计划，和代码一致我就用的 prepare plan cache

Copy link
Contributor

Choose a reason for hiding this comment

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

是否应该统一下？目前存在两个翻译。中文文档中也存在两个翻译，“控制执行计划概览” 文件名为 control-execution-plan.md 。

Copy link
Contributor Author

Choose a reason for hiding this comment

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

如果用 execution-plan-cache 没那么准确，如果用 prepare-execution-plan-cache 又太长了吧

Copy link
Contributor

Choose a reason for hiding this comment

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

这里的 prepare 是作为动词，只是 execution 被省略了？这个阶段主要是讲准备 (prepare) 执行计划 (execution plan) 吧，那我明白了。

Copy link
Contributor Author

@eurekaka eurekaka Jun 30, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

不是。。prepare 是指 SQL 中的 prepare 类型语句，prepare plan cache 指 prepare 这类语句的 execution plan 的 cache

Copy link
Contributor

Choose a reason for hiding this comment

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

本质上都是 execution plan cache ，但这篇文章里特指 prepare 的 execution plan cache ，只是 "prepare execution plan cache" 比较长，缩写为 "prepare plan cache" ？

Copy link
Contributor Author

Choose a reason for hiding this comment

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

对的

Copy link
Contributor

Choose a reason for hiding this comment

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

英文文档中文件名保持一致，使用 "sql-prepare-plan-cache.md" ，正文里使用 "prepare execution plan cache" 或 "execution plan cache" 是否可以？

因为在中文文档正文里，都是使用 "执行计划缓存“ 一个词，若英文一些文章使用 "execution plan cache" 但这篇文章里使用 "prepare plan cache" 似乎有点奇怪。

@cofyc cofyc mentioned this pull request Jun 30, 2020
Merged
5 tasks
@yikeke yikeke added translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. and removed translation/doing This PR’s assignee is translating this PR. labels Jun 30, 2020
@ti-srebot ti-srebot mentioned this pull request Jul 13, 2020
Merged
5 tasks
@jiaqizho jiaqizho mentioned this pull request Dec 22, 2021
Merged
14 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cofyc cofyc cofyc left review comments

@zz-jason zz-jason zz-jason approved these changes

@yikeke yikeke yikeke approved these changes

@winoros winoros Awaiting requested review from winoros

@lzmhhh123 lzmhhh123 Awaiting requested review from lzmhhh123

@kissmydb kissmydb Awaiting requested review from kissmydb

Assignees
No one assigned
Labels
special-week PR from Document Special Week. status/can-merge Indicates a PR has been approved by a committer. status/LGT1 Indicates that a PR has LGTM 1. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@eurekaka @yikeke @sre-bot @cofyc @zz-jason @kissmydb