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.

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

Update system variables for correctness #6224

Merged
merged 5 commits into from
Sep 10, 2021

Conversation

morgo
Copy link
Contributor

@morgo morgo commented Aug 23, 2021

What is changed, added or deleted? (Required)

This updates the sysvars documentation for correctness (I used a script to generate it)

The main difference is that some new variables were not correctly in alphabetical order. I will comment on some of the other changes inline.

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)
  • 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)?

  • 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

@ti-chi-bot
Copy link
Member

ti-chi-bot commented Aug 23, 2021

[REVIEW NOTIFICATION]

This pull request has been approved by:

  • TomShawn
  • dveeden

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.

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

@morgo morgo requested a review from dveeden August 23, 2021 17:30
@ti-chi-bot ti-chi-bot added missing-translation-status This PR does not have translation status info. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Aug 23, 2021
@@ -321,14 +322,14 @@ MPP is a distributed computing framework provided by the TiFlash engine, which a

- Scope: SESSION | GLOBAL
- Default value: `10240`
- Range: `[-1, 9223372036854775807]`
- Range: `[0, 9223372036854775807]`
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is actually wrong. In the source code you can see that it has a minValue of 0, and does not permit the special autovalue of -1:

https://github.com/pingcap/tidb/blob/22034c5bcd690dda3a9e794d6057cb5d9385d7cf/sessionctx/variable/sysvar.go#L876-L879

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

Choose a reason for hiding this comment

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

5.7.25-TiDB-v5.2.0-alpha-720-gd9bf3bf2d 127.0.0.1:4000   test  SQL  set session tidb_broadcast_join_threshold_count=-1;
ERROR: 1231 (42000): Variable 'tidb_broadcast_join_threshold_count' can't be set to the value of '-1'

Copy link
Contributor

@LittleFall LittleFall Aug 24, 2021

Choose a reason for hiding this comment

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

Sorry to hear this. The reason for this error is that although we have implemented the corresponding logic, we have not expanded the scope of the variable, which results in behavior that is inconsistent with the document.
Thanks for pointing it out!
We will modify this document in pingcap/docs-cn#6926 to be consistent with the behavior, and fix this error in 5.2.1.

Comment on lines 331 to 332
- Range: `[-1, 9223372036854775807]`
- Range: `[0, 9223372036854775807]`
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Same as above.

Copy link
Contributor

Choose a reason for hiding this comment

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

@@ -565,7 +566,7 @@ Constraint checking is always performed in place for pessimistic transactions (d
>
> Currently, List partition and List COLUMNS partition are experimental features. It is not recommended that you use it in the production environment.

- Scope: SESSION
- Scope: SESSION | GLOBAL
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@ti-chi-bot ti-chi-bot added the status/LGT1 Indicates that a PR has LGTM 1. label Aug 24, 2021
@dveeden
Copy link
Contributor

dveeden commented Aug 24, 2021

Is there something we can do in CI to avoid items from being out of order etc?

@dveeden
Copy link
Contributor

dveeden commented Aug 24, 2021

Maybe something like this and/or run the script @morgo used?

[dvaneeden@dve-carbon docs]$ diff -u <(awk '/^#{3} / { print $2 }' system-variables.md) <(awk '/^#{3} / { print $2 }' system-variables.md | sort)
--- /dev/fd/63	2021-08-24 08:43:43.251885405 +0200
+++ /dev/fd/62	2021-08-24 08:43:43.252885414 +0200
@@ -1,7 +1,7 @@
 allow_auto_random_explicit_insert
+autocommit
 auto_increment_increment
 auto_increment_offset
-autocommit
 character_set_client
 character_set_connection
 character_set_database
@@ -9,8 +9,8 @@
 character_set_server
 cte_max_recursion_depth
 datadir
-default_authentication_plugin
 ddl_slow_threshold
+default_authentication_plugin
 foreign_key_checks
 hostname
 init_connect
@@ -87,9 +87,9 @@
 tidb_gc_run_interval
 tidb_gc_scan_lock_mode
 tidb_general_log
-tidb_hash_join_concurrency
 tidb_hashagg_final_concurrency
 tidb_hashagg_partial_concurrency
+tidb_hash_join_concurrency
 tidb_index_join_batch_size
 tidb_index_lookup_concurrency
 tidb_index_lookup_join_concurrency
@@ -100,19 +100,19 @@
 tidb_low_resolution_tso
 tidb_max_chunk_size
 tidb_max_delta_schema_count
+tidb_memory_usage_alarm_ratio
 tidb_mem_quota_apply_cache
 tidb_mem_quota_query
-tidb_memory_usage_alarm_ratio
 tidb_metric_query_range_duration
 tidb_metric_query_step
 tidb_multi_statement_mode
 tidb_opt_agg_push_down
-tidb_opt_limit_push_down_threshold
-tidb_opt_enable_correlation_adjustment
 tidb_opt_correlation_exp_factor
 tidb_opt_correlation_threshold
 tidb_opt_distinct_agg_push_down
+tidb_opt_enable_correlation_adjustment
 tidb_opt_insubq_to_join_and_agg
+tidb_opt_limit_push_down_threshold
 tidb_opt_prefer_range_scan
 tidb_opt_write_row_id
 tidb_partition_prune_mode

@TomShawn TomShawn self-assigned this Aug 24, 2021
@TomShawn TomShawn added translation/doing This PR's assignee is translating this PR. type/enhancement The issue or PR belongs to an enhancement. and removed missing-translation-status This PR does not have translation status info. labels Aug 24, 2021
system-variables.md Outdated Show resolved Hide resolved
Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
@ti-chi-bot ti-chi-bot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Aug 24, 2021
@ti-chi-bot ti-chi-bot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Aug 24, 2021
@morgo
Copy link
Contributor Author

morgo commented Aug 24, 2021

Maybe something like this and/or run the script @morgo used?

[dvaneeden@dve-carbon docs]$ diff -u <(awk '/^#{3} / { print $2 }' system-variables.md) <(awk '/^#{3} / { print $2 }' system-variables.md | sort)

The problem with the scripts is it requires the docs team has to be comfortable with maintaining them. My hope is that we can document everything and simplify the logic enough that #5720 can be used to auto-generate the docs. Until then, I will just contribute incremental updates to keep consistency.

Copy link
Contributor

@TomShawn TomShawn left a comment

Choose a reason for hiding this comment

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

LGTM

@ti-chi-bot ti-chi-bot added status/LGT2 Indicates that a PR has LGTM 2. and removed status/LGT1 Indicates that a PR has LGTM 1. labels Aug 25, 2021
@TomShawn TomShawn added sig/docs Indicates that the Issue or PR belongs to the docs SIG. area/sql-infra Indicates that the Issue or PR belongs to the area of sql-infra and sql-metadata. labels Sep 6, 2021
@TomShawn
Copy link
Contributor

/merge

@ti-chi-bot
Copy link
Member

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

Commit hash: dbb77f6

@ti-chi-bot ti-chi-bot added the status/can-merge Indicates a PR has been approved by a committer. label Sep 10, 2021
@ti-chi-bot ti-chi-bot merged commit f42e8fd into pingcap:master Sep 10, 2021
ti-chi-bot pushed a commit to ti-chi-bot/docs that referenced this pull request Sep 10, 2021
@ti-chi-bot
Copy link
Member

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

Liuxiaozhen12 pushed a commit to Liuxiaozhen12/docs that referenced this pull request Sep 13, 2021
commit c05d1be
Author: Daniël van Eeden <github@myname.nl>
Date:   Fri Sep 10 09:32:40 2021 +0200

    encryption-at-rest: Update (pingcap#6152)

commit f42e8fd
Author: Morgan Tocker <tocker@gmail.com>
Date:   Fri Sep 10 00:24:39 2021 -0600

    Update system variables for correctness (pingcap#6224)

commit 380d0df
Author: shichun-0415 <89768198+shichun-0415@users.noreply.github.com>
Date:   Fri Sep 10 14:14:39 2021 +0800

    release note: add a check item for feedback-probability (pingcap#6405)

commit b2e70ce
Author: Morgan Tocker <tocker@gmail.com>
Date:   Thu Sep 9 08:14:38 2021 -0600

    basic features: add feature matrix (pingcap#6130)

commit 055dbf2
Author: Liuxiaozhen12 <82579298+Liuxiaozhen12@users.noreply.github.com>
Date:   Thu Sep 9 21:00:39 2021 +0800

    release-notes: add 5.2.1 release notes (pingcap#6438)

commit bea12de
Author: Fendy <40378371+septemberfd@users.noreply.github.com>
Date:   Thu Sep 9 16:04:39 2021 +0800

    Enhance TiDB login descriptions - EN (pingcap#6427)

commit 815ed6f
Author: Yini Xu <34967660+YiniXu9506@users.noreply.github.com>
Date:   Thu Sep 9 15:06:39 2021 +0800

    chore: update ci scripts (pingcap#6429)

commit c666f05
Author: Kolbe Kegel <kolbe@pingcap.com>
Date:   Thu Sep 9 00:04:40 2021 -0700

    performance_schema -> information_schema (pingcap#6418)

commit b8d3b32
Author: Yini Xu <34967660+YiniXu9506@users.noreply.github.com>
Date:   Thu Sep 9 14:50:39 2021 +0800

    chore: fix byte encode (pingcap#6428)

commit 7db1f25
Author: Fendy <40378371+septemberfd@users.noreply.github.com>
Date:   Thu Sep 9 12:06:38 2021 +0800

    add doc links to overview.md (pingcap#6422)

commit efd371e
Author: Morgan Tocker <tocker@gmail.com>
Date:   Wed Sep 8 19:56:38 2021 -0600

    system-variables: improve noop functions warning (pingcap#6374)

commit 5a56bcc
Author: Enwei <jinenwei@pingcap.com>
Date:   Wed Sep 8 10:50:58 2021 +0200

    Configuration Options: remove two TiDB's command options (pingcap#6370)

commit 9e53b40
Author: Enwei <jinenwei@pingcap.com>
Date:   Wed Sep 8 10:48:58 2021 +0200

    BR FAQ: add a warning about multi br importing (pingcap#6263)

commit 391e4bb
Author: you06 <you1474600@gmail.com>
Date:   Wed Sep 8 16:46:58 2021 +0800

    update transaction doc (pingcap#6158)

commit 7c6c1de
Author: Enwei <jinenwei@pingcap.com>
Date:   Wed Sep 8 10:42:59 2021 +0200

    TiKV config: fix wrong description about `compaction-readahead-size` (pingcap#6371)

commit 5f16115
Author: Liuxiaozhen12 <82579298+Liuxiaozhen12@users.noreply.github.com>
Date:   Wed Sep 8 15:34:58 2021 +0800

    Add description for TiKV Ready handled panel (pingcap#6375)
@TomShawn TomShawn assigned shichun-0415 and unassigned TomShawn Sep 15, 2021
@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. and removed translation/doing This PR's assignee is translating this PR. labels Sep 15, 2021
TomShawn added a commit that referenced this pull request Oct 8, 2021
* Dumping default consistency description (#5985)

* update max-replicas description (#5984)

* Remove the swappiness parameter (#5987)

* system-variables: update for consistency (#5826)

* Change tidb_memory_usage_alarm_ratio scope to instance (#5988)

* Punctuation fix: Replace 。with . (#6002)

* index page: updated the phase of TiDB Cloud from Beta to Public Preview (#6014)

* Migration FAQs: added the FAQ links of the migration related tools (#6010)

* TiUP cluster: update data_dir (#6009)

* Add kafka downstream example (#6005)

* TiKV configuration: Update description for pin-l0-filter-and-index-blocks (#6008)

* Update the default value of tidb_stmt_summary_max_stmt_count (#6021) (#6023)

* update docs related to partition table dynamic mode (#5997)

* partitioning: Corrected partition management (#5498)

* TiDB binlog: update descriptions about commit ts and passoword (#5986)

* releases: add tidb 4.0.14 release notes (#5996)

* fix a typo for sync_diff_inspector (#6041)

* Update dashboard FAQ (#5895)

* update stale read doc for ga (#6047)

* configure-time-zone: mention `system_time_zone` (#6032)

* Update Security Compatibility with MySQL (#5921)

* correct document of using br backup and restore system tables (#6057)

* Add description about telemetry of builtin functions usage (#6028)

* Add TiDB Dashboard session docs (#6058)

* update br faq (#6060)

* releases: add TiDB 5.1.1 release notes (#6030)

* grafana-overview-dashboard: update the monitoring item for CPS (#6066)

* deploy-tidb-binlog: make the expression on deployment clearer (#6073)

* Add documentation on how to modify gcttl by tiup (#6071)

* remove useless variable (#6076)

* ticdc: add mysql sink user privilege (#6072)

* deleted roadmap.md (#6079)

* TiDB Monitoring Metrics: remove a line (#6081)

* TiDB configuration: add a security option `require-secure-transport` (#6080)

* chore: lock plugin versions (#6089)

* cdc: add compatibility notes for sort-dir (#6086)

* Add gc ttl (#6102) (#6103)

* 5.1.0 release notes: Fix link to telemetry docs (#6106)

* sql-statement-select: Add '...FOR UPDATE NOWAIT' (#6085)

* TiCDC: update a golang demo link (#6055)

* br/use-br-command-line-tool: supplement br note (#6000)

* pr_template: Provides tips for cherry-pick (#6042)

* pr_template: Provides tips for cherry-pick

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* TiDB monitoring: add table storage info status api (#6110)

* update doc for Oracle translate function (#6053)

* ticdc: add explicit_defaults_for_timestamp compatibility troubleshoot (#6115)

* Add print the bad sst files and related information for tikv-ctl (#6109)

* add a missing note (#6129)

* Add docs for auto-tls setting (#6125)

* TiFlash: remove outdated tune advise (#6133)

* TiDB lightning: remove default backend setting (#6132)

* tidb-scheduling: fix typo (#6140)

* Suggest Log Redaction when using TDE (#6147)

* Add infoschema.referential_constraints (#6139)

* Add steps to get lightning goroutine (#6001)

* tiup: fix dead links (#6153)

* Deleted description about not supporting some features. (#6157)

* high-concurrency-best-practices: fix the support info of follower read (#6161)

* Update function list pushed down to tiflash (#6165)

* The `log_dir` should be the log directory (#6168)

* Make IP address of Monitoring & Grafana for Minimal Topology consistent (#6178)

* tikv: add storage flow control doc (#6173)

* TiDB configuration: update the default value of `stmt_max_count` (#6172)

* ticdc-open-api: add ticdc open api doc (#6186)

* System variables: update `broadcast_join_threshold_count` and `broadc… (#6181)

* Update tikv-configuration-file.md (#6180)

* TiFlash configuration: update `io_rate_limit` (#6176)

* Add information of hashAgg for memory control (#6171)

* Update description on rule based index selection (#6160)

* add dr auto sync (#6182)

* update doc for SPM (#6146)

* docs: update rereject leader docs (#6183)

* SQL statement, system variables: update expression indexes (#6185)

* Updated sql-plan-management.md (#6184)

* Introduced 2 new variables (#6159)

* Fix broken link in error codes doc and support doc (#6196)

* docs: fix format for TiKV and PD configuration file template invalid. (#6197)

* docs: separate query statement and result in two text boxes. (#6204) (#6205)

* adopters: add zhihu case study (#6207)

* Added descriptions about slow node detection (#6174)

* pd-control: add new config of balance-hot-region-scheduler (#6148)

* add notice about scaling in pd node (#6099)

* add example for expression index (#6215)

* adopters: remove 404 links (#6214)

* ticdc: fix wording (#6231)

* Revert "System variables: update `broadcast_join_threshold_count` and `broadc…" (#6232)

* Update documents of lock view for sprint 4 (#6179)

* ticdc-open-api: correct some error (#6239)

* best practices: add timeout options for Java best practices (#6136)

* update PR template for v5.2 (#6166)

* chore: stop building temporary (#6252)

* fix typo for sql-plan-management.md (#6248)

* alert rules: update some descriptions (#6250)

* Quick start: update version and TiUP playground supports M1 silicon (#6149)

* fix typo: relaod -> reload (#6235)

* tiny fix on index selection (#6265)

* add commands to check tikv user (#5999)

* br: add restore to systables (#6004)

* br: add restore to systables

* Apply suggestions from code review

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

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

* statement summary: update statement summary doc (#6084)

* Require process privilege for dumpling (#6187)

* tiflash: Remove the description about expr_blacklist in use_tiflash.md (#6188)

* Add description about table name/alias specifying for read_from_storage hint (#6164)

* complex tidb binlog.yaml: add checkpoint info (#6216)

* TiKV configuration: remove redundant instructions (#6218)

* alert rules: remove some descriptions (#6223)

* Revert "add dr auto sync" (#6294)

* TiFlash Config: Add annotation (v5.2.0) (#6296)

* sql: improve kill's description (#6233)

* Add v5.2 TPCH report (#6170)

* docs: fix expression index's document again (#6295)

* system variables.md: add a warning message (#6298)

* sql-statement: Add ADMIN SHOW TELEMETRY (#6138)

* tiup: add notice about importing cluster (#6108)

* Bump version for v5.2.0 (#6191)

* add TiDB 5.2.0 release note (#6237)

* add two HTAP documents (#6206)

* benchmark: add v5.2 benchmark results (#6319)

* Fix title typo (#6324)

* release note: update feature description (#6325)

* adopters: add xiaomi (#6303)

* chore: migrate scripts to docs (#6338)

* credits: update links to the full list of code and docs contributors (#6111)

* TiUP: add instructions for offline mirror (#6137)

* tune tikv memory performance: remove description for sync-log (#6234)

* dashboard statement list: add a note to explain the blue bar and yellow line (#6189)

* release 5.1.0: add compatibility change for `tidb_enable_noop_functions` (#6222)

* modify configuration online: remove unsupported parameters (#6300)

* modify configuration online: change a name for consistency (#6301)

* Migrate from Aurora: update Aurora MySQL dumpling command (#6335)

* PD configuration file: add log level (#6302)

* TiDB Binlog config: update "syncer.to.checkpoint" info (#6340)

* update doc on wal-recovery-mode and use-direct-io-for-flush-and-compaction (#6163)

* Fix TOC display error (#6369)

* sql: fix the correctness problem about kill (#6377)

* change expressions related to statement summary tables (#6299)

* Update grafana-pd-dashboard.md (#6388)

* system variables: update description about `tidb_opt_prefer_range_scan` (#6389)

* Update alert rule for low space (#6376)

* chore: add dispatch back (#6404)

* Add description for TiKV Ready handled panel (#6375)

* TiKV config: fix wrong description about `compaction-readahead-size` (#6371)

* update transaction doc (#6158)

* BR FAQ: add a warning about multi br importing (#6263)

* Configuration Options: remove two TiDB's command options (#6370)

* system-variables: improve noop functions warning (#6374)

* add doc links to overview.md (#6422)

* chore: fix byte encode (#6428)

* performance_schema -> information_schema (#6418)

* chore: update ci scripts (#6429)

* Enhance TiDB login descriptions - EN (#6427)

* release-notes: add 5.2.1 release notes (#6438)

* basic features: add feature matrix (#6130)

* release note: add a check item for feedback-probability (#6405)

* Update system variables for correctness (#6224)

* encryption-at-rest: Update (#6152)

* basic-features: collapse charset and collations (#6452)

* system-variables: update from generated source (#6451)

* fix-enable-compaction-filter-in-tikv-configuration-file (#6403)

* Update the related variable description for CREATE INDEX (#6434)

* TiKV config: add 7 log-related congifurations (#6372)

* Configure placement rules: fix placement doc (#6450)

* adopters: add Pinterest (#6443)

* release-5.2.0: Add info about caching_sha2 (#6344)

* faq: add info for schema is changed error (#6453)

* Update enable-tls-between-clients-and-servers.md (#6493)

* adopters: remove Pinterest (#6501)

* Fix wrong wording in mysql-compatibility.md (#6511)

* adopters: add Huya Live (#6516)

* tidb-configuration-file: correct the default value of committer-concurrency (#6526)

* Tune TiKV: change the default value of `grpc-concurrency` (#6531)

* releases: add tidb 4.0.15 release notes (#6475)

* releases: add tidb 5.0.4 release notes (#6449)

* releases: add tidb 5.1.2 release notes (#6500)

* releases: add TiDB 5.1.2-10-06-33 release notes

* releases: add TiDB 5.1.2-10-06-33 release notes
* Update releases/release-5.1.2-10-06-33.md

* toc

* Apply suggestions from code review

Co-authored-by: Liuxiaozhen12 <82579298+Liuxiaozhen12@users.noreply.github.com>

* Update releases/release-5.1.2.md

* Update releases/release-5.1.2.md

* add notes from comments

* add more tidb notes

* Update releases/release-5.1.2.md

Co-authored-by: Yuanjia Zhang <qw4990@163.com>

* Apply suggestions from code review

* Apply suggestions from code review

Co-authored-by: Liuxiaozhen12 <82579298+Liuxiaozhen12@users.noreply.github.com>
Co-authored-by: Enwei <jinenwei@pingcap.com>
Co-authored-by: xixirangrang <35301108+hfxsd@users.noreply.github.com>

* Update releases/release-5.1.2.md

Co-authored-by: shichun-0415 <89768198+shichun-0415@users.noreply.github.com>

* Update releases/release-5.1.2.md

Co-authored-by: Yuanjia Zhang <qw4990@163.com>

* Apply suggestions from code review

Co-authored-by: Liuxiaozhen12 <82579298+Liuxiaozhen12@users.noreply.github.com>
Co-authored-by: shichun-0415 <89768198+shichun-0415@users.noreply.github.com>

* replace pr numbers with issue numbers

* Update releases/release-5.1.2.md

Co-authored-by: Liuxiaozhen12 <82579298+Liuxiaozhen12@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Liuxiaozhen12 <82579298+Liuxiaozhen12@users.noreply.github.com>
Co-authored-by: Enwei <jinenwei@pingcap.com>

* fix

* Update releases/release-5.1.2.md

* Update releases/release-5.1.2.md

* Apply suggestions from code review

* Update releases/release-5.1.2.md

* Update releases/release-5.1.2.md

Co-authored-by: Enwei <jinenwei@pingcap.com>

* Update releases/release-5.1.2.md

Co-authored-by: Grace Cai <qqzczy@126.com>

* Update releases/release-5.1.2.md

* Apply suggestions from code review

* Apply suggestions from code review

* Update releases/release-5.1.2.md

* Update releases/release-5.1.2.md

Co-authored-by: Enwei <jinenwei@pingcap.com>

* Update releases/release-5.1.2.md

Co-authored-by: shichun-0415 <89768198+shichun-0415@users.noreply.github.com>

* Update releases/release-5.1.2.md

* Update releases/release-5.1.2.md

* Apply suggestions from code review

* move notes

Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
Co-authored-by: Liuxiaozhen12 <82579298+Liuxiaozhen12@users.noreply.github.com>
Co-authored-by: Grace Cai <qqzczy@126.com>
Co-authored-by: Yuanjia Zhang <qw4990@163.com>
Co-authored-by: Enwei <jinenwei@pingcap.com>
Co-authored-by: xixirangrang <35301108+hfxsd@users.noreply.github.com>
Co-authored-by: shichun-0415 <89768198+shichun-0415@users.noreply.github.com>

* remove a note about `raftstore.sync-log` (#6563)

* Add desc of "Storage Write Stall" row in the TiFlash grafana (#6524)

* system variables: update tidb_enable_noop_functions behavior (#6525)

* system variables: document last_insert_id (#6502)

* docs: update pd-configuration about upgrade (#6510)

* fix example for expression index (#6499)

* tidb: fix default value of performance.committer-concurrency (#6498)

* chore: remove circleci config (#6577)

* Document missing sysvars (#6485)

* system-variables: add skip-name-resolve (#6491)

* Document a few more system variables (#6492)

* add dr auto sync (#6592)

* Update from master

Co-authored-by: Enwei <jinenwei@pingcap.com>
Co-authored-by: disksing <i@disksing.com>
Co-authored-by: Liuxiaozhen12 <82579298+Liuxiaozhen12@users.noreply.github.com>
Co-authored-by: Morgan Tocker <tocker@gmail.com>
Co-authored-by: Daniël van Eeden <git@myname.nl>
Co-authored-by: Grace Cai <qqzczy@126.com>
Co-authored-by: Ti Chi Robot <ti-community-prow-bot@tidb.io>
Co-authored-by: Mattias Jonsson <mjonss@users.noreply.github.com>
Co-authored-by: ti-srebot <66930949+ti-srebot@users.noreply.github.com>
Co-authored-by: glorv <glorvs@163.com>
Co-authored-by: Suhaha <jklopsdfw@gmail.com>
Co-authored-by: Ian <ArGregoryIan@gmail.com>
Co-authored-by: Yu Lei <leiysky@outlook.com>
Co-authored-by: Wenxuan <hi@breeswish.org>
Co-authored-by: zhouqiang <zhouqiang.cl@gmail.com>
Co-authored-by: xixirangrang <35301108+hfxsd@users.noreply.github.com>
Co-authored-by: Yini Xu <34967660+YiniXu9506@users.noreply.github.com>
Co-authored-by: WangZhengru <harryshaunwang@outlook.com>
Co-authored-by: Xintao <hunterlxt@live.com>
Co-authored-by: Daniël van Eeden <github@myname.nl>
Co-authored-by: Allen Zhong <zhongbenli@pingcap.com>
Co-authored-by: ruoxi <zanmato1984@gmail.com>
Co-authored-by: Yasuo Honda <yasuo.honda@gmail.com>
Co-authored-by: Yasuo Honda <yahonda@pingcap.com>
Co-authored-by: Defined2014 <mohangjie1995@gmail.com>
Co-authored-by: Ran <huangran@pingcap.com>
Co-authored-by: Chengpeng Yan <41809508+Reminiscent@users.noreply.github.com>
Co-authored-by: Yifan Xu <30385241+xuyifangreeneyes@users.noreply.github.com>
Co-authored-by: Weizhen Wang <wangweizhen@pingcap.com>
Co-authored-by: Ziqian Qin <ekexium@gmail.com>
Co-authored-by: shichun-0415 <89768198+shichun-0415@users.noreply.github.com>
Co-authored-by: you06 <you1474600@gmail.com>
Co-authored-by: Fendy <40378371+septemberfd@users.noreply.github.com>
Co-authored-by: Kolbe Kegel <kolbe@pingcap.com>
Co-authored-by: jirongq <719547995@qq.com>
Co-authored-by: Caitin <34535727+CaitinChen@users.noreply.github.com>
Co-authored-by: Yuanjia Zhang <qw4990@163.com>
Co-authored-by: JaySon <tshent@qq.com>
Co-authored-by: unconsolable <chenzhipeng2012@gmail.com>
TomShawn added a commit that referenced this pull request Oct 9, 2021
* Dumping default consistency description (#5985)

* update max-replicas description (#5984)

* Remove the swappiness parameter (#5987)

* system-variables: update for consistency (#5826)

* Change tidb_memory_usage_alarm_ratio scope to instance (#5988)

* Punctuation fix: Replace 。with . (#6002)

* index page: updated the phase of TiDB Cloud from Beta to Public Preview (#6014)

* Migration FAQs: added the FAQ links of the migration related tools (#6010)

* TiUP cluster: update data_dir (#6009)

* Add kafka downstream example (#6005)

* TiKV configuration: Update description for pin-l0-filter-and-index-blocks (#6008)

* Update the default value of tidb_stmt_summary_max_stmt_count (#6021) (#6023)

* update docs related to partition table dynamic mode (#5997)

* partitioning: Corrected partition management (#5498)

* TiDB binlog: update descriptions about commit ts and passoword (#5986)

* releases: add tidb 4.0.14 release notes (#5996)

* fix a typo for sync_diff_inspector (#6041)

* Update dashboard FAQ (#5895)

* update stale read doc for ga (#6047)

* configure-time-zone: mention `system_time_zone` (#6032)

* Update Security Compatibility with MySQL (#5921)

* correct document of using br backup and restore system tables (#6057)

* Add description about telemetry of builtin functions usage (#6028)

* Add TiDB Dashboard session docs (#6058)

* update br faq (#6060)

* releases: add TiDB 5.1.1 release notes (#6030)

* grafana-overview-dashboard: update the monitoring item for CPS (#6066)

* deploy-tidb-binlog: make the expression on deployment clearer (#6073)

* Add documentation on how to modify gcttl by tiup (#6071)

* remove useless variable (#6076)

* ticdc: add mysql sink user privilege (#6072)

* deleted roadmap.md (#6079)

* TiDB Monitoring Metrics: remove a line (#6081)

* TiDB configuration: add a security option `require-secure-transport` (#6080)

* chore: lock plugin versions (#6089)

* cdc: add compatibility notes for sort-dir (#6086)

* Add gc ttl (#6102) (#6103)

* 5.1.0 release notes: Fix link to telemetry docs (#6106)

* sql-statement-select: Add '...FOR UPDATE NOWAIT' (#6085)

* TiCDC: update a golang demo link (#6055)

* br/use-br-command-line-tool: supplement br note (#6000)

* pr_template: Provides tips for cherry-pick (#6042)

* pr_template: Provides tips for cherry-pick

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* TiDB monitoring: add table storage info status api (#6110)

* update doc for Oracle translate function (#6053)

* ticdc: add explicit_defaults_for_timestamp compatibility troubleshoot (#6115)

* Add print the bad sst files and related information for tikv-ctl (#6109)

* add a missing note (#6129)

* Add docs for auto-tls setting (#6125)

* TiFlash: remove outdated tune advise (#6133)

* TiDB lightning: remove default backend setting (#6132)

* tidb-scheduling: fix typo (#6140)

* Suggest Log Redaction when using TDE (#6147)

* Add infoschema.referential_constraints (#6139)

* Add steps to get lightning goroutine (#6001)

* tiup: fix dead links (#6153)

* Deleted description about not supporting some features. (#6157)

* high-concurrency-best-practices: fix the support info of follower read (#6161)

* Update function list pushed down to tiflash (#6165)

* The `log_dir` should be the log directory (#6168)

* Make IP address of Monitoring & Grafana for Minimal Topology consistent (#6178)

* tikv: add storage flow control doc (#6173)

* TiDB configuration: update the default value of `stmt_max_count` (#6172)

* ticdc-open-api: add ticdc open api doc (#6186)

* System variables: update `broadcast_join_threshold_count` and `broadc… (#6181)

* Update tikv-configuration-file.md (#6180)

* TiFlash configuration: update `io_rate_limit` (#6176)

* Add information of hashAgg for memory control (#6171)

* Update description on rule based index selection (#6160)

* add dr auto sync (#6182)

* update doc for SPM (#6146)

* docs: update rereject leader docs (#6183)

* SQL statement, system variables: update expression indexes (#6185)

* Updated sql-plan-management.md (#6184)

* Introduced 2 new variables (#6159)

* Fix broken link in error codes doc and support doc (#6196)

* docs: fix format for TiKV and PD configuration file template invalid. (#6197)

* docs: separate query statement and result in two text boxes. (#6204) (#6205)

* adopters: add zhihu case study (#6207)

* Added descriptions about slow node detection (#6174)

* pd-control: add new config of balance-hot-region-scheduler (#6148)

* add notice about scaling in pd node (#6099)

* add example for expression index (#6215)

* adopters: remove 404 links (#6214)

* ticdc: fix wording (#6231)

* Revert "System variables: update `broadcast_join_threshold_count` and `broadc…" (#6232)

* Update documents of lock view for sprint 4 (#6179)

* ticdc-open-api: correct some error (#6239)

* best practices: add timeout options for Java best practices (#6136)

* update PR template for v5.2 (#6166)

* chore: stop building temporary (#6252)

* fix typo for sql-plan-management.md (#6248)

* alert rules: update some descriptions (#6250)

* Quick start: update version and TiUP playground supports M1 silicon (#6149)

* fix typo: relaod -> reload (#6235)

* tiny fix on index selection (#6265)

* add commands to check tikv user (#5999)

* br: add restore to systables (#6004)

* br: add restore to systables

* Apply suggestions from code review

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

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

* statement summary: update statement summary doc (#6084)

* Require process privilege for dumpling (#6187)

* tiflash: Remove the description about expr_blacklist in use_tiflash.md (#6188)

* Add description about table name/alias specifying for read_from_storage hint (#6164)

* complex tidb binlog.yaml: add checkpoint info (#6216)

* TiKV configuration: remove redundant instructions (#6218)

* alert rules: remove some descriptions (#6223)

* Revert "add dr auto sync" (#6294)

* TiFlash Config: Add annotation (v5.2.0) (#6296)

* sql: improve kill's description (#6233)

* Add v5.2 TPCH report (#6170)

* docs: fix expression index's document again (#6295)

* system variables.md: add a warning message (#6298)

* sql-statement: Add ADMIN SHOW TELEMETRY (#6138)

* tiup: add notice about importing cluster (#6108)

* Bump version for v5.2.0 (#6191)

* add TiDB 5.2.0 release note (#6237)

* add two HTAP documents (#6206)

* benchmark: add v5.2 benchmark results (#6319)

* Fix title typo (#6324)

* release note: update feature description (#6325)

* adopters: add xiaomi (#6303)

* chore: migrate scripts to docs (#6338)

* credits: update links to the full list of code and docs contributors (#6111)

* TiUP: add instructions for offline mirror (#6137)

* tune tikv memory performance: remove description for sync-log (#6234)

* dashboard statement list: add a note to explain the blue bar and yellow line (#6189)

* release 5.1.0: add compatibility change for `tidb_enable_noop_functions` (#6222)

* modify configuration online: remove unsupported parameters (#6300)

* modify configuration online: change a name for consistency (#6301)

* Migrate from Aurora: update Aurora MySQL dumpling command (#6335)

* PD configuration file: add log level (#6302)

* TiDB Binlog config: update "syncer.to.checkpoint" info (#6340)

* update doc on wal-recovery-mode and use-direct-io-for-flush-and-compaction (#6163)

* Fix TOC display error (#6369)

* sql: fix the correctness problem about kill (#6377)

* change expressions related to statement summary tables (#6299)

* Update grafana-pd-dashboard.md (#6388)

* system variables: update description about `tidb_opt_prefer_range_scan` (#6389)

* Update alert rule for low space (#6376)

* chore: add dispatch back (#6404)

* Add description for TiKV Ready handled panel (#6375)

* TiKV config: fix wrong description about `compaction-readahead-size` (#6371)

* update transaction doc (#6158)

* BR FAQ: add a warning about multi br importing (#6263)

* Configuration Options: remove two TiDB's command options (#6370)

* system-variables: improve noop functions warning (#6374)

* add doc links to overview.md (#6422)

* chore: fix byte encode (#6428)

* performance_schema -> information_schema (#6418)

* chore: update ci scripts (#6429)

* Enhance TiDB login descriptions - EN (#6427)

* release-notes: add 5.2.1 release notes (#6438)

* basic features: add feature matrix (#6130)

* release note: add a check item for feedback-probability (#6405)

* Update system variables for correctness (#6224)

* encryption-at-rest: Update (#6152)

* basic-features: collapse charset and collations (#6452)

* system-variables: update from generated source (#6451)

* fix-enable-compaction-filter-in-tikv-configuration-file (#6403)

* Update the related variable description for CREATE INDEX (#6434)

* TiKV config: add 7 log-related congifurations (#6372)

* Configure placement rules: fix placement doc (#6450)

* adopters: add Pinterest (#6443)

* release-5.2.0: Add info about caching_sha2 (#6344)

* faq: add info for schema is changed error (#6453)

* Update enable-tls-between-clients-and-servers.md (#6493)

* adopters: remove Pinterest (#6501)

* Fix wrong wording in mysql-compatibility.md (#6511)

* adopters: add Huya Live (#6516)

* tidb-configuration-file: correct the default value of committer-concurrency (#6526)

* Tune TiKV: change the default value of `grpc-concurrency` (#6531)

* releases: add tidb 4.0.15 release notes (#6475)

* releases: add tidb 5.0.4 release notes (#6449)

* releases: add tidb 5.1.2 release notes (#6500)

* releases: add TiDB 5.1.2-10-06-33 release notes

* releases: add TiDB 5.1.2-10-06-33 release notes
* Update releases/release-5.1.2-10-06-33.md

* toc

* Apply suggestions from code review

Co-authored-by: Liuxiaozhen12 <82579298+Liuxiaozhen12@users.noreply.github.com>

* Update releases/release-5.1.2.md

* Update releases/release-5.1.2.md

* add notes from comments

* add more tidb notes

* Update releases/release-5.1.2.md

Co-authored-by: Yuanjia Zhang <qw4990@163.com>

* Apply suggestions from code review

* Apply suggestions from code review

Co-authored-by: Liuxiaozhen12 <82579298+Liuxiaozhen12@users.noreply.github.com>
Co-authored-by: Enwei <jinenwei@pingcap.com>
Co-authored-by: xixirangrang <35301108+hfxsd@users.noreply.github.com>

* Update releases/release-5.1.2.md

Co-authored-by: shichun-0415 <89768198+shichun-0415@users.noreply.github.com>

* Update releases/release-5.1.2.md

Co-authored-by: Yuanjia Zhang <qw4990@163.com>

* Apply suggestions from code review

Co-authored-by: Liuxiaozhen12 <82579298+Liuxiaozhen12@users.noreply.github.com>
Co-authored-by: shichun-0415 <89768198+shichun-0415@users.noreply.github.com>

* replace pr numbers with issue numbers

* Update releases/release-5.1.2.md

Co-authored-by: Liuxiaozhen12 <82579298+Liuxiaozhen12@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Liuxiaozhen12 <82579298+Liuxiaozhen12@users.noreply.github.com>
Co-authored-by: Enwei <jinenwei@pingcap.com>

* fix

* Update releases/release-5.1.2.md

* Update releases/release-5.1.2.md

* Apply suggestions from code review

* Update releases/release-5.1.2.md

* Update releases/release-5.1.2.md

Co-authored-by: Enwei <jinenwei@pingcap.com>

* Update releases/release-5.1.2.md

Co-authored-by: Grace Cai <qqzczy@126.com>

* Update releases/release-5.1.2.md

* Apply suggestions from code review

* Apply suggestions from code review

* Update releases/release-5.1.2.md

* Update releases/release-5.1.2.md

Co-authored-by: Enwei <jinenwei@pingcap.com>

* Update releases/release-5.1.2.md

Co-authored-by: shichun-0415 <89768198+shichun-0415@users.noreply.github.com>

* Update releases/release-5.1.2.md

* Update releases/release-5.1.2.md

* Apply suggestions from code review

* move notes

Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
Co-authored-by: Liuxiaozhen12 <82579298+Liuxiaozhen12@users.noreply.github.com>
Co-authored-by: Grace Cai <qqzczy@126.com>
Co-authored-by: Yuanjia Zhang <qw4990@163.com>
Co-authored-by: Enwei <jinenwei@pingcap.com>
Co-authored-by: xixirangrang <35301108+hfxsd@users.noreply.github.com>
Co-authored-by: shichun-0415 <89768198+shichun-0415@users.noreply.github.com>

* remove a note about `raftstore.sync-log` (#6563)

* Add desc of "Storage Write Stall" row in the TiFlash grafana (#6524)

* system variables: update tidb_enable_noop_functions behavior (#6525)

* system variables: document last_insert_id (#6502)

* docs: update pd-configuration about upgrade (#6510)

* fix example for expression index (#6499)

* tidb: fix default value of performance.committer-concurrency (#6498)

* chore: remove circleci config (#6577)

* Document missing sysvars (#6485)

* system-variables: add skip-name-resolve (#6491)

* Document a few more system variables (#6492)

* add dr auto sync (#6592)

* tiflash, metric: add alert for TiFlash down (#6590)

Co-authored-by: Enwei <jinenwei@pingcap.com>
Co-authored-by: disksing <i@disksing.com>
Co-authored-by: Liuxiaozhen12 <82579298+Liuxiaozhen12@users.noreply.github.com>
Co-authored-by: Morgan Tocker <tocker@gmail.com>
Co-authored-by: Daniël van Eeden <git@myname.nl>
Co-authored-by: Grace Cai <qqzczy@126.com>
Co-authored-by: Ti Chi Robot <ti-community-prow-bot@tidb.io>
Co-authored-by: Mattias Jonsson <mjonss@users.noreply.github.com>
Co-authored-by: ti-srebot <66930949+ti-srebot@users.noreply.github.com>
Co-authored-by: glorv <glorvs@163.com>
Co-authored-by: Suhaha <jklopsdfw@gmail.com>
Co-authored-by: Ian <ArGregoryIan@gmail.com>
Co-authored-by: Yu Lei <leiysky@outlook.com>
Co-authored-by: Wenxuan <hi@breeswish.org>
Co-authored-by: zhouqiang <zhouqiang.cl@gmail.com>
Co-authored-by: xixirangrang <35301108+hfxsd@users.noreply.github.com>
Co-authored-by: Yini Xu <34967660+YiniXu9506@users.noreply.github.com>
Co-authored-by: WangZhengru <harryshaunwang@outlook.com>
Co-authored-by: Xintao <hunterlxt@live.com>
Co-authored-by: Daniël van Eeden <github@myname.nl>
Co-authored-by: Allen Zhong <zhongbenli@pingcap.com>
Co-authored-by: ruoxi <zanmato1984@gmail.com>
Co-authored-by: Yasuo Honda <yasuo.honda@gmail.com>
Co-authored-by: Yasuo Honda <yahonda@pingcap.com>
Co-authored-by: Defined2014 <mohangjie1995@gmail.com>
Co-authored-by: Ran <huangran@pingcap.com>
Co-authored-by: Chengpeng Yan <41809508+Reminiscent@users.noreply.github.com>
Co-authored-by: Yifan Xu <30385241+xuyifangreeneyes@users.noreply.github.com>
Co-authored-by: Weizhen Wang <wangweizhen@pingcap.com>
Co-authored-by: Ziqian Qin <ekexium@gmail.com>
Co-authored-by: shichun-0415 <89768198+shichun-0415@users.noreply.github.com>
Co-authored-by: you06 <you1474600@gmail.com>
Co-authored-by: Fendy <40378371+septemberfd@users.noreply.github.com>
Co-authored-by: Kolbe Kegel <kolbe@pingcap.com>
Co-authored-by: jirongq <719547995@qq.com>
Co-authored-by: Caitin <34535727+CaitinChen@users.noreply.github.com>
Co-authored-by: Yuanjia Zhang <qw4990@163.com>
Co-authored-by: JaySon <tshent@qq.com>
Co-authored-by: unconsolable <chenzhipeng2012@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/sql-infra Indicates that the Issue or PR belongs to the area of sql-infra and sql-metadata. sig/docs Indicates that the Issue or PR belongs to the docs SIG. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. status/can-merge Indicates a PR has been approved by a committer. status/LGT2 Indicates that a PR has LGTM 2. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. type/enhancement The issue or PR belongs to an enhancement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants