This is an automated email from the ASF dual-hosted git repository.
jianglongtao pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/shardingsphere.git
The following commit(s) were added to refs/heads/master by this push:
new 8aa2ed1b7df Update `alter mask rule` DistSQL document (#23209)
8aa2ed1b7df is described below
commit 8aa2ed1b7df679c7da96f2d7f2c8fa0fcfacc0cd
Author: Zichao <[email protected]>
AuthorDate: Sat Dec 31 03:44:58 2022 +1300
Update `alter mask rule` DistSQL document (#23209)
* Update `alter mask rule` DistSQL document
* Update `alter mask rule` DistSQL document
---
.../encrypt/create-encrypt-rule.en.md | 2 +-
...create-mask-rule.cn.md => alter-mask-rule.cn.md} | 19 +++++++++----------
...create-mask-rule.en.md => alter-mask-rule.en.md} | 21 ++++++++++-----------
.../rdl/rule-definition/mask/create-mask-rule.cn.md | 6 +++---
.../rdl/rule-definition/mask/create-mask-rule.en.md | 4 ++--
5 files changed, 25 insertions(+), 27 deletions(-)
diff --git
a/docs/document/content/reference/distsql/syntax/rdl/rule-definition/encrypt/create-encrypt-rule.en.md
b/docs/document/content/reference/distsql/syntax/rdl/rule-definition/encrypt/create-encrypt-rule.en.md
index 5a2d560990c..18a19c45940 100644
---
a/docs/document/content/reference/distsql/syntax/rdl/rule-definition/encrypt/create-encrypt-rule.en.md
+++
b/docs/document/content/reference/distsql/syntax/rdl/rule-definition/encrypt/create-encrypt-rule.en.md
@@ -108,7 +108,7 @@ COLUMNS(
), QUERY_WITH_CIPHER_COLUMN=FALSE);
```
-### Reserved word
+### Reserved words
`CREATE`, `ENCRYPT`, `RULE`, `COLUMNS`, `NAME`, `CIPHER`, `PLAIN`,
`QUERY_WITH_CIPHER_COLUMN`, `TYPE`, `TRUE`, `FALSE`
diff --git
a/docs/document/content/reference/distsql/syntax/rdl/rule-definition/mask/create-mask-rule.cn.md
b/docs/document/content/reference/distsql/syntax/rdl/rule-definition/mask/alter-mask-rule.cn.md
similarity index 76%
copy from
docs/document/content/reference/distsql/syntax/rdl/rule-definition/mask/create-mask-rule.cn.md
copy to
docs/document/content/reference/distsql/syntax/rdl/rule-definition/mask/alter-mask-rule.cn.md
index 8de750d4784..3740ca850b8 100644
---
a/docs/document/content/reference/distsql/syntax/rdl/rule-definition/mask/create-mask-rule.cn.md
+++
b/docs/document/content/reference/distsql/syntax/rdl/rule-definition/mask/alter-mask-rule.cn.md
@@ -1,11 +1,11 @@
+++
-title = "CREATE MASK RULE"
-weight = 2
+title = "ALTER MASK RULE"
+weight = 3
+++
## 描述
-The `CREATE MASK RULE` 语法用于创建数据脱敏规则.
+The `ALTER MASK RULE` 语法用于修改数据脱敏规则.
### 语法定义
@@ -13,7 +13,7 @@ The `CREATE MASK RULE` 语法用于创建数据脱敏规则.
{{% tab name="语法" %}}
```sql
CreateEncryptRule ::=
- 'CREATE' 'MASK' 'RULE' maskRuleDefinition (',' maskRuleDefinition)*
+ 'ALTER' 'MASK' 'RULE' maskRuleDefinition (',' maskRuleDefinition)*
maskRuleDefinition ::=
ruleName '(' 'COLUMNS' '(' columnDefinition (',' columnDefinition)* ')' ')'
@@ -50,15 +50,14 @@ value ::=
### 补充说明
-- `maskAlgorithmType` 指定数据脱敏算法类型,请参考
[数据脱敏算法](/cn/user-manual/common-config/builtin-algorithm/mask/);
-- 重复的 `ruleName` 将无法被创建;
+- `maskAlgorithmType` 指定数据脱敏算法类型,请参考
[数据脱敏算法](/cn/user-manual/common-config/builtin-algorithm/mask/)。
### 示例
-#### 创建数据脱敏规则
+#### 修改数据脱敏规则
```sql
-CREATE MASK RULE t_mask (
+ALTER MASK RULE t_mask (
COLUMNS(
(NAME=phone_number,TYPE(NAME='MASK_FROM_X_TO_Y', PROPERTIES("from-x"=1,
"to-y"=2, "replace-char"="*"))),
(NAME=address,TYPE(NAME='MD5'))
@@ -67,9 +66,9 @@ COLUMNS(
### 保留字
-`CREATE`、`MASK`、`RULE`、`COLUMNS`、`NAME`、`TYPE`
+`ALTER`、`MASK`、`RULE`、`COLUMNS`、`NAME`、`TYPE`
-### Related links
+### 相关链接
- [保留字](/cn/reference/distsql/syntax/reserved-word/)
- [数据脱敏算法](/cn/user-manual/common-config/builtin-algorithm/mask/)
\ No newline at end of file
diff --git
a/docs/document/content/reference/distsql/syntax/rdl/rule-definition/mask/create-mask-rule.en.md
b/docs/document/content/reference/distsql/syntax/rdl/rule-definition/mask/alter-mask-rule.en.md
similarity index 76%
copy from
docs/document/content/reference/distsql/syntax/rdl/rule-definition/mask/create-mask-rule.en.md
copy to
docs/document/content/reference/distsql/syntax/rdl/rule-definition/mask/alter-mask-rule.en.md
index 84f172e73bb..2c200eb50e6 100644
---
a/docs/document/content/reference/distsql/syntax/rdl/rule-definition/mask/create-mask-rule.en.md
+++
b/docs/document/content/reference/distsql/syntax/rdl/rule-definition/mask/alter-mask-rule.en.md
@@ -1,19 +1,19 @@
+++
-title = "CREATE MASK RULE"
-weight = 2
+title = "ALTER MASK RULE"
+weight = 3
+++
## Description
-The `CREATE MASK RULE` syntax is used to create a mask rule.
+The `ALTER MASK RULE` syntax is used to create a mask rule.
### Syntax
{{< tabs >}}
{{% tab name="Grammar" %}}
```sql
-CreateEncryptRule ::=
- 'CREATE' 'MASK' 'RULE' maskRuleDefinition (',' maskRuleDefinition)*
+AlterEncryptRule ::=
+ 'ALTER' 'MASK' 'RULE' maskRuleDefinition (',' maskRuleDefinition)*
maskRuleDefinition ::=
ruleName '(' 'COLUMNS' '(' columnDefinition (',' columnDefinition)* ')' ')'
@@ -50,24 +50,23 @@ value ::=
### Supplement
-- `maskAlgorithmType` specifies the data masking algorithm type, please refer
to [Data Masking
Algorithm](/en/user-manual/common-config/builtin-algorithm/mask/);
-- Duplicate `ruleName` will not be created;
+- `maskAlgorithmType` specifies the data masking algorithm type, please refer
to [Data Masking
Algorithm](/en/user-manual/common-config/builtin-algorithm/mask/).
### Example
-#### Create a mask rule
+#### Alter a mask rule
```sql
-CREATE MASK RULE t_mask (
+ALTER MASK RULE t_mask (
COLUMNS(
(NAME=phone_number,TYPE(NAME='MASK_FROM_X_TO_Y', PROPERTIES("from-x"=1,
"to-y"=2, "replace-char"="*"))),
(NAME=address,TYPE(NAME='MD5'))
));
```
-### Reserved word
+### Reserved words
-`CREATE`, `MASK`, `RULE`, `COLUMNS`, `NAME`, `TYPE`
+`ALTER`, `MASK`, `RULE`, `COLUMNS`, `NAME`, `TYPE`
### Related links
diff --git
a/docs/document/content/reference/distsql/syntax/rdl/rule-definition/mask/create-mask-rule.cn.md
b/docs/document/content/reference/distsql/syntax/rdl/rule-definition/mask/create-mask-rule.cn.md
index 8de750d4784..9e07a8288c7 100644
---
a/docs/document/content/reference/distsql/syntax/rdl/rule-definition/mask/create-mask-rule.cn.md
+++
b/docs/document/content/reference/distsql/syntax/rdl/rule-definition/mask/create-mask-rule.cn.md
@@ -50,8 +50,8 @@ value ::=
### 补充说明
-- `maskAlgorithmType` 指定数据脱敏算法类型,请参考
[数据脱敏算法](/cn/user-manual/common-config/builtin-algorithm/mask/);
-- 重复的 `ruleName` 将无法被创建;
+- `maskAlgorithmType` 指定数据脱敏算法类型,请参考
[数据脱敏算法](/cn/user-manual/common-config/builtin-algorithm/mask/);
+- 重复的 `ruleName` 将无法被创建。
### 示例
@@ -69,7 +69,7 @@ COLUMNS(
`CREATE`、`MASK`、`RULE`、`COLUMNS`、`NAME`、`TYPE`
-### Related links
+### 相关链接
- [保留字](/cn/reference/distsql/syntax/reserved-word/)
- [数据脱敏算法](/cn/user-manual/common-config/builtin-algorithm/mask/)
\ No newline at end of file
diff --git
a/docs/document/content/reference/distsql/syntax/rdl/rule-definition/mask/create-mask-rule.en.md
b/docs/document/content/reference/distsql/syntax/rdl/rule-definition/mask/create-mask-rule.en.md
index 84f172e73bb..811b3f3a315 100644
---
a/docs/document/content/reference/distsql/syntax/rdl/rule-definition/mask/create-mask-rule.en.md
+++
b/docs/document/content/reference/distsql/syntax/rdl/rule-definition/mask/create-mask-rule.en.md
@@ -51,7 +51,7 @@ value ::=
### Supplement
- `maskAlgorithmType` specifies the data masking algorithm type, please refer
to [Data Masking
Algorithm](/en/user-manual/common-config/builtin-algorithm/mask/);
-- Duplicate `ruleName` will not be created;
+- Duplicate `ruleName` will not be created.
### Example
@@ -65,7 +65,7 @@ COLUMNS(
));
```
-### Reserved word
+### Reserved words
`CREATE`, `MASK`, `RULE`, `COLUMNS`, `NAME`, `TYPE`