soulasuna commented on a change in pull request #13780:
URL: https://github.com/apache/shardingsphere/pull/13780#discussion_r756519495
##########
File path: docs/document/content/reference/shadow/_index.en.md
##########
@@ -248,4 +248,29 @@ 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
Review comment:
Thank you very much for your suggestions.
But I think the document should be a "neutral" point of view to explain the
function.
Rather than "inducing" users how to use it.
##########
File path: docs/document/content/reference/shadow/_index.en.md
##########
@@ -248,4 +248,29 @@ 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
+/*shadow:true,user_id:2*/、/*shadow:true,user_id:2,foo:bar,.....*/
+```
Review comment:
Preferably a SQL statement that completes the structure.
##########
File path: docs/document/content/reference/shadow/_index.en.md
##########
@@ -248,4 +248,29 @@ 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
Review comment:
Indentation format error in yaml configuration.
##########
File path: docs/document/content/reference/shadow/_index.en.md
##########
@@ -248,4 +248,29 @@ 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
+/*shadow:true,user_id:2*/、/*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
+/*shadow:false*/、/*shadow:false,user_id:2,foo:bar,.....*/
+```
Review comment:
Preferably a SQL statement that completes the structure.
##########
File path: docs/document/content/reference/shadow/_index.en.md
##########
@@ -248,4 +248,29 @@ 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
+/*shadow:true,user_id:2*/、/*shadow:true,user_id:2,foo:bar,.....*/
+```
+
+```yaml
+simple-note-algorithm:
+ type: SIMPLE_HINT
+ props:
+ shadow: false
+```
Review comment:
Indentation format error in yaml configuration.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
