You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by ji...@apache.org on 2022/12/31 04:26:32 UTC
[shardingsphere] branch master updated: Update `show mask rule` DistSQL document (#23211)
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 79ef9840b0c Update `show mask rule` DistSQL document (#23211)
79ef9840b0c is described below
commit 79ef9840b0c2d6e1dcc5ecf2db30b48456ca6f49
Author: Zichao <57...@users.noreply.github.com>
AuthorDate: Sat Dec 31 17:26:24 2022 +1300
Update `show mask rule` DistSQL document (#23211)
* Update `show mask rule` DistSQL document
* Update `show mask rule` DistSQL document
---
.../rdl/rule-definition/mask/alter-mask-rule.cn.md | 2 +-
.../syntax/rql/rule-query/mask/_index.cn.md | 7 ++
.../syntax/rql/rule-query/mask/_index.en.md | 7 ++
.../rql/rule-query/mask/show-mask-rule.cn.md | 124 ++++++++++++++++++++
.../rql/rule-query/mask/show-mask-rule.en.md | 126 +++++++++++++++++++++
5 files changed, 265 insertions(+), 1 deletion(-)
diff --git a/docs/document/content/reference/distsql/syntax/rdl/rule-definition/mask/alter-mask-rule.cn.md b/docs/document/content/reference/distsql/syntax/rdl/rule-definition/mask/alter-mask-rule.cn.md
index 3740ca850b8..ce92e88f1a3 100644
--- a/docs/document/content/reference/distsql/syntax/rdl/rule-definition/mask/alter-mask-rule.cn.md
+++ b/docs/document/content/reference/distsql/syntax/rdl/rule-definition/mask/alter-mask-rule.cn.md
@@ -5,7 +5,7 @@ weight = 3
## 描述
-The `ALTER MASK RULE` 语法用于修改数据脱敏规则.
+`ALTER MASK RULE` 语法用于修改数据脱敏规则.
### 语法定义
diff --git a/docs/document/content/reference/distsql/syntax/rql/rule-query/mask/_index.cn.md b/docs/document/content/reference/distsql/syntax/rql/rule-query/mask/_index.cn.md
new file mode 100644
index 00000000000..f49517ab8d3
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/rql/rule-query/mask/_index.cn.md
@@ -0,0 +1,7 @@
++++
+title = "数据脱敏"
+weight = 1
+chapter = true
++++
+
+本章节将对数据脱敏的语法进行详细说明。
diff --git a/docs/document/content/reference/distsql/syntax/rql/rule-query/mask/_index.en.md b/docs/document/content/reference/distsql/syntax/rql/rule-query/mask/_index.en.md
new file mode 100644
index 00000000000..474d428955c
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/rql/rule-query/mask/_index.en.md
@@ -0,0 +1,7 @@
++++
+title = "Mask"
+weight = 1
+chapter = true
++++
+
+This chapter describes the syntax of mask.
diff --git a/docs/document/content/reference/distsql/syntax/rql/rule-query/mask/show-mask-rule.cn.md b/docs/document/content/reference/distsql/syntax/rql/rule-query/mask/show-mask-rule.cn.md
new file mode 100644
index 00000000000..7e657cff65b
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/rql/rule-query/mask/show-mask-rule.cn.md
@@ -0,0 +1,124 @@
++++
+title = "SHOW MASK RULES"
+weight = 2
++++
+
+### 描述
+
+`SHOW MASK RULES` 语法用于查询指定逻辑库中的数据脱敏规则。
+
+### 语法
+
+{{< tabs >}}
+{{% tab name="语法" %}}
+```sql
+ShowMaskRule::=
+ 'SHOW' 'MASK' ('RULES' | 'RULE' ruleName) ('FROM' databaseName)?
+
+ruleName ::=
+ identifier
+
+databaseName ::=
+ identifier
+```
+{{% /tab %}}
+{{% tab name="铁路图" %}}
+<iframe frameborder="0" name="diagram" id="diagram" width="100%" height="100%"></iframe>
+{{% /tab %}}
+{{< /tabs >}}
+
+### 补充说明
+
+- 未指定 `databaseName` 时，默认是当前使用的 `DATABASE`， 如果也未使用 `DATABASE` 则会提示 `No database selected`。
+
+### 返回值说明
+
+| 列 | 说明 |
+|--------------------------| ------------------ |
+| table | 表名 |
+| column | 列名 |
+| algorithm_type | 数据脱敏算法类型 |
+| algorithm_props | 数据脱敏算法参数 |
+
+### 示例
+
+- 查询指定逻辑库中的所有数据脱敏规则
+
+```sql
+SHOW MASK RULES FROM mask_db;
+```
+
+```sql
+mysql> SHOW MASK RULES FROM mask_db;
++---------+----------+------------------+--------------------------------+
+| table | column | algorithm_type | algorithm_props |
++---------+----------+------------------+--------------------------------+
+| t_mask | phoneNum | MASK_FROM_X_TO_Y | to-y=2,replace-char=*,from-x=1 |
+| t_mask | address | MD5 | |
+| t_order | order_id | MD5 | |
+| t_user | user_id | MASK_FROM_X_TO_Y | to-y=2,replace-char=*,from-x=1 |
++---------+----------+------------------+--------------------------------+
+4 rows in set (0.01 sec)
+```
+
+- 查询当前逻辑库中的所有数据脱敏规则
+
+```sql
+SHOW MASK RULES;
+```
+
+```sql
+mysql> SHOW MASK RULES;
++---------+----------+------------------+--------------------------------+
+| table | column | algorithm_type | algorithm_props |
++---------+----------+------------------+--------------------------------+
+| t_mask | phoneNum | MASK_FROM_X_TO_Y | to-y=2,replace-char=*,from-x=1 |
+| t_mask | address | MD5 | |
+| t_order | order_id | MD5 | |
+| t_user | user_id | MASK_FROM_X_TO_Y | to-y=2,replace-char=*,from-x=1 |
++---------+----------+------------------+--------------------------------+
+4 rows in set (0.01 sec)
+```
+
+- 查询指定逻辑库中的指定数据脱敏算法
+
+```sql
+SHOW MASK RULE t_mask FROM mask_db;
+```
+
+```sql
+mysql> SHOW MASK RULE t_mask FROM mask_db;
++--------+--------------+------------------+--------------------------------+
+| table | logic_column | mask_algorithm | props |
++--------+--------------+------------------+--------------------------------+
+| t_mask | phoneNum | MASK_FROM_X_TO_Y | to-y=2,replace-char=*,from-x=1 |
+| t_mask | address | MD5 | |
++--------+--------------+------------------+--------------------------------+
+2 rows in set (0.00 sec)
+```
+
+- 查询当前逻辑库中的指定数据脱敏算法
+
+```sql
+SHOW MASK RULE t_mask;
+```
+
+```sql
+mysql> SHOW MASK RULE t_mask;
++--------+--------------+------------------+--------------------------------+
+| table | logic_column | mask_algorithm | props |
++--------+--------------+------------------+--------------------------------+
+| t_mask | phoneNum | MASK_FROM_X_TO_Y | to-y=2,replace-char=*,from-x=1 |
+| t_mask | address | MD5 | |
++--------+--------------+------------------+--------------------------------+
+2 rows in set (0.00 sec)
+```
+
+### 保留字
+
+`SHOW`、`MASK`、`RULE`、`RULES`、`FROM`
+
+### 相关链接
+
+- [保留字](/cn/reference/distsql/syntax/reserved-word/)
+
diff --git a/docs/document/content/reference/distsql/syntax/rql/rule-query/mask/show-mask-rule.en.md b/docs/document/content/reference/distsql/syntax/rql/rule-query/mask/show-mask-rule.en.md
new file mode 100644
index 00000000000..3bbc9df11b8
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/rql/rule-query/mask/show-mask-rule.en.md
@@ -0,0 +1,126 @@
++++
+title = "SHOW MASK RULES"
+weight = 2
++++
+
+### Description
+
+The `SHOW MASK RULES` syntax is used to query mask rules for specified database.
+
+### Syntax
+
+{{< tabs >}}
+{{% tab name="Grammar" %}}
+```sql
+ShowMaskRule::=
+ 'SHOW' 'MASK' ('RULES' | 'RULE' ruleName) ('FROM' databaseName)?
+
+ruleName ::=
+ identifier
+
+databaseName ::=
+ identifier
+```
+{{% /tab %}}
+{{% tab name="Railroad diagram" %}}
+<iframe frameborder="0" name="diagram" id="diagram" width="100%" height="100%"></iframe>
+{{% /tab %}}
+{{< /tabs >}}
+
+### Supplement
+
+- When `databaseName` is not specified, the default is the currently used `DATABASE`. If `DATABASE` is not used, `No database selected` will be prompted.
+
+### Return value description
+
+| Column | Description |
+| ------------------------- |-------------------------------|
+| table | Table name |
+| column | Column name |
+| algorithm_type | Mask algorithm type |
+| algorithm_props | Mask algorithm properties |
+
+
+
+
+### Example
+
+- Query mask rules for specified database
+
+```sql
+SHOW MASK RULES FROM mask_db;
+```
+
+```sql
+mysql> SHOW MASK RULES FROM mask_db;
++---------+----------+------------------+--------------------------------+
+| table | column | algorithm_type | algorithm_props |
++---------+----------+------------------+--------------------------------+
+| t_mask | phoneNum | MASK_FROM_X_TO_Y | to-y=2,replace-char=*,from-x=1 |
+| t_mask | address | MD5 | |
+| t_order | order_id | MD5 | |
+| t_user | user_id | MASK_FROM_X_TO_Y | to-y=2,replace-char=*,from-x=1 |
++---------+----------+------------------+--------------------------------+
+4 rows in set (0.01 sec)
+```
+
+- Query mask rules for current database
+
+```sql
+SHOW MASK RULES;
+```
+
+```sql
+mysql> SHOW MASK RULES;
++---------+----------+------------------+--------------------------------+
+| table | column | algorithm_type | algorithm_props |
++---------+----------+------------------+--------------------------------+
+| t_mask | phoneNum | MASK_FROM_X_TO_Y | to-y=2,replace-char=*,from-x=1 |
+| t_mask | address | MD5 | |
+| t_order | order_id | MD5 | |
+| t_user | user_id | MASK_FROM_X_TO_Y | to-y=2,replace-char=*,from-x=1 |
++---------+----------+------------------+--------------------------------+
+4 rows in set (0.01 sec)
+```
+
+- Query specified mask rule for specified database
+
+```sql
+SHOW MASK RULE t_mask FROM mask_db;
+```
+
+```sql
+mysql> SHOW MASK RULE t_mask FROM mask_db;
++--------+--------------+------------------+--------------------------------+
+| table | logic_column | mask_algorithm | props |
++--------+--------------+------------------+--------------------------------+
+| t_mask | phoneNum | MASK_FROM_X_TO_Y | to-y=2,replace-char=*,from-x=1 |
+| t_mask | address | MD5 | |
++--------+--------------+------------------+--------------------------------+
+2 rows in set (0.00 sec)
+```
+
+- Query specified mask rule for current database
+
+```sql
+SHOW MASK RULE t_mask;
+```
+
+```sql
+mysql> SHOW MASK RULE t_mask;
++--------+--------------+------------------+--------------------------------+
+| table | logic_column | mask_algorithm | props |
++--------+--------------+------------------+--------------------------------+
+| t_mask | phoneNum | MASK_FROM_X_TO_Y | to-y=2,replace-char=*,from-x=1 |
+| t_mask | address | MD5 | |
++--------+--------------+------------------+--------------------------------+
+2 rows in set (0.00 sec)
+```
+
+### Reserved word
+
+`SHOW`, `MASK`, `RULE`, `RULES`, `FROM`
+
+### Related links
+
+- [Reserved word](/en/reference/distsql/syntax/reserved-word/)