This is an automated email from the ASF dual-hosted git repository.
menghaoran 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 d6ee358 Update index of user-manual (#13547)
d6ee358 is described below
commit d6ee35835262edabde596aef99d416b5de5595e6
Author: Liang Zhang <[email protected]>
AuthorDate: Thu Nov 11 00:43:09 2021 +0800
Update index of user-manual (#13547)
* Update index of user-manual
* Update index of user-manual
---
docs/document/content/user-manual/_index.cn.md | 1 -
docs/document/content/user-manual/_index.en.md | 1 -
.../user-manual/shardingsphere-jdbc/_index.cn.md | 26 ++-------------------
.../user-manual/shardingsphere-jdbc/_index.en.md | 27 ++--------------------
.../shardingsphere-jdbc/api/_index.cn.md | 1 -
.../shardingsphere-jdbc/api/_index.en.md | 3 +--
.../shardingsphere-jdbc/configuration/_index.cn.md | 2 ++
.../shardingsphere-jdbc/configuration/_index.en.md | 2 ++
.../user-manual/shardingsphere-proxy/_index.cn.md | 25 ++------------------
.../user-manual/shardingsphere-proxy/_index.en.md | 25 ++------------------
.../shardingsphere-proxy/usage/_index.cn.md | 1 -
.../shardingsphere-proxy/usage/_index.en.md | 3 +--
12 files changed, 14 insertions(+), 103 deletions(-)
diff --git a/docs/document/content/user-manual/_index.cn.md
b/docs/document/content/user-manual/_index.cn.md
index 7e0ee2d..e66385e 100644
--- a/docs/document/content/user-manual/_index.cn.md
+++ b/docs/document/content/user-manual/_index.cn.md
@@ -6,4 +6,3 @@ chapter = true
+++
本章节面向 Apache ShardingSphere 的用户，详细阐述项目的使用说明。
-用户不必通读本章节，可以在需要时当作字典查阅。
diff --git a/docs/document/content/user-manual/_index.en.md
b/docs/document/content/user-manual/_index.en.md
index c28be79..d8cc2f6 100644
--- a/docs/document/content/user-manual/_index.en.md
+++ b/docs/document/content/user-manual/_index.en.md
@@ -6,4 +6,3 @@ chapter = true
+++
This chapter describes how to use projects of Apache ShardingSphere.
-Users do not have to read this chapter through, but can refer to it as a
dictionary when necessary.
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/_index.cn.md
b/docs/document/content/user-manual/shardingsphere-jdbc/_index.cn.md
index 1320b4b..c38083e 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/_index.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/_index.cn.md
@@ -5,27 +5,5 @@ weight = 1
chapter = true
+++
-## 简介
-
-ShardingSphere-JDBC 是 Apache ShardingSphere 的第一个产品，也是 Apache ShardingSphere
的前身。
-定位为轻量级 Java 框架，在 Java 的 JDBC 层提供的额外服务。
-它使用客户端直连数据库，以 jar 包形式提供服务，无需额外部署和依赖，可理解为增强版的 JDBC 驱动，完全兼容 JDBC 和各种 ORM 框架。
-
-* 适用于任何基于 JDBC 的 ORM 框架，如：JPA, Hibernate, Mybatis, Spring JDBC Template 或直接使用
JDBC；
-* 支持任何第三方的数据库连接池，如：DBCP, C3P0, BoneCP, HikariCP 等；
-* 支持任意实现 JDBC 规范的数据库，目前支持 MySQL，PostgreSQL，Oracle，SQLServer 以及任何可使用 JDBC
访问的数据库。
-
-
-
-## 对比
-
-| | *ShardingSphere-JDBC* | *ShardingSphere-Proxy* |
*ShardingSphere-Sidecar* |
-| --------- | --------------------- | ---------------------- |
------------------------ |
-| 数据库 | `任意` | MySQL/PostgreSQL | MySQL/PostgreSQL
|
-| 连接消耗数 | `高` | 低 | 高
|
-| 异构语言 | `仅Java` | 任意 | 任意
|
-| 性能 | `损耗低` | 损耗略高 | 损耗低
|
-| 无中心化 | `是` | 否 | 是
|
-| 静态入口 | `无` | 有 | 无
|
-
-ShardingSphere-JDBC 的优势在于对 Java 应用的友好度。
+本章节面向 ShardingSphere-JDBC 的用户，详细阐述项目的使用说明。
+更多使用细节请参见[使用示例](https://github.com/apache/shardingsphere/tree/master/examples)。
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/_index.en.md
b/docs/document/content/user-manual/shardingsphere-jdbc/_index.en.md
index b51f1b2..cc4d99e 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/_index.en.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/_index.en.md
@@ -5,28 +5,5 @@ weight = 1
chapter = true
+++
-## Introduction
-
-As the first product and the predecessor of Apache ShardingSphere,
-ShardingSphere-JDBC defines itself as a lightweight Java framework that
provides extra service at Java JDBC layer.
-With the client end connecting directly to the database, it provides service
in the form of jar and requires no extra deployment and dependence.
-It can be considered as an enhanced JDBC driver, which is fully compatible
with JDBC and all kinds of ORM frameworks.
-
-* Applicable in any ORM framework based on JDBC, such as JPA, Hibernate,
Mybatis, Spring JDBC Template or direct use of JDBC;
-* Support any third-party database connection pool, such as DBCP, C3P0,
BoneCP, HikariCP;
-* Support any kind of JDBC standard database: MySQL, PostgreSQL, Oracle,
SQLServer and any JDBC adapted databases.
-
-
-
-## Comparison
-
-| | *ShardingSphere-JDBC* | *ShardingSphere-Proxy* |
*ShardingSphere-Sidecar* |
-| ---------------------- | --------------------- | ---------------------- |
------------------------ |
-| Database | `Any` | MySQL/PostgreSQL |
MySQL/PostgreSQL |
-| Connections Count Cost | `More` | Less |
More |
-| Supported Languages | `Java Only` | Any |
Any |
-| Performance | `Low loss` | Relatively High loss |
Low loss |
-| Decentralization | `Yes` | No | No
|
-| Static Entry | `No` | Yes | No
|
-
-ShardingSphere-JDBC is suitable for java application.
+This chapter describes how to use projects of ShardingSphere-JDBC.
+Please refer to
[Example](https://github.com/apache/shardingsphere/tree/master/examples) for
more details.
\ No newline at end of file
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/api/_index.cn.md
b/docs/document/content/user-manual/shardingsphere-jdbc/api/_index.cn.md
index 52377cd..721a288 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/api/_index.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/api/_index.cn.md
@@ -5,4 +5,3 @@ chapter = true
+++
本章节将介绍 ShardingSphere-JDBC 使用 API。
-更多使用细节请参见[使用示例](https://github.com/apache/shardingsphere/tree/master/examples)。
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/api/_index.en.md
b/docs/document/content/user-manual/shardingsphere-jdbc/api/_index.en.md
index 9152c88..108c026 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/api/_index.en.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/api/_index.en.md
@@ -4,5 +4,4 @@ weight = 1
chapter = true
+++
-This chapter will introduce the API of ShardingSphere-JDBC.
-Please refer to
[Example](https://github.com/apache/shardingsphere/tree/master/examples) for
more details.
+This chapter will introduce the API of ShardingSphere-JDBC.
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/configuration/_index.cn.md
b/docs/document/content/user-manual/shardingsphere-jdbc/configuration/_index.cn.md
index a476295..9aa9f3f 100644
---
a/docs/document/content/user-manual/shardingsphere-jdbc/configuration/_index.cn.md
+++
b/docs/document/content/user-manual/shardingsphere-jdbc/configuration/_index.cn.md
@@ -16,3 +16,5 @@ ShardingSphere-JDBC 提供了 4 种配置方式，用于不同的使用场景。
需要注意的是，规则项之间的叠加使用是通过数据源名称和表名称关联的。
如果前一个规则是面向数据源聚合的，下一个规则在配置数据源时，则需要使用前一个规则配置的聚合后的逻辑数据源名称；
同理，如果前一个规则是面向表聚合的，下一个规则在配置表时，则需要使用前一个规则配置的聚合后的逻辑表名称。
+
+用户不必通读本章节，可以在需要时当作字典查阅。
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/configuration/_index.en.md
b/docs/document/content/user-manual/shardingsphere-jdbc/configuration/_index.en.md
index b06f5e0..7b1f95f 100644
---
a/docs/document/content/user-manual/shardingsphere-jdbc/configuration/_index.en.md
+++
b/docs/document/content/user-manual/shardingsphere-jdbc/configuration/_index.en.md
@@ -17,3 +17,5 @@ Mixed rule configurations are very similar to single rule
configuration, except
It should be noted that the superposition between rules are data source and
table name related.
If the previous rule is data source oriented aggregation, the next rule needs
to use the aggregated logical data source name configured by the previous rule
when configuring the data source;
Similarly, if the previous rule is table oriented aggregation, the next rule
needs to use the aggregated logical table name configured by the previous rule
when configuring the table.
+
+Users do not have to read this chapter through, but can refer to it as a
dictionary when necessary.
diff --git
a/docs/document/content/user-manual/shardingsphere-proxy/_index.cn.md
b/docs/document/content/user-manual/shardingsphere-proxy/_index.cn.md
index 8ab174c..c9bce81 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/_index.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/_index.cn.md
@@ -5,26 +5,5 @@ weight = 2
chapter = true
+++
-## 简介
-
-ShardingSphere-Proxy 是 Apache ShardingSphere 的第二个产品。
-它定位为透明化的数据库代理端，提供封装了数据库二进制协议的服务端版本，用于完成对异构语言的支持。
-目前提供 MySQL 和 PostgreSQL（兼容 openGauss 等基于 PostgreSQL 的数据库）版本，它可以使用任何兼容
MySQL/PostgreSQL 协议的访问客户端（如：MySQL Command Client, MySQL Workbench, Navicat
等）操作数据，对 DBA 更加友好。
-
-* 向应用程序完全透明，可直接当做 MySQL/PostgreSQL 使用。
-* 适用于任何兼容 MySQL/PostgreSQL 协议的的客户端。
-
-
-
-## 对比
-
-| | *ShardingSphere-JDBC* | *ShardingSphere-Proxy* |
*ShardingSphere-Sidecar* |
-| --------- | --------------------- | ----------------------- |
------------------------ |
-| 数据库 | 任意 | `MySQL/PostgreSQL` | MySQL/PostgreSQL
|
-| 连接消耗数 | 高 | `低` | 高
|
-| 异构语言 | 仅Java | `任意` | 任意
|
-| 性能 | 损耗低 | `损耗略高` | 损耗低
|
-| 无中心化 | 是 | `否` | 是
|
-| 静态入口 | 无 | `有` | 无
|
-
-ShardingSphere-Proxy 的优势在于对异构语言的支持，以及为 DBA 提供可操作入口。
+本章节面向 ShardingSphere-Proxy 的用户，详细阐述项目的使用说明。
+更多使用细节请参见[使用示例](https://github.com/apache/shardingsphere/tree/master/examples)。
diff --git
a/docs/document/content/user-manual/shardingsphere-proxy/_index.en.md
b/docs/document/content/user-manual/shardingsphere-proxy/_index.en.md
index 2342017..f87899a 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/_index.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/_index.en.md
@@ -5,26 +5,5 @@ weight = 2
chapter = true
+++
-## Introduction
-
-ShardingSphere-Proxy is the second product of Apache ShardingSphere.
-It defines itself as a transparent database proxy, providing a database server
that encapsulates database binary protocol to support heterogeneous languages.
-Currently, MySQL and PostgreSQL (compatible with PostgreSQL-based databases,
such as openGauss) versions are provided. It can use any kind of terminal (such
as MySQL Command Client, MySQL Workbench, etc.) that is compatible of MySQL or
PostgreSQL protocol to operate data, which is friendlier to DBAs
-
-* Totally transparent to applications, it can be used directly as
MySQL/PostgreSQL.
-* Applicable to any kind of client end that is compatible with
MySQL/PostgreSQL protocol.
-
-
-
-## Comparison
-
-| | *ShardingSphere-JDBC* | *ShardingSphere-Proxy*
| *ShardingSphere-Sidecar* |
-| ------------------------ | --------------------- |
---------------------------- | ------------------------ |
-| Database | Any | `MySQL/PostgreSQL`
| MySQL |
-| Connections Count Cost | High | `Low`
| High |
-| Supported Languages | Java Only | `Any`
| Any |
-| Performance | Low loss | `Relatively high loss`
| Low loss |
-| Decentralization | Yes | `No`
| Yes |
-| Static Entry | No | `Yes`
| No |
-
-The advantages of ShardingSphere-Proxy lie in supporting heterogeneous
languages and providing operational entries for DBA.
+This chapter describes how to use projects of ShardingSphere-Proxy.
+Please refer to
[Example](https://github.com/apache/shardingsphere/tree/master/examples) for
more details.
diff --git
a/docs/document/content/user-manual/shardingsphere-proxy/usage/_index.cn.md
b/docs/document/content/user-manual/shardingsphere-proxy/usage/_index.cn.md
index 13831db..ecb8479 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/usage/_index.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/usage/_index.cn.md
@@ -4,4 +4,3 @@ weight = 1
+++
本章节将介绍 ShardingSphere-Proxy 相关使用。
-更多使用细节请参见[使用示例](https://github.com/apache/shardingsphere/tree/master/examples)。
diff --git
a/docs/document/content/user-manual/shardingsphere-proxy/usage/_index.en.md
b/docs/document/content/user-manual/shardingsphere-proxy/usage/_index.en.md
index 8e66388..3eb7be6 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/usage/_index.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/usage/_index.en.md
@@ -3,5 +3,4 @@ title = "Usage"
weight = 1
+++
-This chapter will introduce the use of ShardingSphere-Proxy.
-Please refer to
[Example](https://github.com/apache/shardingsphere/tree/master/examples) for
more details.
+This chapter will introduce the use of ShardingSphere-Proxy.
