You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by me...@apache.org on 2022/08/12 11:48:17 UTC
[shardingsphere] branch master updated: Update readme of release doc (#20124)
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 b4bfced5925 Update readme of release doc (#20124)
b4bfced5925 is described below
commit b4bfced5925db76fc1c31f5b0ec928abd3a79655
Author: Liang Zhang <zh...@apache.org>
AuthorDate: Fri Aug 12 19:48:12 2022 +0800
Update readme of release doc (#20124)
* Update readme of release doc
* Update readme of release doc
---
README.md | 10 ++++------
docs/document/content/overview/intro.en.md | 2 +-
.../src/main/release-docs/README.txt | 22 +++++++++++++---------
.../src/main/release-docs/README.txt | 21 +++++++++++++--------
4 files changed, 31 insertions(+), 24 deletions(-)
diff --git a/README.md b/README.md
index 85a7238edf4..e9e4e336fd2 100644
--- a/README.md
+++ b/README.md
@@ -130,9 +130,8 @@ They all provide functions of data scale-out, distributed transaction and distri
[](https://mvnrepository.com/artifact/org.apache.shardingsphere/shardingsphere-jdbc)
-A lightweight Java framework that provides additional services at Java's JDBC layer.
-With the client connecting directly to the database, it provides services in the form of jar and requires no extra deployment and dependence.
-It can be considered as an enhanced version of the JDBC driver, which is fully compatible with JDBC and all kinds of ORM frameworks.
+A lightweight Java framework providing extra services at the Java JDBC layer.
+With the client end connecting directly to the database, it provides services in the form of a jar and requires no extra deployment and dependence.
:link: For more details, follow this [link to the official website](https://shardingsphere.apache.org/document/current/en/overview/#shardingsphere-jdbc).
@@ -144,9 +143,8 @@ It can be considered as an enhanced version of the JDBC driver, which is fully c
[](https://www.apache.org/dyn/closer.lua/shardingsphere/5.1.2/apache-shardingsphere-5.1.2-shardingsphere-proxy-bin.tar.gz)
[](https://store.docker.com/community/images/apache/shardingsphere-proxy)
-A transparent database proxy, providing a database server that encapsulates database binary protocol to support heterogeneous languages.
-Currently, MySQL and PostgreSQL protocols are provided.
-It can use any kind of terminal that is compatible with MySQL or PostgreSQL protocol to operate data, which is more friendly to DBAs.
+A transparent database proxy, providing a database server that encapsulates database binary protocol to support heterogeneous languages.
+Friendlier to DBAs, the MySQL and PostgreSQL version now provided can use any kind of terminal.
:link: For more details, follow this [link to the official website](https://shardingsphere.apache.org/document/current/en/overview/#shardingsphere-proxy).
diff --git a/docs/document/content/overview/intro.en.md b/docs/document/content/overview/intro.en.md
index 2a5dcc7370e..c7cbe07e44f 100644
--- a/docs/document/content/overview/intro.en.md
+++ b/docs/document/content/overview/intro.en.md
@@ -8,7 +8,7 @@ chapter = true
## Definition
Apache ShardingSphere is an open source ecosystem of distributed databases, including two independent products: JDBC & Proxy.
-It adopts a plugin-oriented (or plugabble) architecture and expands the original databases' features list thanks to components.
+It adopts a plugin-oriented (or plugabble) architecture and expands the original databases' features list thanks to components.
ShardingSphere provides many enhanced features in the form of database protocol and SQL, including data sharding, access routing, data security, etc.
It supports MySQL, PostgreSQL, SQL Server, Oracle, and other data storage engines.
diff --git a/shardingsphere-distribution/shardingsphere-jdbc-distribution/src/main/release-docs/README.txt b/shardingsphere-distribution/shardingsphere-jdbc-distribution/src/main/release-docs/README.txt
index a8584ee1d7a..760615a0896 100644
--- a/shardingsphere-distribution/shardingsphere-jdbc-distribution/src/main/release-docs/README.txt
+++ b/shardingsphere-distribution/shardingsphere-jdbc-distribution/src/main/release-docs/README.txt
@@ -2,7 +2,8 @@ Welcome to Apache ShardingSphere
===============================================================================
Apache ShardingSphere is positioned as a Database Plus, and aims at building a standard layer and ecosystem above heterogeneous databases.
-It focuses on how to reuse existing databases and their respective upper layer, rather than creating a new database. The goal is to minimize or eliminate the challenges caused by underlying databases fragmentation.
+It focuses on how to reuse existing databases and their respective upper layer, rather than creating a new database.
+The goal is to minimize or eliminate the challenges caused by underlying databases fragmentation.
The concepts at the core of the project are Connect, Enhance and Pluggable.
@@ -10,19 +11,22 @@ The concepts at the core of the project are Connect, Enhance and Pluggable.
- `Enhance:` Capture database access entry to provide additional features transparently, such as: redirect (sharding, readwrite-splitting and shadow), transform (data encrypt and mask), authentication (security, audit and authority), governance (circuit breaker and access limitation and analyze, QoS and observability).
- `Pluggable:` Leveraging the micro kernel and 3 layers pluggable mode, features and database ecosystem can be embedded flexibily. Developers can customize their ShardingSphere just like building with LEGO blocks.
-Apache ShardingSphere including 3 independent products: JDBC, Proxy & Sidecar (Planning).
+Apache ShardingSphere including 2 independent products: JDBC & Proxy.
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.
+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 defines itself as a lightweight Java framework that provides extra services at the Java JDBC layer.
-With the client end connecting directly to the database, it provides services in the form of a 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.
+ShardingSphere-JDBC is a lightweight Java framework that provides additional services at Java's JDBC layer.
+With the client connecting directly to the database, it provides services in the form of jar and requires no extra deployment and dependence.
+It can be considered as an enhanced version of the 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;
-* Supports 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.
+- 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.
+
+ShardingSphere-JDBC is suitable for java applications.
Getting Started
===============================================================================
diff --git a/shardingsphere-distribution/shardingsphere-proxy-distribution/src/main/release-docs/README.txt b/shardingsphere-distribution/shardingsphere-proxy-distribution/src/main/release-docs/README.txt
index 3b18a4f431c..1989894fb98 100644
--- a/shardingsphere-distribution/shardingsphere-proxy-distribution/src/main/release-docs/README.txt
+++ b/shardingsphere-distribution/shardingsphere-proxy-distribution/src/main/release-docs/README.txt
@@ -2,7 +2,8 @@ Welcome to Apache ShardingSphere
===============================================================================
Apache ShardingSphere is positioned as a Database Plus, and aims at building a standard layer and ecosystem above heterogeneous databases.
-It focuses on how to reuse existing databases and their respective upper layer, rather than creating a new database. The goal is to minimize or eliminate the challenges caused by underlying databases fragmentation.
+It focuses on how to reuse existing databases and their respective upper layer, rather than creating a new database.
+The goal is to minimize or eliminate the challenges caused by underlying databases fragmentation.
The concepts at the core of the project are Connect, Enhance and Pluggable.
@@ -10,18 +11,22 @@ The concepts at the core of the project are Connect, Enhance and Pluggable.
- `Enhance:` Capture database access entry to provide additional features transparently, such as: redirect (sharding, readwrite-splitting and shadow), transform (data encrypt and mask), authentication (security, audit and authority), governance (circuit breaker and access limitation and analyze, QoS and observability).
- `Pluggable:` Leveraging the micro kernel and 3 layers pluggable mode, features and database ecosystem can be embedded flexibily. Developers can customize their ShardingSphere just like building with LEGO blocks.
-Apache ShardingSphere including 3 independent products: JDBC, Proxy & Sidecar (Planning).
+Apache ShardingSphere including 2 independent products: JDBC & Proxy.
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.
+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-Proxy 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.
+ShardingSphere-Proxy is a transparent database proxy, providing a database server that encapsulates database binary protocol to support heterogeneous languages.
+Currently, MySQL and PostgreSQL protocols are provided.
+It can use any kind of terminal that is compatible with MySQL or PostgreSQL protocol to operate data, which is more friendly to DBAs.
-* Transparent towards applications, it can be used directly as MySQL and PostgreSQL servers;
-* Applicable to any kind of terminal that is compatible with MySQL and PostgreSQL protocol.
+- Transparent to applications, it can be used directly as MySQL/PostgreSQL;
+- Compatible with MySQL-based databases, such as MariaDB, and PostgreSQL-based databases, such as openGauss;
+- Applicable to any kind of client that is compatible with MySQL/PostgreSQL protocol, such as MySQL Command Client, MySQL Workbench, etc.
+
+The advantages of ShardingSphere-Proxy lie in supporting heterogeneous languages and providing operational entries for DBA.
Getting Started
===============================================================================