This is an automated email from the ASF dual-hosted git repository.
yx9o 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 49c16e871b2 Update documents of RAL. (#20417)
49c16e871b2 is described below
commit 49c16e871b21ca9e1bb390f76e92ba635c337777
Author: Raigor <[email protected]>
AuthorDate: Mon Aug 22 21:40:10 2022 +0800
Update documents of RAL. (#20417)
* Update doc if RAL.
* Update doc if RAL.
---
.../distsql/syntax/ral/_index.cn.md | 52 +++++++++++-----------
.../distsql/syntax/ral/_index.en.md | 8 ++--
2 files changed, 30 insertions(+), 30 deletions(-)
diff --git
a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/_index.cn.md
b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/_index.cn.md
index b5c5f9fd101..6ca4c807681 100644
---
a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/_index.cn.md
+++
b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/_index.cn.md
@@ -8,15 +8,15 @@ RAL (Resource & Rule Administration Language) 为 Apache
ShardingSphere 的管
## 强制路由
-| 语句 | 说明
| 示例
|
-|:----------------------------------------------------
|:--------------------------------------------------------------
|:---------------------------------------------- |
-| SET READWRITE_SPLITTING HINT SOURCE = [auto / write] |
针对当前连接，设置读写分离的路由策略（自动路由或强制到写库） | SET READWRITE_SPLITTING HINT
SOURCE = write |
-| SET SHARDING HINT DATABASE_VALUE = yy | 针对当前连接，设置 hint
仅对数据库分片有效，并添加分片值，yy：数据库分片值 | SET SHARDING HINT DATABASE_VALUE = 100 |
+| 语句 | 说明
| 示例
|
+|:----------------------------------------------------
|:-----------------------------------------------------------------
|:----------------------------------------------|
+| SET READWRITE_SPLITTING HINT SOURCE = [auto / write] |
针对当前连接，设置读写分离的路由策略（自动路由或强制到写库） | SET READWRITE_SPLITTING HINT
SOURCE = write |
+| SET SHARDING HINT DATABASE_VALUE = yy | 针对当前连接，设置 hint
仅对数据库分片有效，并添加分片值，yy：数据库分片值 | SET SHARDING HINT DATABASE_VALUE = 100 |
| ADD SHARDING HINT DATABASE_VALUE xx = yy | 针对当前连接，为表 xx 添加分片值
yy，xx：逻辑表名称，yy：数据库分片值 | ADD SHARDING HINT DATABASE_VALUE t_order= 100 |
-| ADD SHARDING HINT TABLE_VALUE xx = yy | 针对当前连接，为表 xx 添加分片值
yy，xx：逻辑表名称，yy：表分片值 | ADD SHARDING HINT TABLE_VALUE t_order = 100 |
-| CLEAR HINT SETTINGS | 针对当前连接，清除 hint 所有设置
| CLEAR HINT
|
-| CLEAR [SHARDING HINT / READWRITE_SPLITTING HINT] | 针对当前连接，清除 sharding 或
readwrite_splitting 的 hint 设置 | CLEAR READWRITE_SPLITTING HINT
|
-| SHOW [SHARDING / READWRITE_SPLITTING] HINT STATUS | 针对当前连接，查询 sharding 或
readwrite_splitting 的 hint 设置 | SHOW READWRITE_SPLITTING HINT STATUS
|
+| ADD SHARDING HINT TABLE_VALUE xx = yy | 针对当前连接，为表 xx 添加分片值
yy，xx：逻辑表名称，yy：表分片值 | ADD SHARDING HINT TABLE_VALUE t_order = 100 |
+| CLEAR HINT | 针对当前连接，清除 hint 所有设置
| CLEAR HINT
|
+| CLEAR [SHARDING HINT / READWRITE_SPLITTING HINT] | 针对当前连接，清除 sharding 或
readwrite_splitting 的 hint 设置 | CLEAR READWRITE_SPLITTING HINT
|
+| SHOW [SHARDING / READWRITE_SPLITTING] HINT STATUS | 针对当前连接，查询 sharding 或
readwrite_splitting 的 hint 设置 | SHOW READWRITE_SPLITTING HINT STATUS
|
## 弹性伸缩
@@ -46,34 +46,34 @@ RAL (Resource & Rule Administration Language) 为 Apache
ShardingSphere 的管
## 全局规则
-| 语句
| 说明
| 示例
[...]
-|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------
[...]
-| SHOW AUTHORITY RULE
| 查询权限规则配置
| SHOW AUTHORITY RULE
[...]
-| SHOW TRANSACTION RULE
| 查询事务规则配置
| SHOW TRANSACTION RULE
[...]
-| SHOW SQL_PARSER RULE
| 查询解析引擎规则配置
| SHOW SQL_PARSER RULE
[...]
-| ALTER TRANSACTION RULE(DEFAULT=xx,TYPE(NAME=xxx,
PROPERTIES("key1"="value1","key2"="value2"...)))
| 更新事务规则配置，`DEFAULT`：默认事务类型，支持 LOCAL、XA、BASE；`NAME`：事务管理器名称，支持
Atomikos、Narayana 和 Bitronix | ALTER TRANSACTION
RULE(DEFAULT=XA,TYPE(NAME=Narayana,
PROPERTIES("databaseName"="jbossts","host"="127.0.0.1")))
[...]
-| ALTER SQL_PARSER RULE SQL_COMMENT_PARSE_ENABLE=xx,
PARSE_TREE_CACHE(INITIAL_CAPACITY=xx, MAXIMUM_SIZE=xx, CONCURRENCY_LEVEL=xx),
SQL_STATEMENT_CACHE(INITIAL_CAPACITY=xxx, MAXIMUM_SIZE=xxx,
CONCURRENCY_LEVEL=xxx) | 更新解析引擎规则配置，`SQL_COMMENT_PARSE_ENABLE`：是否解析 SQL
注释，`PARSE_TREE_CACHE`：语法树本地缓存配置，`SQL_STATEMENT_CACHE`：SQL 语句本地缓存配置项 | ALTER
SQL_PARSER RULE SQL_COMMENT_PARSE_ENABLE=false,
PARSE_TREE_CACHE(INITIAL_CAPACITY=10, MAXIMUM_SIZE=11, CONCURRENCY_LEVEL=1),
SQL_STATEMENT_CACHE(INITIAL_ [...]
+| 语句
| 说明
| 示例
[...]
+|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------
[...]
+| SHOW AUTHORITY RULE
| 查询权限规则配置
| SHOW AUTHORITY RULE
[...]
+| SHOW TRANSACTION RULE
| 查询事务规则配置
| SHOW TRANSACTION RULE
[...]
+| SHOW SQL_PARSER RULE
| 查询解析引擎规则配置
| SHOW SQL_PARSER RULE
[...]
+| ALTER TRANSACTION RULE(DEFAULT=xx,TYPE(NAME=xxx,
PROPERTIES(key1=value1,key2=value2...)))
| 更新事务规则配置，`DEFAULT`：默认事务类型，支持 LOCAL、XA、BASE；`NAME`：事务管理器名称，支持
Atomikos、Narayana 和 Bitronix | ALTER TRANSACTION
RULE(DEFAULT="XA",TYPE(NAME="Narayana",
PROPERTIES("databaseName"="jbossts","host"="127.0.0.1")))
[...]
+| ALTER SQL_PARSER RULE SQL_COMMENT_PARSE_ENABLE=xx,
PARSE_TREE_CACHE(INITIAL_CAPACITY=xx, MAXIMUM_SIZE=xx, CONCURRENCY_LEVEL=xx),
SQL_STATEMENT_CACHE(INITIAL_CAPACITY=xxx, MAXIMUM_SIZE=xxx,
CONCURRENCY_LEVEL=xxx) | 更新解析引擎规则配置，`SQL_COMMENT_PARSE_ENABLE`：是否解析 SQL
注释，`PARSE_TREE_CACHE`：语法树本地缓存配置，`SQL_STATEMENT_CACHE`：SQL 语句本地缓存配置项| ALTER
SQL_PARSER RULE SQL_COMMENT_PARSE_ENABLE=false,
PARSE_TREE_CACHE(INITIAL_CAPACITY=10, MAXIMUM_SIZE=11, CONCURRENCY_LEVEL=1),
SQL_STATEMENT_CACHE(INITIAL_C [...]
## 其他
-| 语句 |
说明
| 示例
|
-|:--------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------|
-| SHOW INSTANCE MODE |
查询当前 proxy 的 mode 配置
| SHOW INSTANCE MODE
|
+| 语句 |
说明
| 示例
|
+|:--------------------------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------|
+| SHOW INSTANCE MODE |
查询当前 proxy 的 mode 配置
| SHOW INSTANCE MODE
|
| COUNT DATABASE RULES [FROM database] |
查询 database 中的规则数量
| COUNT DATABASE RULES
|
| SET VARIABLE proxy_property_name = xx |
proxy_property_name 为 proxy
的[属性配置](/cn/user-manual/shardingsphere-proxy/yaml-config/props/) ，需使用下划线命名 |
SET VARIABLE sql_show = true |
-| SET VARIABLE transaction_type = xx |
修改当前连接的事务类型, 支持 LOCAL，XA，BASE
| SET VARIABLE transaction_type = XA
|
+| SET VARIABLE transaction_type = xx |
修改当前连接的事务类型, 支持 LOCAL，XA，BASE
| SET VARIABLE transaction_type = "XA"
|
| SET VARIABLE agent_plugins_enabled = [TRUE / FALSE] |
设置 agent 插件的启用状态，默认值 false
| SET VARIABLE agent_plugins_enabled = TRUE
|
| SHOW ALL VARIABLES |
查询 proxy 所有的属性配置
| SHOW ALL VARIABLES
|
-| SHOW VARIABLE variable_name |
查询 proxy 属性，需使用下划线命名
| SHOW VARIABLE sql_show
|
+| SHOW VARIABLE variable_name |
查询 proxy 属性，需使用下划线命名
| SHOW VARIABLE sql_show
|
| REFRESH TABLE METADATA |
刷新所有表的元数据
| REFRESH TABLE METADATA
|
| REFRESH TABLE METADATA tableName |
刷新指定表的元数据
| REFRESH TABLE METADATA t_order
|
-| REFRESH TABLE METADATA tableName FROM RESOURCE resourceName |
刷新指定数据源中表的元数据
| REFRESH TABLE METADATA t_order FROM RESOURCE ds_1
|
-| REFRESH TABLE METADATA FROM RESOURCE resourceName SCHEMA schemaName |
刷新指定 schema 中表的元数据，如果 schema 中不存在表，则会删除该 schema
| REFRESH TABLE METADATA FROM RESOURCE ds_1 SCHEMA db_schema |
+| REFRESH TABLE METADATA tableName FROM RESOURCE resourceName |
刷新指定数据源中表的元数据
| REFRESH TABLE METADATA t_order FROM RESOURCE ds_1
|
+| REFRESH TABLE METADATA FROM RESOURCE resourceName SCHEMA schemaName |
刷新指定 schema 中表的元数据，如果 schema 中不存在表，则会删除该 schema
| REFRESH TABLE METADATA FROM RESOURCE ds_1 SCHEMA db_schema |
| SHOW TABLE METADATA tableName [, tableName] ... |
查询表的元数据
| SHOW TABLE METADATA t_order
|
-| EXPORT DATABASE CONFIG [FROM database_name] [, file="file_path"] |
将 database 中的资源和规则配置导出为 YAML 格式
| EXPORT DATABASE CONFIG FROM readwrite_splitting_db
|
-| IMPORT DATABASE CONFIG FILE="file_path" |
将 YAML 中的配置导入到 database 中，仅支持对空库进行导入操作
| IMPORT DATABASE CONFIG FILE = "/xxx/config-sharding.yaml" |
-| SHOW RULES USED RESOURCE resourceName [from database] |
查询 database 中使用指定资源的规则
| SHOW RULES USED RESOURCE ds_0 FROM databaseName
|
+| EXPORT DATABASE CONFIG [FROM database_name] [, file="file_path"] |
将 database 中的资源和规则配置导出为 YAML 格式
| EXPORT DATABASE CONFIG FROM readwrite_splitting_db
|
+| IMPORT DATABASE CONFIG FILE="file_path" |
将 YAML 中的配置导入到 database 中，仅支持对空库进行导入操作
| IMPORT DATABASE CONFIG FILE = "/xxx/config-sharding.yaml" |
+| SHOW RULES USED RESOURCE resourceName [from database] |
查询 database 中使用指定资源的规则
| SHOW RULES USED RESOURCE ds_0 FROM databaseName
|
## 注意事项
-ShardingSphere-Proxy 默认不支持 hint，如需支持，请在 `conf/server.yaml` 中，将 `properties`
的属性 `proxy-hint-enabled` 设置为 true。
+ShardingSphere-Proxy 默认不支持 hint，如需支持，请在 `conf/server.yaml` 中，将 `props` 的属性
`proxy-hint-enabled` 设置为 true。
diff --git
a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/_index.en.md
b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/_index.en.md
index 3d0da2c1f13..b2c8076b705 100644
---
a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/_index.en.md
+++
b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/_index.en.md
@@ -14,7 +14,7 @@ RAL (Resource & Rule Administration Language) responsible for
hint, circuit brea
| SET SHARDING HINT DATABASE_VALUE = yy | For current
connection, set sharding value for database sharding only, yy: sharding value
| SET SHARDING HINT DATABASE_VALUE = 100 |
| ADD SHARDING HINT DATABASE_VALUE xx = yy | For current
connection, add sharding value for table, xx: logic table, yy: database
sharding value | ADD SHARDING HINT DATABASE_VALUE t_order = 100 |
| ADD SHARDING HINT TABLE_VALUE xx = yy | For current
connection, add sharding value for table, xx: logic table, yy: table sharding
value | ADD SHARDING HINT TABLE_VALUE t_order = 100 |
-| CLEAR HINT SETTINGS | For current
connection, clear all hint settings
| CLEAR HINT |
+| CLEAR HINT | For current
connection, clear all hint settings
| CLEAR HINT |
| CLEAR [SHARDING HINT / READWRITE_SPLITTING HINT] | For current
connection, clear hint settings of sharding or readwrite splitting
| CLEAR READWRITE_SPLITTING HINT |
| SHOW [SHARDING / READWRITE_SPLITTING] HINT STATUS | For current
connection, query hint settings of sharding or readwrite splitting
| SHOW READWRITE_SPLITTING HINT STATUS |
@@ -47,11 +47,11 @@ RAL (Resource & Rule Administration Language) responsible
for hint, circuit brea
## Global Rule
| Statement
| Function
| Example
[...]
-|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
|:------------------------------------------------------------- [...]
+|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
|:------------------------------------------------------------- [...]
| SHOW AUTHORITY RULE
| Query authority rule
configuration
| SHOW AUTHORITY RULE
[...]
| SHOW TRANSACTION RULE
| Query transaction rule
configuration
| SHOW TRANSACTION RULE
[...]
| SHOW SQL_PARSER RULE
| Query SQL parser rule
configuration
| SHOW SQL_PARSER RULE
[...]
-| ALTER TRANSACTION RULE(DEFAULT=xx,TYPE(NAME=xxx,
PROPERTIES("key1"="value1","key2"="value2"...)))
| Alter transaction rule configuration, `DEFAULT`: default transaction type,
support LOCAL, XA, BASE; `NAME`: name of transaction manager, support Atomikos,
Narayana and Bitronix | ALTER TRANSACTION
RULE(DEFAULT=XA,TYPE(NAME=Narayana, PROPERT [...]
+| ALTER TRANSACTION RULE(DEFAULT=xx,TYPE(NAME=xxx,
PROPERTIES(key1=value1,key2=value2...)))
| Alter transaction rule configuration, `DEFAULT`: default transaction type,
support LOCAL, XA, BASE; `NAME`: name of transaction manager, support Atomikos,
Narayana and Bitronix | ALTER TRANSACTION
RULE(DEFAULT="XA",TYPE(NAME="Narayana", PRO [...]
| ALTER SQL_PARSER RULE SQL_COMMENT_PARSE_ENABLE=xx,
PARSE_TREE_CACHE(INITIAL_CAPACITY=xx, MAXIMUM_SIZE=xx, CONCURRENCY_LEVEL=xx),
SQL_STATEMENT_CACHE(INITIAL_CAPACITY=xxx, MAXIMUM_SIZE=xxx,
CONCURRENCY_LEVEL=xxx) | Alter SQL parser rule configuration,
`SQL_COMMENT_PARSE_ENABLE`: whether to parse the SQL comment,
`PARSE_TREE_CACHE`: local cache configuration of syntax tree,
`SQL_STATEMENT_CACHE`: local cache of SQL statement | ALTER SQL_PARSER RULE
SQL_COMMENT_PARSE_ENABLE=false, PARSE_T [...]
## Other
@@ -61,7 +61,7 @@ RAL (Resource & Rule Administration Language) responsible for
hint, circuit brea
| SHOW INSTANCE MODE |
Query the mode configuration of the proxy
| SHOW
INSTANCE MODE |
| COUNT DATABASE RULES [FROM database] |
Query the number of rules in a database
| COUNT
DATABASE RULES |
| SET VARIABLE proxy_property_name = xx |
proxy_property_name is one of [properties
configuration](/en/user-manual/shardingsphere-proxy/yaml-config/props/) of
proxy, name is split by underscore | SET VARIABLE sql_show = true
|
-| SET VARIABLE transaction_type = xx |
Modify transaction_type of the current connection, supports LOCAL, XA, BASE
| SET
VARIABLE transaction_type = XA |
+| SET VARIABLE transaction_type = xx |
Modify transaction_type of the current connection, supports LOCAL, XA, BASE
| SET
VARIABLE transaction_type = "XA" |
| SET VARIABLE agent_plugins_enabled = [TRUE / FALSE] |
Set whether the agent plugins are enabled, the default value is false
| SET
VARIABLE agent_plugins_enabled = TRUE |
| SHOW ALL VARIABLES |
Query proxy all properties configuration
| SHOW
ALL VARIABLES |
| SHOW VARIABLE variable_name |
Query proxy variable, name is split by underscore
| SHOW
VARIABLE sql_show |
