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 2ecfd0a Update _index.en.md (#13780)
2ecfd0a is described below
commit 2ecfd0a7f392b42c5583f0bb81427ba9fd8c0bfd
Author: Z <[email protected]>
AuthorDate: Thu Nov 25 18:28:36 2021 +0800
Update _index.en.md (#13780)
* Update _index.en.md
About shadow 'HINT' description
* Update _index.en.md
code format
---
.../document/content/reference/shadow/_index.en.md | 33 +++++++++++++++++++++-
1 file changed, 32 insertions(+), 1 deletion(-)
diff --git a/docs/document/content/reference/shadow/_index.en.md
b/docs/document/content/reference/shadow/_index.en.md
index d4c3952..1a43aa4 100644
--- a/docs/document/content/reference/shadow/_index.en.md
+++ b/docs/document/content/reference/shadow/_index.en.md
@@ -248,4 +248,35 @@ props:
sql-comment-parse-enabled: true
```
-**Note**: The default shadow algorithm only supports note shadow algorithm.
+**Note**:
+The default shadow algorithm only supports note shadow algorithm.
+When using HINT, ensure that the configuration items of `props` in the
configuration file are less than or equal to those in the SQL comment, and that
the configuration items in the configuration file are the same as those in the
SQL comment. The fewer the configuration items in the configuration file, the
looser the matching conditions are
+
+```yaml
+simple-note-algorithm:
+ type: SIMPLE_HINT
+ props:
+ shadow: true
+ user_id: 2
+```
+For example, the 'props' item have `2` configure, the following syntax can be
used in SQL:
+```sql
+SELECT * FROM t_xxx_2 WHERE order_id = xxx /*shadow:true,user_id:2*/、
+```
+```sql
+SELECT * FROM t_xxx_2 WHERE order_id = xxx
/*shadow:true,user_id:2,foo:bar,.....*/
+```
+
+```yaml
+simple-note-algorithm:
+ type: SIMPLE_HINT
+ props:
+ shadow: false
+```
+For example, the 'props' item have `1` configure, the following syntax can be
used in SQL:
+```sql
+SELECT * FROM t_xxx_2 WHERE order_id = xxx /*shadow:false*/、
+```
+```sql
+SELECT * FROM t_xxx_2 WHERE order_id = xxx
/*shadow:false,user_id:2,foo:bar,.....*/
+```
