*: refine placement documents #7885

xhebox · 2022-03-18T07:25:41Z

First-time contributors' checklist

I've signed Contributor License Agreement that's required for repo owners to accept my contribution.

What is changed, added or deleted? (Required)

Address remove direct placement docs-cn#8230 (comment), rename PLACEMENT_RULES table.
Address remove direct placement docs-cn#8230 (comment), restructure syntax tree
Remove VOTERS as the implementation
Refines on the introduction page, changes are marked out

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.

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 · 2022-03-18T07:25:42Z

[REVIEW NOTIFICATION]

This pull request has been approved by:

TomShawn
morgo

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.

xhebox · 2022-03-18T07:26:12Z

sql-statements/sql-statement-alter-placement-policy.md


 `ALTER PLACEMENT POLICY` _replaces_ the previous policy with the new definition. It does not _merge_ the old policy with the new one. In the following example, `FOLLOWERS=4` is lost when the `ALTER PLACEMENT POLICY` is executed:

-```sql


Moved to Examples section

xhebox · 2022-03-18T07:26:58Z

placement-rules-in-sql.md

+It is also possible to alter placement policies by [`ALTER PLACEMENT POLICY`](/sql-statements/sql-statement-alter-placement-policy.md), and the changes will propagate to all objects with the corresponding policy.
+
+```sql
+ALTER PLACEMENT POLICY myplacementpolicy FOLLOWERS=5;
+```
+
+Finally, you can use [`DROP PLACEMENT POLICY`](/sql-statements/sql-statement-drop-placement-policy.md) to drop policies that are not attached to any table or partition:
+
+```sql
+DROP PLACEMENT POLICY myplacementpolicy;
+```


Additional entry for ALTER and DROP.

placement-rules-in-sql.md

xhebox · 2022-03-18T07:27:33Z

placement-rules-in-sql.md

@@ -99,8 +131,12 @@ In addition to the placement options above, you can also use the advance configu

 | Option Name                | Description                                                                                    |
 | --------------| ------------ |
-| `CONSTRAINTS`              | A list of constraints that apply to all roles. For example, `CONSTRAINTS="[+disk=ssd]`.        |
-| `FOLLOWER_CONSTRAINTS`     | A list of constraints that only apply to followers.                                            |
+| `CONSTRAINTS`              | A list of constraints that apply to all roles. For example, `CONSTRAINTS="[+disk=ssd]`.       |


Complete list of advanced constraints

placement-rules-in-sql.md

xhebox · 2022-03-18T07:28:40Z

placement-rules-in-sql.md

@@ -174,7 +214,7 @@ CREATE TABLE t4 (a INT);  -- Creates a table t4 with the default policy p3.
 ALTER PLACEMENT POLICY p3 FOLLOWERS=3; -- The table with policy p3 (t4) will have FOLLOWERS=3.
 ```

-You can use [`ALTER PLACEMENT POLICY`](/sql-statements/sql-statement-alter-placement-policy.md) to change a policy, and the changes will propagate to all objects with the corresponding policy.
+Note that this is different from inheritance between partitions and tables, where changing policy of tables will effect their partitions. Tables only inherit the policy of schema when it is created without attaching policies.


Move ALTER in the above section, and clarify inheritance between partition/table, table/schema

TomShawn · 2022-03-21T03:23:03Z

/rebase

Signed-off-by: xhe <[email protected]>

information-schema/information-schema-placement-policies.md

Co-authored-by: Ran <[email protected]>

Signed-off-by: xhe <[email protected]>

TomShawn

Mostly minor edits in line

br/backup-and-restore-tool.md

information-schema/information-schema-placement-policies.md

information-schema/information-schema.md

sql-statements/sql-statement-alter-placement-policy.md

system-variables.md

Co-authored-by: TomShawn <[email protected]>

Signed-off-by: xhe <[email protected]>

TomShawn

LGTM

TomShawn · 2022-03-23T08:10:49Z

/merge

ti-chi-bot · 2022-03-23T08:10:52Z

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

Commit hash: 8b7d130

xhebox requested review from morgo and TomShawn March 18, 2022 07:25

ti-chi-bot added missing-translation-status This PR does not have translation status info. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Mar 18, 2022

xhebox commented Mar 18, 2022

View reviewed changes

placement-rules-in-sql.md Outdated Show resolved Hide resolved

xhebox commented Mar 18, 2022

View reviewed changes

placement-rules-in-sql.md Outdated Show resolved Hide resolved

xhebox commented Mar 18, 2022

View reviewed changes

This was referenced Mar 18, 2022

remove direct placement pingcap/docs-cn#8230

Merged

*: refine placement pingcap/docs-cn#8706

Merged

shichun-0415 assigned xhebox and TomShawn Mar 18, 2022

morgo approved these changes Mar 18, 2022

View reviewed changes

ti-chi-bot added the status/LGT1 Indicates that a PR has LGTM 1. label Mar 18, 2022

TomShawn added the v6.0 This PR/issue applies to TiDB v6.0. label Mar 21, 2022

xhebox added 7 commits March 21, 2022 03:23

*: refine placement documents

26ee595

Signed-off-by: xhe <[email protected]>

*: reword

2d2b7be

Signed-off-by: xhe <[email protected]>

*: improve words, update compatibility

3ca9d53

Signed-off-by: xhe <[email protected]>

address comments

5ff6550

Signed-off-by: xhe <[email protected]>

fix lint

c7ad1bf

Signed-off-by: xhe <[email protected]>

sync with cn doc

77bf050

Signed-off-by: xhe <[email protected]>

sync with cn

838a4e3

Signed-off-by: xhe <[email protected]>

ran-huang reviewed Mar 21, 2022

View reviewed changes

information-schema/information-schema-placement-policies.md Outdated Show resolved Hide resolved

xhebox and others added 6 commits March 21, 2022 17:51

Update information-schema/information-schema-placement-policies.md

fd947f3

Co-authored-by: Ran <[email protected]>

variable update

29816fa

Signed-off-by: xhe <[email protected]>

compatibility refine

f68dc3c

Signed-off-by: xhe <[email protected]>

fix CI

a96eabd

Signed-off-by: xhe <[email protected]>

sync with cn

44001ab

Signed-off-by: xhe <[email protected]>

remove enable_alter

54ba1b1

Signed-off-by: xhe <[email protected]>

TomShawn reviewed Mar 23, 2022

View reviewed changes

xhebox and others added 6 commits March 23, 2022 15:25

Update system-variables.md

275079f

Co-authored-by: TomShawn <[email protected]>

Apply suggestions from code review

b7a9a7c

Co-authored-by: TomShawn <[email protected]>

Update system-variables.md

327dbbc

Co-authored-by: TomShawn <[email protected]>

Update sql-statements/sql-statement-alter-placement-policy.md

1958aae

Co-authored-by: TomShawn <[email protected]>

Update system-variables.md

9980a6b

Co-authored-by: TomShawn <[email protected]>

reword

8b7d130

Signed-off-by: xhe <[email protected]>

TomShawn approved these changes Mar 23, 2022

View reviewed changes

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 Mar 23, 2022

ti-chi-bot added the status/can-merge Indicates a PR has been approved by a committer. label Mar 23, 2022

TomShawn added the type/compatibility-or-feature-change This PR involves compatibility changes or feature behavior changes. label Mar 23, 2022

TomShawn merged commit 91fe4b0 into pingcap:master Mar 23, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

*: refine placement documents #7885

*: refine placement documents #7885

xhebox commented Mar 18, 2022 •

edited

Loading

ti-chi-bot commented Mar 18, 2022 •

edited

Loading

xhebox Mar 18, 2022

xhebox Mar 18, 2022

xhebox Mar 18, 2022

xhebox Mar 18, 2022

TomShawn commented Mar 21, 2022

TomShawn left a comment

TomShawn left a comment

TomShawn commented Mar 23, 2022

ti-chi-bot commented Mar 23, 2022


		`ALTER PLACEMENT POLICY` _replaces_ the previous policy with the new definition. It does not _merge_ the old policy with the new one. In the following example, `FOLLOWERS=4` is lost when the `ALTER PLACEMENT POLICY` is executed:

		```sql

*: refine placement documents #7885

*: refine placement documents #7885

Conversation

xhebox commented Mar 18, 2022 • edited Loading

First-time contributors' checklist

What is changed, added or deleted? (Required)

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

What is the related PR or file link(s)?

Do your changes match any of the following descriptions?

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

xhebox Mar 18, 2022

Choose a reason for hiding this comment

xhebox Mar 18, 2022

Choose a reason for hiding this comment

xhebox Mar 18, 2022

Choose a reason for hiding this comment

xhebox Mar 18, 2022

Choose a reason for hiding this comment

TomShawn commented Mar 21, 2022

TomShawn left a comment

Choose a reason for hiding this comment

TomShawn left a comment

Choose a reason for hiding this comment

TomShawn commented Mar 23, 2022

ti-chi-bot commented Mar 23, 2022

xhebox commented Mar 18, 2022 •

edited

Loading

ti-chi-bot commented Mar 18, 2022 •

edited

Loading