You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by wu...@apache.org on 2021/09/12 17:02:03 UTC
[shardingsphere] branch master updated: Update readme (#12384)
This is an automated email from the ASF dual-hosted git repository.
wuweijie 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 aa793bd Update readme (#12384)
aa793bd is described below
commit aa793bd217702e6b032675855034d03931b3e7b5
Author: Liang Zhang <te...@163.com>
AuthorDate: Mon Sep 13 01:01:30 2021 +0800
Update readme (#12384)
* Update readme
* Update readme
---
README.md | 40 +++++++++++----------
README_ZH.md | 41 +++++++++++----------
docs/document/content/overview/_index.cn.md | 42 ++++++++++++----------
docs/document/content/overview/_index.en.md | 39 +++++++++++---------
.../user-manual/shardingsphere-proxy/_index.cn.md | 2 +-
5 files changed, 92 insertions(+), 72 deletions(-)
diff --git a/README.md b/README.md
index cd11bd7..fa1e507 100644
--- a/README.md
+++ b/README.md
@@ -36,8 +36,6 @@ Apache ShardingSphere is positioned as `Database Plus`, which aims to build crit
It focuses on how to reuse existing database, rather than creating a new database.
ShardingSphere focus on the upper layer of databases, pays more attention on cooperation between databases rather than database itself.
-As the cornerstone of enterprises, the relational database has a huge market share. Therefore, we prefer to focus on its incrementation instead of a total overturn.
-
`Link`, `Enhance` and `Pluggable` is the core concepts of Apache ShardingSphere.
- `Link`：Flexible adaptation of database protocol, SQL dialect and database storage, it can link applications and multi-mode heterogeneous databases quickly;
@@ -54,6 +52,8 @@ Apache ShardingSphere including 3 independent products: JDBC, Proxy & Sidecar (P
They all provide functions of data scale-out, distributed transaction and distributed governance,
applicable in a variety of situations such as Java isomorphism, heterogeneous language and Cloud-Native.
+As the cornerstone of enterprises, the relational database has a huge market share. Therefore, we prefer to focus on its incrementation instead of a total overturn.
+
### ShardingSphere-JDBC
[](https://mvnrepository.com/artifact/org.apache.shardingsphere/shardingsphere-jdbc)
@@ -104,28 +104,32 @@ ShardingSphere is an ecosystem consisting of multiple endpoints together. Throug
-## Features
+## Solution
+
+### Distributed Database
+
+* Data Sharding
+* Readwrite-splitting
+* Distributed Transaction
+* Elastic Scale-out
+* Distributed Highly Available
-### Data Sharding
+### Data Security
-* Database sharding & Table sharding
-* Replica query
-* Sharding strategy customization
-* Centre-less Distributed primary key
+* Data Encrypt
+* Row Authority (TODO)
+* SQL Audit (TODO)
+* SQL Firewall (TODO)
-### Distributed Transaction
+### Database Gateway
-* Unified Transaction API
-* XA transaction
-* BASE transaction
+* Multi-model Databases supported
+* SQL Dialect Translate（TODO）
-### Database Governance
+### Stress Testing
-* Distributed Governance
-* Data migration & Scale-out
-* Observability(Tracing/Metrics) Supported
-* Data Encryption&Decryption
-* Shadow Table for Performance Testing
+* Shadow Database
+* Observability (Tracing and Metrics)
## How to Build
diff --git a/README_ZH.md b/README_ZH.md
index d85062d..7e2915a 100644
--- a/README_ZH.md
+++ b/README_ZH.md
@@ -34,8 +34,6 @@
Apache ShardingSphere 产品定位为 `Database Plus`，旨在构建多模数据库上层的标准和生态。
它关注如何充分合理地利用数据库的计算和存储能力，而并非实现一个全新的数据库。ShardingSphere 站在数据库的上层视角，关注他们之间的协作多于数据库自身。
-关系型数据库当今依然占有巨大市场份额，是企业核心系统的基石，未来也难于撼动，我们更加注重在原有基础上提供增量，而非颠覆。
-
`连接`、`增量`和`可插拔`是 Apache ShardingSphere 的核心概念。
- `连接`：通过对数据库协议、SQL 方言以及数据库存储的灵活适配，快速的连接应用与多模式的异构数据库；
@@ -50,6 +48,8 @@ ShardingSphere 已于 2020 年 4 月 16 日成为 [Apache 软件基金会](https
Apache ShardingSphere 由 JDBC、Proxy 和 Sidecar（规划中）这 3 款既能够独立部署，又支持混合部署配合使用的产品组成。
它们均提供标准化的基于数据库作为存储节点的增量功能，可适用于如 Java 同构、异构语言、云原生等各种多样化的应用场景。
+关系型数据库当今依然占有巨大市场份额，是企业核心系统的基石，未来也难于撼动，我们更加注重在原有基础上提供增量，而非颠覆。
+
### ShardingSphere-JDBC
[](https://mvnrepository.com/artifact/org.apache.shardingsphere/shardingsphere-jdbc)
@@ -69,7 +69,7 @@ Apache ShardingSphere 由 JDBC、Proxy 和 Sidecar（规划中）这 3 款既能
[](https://store.docker.com/community/images/apache/sharding-proxy)
定位为透明化的数据库代理端，提供封装了数据库二进制协议的服务端版本，用于完成对异构语言的支持。
-目前提供 MySQL 和 PostgreSQL 版本，它可以使用任何兼容 MySQL/PostgreSQL 协议的访问客户端(如：MySQL Command Client, MySQL Workbench, Navicat 等)操作数据，对 DBA 更加友好。
+目前提供 MySQL 和 PostgreSQL 版本，它可以使用任何兼容 MySQL/PostgreSQL 协议的访问客户端（如：MySQL Command Client, MySQL Workbench, Navicat 等）操作数据，对 DBA 更加友好。
* 向应用程序完全透明，可直接当做 MySQL/PostgreSQL 服务端使用。
* 适用于任何兼容 MySQL/PostgreSQL 协议的的客户端。
@@ -97,35 +97,40 @@ Database Mesh 的关注重点在于如何将分布式的数据访问应用与数
### 混合架构
-ShardingSphere-JDBC 采用无中心化架构，适用于 Java 开发的高性能的轻量级 OLTP 应用；ShardingSphere-Proxy 提供静态入口以及异构语言的支持，适用于 OLAP 应用以及对分片数据库进行管理和运维的场景。
+ShardingSphere-JDBC 采用无中心化架构，与应用程序共享资源，适用于 Java 开发的高性能的轻量级 OLTP 应用；
+ShardingSphere-Proxy 提供静态入口以及异构语言的支持，独立于应用程序部署，适用于 OLAP 应用以及对分片数据库进行管理和运维的场景。
Apache ShardingSphere 是多接入端共同组成的生态圈。
通过混合使用 ShardingSphere-JDBC 和 ShardingSphere-Proxy，并采用同一注册中心统一配置分片策略，能够灵活的搭建适用于各种场景的应用系统，使得架构师更加自由地调整适合与当前业务的最佳系统架构。
-## 功能列表
+## 解决方案
-### 数据分片
+### 分布式数据库
-* 分库 & 分表
+* 数据分片
* 读写分离
-* 分片策略定制化
-* 无中心化分布式主键
+* 分布式事务
+* 弹性伸缩
+* 分布式高可用
-### 分布式事务
+### 数据安全
-* 标准化事务接口
-* XA 强一致事务
-* 柔性事务
+* 数据加密
+* 行级权限（TODO）
+* SQL 审计（TODO）
+* SQL 防火墙（TODO）
-### 数据库治理
+### 数据库网关
-* 分布式治理
-* 弹性伸缩
+* 异构数据库支持
+* SQL 方言转换（TODO）
+
+### 全链路压测
+
+* 影子库
* 可观测性（分布式跟踪、指标度量）
-* 数据加解密
-* 影子表压测
## 如何构建
diff --git a/docs/document/content/overview/_index.cn.md b/docs/document/content/overview/_index.cn.md
index b36bce4..9ede21a 100644
--- a/docs/document/content/overview/_index.cn.md
+++ b/docs/document/content/overview/_index.cn.md
@@ -21,8 +21,6 @@ chapter = true
Apache ShardingSphere 产品定位为 `Database Plus`，旨在构建多模数据库上层的标准和生态。
它关注如何充分合理地利用数据库的计算和存储能力，而并非实现一个全新的数据库。ShardingSphere 站在数据库的上层视角，关注他们之间的协作多于数据库自身。
-关系型数据库当今依然占有巨大市场份额，是企业核心系统的基石，未来也难于撼动，我们更加注重在原有基础上提供增量，而非颠覆。
-
`连接`、`增量`和`可插拔`是 Apache ShardingSphere 的核心概念。
- `连接`：通过对数据库协议、SQL 方言以及数据库存储的灵活适配，快速的连接应用与多模式的异构数据库；
@@ -54,6 +52,8 @@ ShardingSphere 已于2020年4月16日成为 [Apache 软件基金会](https://apa
Apache ShardingSphere 由 JDBC、Proxy 和 Sidecar（规划中）这 3 款既能够独立部署，又支持混合部署配合使用的产品组成。
它们均提供标准化的基于数据库作为存储节点的增量功能，可适用于如 Java 同构、异构语言、云原生等各种多样化的应用场景。
+关系型数据库当今依然占有巨大市场份额，是企业核心系统的基石，未来也难于撼动，我们更加注重在原有基础上提供增量，而非颠覆。
+
### ShardingSphere-JDBC
[](https://mvnrepository.com/artifact/org.apache.shardingsphere/shardingsphere-jdbc)
@@ -73,7 +73,7 @@ Apache ShardingSphere 由 JDBC、Proxy 和 Sidecar（规划中）这 3 款既能
[](https://store.docker.com/community/images/apache/sharding-proxy)
定位为透明化的数据库代理端，提供封装了数据库二进制协议的服务端版本，用于完成对异构语言的支持。
-目前提供 MySQL 和 PostgreSQL 版本，它可以使用任何兼容 MySQL/PostgreSQL 协议的访问客户端(如：MySQL Command Client, MySQL Workbench, Navicat 等)操作数据，对 DBA 更加友好。
+目前提供 MySQL 和 PostgreSQL 版本，它可以使用任何兼容 MySQL/PostgreSQL 协议的访问客户端（如：MySQL Command Client, MySQL Workbench, Navicat 等）操作数据，对 DBA 更加友好。
* 向应用程序完全透明，可直接当做 MySQL/PostgreSQL 使用。
* 适用于任何兼容 MySQL/PostgreSQL 协议的的客户端。
@@ -101,34 +101,40 @@ Database Mesh 的关注重点在于如何将分布式的数据访问应用与数
### 混合架构
-ShardingSphere-JDBC 采用无中心化架构，适用于 Java 开发的高性能的轻量级 OLTP 应用；ShardingSphere-Proxy 提供静态入口以及异构语言的支持，适用于 OLAP 应用以及对分片数据库进行管理和运维的场景。
+ShardingSphere-JDBC 采用无中心化架构，与应用程序共享资源，适用于 Java 开发的高性能的轻量级 OLTP 应用；
+ShardingSphere-Proxy 提供静态入口以及异构语言的支持，独立于应用程序部署，适用于 OLAP 应用以及对分片数据库进行管理和运维的场景。
Apache ShardingSphere 是多接入端共同组成的生态圈。
通过混合使用 ShardingSphere-JDBC 和 ShardingSphere-Proxy，并采用同一注册中心统一配置分片策略，能够灵活的搭建适用于各种场景的应用系统，使得架构师更加自由地调整适合与当前业务的最佳系统架构。
-## 功能列表
+## 解决方案
-### 数据分片
+### 分布式数据库
-* 分库 & 分表
+* 数据分片
* 读写分离
-* 分片策略定制化
-* 无中心化分布式主键
+* 分布式事务
+* 弹性伸缩
+* 分布式高可用
-### 分布式事务
+### 数据安全
-* 标准化事务接口
-* XA 强一致事务
-* 柔性事务
+* 数据加密
+* 行级权限（TODO）
+* SQL 审计（TODO）
+* SQL 防火墙（TODO）
-### 数据库治理
+### 数据库网关
-* 分布式治理
-* 弹性伸缩
-* 可视化链路追踪
-* 数据加密
+* 异构数据库支持
+* SQL 方言转换（TODO）
+
+### 全链路压测
+
+* 影子库
+* 可观测性（分布式跟踪、指标度量）
## 线路规划
diff --git a/docs/document/content/overview/_index.en.md b/docs/document/content/overview/_index.en.md
index 8ec0ad0..92f3578 100644
--- a/docs/document/content/overview/_index.en.md
+++ b/docs/document/content/overview/_index.en.md
@@ -22,8 +22,6 @@ Apache ShardingSphere is positioned as `Database Plus`, which aims to build crit
It focuses on how to reuse existing database, rather than creating a new database.
ShardingSphere focus on the upper layer of databases, pays more attention on cooperation between databases rather than database itself.
-As the cornerstone of enterprises, the relational database has a huge market share. Therefore, we prefer to focus on its incrementation instead of a total overturn.
-
`Link`, `Enhance` and `Pluggable` is the core concepts of Apache ShardingSphere.
- `Link`：Flexible adaptation of database protocol, SQL dialect and database storage, it can link applications and multi-mode heterogeneous databases quickly;
@@ -57,6 +55,8 @@ Apache ShardingSphere including 3 independent products: JDBC, Proxy & Sidecar (P
They all provide functions of data scale-out, distributed transaction and distributed governance,
applicable in a variety of situations such as Java isomorphism, heterogeneous language and Cloud-Native.
+As the cornerstone of enterprises, the relational database has a huge market share. Therefore, we prefer to focus on its incrementation instead of a total overturn.
+
### ShardingSphere-JDBC
[](https://mvnrepository.com/artifact/org.apache.shardingsphere/shardingsphere-jdbc)
@@ -116,27 +116,32 @@ Architects can adjust the system architecture to the most applicable one to thei
-## Features
+## Solution
+
+### Distributed Database
+
+* Data Sharding
+* Readwrite-splitting
+* Distributed Transaction
+* Elastic Scale-out
+* Distributed Highly Available
-### Data Sharding
+### Data Security
-* Database sharding & Table sharding
-* Replica query
-* Sharding strategy customization
-* Centre-less Distributed primary key
+* Data Encrypt
+* Row Authority (TODO)
+* SQL Audit (TODO)
+* SQL Firewall (TODO)
-### Distributed Transaction
+### Database Gateway
-* Unified Transaction API
-* XA transaction
-* BASE transaction
+* Multi-model Databases supported
+* SQL Dialect Translate（TODO）
-### Database Governance
+### Stress Testing
-* Distributed Governance
-* Data migration & Scale-out
-* Tracing & Observability Supported
-* Data Encryption
+* Shadow Database
+* Observability (Tracing and Metrics)
## Roadmap
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 b8a6f91..78d8fd4 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/_index.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/_index.cn.md
@@ -9,7 +9,7 @@ chapter = true
ShardingSphere-Proxy 是 Apache ShardingSphere 的第二个产品。
它定位为透明化的数据库代理端，提供封装了数据库二进制协议的服务端版本，用于完成对异构语言的支持。
-目前提供 MySQL 和 PostgreSQL 版本，它可以使用任何兼容 MySQL/PostgreSQL 协议的访问客户端(如：MySQL Command Client, MySQL Workbench, Navicat 等)操作数据，对 DBA 更加友好。
+目前提供 MySQL 和 PostgreSQL 版本，它可以使用任何兼容 MySQL/PostgreSQL 协议的访问客户端（如：MySQL Command Client, MySQL Workbench, Navicat 等）操作数据，对 DBA 更加友好。
* 向应用程序完全透明，可直接当做 MySQL/PostgreSQL 使用。
* 适用于任何兼容 MySQL/PostgreSQL 协议的的客户端。