docs-cn icon indicating copy to clipboard operation
docs-cn copied to clipboard

Optimize placement rules in sql

Open Icemap opened this issue 2 years ago • 8 comments

First-time contributors' checklist

What is changed, added or deleted? (Required)

重构整篇 Placement Rules in SQL 文档,用户反馈结构较乱。

  1. 规范用词:

    • 同义的 参数选项,统一为 参数
    • 同义的 放置规则放置策略,统一为 放置规则 (与 configure-placement-rules.md 保持一致)
    • 其他不严谨的用词
  2. 更改结构:

    • 绑定放置规则 中,创建、更新、删除 放置规则的部分单独成章。
    • 高级参数 中,不应放在 示例 下的部分,转为在 放置规则参数参考 一章中描述。
  3. 参数解释:

    • 添加了参数的解释,如 SCHEDULE 中的 EVEN/ MAJORITY_IN_PRIMARY 原本无任何解释,SQL 参数亦无。需要相关技术审核,以防出现谬误。
    • 更改了 PRIMARY_REGION / REGIONS 中较晦涩的句法。

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 (in Chinese).

  • [ ] master (the latest development version)
  • [ ] v6.2 (TiDB 6.2 versions)
  • [ ] v6.1 (TiDB 6.1 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)

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

Icemap avatar Jul 29 '22 13:07 Icemap

[REVIEW NOTIFICATION]

This pull request has not been approved.

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.

ti-chi-bot avatar Jul 29 '22 13:07 ti-chi-bot

@TomShawn 有几点建议,PTAL.

格式:有几处加粗斜体显示不对,建议修正 typo:查询表已绑定放置规则名称, myplacementpolicy 应为 my_policy 其他:工具兼容性, “BR 兼容性” 的页面,并没有“放置规则”相关说明 易用:建议将create table的示例中加入drop table if exists t1;,不然将示例中的语句复制出来测试时还需要再手动删一次表。 补充:建议补充【重置库、表绑定的放置规则】章节,

ALTER DATABASE test PLACEMENT POLICY default;
ALTER TABLE t1 PLACEMENT POLICY default;

shawn0915 avatar Aug 05 '22 02:08 shawn0915

@Icemap: PR needs rebase.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

ti-chi-bot avatar Nov 11 '22 09:11 ti-chi-bot

Removed the needs-cherry-pick-release-6.3 label because the v6.3 docs have been archived at https://docs-archive.pingcap.com/zh/tidb/v6.3 and will no longer receive new updates.

qiancai avatar Feb 24 '23 11:02 qiancai

Removed the needs-cherry-pick-release-6.4 label because the v6.4 docs have been archived at https://docs-archive.pingcap.com/zh/tidb/v6.4 and will no longer receive new updates.

qiancai avatar Apr 06 '23 07:04 qiancai

Removed the needs-cherry-pick-release-6.6 label because the v6.6 docs have been archived at https://docs-archive.pingcap.com/zh/tidb/v6.6 and will no longer receive new updates.

qiancai avatar Jul 07 '23 06:07 qiancai

Removed the needs-cherry-pick-release-7.2 label because the v7.2 docs have been archived at https://docs-archive.pingcap.com/zh/tidb/v7.2 and will no longer receive new updates.

qiancai avatar Oct 20 '23 07:10 qiancai

@Icemap: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
pull-verify dc43e54b8f63983649849128bfeb9a52a3c3427b link true /test pull-verify

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

ti-chi-bot[bot] avatar Jan 26 '24 10:01 ti-chi-bot[bot]