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 5518f583e0a Fix doc (#21145)
5518f583e0a is described below
commit 5518f583e0afee425e8a6b415c587ff27a1ae97d
Author: Qianyi951015 <[email protected]>
AuthorDate: Mon Sep 26 00:50:07 2022 +1300
Fix doc (#21145)
* correction RAL example
* Supplement the documentation of the distributed transaction dependency
* Delete RAL example
---
.../distsql/syntax/ral/_index.cn.md | 2 +-
.../distsql/syntax/ral/_index.en.md | 4 ++--
.../add_Bitronix_dependency.cn.md | 9 +++++++++
.../add_Bitronix_dependency.en.md | 9 +++++++++
.../add_Narayana_dependency.cn.md | 23 ++++++++++++++++++++++
.../add_Narayana_dependency.en.md | 23 ++++++++++++++++++++++
6 files changed, 67 insertions(+), 3 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 b422fb29a86..6291972d0d5 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
@@ -49,7 +49,7 @@ 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 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 [...]
## 其他
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 4e9aa54c608..16da8585c7e 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
@@ -45,11 +45,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", PRO [...]
+| 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
diff --git
a/docs/document/content/user-manual/shardingsphere-proxy/startup/dependencies-download/add_Bitronix_dependency.cn.md
b/docs/document/content/user-manual/shardingsphere-proxy/startup/dependencies-download/add_Bitronix_dependency.cn.md
new file mode 100644
index 00000000000..64ba25b145c
--- /dev/null
+++
b/docs/document/content/user-manual/shardingsphere-proxy/startup/dependencies-download/add_Bitronix_dependency.cn.md
@@ -0,0 +1,9 @@
+## 添加 Bitronix 依赖包
+
+添加 Bitronix 依赖需要下载以下 .jar 文件并将其添加 `ext-lib` 目录下
+
+
+### .jar 文件下载地址：
+-
[btm-2.1.3.jar](https://repo1.maven.org/maven2/org/codehaus/btm/btm/2.1.3/btm-2.1.3.jar)
+-
[shardingsphere-transaction-xa-bitronix.jar](https://mvnrepository.com/artifact/org.apache.shardingsphere/shardingsphere-transaction-xa-bitronix)
+请根据 `proxy` 版本下载对应 `shardingsphere-transaction-xa-bitronix.jar` 文件
diff --git
a/docs/document/content/user-manual/shardingsphere-proxy/startup/dependencies-download/add_Bitronix_dependency.en.md
b/docs/document/content/user-manual/shardingsphere-proxy/startup/dependencies-download/add_Bitronix_dependency.en.md
new file mode 100644
index 00000000000..3866d8b6f57
--- /dev/null
+++
b/docs/document/content/user-manual/shardingsphere-proxy/startup/dependencies-download/add_Bitronix_dependency.en.md
@@ -0,0 +1,9 @@
+## Add Bitronix dependencies
+
+Adding Bitronix dependencies requires downloading the following .jar files and
adding them under `ext-lib` path
+
+
+### .jar file downloads：
+-
[btm-2.1.3.jar](https://repo1.maven.org/maven2/org/codehaus/btm/btm/2.1.3/btm-2.1.3.jar)
+-
[shardingsphere-transaction-xa-bitronix.jar](https://mvnrepository.com/artifact/org.apache.shardingsphere/shardingsphere-transaction-xa-bitronix)
+Please download the corresponding `shardingsphere-transaction-xa-bitronix.jar`
file according to the `proxy` version
diff --git
a/docs/document/content/user-manual/shardingsphere-proxy/startup/dependencies-download/add_Narayana_dependency.cn.md
b/docs/document/content/user-manual/shardingsphere-proxy/startup/dependencies-download/add_Narayana_dependency.cn.md
new file mode 100644
index 00000000000..3a0772ee931
--- /dev/null
+++
b/docs/document/content/user-manual/shardingsphere-proxy/startup/dependencies-download/add_Narayana_dependency.cn.md
@@ -0,0 +1,23 @@
+## 添加 Narayana 依赖包
+
+添加 Narayana 依赖需要下载以下 .jar 文件并将其添加至 `ext-lib` 下
+
+
+### .jar 文件下载地址：
+-
[arjuna-5.12.4.Final.jar](https://repo1.maven.org/maven2/org/jboss/narayana/arjunacore/arjuna/5.12.4.Final/arjuna-5.12.4.Final.jar)
+-
[common-5.12.4.Final.jar](https://repo1.maven.org/maven2/org/jboss/narayana/common/5.12.4.Final/common-5.12.4.Final.jar)
+-
[javax.activation-api-1.2.0.jar](https://repo1.maven.org/maven2/javax/activation/javax.activation-api/1.2.0/javax.activation-api-1.2.0.jar)
+-
[jaxb-api-2.3.0.jar](https://repo1.maven.org/maven2/javax/xml/bind/jaxb-api/2.3.0/jaxb-api-2.3.0.jar)
+-
[jaxb-core-2.3.0.jar](https://repo1.maven.org/maven2/com/sun/xml/bind/jaxb-core/2.3.0/jaxb-core-2.3.0.jar)
+-
[jaxb-impl-2.3.0.jar](https://repo1.maven.org/maven2/com/sun/xml/bind/jaxb-impl/2.3.0/jaxb-impl-2.3.0.jar)
+-
[jboss-connector-api_1.7_spec-1.0.0.Final.jar](https://repo1.maven.org/maven2/org/jboss/spec/javax/resource/jboss-connector-api_1.7_spec/1.0.0.Final/jboss-connector-api_1.7_spec-1.0.0.Final.jar)
+-
[jboss-logging-3.2.1.Final.jar](https://repo1.maven.org/maven2/org/jboss/logging/jboss-logging/3.2.1.Final/jboss-logging-3.2.1.Final.jar)
+-
[jboss-transaction-api_1.2_spec-1.0.0.Alpha3.jar](https://repo1.maven.org/maven2/org/jboss/spec/javax/transaction/jboss-transaction-api_1.2_spec/1.0.0.Alpha3/jboss-transaction-api_1.2_spec-1.0.0.Alpha3.jar)
+-
[jboss-transaction-spi-7.6.0.Final.jar](https://repo1.maven.org/maven2/org/jboss/jboss-transaction-spi/7.6.0.Final/jboss-transaction-spi-7.6.0.Final.jar)
+-
[jta-5.12.4.Final.jar](https://repo1.maven.org/maven2/org/jboss/narayana/jta/jta/5.12.4.Final/jta-5.12.4.Final.jar)
+-
[narayana-jts-integration-5.12.4.Final.jar](https://repo1.maven.org/maven2/org/jboss/narayana/jts/narayana-jts-integration/5.12.4.Final/narayana-jts-integration-5.12.4.Final.jar)
+-
[shardingsphere-transaction-xa-narayana.jar](https://mvnrepository.com/artifact/org.apache.shardingsphere/shardingsphere-transaction-xa-narayana)
+请根据 `proxy` 版本下载对应 `shardingsphere-transaction-xa-narayana.jar` 文件
+
+
+
diff --git
a/docs/document/content/user-manual/shardingsphere-proxy/startup/dependencies-download/add_Narayana_dependency.en.md
b/docs/document/content/user-manual/shardingsphere-proxy/startup/dependencies-download/add_Narayana_dependency.en.md
new file mode 100644
index 00000000000..6b0c1aaa879
--- /dev/null
+++
b/docs/document/content/user-manual/shardingsphere-proxy/startup/dependencies-download/add_Narayana_dependency.en.md
@@ -0,0 +1,23 @@
+## Add Narayana dependencies
+
+Adding Narayana dependencies requires downloading the following .jar files and
adding them under `ext-lib` path
+
+
+### .jar file downloads：
+-
[arjuna-5.12.4.Final.jar](https://repo1.maven.org/maven2/org/jboss/narayana/arjunacore/arjuna/5.12.4.Final/arjuna-5.12.4.Final.jar)
+-
[common-5.12.4.Final.jar](https://repo1.maven.org/maven2/org/jboss/narayana/common/5.12.4.Final/common-5.12.4.Final.jar)
+-
[javax.activation-api-1.2.0.jar](https://repo1.maven.org/maven2/javax/activation/javax.activation-api/1.2.0/javax.activation-api-1.2.0.jar)
+-
[jaxb-api-2.3.0.jar](https://repo1.maven.org/maven2/javax/xml/bind/jaxb-api/2.3.0/jaxb-api-2.3.0.jar)
+-
[jaxb-core-2.3.0.jar](https://repo1.maven.org/maven2/com/sun/xml/bind/jaxb-core/2.3.0/jaxb-core-2.3.0.jar)
+-
[jaxb-impl-2.3.0.jar](https://repo1.maven.org/maven2/com/sun/xml/bind/jaxb-impl/2.3.0/jaxb-impl-2.3.0.jar)
+-
[jboss-connector-api_1.7_spec-1.0.0.Final.jar](https://repo1.maven.org/maven2/org/jboss/spec/javax/resource/jboss-connector-api_1.7_spec/1.0.0.Final/jboss-connector-api_1.7_spec-1.0.0.Final.jar)
+-
[jboss-logging-3.2.1.Final.jar](https://repo1.maven.org/maven2/org/jboss/logging/jboss-logging/3.2.1.Final/jboss-logging-3.2.1.Final.jar)
+-
[jboss-transaction-api_1.2_spec-1.0.0.Alpha3.jar](https://repo1.maven.org/maven2/org/jboss/spec/javax/transaction/jboss-transaction-api_1.2_spec/1.0.0.Alpha3/jboss-transaction-api_1.2_spec-1.0.0.Alpha3.jar)
+-
[jboss-transaction-spi-7.6.0.Final.jar](https://repo1.maven.org/maven2/org/jboss/jboss-transaction-spi/7.6.0.Final/jboss-transaction-spi-7.6.0.Final.jar)
+-
[jta-5.12.4.Final.jar](https://repo1.maven.org/maven2/org/jboss/narayana/jta/jta/5.12.4.Final/jta-5.12.4.Final.jar)
+-
[narayana-jts-integration-5.12.4.Final.jar](https://repo1.maven.org/maven2/org/jboss/narayana/jts/narayana-jts-integration/5.12.4.Final/narayana-jts-integration-5.12.4.Final.jar)
+-
[shardingsphere-transaction-xa-narayana.jar](https://mvnrepository.com/artifact/org.apache.shardingsphere/shardingsphere-transaction-xa-narayana)
+Please download the corresponding `shardingsphere-transaction-xa-narayana.jar`
file according to the `proxy` version
+
+
+
