This is an automated email from the ASF dual-hosted git repository.
zhangliang 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 f6da3c23a64 update SQL hint document (#23255)
f6da3c23a64 is described below
commit f6da3c23a642a5f804a638b76937efb8df5742e6
Author: Zonglei Dong <[email protected]>
AuthorDate: Mon Jan 2 18:10:21 2023 +0800
update SQL hint document (#23255)
---
.../shardingsphere-jdbc/special-api/readwrite-splitting/hint.cn.md | 5 ++---
.../shardingsphere-jdbc/special-api/readwrite-splitting/hint.en.md | 5 ++---
.../user-manual/shardingsphere-jdbc/special-api/sharding/hint.cn.md | 2 +-
.../user-manual/shardingsphere-jdbc/special-api/sharding/hint.en.md | 3 +--
4 files changed, 6 insertions(+), 9 deletions(-)
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/special-api/readwrite-splitting/hint.cn.md
b/docs/document/content/user-manual/shardingsphere-jdbc/special-api/readwrite-splitting/hint.cn.md
index 8c633245101..0110cb270a4 100644
---
a/docs/document/content/user-manual/shardingsphere-jdbc/special-api/readwrite-splitting/hint.cn.md
+++
b/docs/document/content/user-manual/shardingsphere-jdbc/special-api/readwrite-splitting/hint.cn.md
@@ -54,7 +54,7 @@ try (HintManager hintManager = HintManager.getInstance();
##### 使用规范
-SQL Hint 功能需要用户提前开启解析注释的配置，设置 `sqlCommentParseEnabled` 为 `true`。 注释格式暂时只支持 `/*
*/`，内容需要以 `SHARDINGSPHERE_HINT:` 开始，属性名为 `WRITE_ROUTE_ONLY`。
+SQL Hint 功能的注释格式暂时只支持 `/* */`，内容需要以 `SHARDINGSPHERE_HINT:` 开始，属性名为
`WRITE_ROUTE_ONLY`。
##### 完整示例
@@ -95,8 +95,7 @@ try (HintManager hintManager = HintManager.getInstance();
##### 使用规范
-SQL Hint 功能需要用户提前开启解析注释的配置，设置 `sqlCommentParseEnabled` 为 `true`，目前只支持路由至一个数据源。
-注释格式暂时只支持 `/* */`，内容需要以 `SHARDINGSPHERE_HINT:` 开始，属性名为 `DATA_SOURCE_NAME`。
+SQL Hint 功能目前只支持路由至一个数据源。 注释格式暂时只支持 `/* */`，内容需要以 `SHARDINGSPHERE_HINT:`
开始，属性名为 `DATA_SOURCE_NAME`。
如果使用 `MySQL` 客户端连接需要添加 `-c` 选项保留注释，客户端默认是 `--skip-comments` 过滤注释。
##### 完整示例
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/special-api/readwrite-splitting/hint.en.md
b/docs/document/content/user-manual/shardingsphere-jdbc/special-api/readwrite-splitting/hint.en.md
index 5a16f09703c..e16d3a8e0d7 100644
---
a/docs/document/content/user-manual/shardingsphere-jdbc/special-api/readwrite-splitting/hint.en.md
+++
b/docs/document/content/user-manual/shardingsphere-jdbc/special-api/readwrite-splitting/hint.en.md
@@ -55,8 +55,7 @@ try (HintManager hintManager = HintManager.getInstance();
##### Terms of Use
-To use SQL Hint function, users need to set `sqlCommentParseEnabled` to `true`.
-The comment format only supports `/* */` for now. The content needs to start
with `SHARDINGSPHERE_HINT:`, and the attribute name needs to be
`WRITE_ROUTE_ONLY`.
+For SQL Hint function, the comment format only supports `/* */` for now. The
content needs to start with `SHARDINGSPHERE_HINT:`, and the attribute name
needs to be `WRITE_ROUTE_ONLY`.
##### Codes:
```sql
@@ -96,7 +95,7 @@ try (HintManager hintManager = HintManager.getInstance();
##### Terms of Use
-To use SQL Hint function, users need to set `sqlCommentParseEnabled` to
`true`. Currently, only support routing to one data source.
+Currently, the SQL Hint function only support routing to one data source.
The comment format only supports `/* */` for now. The content needs to start
with `SHARDINGSPHERE_HINT:`, and the attribute name needs to be
`DATA_SOURCE_NAME`.
Client connections using `MySQL` need to add the `-c` option to preserve
comments, because the client defaults to `--skip-comments` to filter comments.
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/special-api/sharding/hint.cn.md
b/docs/document/content/user-manual/shardingsphere-jdbc/special-api/sharding/hint.cn.md
index cc5f3f86444..0cf22c5bc34 100644
---
a/docs/document/content/user-manual/shardingsphere-jdbc/special-api/sharding/hint.cn.md
+++
b/docs/document/content/user-manual/shardingsphere-jdbc/special-api/sharding/hint.cn.md
@@ -106,7 +106,7 @@ try (HintManager hintManager = HintManager.getInstance();
##### 使用规范
-SQL Hint 功能需要用户提前开启解析注释的配置，设置 `sqlCommentParseEnabled` 为 `true`。 注释格式暂时只支持 `/*
*/`，内容需要以 `SHARDINGSPHERE_HINT:` 开始，可选的属性包括：
+SQL Hint 功能的注释格式暂时只支持 `/* */`，内容需要以 `SHARDINGSPHERE_HINT:` 开始，可选的属性包括：
- `{table}.SHARDING_DATABASE_VALUE`：用于添加 `{table}` 表对应的数据源分片键值，多个属性使用逗号分隔；
- `{table}.SHARDING_TABLE_VALUE`：用于添加 `{table}` 表对应的表分片键值，多个属性使用逗号分隔。
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/special-api/sharding/hint.en.md
b/docs/document/content/user-manual/shardingsphere-jdbc/special-api/sharding/hint.en.md
index 28dd009bca8..591557dba87 100644
---
a/docs/document/content/user-manual/shardingsphere-jdbc/special-api/sharding/hint.en.md
+++
b/docs/document/content/user-manual/shardingsphere-jdbc/special-api/sharding/hint.en.md
@@ -106,8 +106,7 @@ try (HintManager hintManager = HintManager.getInstance();
##### Terms of Use
-To use SQL Hint function, users need to set `sqlCommentParseEnabled` to `true`.
-The comment format only supports `/* */` for now. The content needs to start
with `SHARDINGSPHERE_HINT:`, and optional attributes include:
+For the SQL Hint function, the comment format only supports `/* */` for now.
The content needs to start with `SHARDINGSPHERE_HINT:`, and optional attributes
include:
- `{table}.SHARDING_DATABASE_VALUE`: used to add the data source sharding
value corresponding to `{table}` table, multiple attributes are separated by
commas;
- `{table}.SHARDING_TABLE_VALUE`: used to add the table sharding value
corresponding to `{table}` table, multiple attributes are separated by commas.
