This is an automated email from the ASF dual-hosted git repository.
duanzhengqiang 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 4d32b087fb3 Replace shadow SIMPLE HINT to SQL HINT for doc. (#24036)
4d32b087fb3 is described below
commit 4d32b087fb3a9c41d866b13b4939b9f55b8edb69
Author: Chuxin Chen <[email protected]>
AuthorDate: Tue Feb 7 10:54:02 2023 +0800
Replace shadow SIMPLE HINT to SQL HINT for doc. (#24036)
---
docs/document/content/dev-manual/shadow.cn.md | 10 +++++-----
docs/document/content/dev-manual/shadow.en.md | 4 ++--
.../user-manual/common-config/builtin-algorithm/shadow.cn.md | 11 +++++------
.../user-manual/common-config/builtin-algorithm/shadow.en.md | 11 +++++------
.../shardingsphere-jdbc/yaml-config/rules/shadow.cn.md | 8 +++-----
.../shardingsphere-jdbc/yaml-config/rules/shadow.en.md | 8 +++-----
.../shadow/alter-default-shadow-algorithm.cn.md | 4 ++--
.../shadow/alter-default-shadow-algorithm.en.md | 4 ++--
.../syntax/rdl/rule-definition/shadow/alter-shadow-rule.cn.md | 4 ++--
.../syntax/rdl/rule-definition/shadow/alter-shadow-rule.en.md | 4 ++--
.../shadow/create-default-shadow-algorithm.cn.md | 6 +++---
.../shadow/create-default-shadow-algorithm.en.md | 6 +++---
.../rdl/rule-definition/shadow/create-shadow-rule.cn.md | 6 +++---
.../rdl/rule-definition/shadow/create-shadow-rule.en.md | 6 +++---
.../rdl/rule-definition/shadow/drop-shadow-algorithm.cn.md | 6 +++---
.../rdl/rule-definition/shadow/drop-shadow-algorithm.en.md | 6 +++---
.../syntax/rql/rule-query/shadow/show-shadow-table-rule.cn.md | 4 ++--
.../syntax/rql/rule-query/shadow/show-shadow-table-rule.en.md | 4 ++--
.../shardingsphere-proxy/distsql/usage/shadow-rule.cn.md | 6 +++---
.../shardingsphere-proxy/distsql/usage/shadow-rule.en.md | 6 +++---
20 files changed, 59 insertions(+), 65 deletions(-)
diff --git a/docs/document/content/dev-manual/shadow.cn.md
b/docs/document/content/dev-manual/shadow.cn.md
index 3c322b49463..7bfca9ba420 100644
--- a/docs/document/content/dev-manual/shadow.cn.md
+++ b/docs/document/content/dev-manual/shadow.cn.md
@@ -17,8 +17,8 @@ chapter = true
### 已知实现
-| *已知实现类* | *详细说明* | *完全限定类名* |
-|-----------------------------------| ---------------------- | ----------- |
-| ColumnValueMatchedShadowAlgorithm | 基于字段值匹配影子算法 |
[`org.apache.shardingsphere.shadow.algorithm.shadow.column.ColumnValueMatchedShadowAlgorithm`](https://github.com/apache/shardingsphere/blob/master/features/shadow/core/src/main/java/org/apache/shardingsphere/shadow/algorithm/shadow/column/ColumnValueMatchedShadowAlgorithm.java)
|
-| ColumnRegexMatchedShadowAlgorithm | 基于字段值正则匹配影子算法 |
[`org.apache.shardingsphere.shadow.algorithm.shadow.column.ColumnRegexMatchedShadowAlgorithm`](https://github.com/apache/shardingsphere/blob/master/features/shadow/core/src/main/java/org/apache/shardingsphere/shadow/algorithm/shadow/column/ColumnRegexMatchedShadowAlgorithm.java)
|
-| SQLHintShadowAlgorithm | 基于 Hint 简单匹配影子算法 |
[`org.apache.shardingsphere.shadow.algorithm.shadow.hint.SQLHintShadowAlgorithm`](https://github.com/apache/shardingsphere/blob/master/features/shadow/core/src/main/java/org/apache/shardingsphere/shadow/algorithm/shadow/hint/SQLHintShadowAlgorithm.java)
|
+| *配置表示* | *详细说明* | *完全限定类名* |
+|------------------|-------------------| ----------- |
+| VALUE_MATCH | 基于字段值匹配影子算法 |
[`org.apache.shardingsphere.shadow.algorithm.shadow.column.ColumnValueMatchedShadowAlgorithm`](https://github.com/apache/shardingsphere/blob/master/features/shadow/core/src/main/java/org/apache/shardingsphere/shadow/algorithm/shadow/column/ColumnValueMatchedShadowAlgorithm.java)
|
+| REGEX_MATCH | 基于字段值正则匹配影子算法 |
[`org.apache.shardingsphere.shadow.algorithm.shadow.column.ColumnRegexMatchedShadowAlgorithm`](https://github.com/apache/shardingsphere/blob/master/features/shadow/core/src/main/java/org/apache/shardingsphere/shadow/algorithm/shadow/column/ColumnRegexMatchedShadowAlgorithm.java)
|
+| SQL_HINT | 基于 SQL Hint 的影子算法 |
[`org.apache.shardingsphere.shadow.algorithm.shadow.hint.SQLHintShadowAlgorithm`](https://github.com/apache/shardingsphere/blob/master/features/shadow/core/src/main/java/org/apache/shardingsphere/shadow/algorithm/shadow/hint/SQLHintShadowAlgorithm.java)
|
diff --git a/docs/document/content/dev-manual/shadow.en.md
b/docs/document/content/dev-manual/shadow.en.md
index f2643bb105b..9a989f99438 100644
--- a/docs/document/content/dev-manual/shadow.en.md
+++ b/docs/document/content/dev-manual/shadow.en.md
@@ -18,7 +18,7 @@ Shadow algorithm's definition
### Implementation classes
| *Configuration Type* | *Description*
| *Fully-qualified class name* |
-| -------------------- |
------------------------------------------------------ |
---------------------------- |
+|----------------------|--------------------------------------------------------|
---------------------------- |
| VALUE_MATCH | Match shadow algorithms based on field values
|
[`org.apache.shardingsphere.shadow.algorithm.shadow.column.ColumnValueMatchedShadowAlgorithm`](https://github.com/apache/shardingsphere/blob/master/features/shadow/core/src/main/java/org/apache/shardingsphere/shadow/algorithm/shadow/column/ColumnValueMatchedShadowAlgorithm.java)
|
| REGEX_MATCH | Regular matching shadow algorithm based on field
value |
[`org.apache.shardingsphere.shadow.algorithm.shadow.column.ColumnRegexMatchedShadowAlgorithm`](https://github.com/apache/shardingsphere/blob/master/features/shadow/core/src/main/java/org/apache/shardingsphere/shadow/algorithm/shadow/column/ColumnRegexMatchedShadowAlgorithm.java)
|
-| SIMPLE_HINT | Simple match shadow algorithm based on Hint
|
[`org.apache.shardingsphere.shadow.algorithm.shadow.hint.SQLHintShadowAlgorithm`](https://github.com/apache/shardingsphere/blob/master/features/shadow/core/src/main/java/org/apache/shardingsphere/shadow/algorithm/shadow/hint/SQLHintShadowAlgorithm.java)
|
+| SQL_HINT | Shadow algorithm on sql hint
|
[`org.apache.shardingsphere.shadow.algorithm.shadow.hint.SQLHintShadowAlgorithm`](https://github.com/apache/shardingsphere/blob/master/features/shadow/core/src/main/java/org/apache/shardingsphere/shadow/algorithm/shadow/hint/SQLHintShadowAlgorithm.java)
|
diff --git
a/docs/document/content/user-manual/common-config/builtin-algorithm/shadow.cn.md
b/docs/document/content/user-manual/common-config/builtin-algorithm/shadow.cn.md
index 7a172a5c30e..df04169c04e 100644
---
a/docs/document/content/user-manual/common-config/builtin-algorithm/shadow.cn.md
+++
b/docs/document/content/user-manual/common-config/builtin-algorithm/shadow.cn.md
@@ -33,13 +33,12 @@ weight = 6
### Hint 影子算法
-#### 简单 Hint 匹配影子算法
+#### SQL HINT 影子算法
-类型：SIMPLE_HINT
-
-| *属性名称* | *数据类型* | *说明* |
-| --------- | -------- | ----- |
-| foo | String | bar |
+类型：SQL_HINT
+```sql
+/* SHARDINGSPHERE_HINT: SHADOW=true */
+```
## 配置示例
diff --git
a/docs/document/content/user-manual/common-config/builtin-algorithm/shadow.en.md
b/docs/document/content/user-manual/common-config/builtin-algorithm/shadow.en.md
index a19b42fdb75..a504e16af83 100644
---
a/docs/document/content/user-manual/common-config/builtin-algorithm/shadow.en.md
+++
b/docs/document/content/user-manual/common-config/builtin-algorithm/shadow.en.md
@@ -33,13 +33,12 @@ Type：REGEX_MATCH
### Hint-based shadow algorithm
-#### Simple Hint matching shadow algorithm
+#### SQL HINT shadow algorithm
-Type：SIMPLE_HINT
-
-| *Attribute Name* | *Data Type* | *Description* |
-| ---------------- | ----------- | ------------- |
-| foo | String | bar |
+Type：SQL_HINT
+```sql
+/* SHARDINGSPHERE_HINT: SHADOW=true */
+```
## Configuration sample
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/shadow.cn.md
b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/shadow.cn.md
index 4a74d8c14cf..3a95fb0b6e4 100644
---
a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/shadow.cn.md
+++
b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/shadow.cn.md
@@ -70,7 +70,7 @@ rules:
- shadowDataSource
shadowAlgorithmNames:
- user_id_insert_match_algorithm
- - simple_hint_algorithm
+ - sql_hint_algorithm
shadowAlgorithms:
user_id_insert_match_algorithm:
type: REGEX_MATCH
@@ -78,10 +78,8 @@ rules:
operation: insert
column: user_id
regex: "[1]"
- simple_hint_algorithm:
- type: SIMPLE_HINT
- props:
- foo: bar
+ sql_hint_algorithm:
+ type: SQL_HINT
```
## 相关参考
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/shadow.en.md
b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/shadow.en.md
index b6caa0f0507..b3e29e9edbb 100644
---
a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/shadow.en.md
+++
b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/shadow.en.md
@@ -72,7 +72,7 @@ rules:
- shadowDataSource
shadowAlgorithmNames:
- user_id_insert_match_algorithm
- - simple_hint_algorithm
+ - sql_hint_algorithm
shadowAlgorithms:
user_id_insert_match_algorithm:
type: REGEX_MATCH
@@ -80,10 +80,8 @@ rules:
operation: insert
column: user_id
regex: "[1]"
- simple_hint_algorithm:
- type: SIMPLE_HINT
- props:
- foo: bar
+ sql_hint_algorithm:
+ type: SQL_HINT
```
## Related References
diff --git
a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/alter-default-shadow-algorithm.cn.md
b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/alter-default-shadow-algorithm.cn.md
index 6241b4a7901..962be140c91 100644
---
a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/alter-default-shadow-algorithm.cn.md
+++
b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/alter-default-shadow-algorithm.cn.md
@@ -38,14 +38,14 @@ value ::=
### 补充说明
-- `shadowAlgorithmType` 目前支持 `VALUE_MATCH`、`REGEX_MATCH` 和 `SIMPLE_HINT`。
+- `shadowAlgorithmType` 目前支持 `VALUE_MATCH`、`REGEX_MATCH` 和 `SQL_HINT`。
### 示例
- 修改默认影子库压测算法
```sql
-ALTER DEFAULT SHADOW ALGORITHM TYPE(NAME="SIMPLE_HINT",
PROPERTIES("shadow"="true", "foo"="bar");
+ALTER DEFAULT SHADOW ALGORITHM TYPE(NAME="SQL_HINT");
```
### 保留字
diff --git
a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/alter-default-shadow-algorithm.en.md
b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/alter-default-shadow-algorithm.en.md
index 7b2aff9bb60..acaa1e4fec7 100644
---
a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/alter-default-shadow-algorithm.en.md
+++
b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/alter-default-shadow-algorithm.en.md
@@ -38,14 +38,14 @@ value ::=
### Supplement
-- `shadowAlgorithmType` currently supports `VALUE_MATCH`, `REGEX_MATCH` and
`SIMPLE_HINT`.
+- `shadowAlgorithmType` currently supports `VALUE_MATCH`, `REGEX_MATCH` and
`SQL_HINT`.
### Example
- Alter default shadow algorithm
```sql
-ALTER DEFAULT SHADOW ALGORITHM TYPE(NAME="SIMPLE_HINT",
PROPERTIES("shadow"="true", "foo"="bar");
+ALTER DEFAULT SHADOW ALGORITHM TYPE(NAME="SQL_HINT");
```
### Reserved word
diff --git
a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/alter-shadow-rule.cn.md
b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/alter-shadow-rule.cn.md
index 2508d60d659..6d111a649be 100644
---
a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/alter-shadow-rule.cn.md
+++
b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/alter-shadow-rule.cn.md
@@ -63,7 +63,7 @@ value ::=
，请参考
[存储单元](https://shardingsphere.apache.org/document/current/cn/user-manual/shardingsphere-proxy/distsql/syntax/rdl/storage-unit-definition/)；
- `shadowAlgorithm` 可同时作用于多个 `shadowTableRule`；
- `algorithmName` 会根据 `ruleName`、`tableName` 和 `shadowAlgorithmType` 自动生成；
-- `shadowAlgorithmType` 目前支持 `VALUE_MATCH`、`REGEX_MATCH` 和 `SIMPLE_HINT`。
+- `shadowAlgorithmType` 目前支持 `VALUE_MATCH`、`REGEX_MATCH` 和 `SQL_HINT`。
### 示例
@@ -73,7 +73,7 @@ value ::=
ALTER SHADOW RULE shadow_rule(
SOURCE=demo_ds,
SHADOW=demo_ds_shadow,
- t_order(TYPE(NAME="SIMPLE_HINT", PROPERTIES("shadow"="true", "foo"="bar"))),
+ t_order(TYPE(NAME="SQL_HINT")),
t_order_item(TYPE(NAME="VALUE_MATCH",
PROPERTIES("operation"="insert","column"="user_id", "value"='1')))
);
```
diff --git
a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/alter-shadow-rule.en.md
b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/alter-shadow-rule.en.md
index 5d11806a199..4824e4461f3 100644
---
a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/alter-shadow-rule.en.md
+++
b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/alter-shadow-rule.en.md
@@ -65,7 +65,7 @@ value ::=
- `shadowAlgorithm` can act on multiple `shadowTableRule` at the same time;
- If `algorithmName` is not specified, it will be automatically generated
according to `ruleName`, `tableName`
and `shadowAlgorithmType`;
-- `shadowAlgorithmType` currently supports `VALUE_MATCH`, `REGEX_MATCH` and
`SIMPLE_HINT`.
+- `shadowAlgorithmType` currently supports `VALUE_MATCH`, `REGEX_MATCH` and
`SQL_HINT`.
### Example
@@ -75,7 +75,7 @@ value ::=
ALTER SHADOW RULE shadow_rule(
SOURCE=demo_ds,
SHADOW=demo_ds_shadow,
- t_order(TYPE(NAME="SIMPLE_HINT", PROPERTIES("shadow"="true", "foo"="bar"))),
+ t_order(TYPE(NAME="SQL_HINT")),
t_order_item(TYPE(NAME="VALUE_MATCH",
PROPERTIES("operation"="insert","column"="user_id", "value"='1')))
);
```
diff --git
a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/create-default-shadow-algorithm.cn.md
b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/create-default-shadow-algorithm.cn.md
index 4301903cd48..421ae65daac 100644
---
a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/create-default-shadow-algorithm.cn.md
+++
b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/create-default-shadow-algorithm.cn.md
@@ -41,7 +41,7 @@ value ::=
### 补充说明
-- `shadowAlgorithmType` 目前支持 `VALUE_MATCH`、`REGEX_MATCH` 和 `SIMPLE_HINT`；
+- `shadowAlgorithmType` 目前支持 `VALUE_MATCH`、`REGEX_MATCH` 和 `SQL_HINT`；
- `ifNotExists` 子句用于避免出现 `Duplicate default shadow algorithm` 错误。
### 示例
@@ -49,13 +49,13 @@ value ::=
- 创建默认影子库压测算法
```sql
-CREATE DEFAULT SHADOW ALGORITHM TYPE(NAME="SIMPLE_HINT",
PROPERTIES("shadow"="true", "foo"="bar"));
+CREATE DEFAULT SHADOW ALGORITHM TYPE(NAME="SQL_HINT");
```
- 使用 `ifNotExists` 子句创建默认影子库压测算法
```sql
-CREATE DEFAULT SHADOW ALGORITHM IF NOT EXISTS TYPE(NAME="SIMPLE_HINT",
PROPERTIES("shadow"="true", "foo"="bar"));
+CREATE DEFAULT SHADOW ALGORITHM IF NOT EXISTS TYPE(NAME="SQL_HINT");
```
### 保留字
diff --git
a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/create-default-shadow-algorithm.en.md
b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/create-default-shadow-algorithm.en.md
index 97e823a8601..efda78daa6b 100644
---
a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/create-default-shadow-algorithm.en.md
+++
b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/create-default-shadow-algorithm.en.md
@@ -41,7 +41,7 @@ value ::=
### Supplement
-- `shadowAlgorithmType` currently supports `VALUE_MATCH`, `REGEX_MATCH` and
`SIMPLE_HINT`;
+- `shadowAlgorithmType` currently supports `VALUE_MATCH`, `REGEX_MATCH` and
`SQL_HINT`;
- `ifNotExists` clause is used for avoid `Duplicate default shadow algorithm`
error.
### Example
@@ -49,13 +49,13 @@ value ::=
- Create default shadow algorithm
```sql
-CREATE DEFAULT SHADOW ALGORITHM TYPE(NAME="SIMPLE_HINT",
PROPERTIES("shadow"="true", "foo"="bar"));
+CREATE DEFAULT SHADOW ALGORITHM TYPE(NAME="SQL_HINT");
```
- Create default shadow algorithm with `ifNotExist` clause
```sql
-CREATE DEFAULT SHADOW ALGORITHM IF NOT EXISTS TYPE(NAME="SIMPLE_HINT",
PROPERTIES("shadow"="true", "foo"="bar"));
+CREATE DEFAULT SHADOW ALGORITHM IF NOT EXISTS TYPE(NAME="SQL_HINT");
```
### Reserved word
diff --git
a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/create-shadow-rule.cn.md
b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/create-shadow-rule.cn.md
index f71e33784ae..7657b2efb4f 100644
---
a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/create-shadow-rule.cn.md
+++
b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/create-shadow-rule.cn.md
@@ -67,7 +67,7 @@ value ::=
，请参考
[存储单元](https://shardingsphere.apache.org/document/current/cn/user-manual/shardingsphere-proxy/distsql/syntax/rdl/storage-unit-definition/)；
- `shadowAlgorithm` 可同时作用于多个 `shadowTableRule`；
- `algorithmName` 会根据 `ruleName`、`tableName` 和 `shadowAlgorithmType` 自动生成；
-- `shadowAlgorithmType` 目前支持 `VALUE_MATCH`、`REGEX_MATCH` 和 `SIMPLE_HINT`；
+- `shadowAlgorithmType` 目前支持 `VALUE_MATCH`、`REGEX_MATCH` 和 `SQL_HINT`；
- `ifNotExists` 子句用于避免出现 `Duplicate shadow rule` 错误。
### 示例
@@ -78,7 +78,7 @@ value ::=
CREATE SHADOW RULE shadow_rule(
SOURCE=demo_ds,
SHADOW=demo_ds_shadow,
- t_order(TYPE(NAME="SIMPLE_HINT", PROPERTIES("shadow"="true", "foo"="bar"))),
+ t_order(TYPE(NAME="SQL_HINT")),
t_order_item(TYPE(NAME="VALUE_MATCH",
PROPERTIES("operation"="insert","column"="user_id", "value"='1')))
);
```
@@ -89,7 +89,7 @@ CREATE SHADOW RULE shadow_rule(
CREATE SHADOW RULE IF NOT EXISTS shadow_rule(
SOURCE=demo_ds,
SHADOW=demo_ds_shadow,
- t_order(TYPE(NAME="SIMPLE_HINT", PROPERTIES("shadow"="true", "foo"="bar"))),
+ t_order(TYPE(NAME="SQL_HINT")),
t_order_item(TYPE(NAME="VALUE_MATCH",
PROPERTIES("operation"="insert","column"="user_id", "value"='1')))
);
```
diff --git
a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/create-shadow-rule.en.md
b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/create-shadow-rule.en.md
index d60e75102e6..b80d76ca759 100644
---
a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/create-shadow-rule.en.md
+++
b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/create-shadow-rule.en.md
@@ -69,7 +69,7 @@ value ::=
- `shadowAlgorithm` can act on multiple `shadowTableRule` at the same time;
- If `algorithmName` is not specified, it will be automatically generated
according to `ruleName`, `tableName`
and `shadowAlgorithmType`;
-- `shadowAlgorithmType` currently supports `VALUE_MATCH`, `REGEX_MATCH` and
`SIMPLE_HINT`;
+- `shadowAlgorithmType` currently supports `VALUE_MATCH`, `REGEX_MATCH` and
`SQL_HINT`;
- `ifNotExists` caluse is used for avoid `Duplicate shadow rule` error.
### Example
@@ -80,7 +80,7 @@ value ::=
CREATE SHADOW RULE shadow_rule(
SOURCE=demo_ds,
SHADOW=demo_ds_shadow,
- t_order(TYPE(NAME="SIMPLE_HINT", PROPERTIES("shadow"="true", "foo"="bar"))),
+ t_order(TYPE(NAME="SQL_HINT")),
t_order_item(TYPE(NAME="VALUE_MATCH",
PROPERTIES("operation"="insert","column"="user_id", "value"='1')))
);
```
@@ -91,7 +91,7 @@ CREATE SHADOW RULE shadow_rule(
CREATE SHADOW RULE IF NOT EXISTS shadow_rule(
SOURCE=demo_ds,
SHADOW=demo_ds_shadow,
- t_order(TYPE(NAME="SIMPLE_HINT", PROPERTIES("shadow"="true", "foo"="bar"))),
+ t_order(TYPE(NAME="SQL_HINT")),
t_order_item(TYPE(NAME="VALUE_MATCH",
PROPERTIES("operation"="insert","column"="user_id", "value"='1')))
);
```
diff --git
a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/drop-shadow-algorithm.cn.md
b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/drop-shadow-algorithm.cn.md
index 643b2137111..d7bfcc0b9c8 100644
---
a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/drop-shadow-algorithm.cn.md
+++
b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/drop-shadow-algorithm.cn.md
@@ -40,19 +40,19 @@ databaseName ::=
- 为指定数据库删除多个影子库压测算法
```sql
-DROP SHADOW ALGORITHM shadow_rule_t_order_simple_hint_0,
shadow_rule_t_order_item_simple_hint_0 FROM shadow_db;
+DROP SHADOW ALGORITHM shadow_rule_t_order_sql_hint_0,
shadow_rule_t_order_item_sql_hint_0 FROM shadow_db;
```
- 为当前数据库删除单个影子库压测算法
```sql
-DROP SHADOW ALGORITHM shadow_rule_t_order_simple_hint_0;
+DROP SHADOW ALGORITHM shadow_rule_t_order_sql_hint_0;
```
- 使用 `ifExists` 子句删除影子库压测算法
```sql
-DROP SHADOW ALGORITHM IF EXISTS shadow_rule_t_order_simple_hint_0;
+DROP SHADOW ALGORITHM IF EXISTS shadow_rule_t_order_sql_hint_0;
```
### 保留字
diff --git
a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/drop-shadow-algorithm.en.md
b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/drop-shadow-algorithm.en.md
index d79ef420a7a..0ecb605252e 100644
---
a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/drop-shadow-algorithm.en.md
+++
b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/drop-shadow-algorithm.en.md
@@ -40,19 +40,19 @@ databaseName ::=
- Drop mutiple shadow algorithm for specified database
```sql
-DROP SHADOW ALGORITHM shadow_rule_t_order_simple_hint_0,
shadow_rule_t_order_item_simple_hint_0 FROM shadow_db;
+DROP SHADOW ALGORITHM shadow_rule_t_order_sql_hint_0,
shadow_rule_t_order_item_sql_hint_0 FROM shadow_db;
```
- Drop single shadow algorithm for current database
```sql
-DROP SHADOW ALGORITHM shadow_rule_t_order_simple_hint_0;
+DROP SHADOW ALGORITHM shadow_rule_t_order_sql_hint_0;
```
- Drop shadow algorithm with `ifExists` clause
```sql
-DROP SHADOW ALGORITHM IF EXISTS shadow_rule_t_order_simple_hint_0;
+DROP SHADOW ALGORITHM IF EXISTS shadow_rule_t_order_sql_hint_0;
```
### Reserved word
diff --git
a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/shadow/show-shadow-table-rule.cn.md
b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/shadow/show-shadow-table-rule.cn.md
index 99514f218b2..ff75e2a6a75 100644
---
a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/shadow/show-shadow-table-rule.cn.md
+++
b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/shadow/show-shadow-table-rule.cn.md
@@ -49,7 +49,7 @@ mysql> SHOW SHADOW TABLE RULES FROM shadow_db;
| shadow_table | shadow_algorithm_name |
+--------------+-------------------------------------------------------+
| t_order_item | shadow_rule_t_order_item_value_match |
-| t_order | simple_hint_algorithm,shadow_rule_t_order_regex_match |
+| t_order | sql_hint_algorithm,shadow_rule_t_order_regex_match |
+--------------+-------------------------------------------------------+
2 rows in set (0.00 sec)
```
@@ -66,7 +66,7 @@ mysql> SHOW SHADOW TABLE RULES;
| shadow_table | shadow_algorithm_name |
+--------------+-------------------------------------------------------+
| t_order_item | shadow_rule_t_order_item_value_match |
-| t_order | simple_hint_algorithm,shadow_rule_t_order_regex_match |
+| t_order | sql_hint_algorithm,shadow_rule_t_order_regex_match |
+--------------+-------------------------------------------------------+
2 rows in set (0.01 sec)
```
diff --git
a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/shadow/show-shadow-table-rule.en.md
b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/shadow/show-shadow-table-rule.en.md
index 6c0a4a4fdd5..f8bad29d758 100644
---
a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/shadow/show-shadow-table-rule.en.md
+++
b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/shadow/show-shadow-table-rule.en.md
@@ -49,7 +49,7 @@ mysql> SHOW SHADOW TABLE RULES FROM shadow_db;
| shadow_table | shadow_algorithm_name |
+--------------+-------------------------------------------------------+
| t_order_item | shadow_rule_t_order_item_value_match |
-| t_order | simple_hint_algorithm,shadow_rule_t_order_regex_match |
+| t_order | sql_hint_algorithm,shadow_rule_t_order_regex_match |
+--------------+-------------------------------------------------------+
2 rows in set (0.00 sec)
```
@@ -66,7 +66,7 @@ mysql> SHOW SHADOW TABLE RULES;
| shadow_table | shadow_algorithm_name |
+--------------+-------------------------------------------------------+
| t_order_item | shadow_rule_t_order_item_value_match |
-| t_order | simple_hint_algorithm,shadow_rule_t_order_regex_match |
+| t_order | sql_hint_algorithm,shadow_rule_t_order_regex_match |
+--------------+-------------------------------------------------------+
2 rows in set (0.01 sec)
```
diff --git
a/docs/document/content/user-manual/shardingsphere-proxy/distsql/usage/shadow-rule.cn.md
b/docs/document/content/user-manual/shardingsphere-proxy/distsql/usage/shadow-rule.cn.md
index 04d281f5643..cfe4103a900 100644
---
a/docs/document/content/user-manual/shardingsphere-proxy/distsql/usage/shadow-rule.cn.md
+++
b/docs/document/content/user-manual/shardingsphere-proxy/distsql/usage/shadow-rule.cn.md
@@ -35,8 +35,8 @@ REGISTER STORAGE UNIT ds_0 (
CREATE SHADOW RULE group_0(
SOURCE=ds_0,
SHADOW=ds_1,
-t_order(TYPE(NAME="SIMPLE_HINT",
PROPERTIES("foo"="bar")),TYPE(NAME="REGEX_MATCH",
PROPERTIES("operation"="insert","column"="user_id", "regex"='[1]'))),
-t_order_item(TYPE(NAME="SIMPLE_HINT", PROPERTIES("foo"="bar"))));
+t_order(TYPE(NAME="SQL_HINT"),TYPE(NAME="REGEX_MATCH",
PROPERTIES("operation"="insert","column"="user_id", "regex"='[1]'))),
+t_order_item(TYPE(NAME="SQL_HINT")));
```
- 修改影子库压测规则
@@ -45,7 +45,7 @@ t_order_item(TYPE(NAME="SIMPLE_HINT",
PROPERTIES("foo"="bar"))));
ALTER SHADOW RULE group_0(
SOURCE=ds_0,
SHADOW=ds_2,
-t_order_item(TYPE(NAME="SIMPLE_HINT", PROPERTIES("foo"="bar"))));
+t_order_item(TYPE(NAME="SQL_HINT")));
```
- 删除影子库压测规则
diff --git
a/docs/document/content/user-manual/shardingsphere-proxy/distsql/usage/shadow-rule.en.md
b/docs/document/content/user-manual/shardingsphere-proxy/distsql/usage/shadow-rule.en.md
index 708babb5d1c..654eb3f74e8 100644
---
a/docs/document/content/user-manual/shardingsphere-proxy/distsql/usage/shadow-rule.en.md
+++
b/docs/document/content/user-manual/shardingsphere-proxy/distsql/usage/shadow-rule.en.md
@@ -35,8 +35,8 @@ REGISTER STORAGE UNIT ds_0 (
CREATE SHADOW RULE group_0(
SOURCE=ds_0,
SHADOW=ds_1,
-t_order(TYPE(NAME="SIMPLE_HINT",
PROPERTIES("foo"="bar")),TYPE(NAME="REGEX_MATCH",
PROPERTIES("operation"="insert","column"="user_id", "regex"='[1]'))),
-t_order_item(TYPE(NAME="SIMPLE_HINT", PROPERTIES("foo"="bar"))));
+t_order(TYPE(NAME="SQL_HINT"),TYPE(NAME="REGEX_MATCH",
PROPERTIES("operation"="insert","column"="user_id", "regex"='[1]'))),
+t_order_item(TYPE(NAME="SQL_HINT")));
```
- Alter shadow rule
@@ -45,7 +45,7 @@ t_order_item(TYPE(NAME="SIMPLE_HINT",
PROPERTIES("foo"="bar"))));
ALTER SHADOW RULE group_0(
SOURCE=ds_0,
SHADOW=ds_2,
-t_order_item(TYPE(NAME="SIMPLE_HINT", PROPERTIES("foo"="bar"))));
+t_order_item(TYPE(NAME="SQL_HINT")));
```
- Drop shadow rule
