This is an automated email from the ASF dual-hosted git repository.
panjuan 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 475f3d5 Refactor proxy/startup document (#13624)
475f3d5 is described below
commit 475f3d534e53677757a9ebefd0040de26440c325
Author: Liang Zhang <[email protected]>
AuthorDate: Mon Nov 15 21:01:05 2021 +0800
Refactor proxy/startup document (#13624)
---
.../{usage => startup}/_index.cn.md | 2 +-
.../{usage => startup}/_index.en.md | 2 +-
.../{usage/startup.cn.md => startup/bin.cn.md} | 8 +-
.../{usage/startup.en.md => startup/bin.en.md} | 8 +-
.../{usage => startup}/docker.cn.md | 4 +-
.../{usage => startup}/docker.en.md | 4 +-
.../shardingsphere-proxy/usage/transaction.cn.md | 98 ----------------------
.../shardingsphere-proxy/usage/transaction.en.md | 90 --------------------
8 files changed, 18 insertions(+), 198 deletions(-)
diff --git
a/docs/document/content/user-manual/shardingsphere-proxy/usage/_index.cn.md
b/docs/document/content/user-manual/shardingsphere-proxy/startup/_index.cn.md
similarity index 81%
rename from
docs/document/content/user-manual/shardingsphere-proxy/usage/_index.cn.md
rename to
docs/document/content/user-manual/shardingsphere-proxy/startup/_index.cn.md
index 5c82a07..b86db82 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/usage/_index.cn.md
+++
b/docs/document/content/user-manual/shardingsphere-proxy/startup/_index.cn.md
@@ -1,5 +1,5 @@
+++
-title = "操作手册"
+title = "启动手册"
weight = 1
+++
diff --git
a/docs/document/content/user-manual/shardingsphere-proxy/usage/_index.en.md
b/docs/document/content/user-manual/shardingsphere-proxy/startup/_index.en.md
similarity index 84%
rename from
docs/document/content/user-manual/shardingsphere-proxy/usage/_index.en.md
rename to
docs/document/content/user-manual/shardingsphere-proxy/startup/_index.en.md
index b082428..f84ac64 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/usage/_index.en.md
+++
b/docs/document/content/user-manual/shardingsphere-proxy/startup/_index.en.md
@@ -1,5 +1,5 @@
+++
-title = "Usage"
+title = "Startup"
weight = 1
+++
diff --git
a/docs/document/content/user-manual/shardingsphere-proxy/usage/startup.cn.md
b/docs/document/content/user-manual/shardingsphere-proxy/startup/bin.cn.md
similarity index 91%
rename from
docs/document/content/user-manual/shardingsphere-proxy/usage/startup.cn.md
rename to
docs/document/content/user-manual/shardingsphere-proxy/startup/bin.cn.md
index 89e8591..f8fa33a 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/usage/startup.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/startup/bin.cn.md
@@ -1,5 +1,5 @@
+++
-title = "启动"
+title = "使用二进制发布包"
weight = 1
+++
@@ -8,7 +8,6 @@ weight = 1
1. 下载 ShardingSphere-Proxy 的最新发行版。
1. 解压缩后修改 `conf/server.yaml` 和以 `config-` 前缀开头的文件，如：`conf/config-xxx.yaml`
文件，进行分片规则、读写分离规则配置。配置方式请参考[配置手册](/cn/user-manual/shardingsphere-proxy/configuration/)。
1. Linux 操作系统请运行 `bin/start.sh`，Windows 操作系统请运行 `bin/start.bat` 启动
ShardingSphere-Proxy。如需配置启动端口、配置文件位置，可参考[快速入门](/cn/quick-start/shardingsphere-proxy-quick-start/)。
-1. 使用 docker 请参考[Docker镜像](/cn/user-manual/shardingsphere-proxy/docker/)。
## 选择数据库协议
@@ -36,6 +35,11 @@ weight = 1
1. 将 Etcd 的客户端驱动程序复制至目录 `ext-lib/`。
+## 使用分布式事务
+
+与 ShardingSphere-JDBC 使用方式相同。
+具体可参考[分布式事务](/cn/user-manual/shardingsphere-jdbc/special-api/transaction/)。
+
## 使用自定义算法
当用户需要使用自定义的算法类时，可通过以下方式配置使用自定义算法，以分片为例：
diff --git
a/docs/document/content/user-manual/shardingsphere-proxy/usage/startup.en.md
b/docs/document/content/user-manual/shardingsphere-proxy/startup/bin.en.md
similarity index 91%
rename from
docs/document/content/user-manual/shardingsphere-proxy/usage/startup.en.md
rename to
docs/document/content/user-manual/shardingsphere-proxy/startup/bin.en.md
index ba44046..8da8b44 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/usage/startup.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/startup/bin.en.md
@@ -1,5 +1,5 @@
+++
-title = "Startup"
+title = "Use Binary Tar"
weight = 1
+++
@@ -8,7 +8,6 @@ weight = 1
1. Download the latest version of ShardingSphere-Proxy.
1. After the decompression, revise `conf/server.yaml` and documents begin with
`config-` prefix, `conf/config-xxx.yaml` for example, to configure sharding
rules and readwrite-splitting rules. Please refer to [Configuration
Manual](/en/user-manual/shardingsphere-proxy/configuration/) for the
configuration method.
1. Please run `bin/start.sh` for Linux operating system; run `bin/start.bat`
for Windows operating system to start ShardingSphere-Proxy. To configure start
port and document location, please refer to [Quick
Start](/en/quick-start/shardingsphere-proxy-quick-start/).
-1. Using docker please refer to [Docker
Image](/en/user-manual/shardingsphere-proxy/docker/) for more details.
## Using database protocol
@@ -36,6 +35,11 @@ Default integration.
1. Copy Etcd's client driver to folder `ext-lib/`.
+## Using Distributed Transaction
+
+Same with ShardingSphere-JDBC.
+please refer to [Distributed
Transaction](/en/user-manual/shardingsphere-jdbc/special-api/transaction/) for
more details.
+
## Using user-defined algorithm
When developer need to use user-defined algorithm, should use the way below to
configure algorithm, use sharding algorithm as example.
diff --git
a/docs/document/content/user-manual/shardingsphere-proxy/usage/docker.cn.md
b/docs/document/content/user-manual/shardingsphere-proxy/startup/docker.cn.md
similarity index 98%
rename from
docs/document/content/user-manual/shardingsphere-proxy/usage/docker.cn.md
rename to
docs/document/content/user-manual/shardingsphere-proxy/startup/docker.cn.md
index bf855fd..bb8ba78 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/usage/docker.cn.md
+++
b/docs/document/content/user-manual/shardingsphere-proxy/startup/docker.cn.md
@@ -1,6 +1,6 @@
+++
-title = "Docker 镜像"
-weight = 3
+title = "使用 Docker"
+weight = 2
+++
## 拉取官方 Docker 镜像
diff --git
a/docs/document/content/user-manual/shardingsphere-proxy/usage/docker.en.md
b/docs/document/content/user-manual/shardingsphere-proxy/startup/docker.en.md
similarity index 98%
rename from
docs/document/content/user-manual/shardingsphere-proxy/usage/docker.en.md
rename to
docs/document/content/user-manual/shardingsphere-proxy/startup/docker.en.md
index dae3f28..03ee7d4 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/usage/docker.en.md
+++
b/docs/document/content/user-manual/shardingsphere-proxy/startup/docker.en.md
@@ -1,6 +1,6 @@
+++
-title = "Docker Image"
-weight = 3
+title = "Use Docker"
+weight = 2
+++
## Pull Official Docker Image
diff --git
a/docs/document/content/user-manual/shardingsphere-proxy/usage/transaction.cn.md
b/docs/document/content/user-manual/shardingsphere-proxy/usage/transaction.cn.md
deleted file mode 100644
index 759ee2e..0000000
---
a/docs/document/content/user-manual/shardingsphere-proxy/usage/transaction.cn.md
+++ /dev/null
@@ -1,98 +0,0 @@
-+++
-title = "分布式事务"
-weight = 2
-+++
-
-ShardingSphere-Proxy 接入的分布式事务 API 同 ShardingSphere-JDBC 保持一致，支持 LOCAL，XA，BASE
类型的事务。
-
-## XA 事务
-
-* ShardingSphere-Proxy 原生支持 XA 事务，默认的事务管理器为 Atomikos。
-可以通过在 ShardingSphere-Proxy 的 `conf` 目录中添加 `jta.properties` 来定制化 Atomikos 配置项。
-具体的配置规则请参考 Atomikos
的[官方文档](https://www.atomikos.com/Documentation/JtaProperties)。
-
-* 使用 Narayana事务管理器，需要参考以下步骤。
-
-1. 将 Narayana 所需 jar 拷贝至 `/lib` 目录。参考如下：
-
-```xml
-<properties>
- <narayana.version>5.9.1.Final</narayana.version>
- <jboss-transaction-spi.version>7.6.0.Final</jboss-transaction-spi.version>
- <jboss-logging.version>3.2.1.Final</jboss-logging.version>
-</properties>
-
-<dependency>
- <groupId>org.apache.shardingsphere</groupId>
- <artifactId>shardingsphere-transaction-xa-narayana</artifactId>
- <version>${shardingsphere.version}</version>
-</dependency>
-<dependency>
- <groupId>org.jboss.narayana.jta</groupId>
- <artifactId>jta</artifactId>
- <version>${narayana.version}</version>
-</dependency>
-<dependency>
- <groupId>org.jboss.narayana.jts</groupId>
- <artifactId>narayana-jts-integration</artifactId>
- <version>${narayana.version}</version>
-</dependency>
-<dependency>
- <groupId>org.jboss</groupId>
- <artifactId>jboss-transaction-spi</artifactId>
- <version>${jboss-transaction-spi.version}</version>
-</dependency>
-<dependency>
- <groupId>org.jboss.logging</groupId>
- <artifactId>jboss-logging</artifactId>
- <version>${jboss-logging.version}</version>
-</dependency>
-```
-
-2. 在 `conf/server.yaml` 中加入如下配置：
-
-```yaml
-- !TRANSACTION
- defaultType: XA
- providerType: Narayana
-```
-
-3. 新增 `jbossts-properties.xml` 文件来定制化 Narayana 配置项，它的加载路径顺序：`user.dir (pwd)` >
`user.home` > `java.home` > `classpath`。
-详情请参见[Narayana官方文档](https://narayana.io/documentation/index.html)。
-
-* 使用 Bitronix事务管理器，需要参考以下步骤。
-
-1. 将 Bitronix 所需 jar 拷贝至 `/lib` 目录。参考如下：
-
-```xml
-<properties>
- <btm.version>2.1.3</btm.version>
-</properties>
-
-<dependency>
- <groupId>org.apache.shardingsphere</groupId>
- <artifactId>shardingsphere-transaction-xa-bitronix</artifactId>
- <version>${shardingsphere.version}</version>
-</dependency>
-
-<dependency>
- <groupId>org.codehaus.btm</groupId>
- <artifactId>btm</artifactId>
- <version>${btm.version}</version>
-</dependency>
-```
-
-2. 在 `conf/server.yaml` 中加入如下配置：
-
-```yaml
-- !TRANSACTION
- defaultType: XA
- providerType: Bitronix
-```
-
-3. Bitronix 配置详情请参见[Bitronix官方文档](https://github.com/bitronix/btm/wiki)。
-
-
-## BASE 事务
-
-BASE 目前没有集成至 ShardingSphere-Proxy 的二进制发布包中，使用时需要将实现了
`ShardingSphereTransactionManager` SPI 的 jar 拷贝至 `conf/lib` 目录，然后切换事务类型为 BASE。
diff --git
a/docs/document/content/user-manual/shardingsphere-proxy/usage/transaction.en.md
b/docs/document/content/user-manual/shardingsphere-proxy/usage/transaction.en.md
deleted file mode 100644
index d2ce849..0000000
---
a/docs/document/content/user-manual/shardingsphere-proxy/usage/transaction.en.md
+++ /dev/null
@@ -1,90 +0,0 @@
-+++
-title = "Distributed Transaction"
-weight = 2
-+++
-
-ShardingSphere-Proxy supports LOCAL, XA, BASE transactions, LOCAL transaction
is default value, it is original transaction of relational database.
-
-## XA transaction
-
-Default XA transaction manager of ShardingSphere is Atomikos. Users can
customize Atomikos configuration items through adding `jta.properties` in conf
catalog of ShardingSphere-Proxy. Please refer to [Official
Documents](https://www.atomikos.com/Documentation/JtaProperties) of Atomikos
for detailed configurations.
-
-* Use Narayana XA Transaction Manager。
-
-1. Copy the jar file required by Narayana to `conf/lib`. The reference package
is as follows:
-
-```xml
-<properties>
- <narayana.version>5.9.1.Final</narayana.version>
- <jboss-transaction-spi.version>7.6.0.Final</jboss-transaction-spi.version>
- <jboss-logging.version>3.2.1.Final</jboss-logging.version>
-</properties>
-<dependency>
- <groupId>org.jboss.narayana.jta</groupId>
- <artifactId>jta</artifactId>
- <version>${narayana.version}</version>
-</dependency>
-<dependency>
- <groupId>org.jboss.narayana.jts</groupId>
- <artifactId>narayana-jts-integration</artifactId>
- <version>${narayana.version}</version>
-</dependency>
-<dependency>
- <groupId>org.jboss</groupId>
- <artifactId>jboss-transaction-spi</artifactId>
- <version>${jboss-transaction-spi.version}</version>
-</dependency>
-<dependency>
- <groupId>org.jboss.logging</groupId>
- <artifactId>jboss-logging</artifactId>
- <version>${jboss-logging.version}</version>
-</dependency>
-```
-
-2. Configure `xa-transaction-manager-type` in `conf/server.yaml`：
-
-```yaml
-- !TRANSACTION
- defaultType: XA
- providerType: Narayana
-```
-
-3. Add `jbossts-properties.xml` to customize Narayana configuration.
-The order of path loading is` user.dir (pwd)` > `user.home` > `java.home` >
`classpath`.
-Please refer to [Narayana official
documentation](https://narayana.io/documentation/index.html) for more details.
-
-* Use Bitronix XA Transaction Manager。
-
-1. Copy the jar file required by Bitronix to `conf/lib`. The reference package
is as follows:
-
-```xml
-<properties>
- <btm.version>2.1.3</btm.version>
-</properties>
-
-<dependency>
- <groupId>org.apache.shardingsphere</groupId>
- <artifactId>shardingsphere-transaction-xa-bitronix</artifactId>
- <version>${shardingsphere.version}</version>
-</dependency>
-
-<dependency>
- <groupId>org.codehaus.btm</groupId>
- <artifactId>btm</artifactId>
- <version>${btm.version}</version>
-</dependency>
-```
-
-2. Configure `xa-transaction-manager-type` in `conf/server.yaml`：
-
-```yaml
-- !TRANSACTION
- defaultType: XA
- providerType: Bitronix
-```
-
-3. Please refer to [Bitronix official
documentation](https://github.com/bitronix/btm/wiki) for more details.
-
-## BASE Transaction
-
-Since we have not packed the BASE implementation jar into
ShardingSphere-Proxy, you should copy relevant jar which implement
`ShardingSphereTransactionManager` SPI to `conf/lib`, then switch the
transaction type to `BASE`.
