This is an automated email from the ASF dual-hosted git repository.
zhaojinchao 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 37a8b7c6216 Modify the level of the title (#20734)
37a8b7c6216 is described below
commit 37a8b7c62166ef0c53a6f5d5a9014c4bf0cc1a54
Author: Mike0601 <[email protected]>
AuthorDate: Fri Sep 2 14:54:37 2022 +0800
Modify the level of the title (#20734)
---
docs/document/content/overview/_index.cn.md | 46 ++++++++++++++---------------
docs/document/content/overview/_index.en.md | 46 ++++++++++++++---------------
2 files changed, 46 insertions(+), 46 deletions(-)
diff --git a/docs/document/content/overview/_index.cn.md
b/docs/document/content/overview/_index.cn.md
index 4425103224d..e3a1f74facc 100644
--- a/docs/document/content/overview/_index.cn.md
+++ b/docs/document/content/overview/_index.cn.md
@@ -9,21 +9,21 @@ chapter = true
更多常见问题，请参考 [FAQ](https://github.com/apache/shardingsphere/wiki/FAQ)。
-# 什么是 ShardingSphere
+## 什么是 ShardingSphere
-## 介绍
+### 介绍
Apache ShardingSphere 是一款开源的分布式数据库生态项目，由 JDBC 和 Proxy
两款产品组成。其核心采用微内核+可插拔架构，通过插件开放扩展功能。它提供多源异构数据库增强平台，进而围绕其上层构建生态。
Apache ShardingSphere 设计哲学为 Database
Plus，旨在构建异构数据库上层的标准和生态。它关注如何充分合理地利用数据库的计算和存储能力，而并非实现一个全新的数据库。它站在数据库的上层视角，关注它们之间的协作多于数据库自身。
-### ShardingSphere-JDBC
+#### ShardingSphere-JDBC
[](https://mvnrepository.com/artifact/org.apache.shardingsphere/shardingsphere-jdbc)
ShardingSphere-JDBC 定位为轻量级 Java 框架，在 Java 的 JDBC 层提供的额外服务。
-### ShardingSphere-Proxy
+#### ShardingSphere-Proxy
[](https://nightlies.apache.org/shardingsphere/)
[](/cn/downloads/)
@@ -31,7 +31,7 @@ ShardingSphere-JDBC 定位为轻量级 Java 框架，在 Java 的 JDBC 层提供
ShardingSphere-Proxy 定位为透明化的数据库代理端，通过实现数据库二进制协议，对异构语言提供支持。
-## 产品功能
+### 产品功能
| 特性 | 定义 |
| --------- | ----- |
@@ -44,7 +44,7 @@ ShardingSphere-Proxy 定位为透明化的数据库代理端，通过实现数
| 数据加密 | 数据加密，是保证数据安全的基本手段。ShardingSphere 提供一套完整的、透明化、安全的、低改造成本的数据加密解决方案。 |
| 影子库 | 在全链路压测场景下，ShardingSphere
通过影子库功能支持在复杂压测场景下数据隔离，压测获得测试结果可准确反应系统真实容量和性能水平。 |
-## 产品优势
+### 产品优势
* 极致性能
@@ -74,59 +74,59 @@ ShardingSphere-Proxy 定位为透明化的数据库代理端，通过实现数
通过多层次（内核、功能、生态）插件化能力，为用户提供可定制满足自身特殊需求的独有系统。
-## 线路规划
+### 线路规划
-## 如何参与
+### 如何参与
ShardingSphere 已于 2020 年 4 月 16 日成为 [Apache
软件基金会](https://apache.org/index.html#projects-list)的顶级项目。
欢迎通过[邮件列表](mailto:[email protected])参与讨论。
-# 设计哲学
+## 设计哲学
ShardingSphere 采用 Database Plus 设计哲学，该理念致力于构建数据库上层的标准和生态，在生态中补充数据库所缺失的能力。
-## 连接：打造数据库上层标准
+### 连接：打造数据库上层标准
通过对数据库协议、SQL 方言以及数据库存储的灵活适配，快速构建多模异构数据库上层的标准，同时通过内置 DistSQL 为应用提供标准化的连接方式。
-## 增强：数据库计算增强引擎
+### 增强：数据库计算增强引擎
在原生数据库基础能力之上，提供分布式及流量增强方面的能力。前者可突破底层数据库在计算与存储上的瓶颈，后者通过对流量的变形、重定向、治理、鉴权及分析能力提供更为丰富的数据应用增强能力。
-## 可插拔：构建数据库功能生态
+### 可插拔：构建数据库功能生态
Apache ShardingSphere 的可插拔架构划分为 3 层，它们是：L1 内核层、L2 功能层、L3 生态层。
-### L1 内核层
+#### L1 内核层
是数据库基本能力的抽象，其所有组件均必须存在，但具体实现方式可通过可插拔的方式更换。
主要包括查询优化器、分布式事务引擎、分布式执行引擎、权限引擎和调度引擎等。
-### L2 功能层
+#### L2 功能层
用于提供增量能力，其所有组件均是可选的，可以包含零至多个组件。
组件之间完全隔离，互无感知，多组件可通过叠加的方式相互配合使用。
主要包括数据分片、读写分离、数据库高可用、数据加密、影子库等。
用户自定义功能可完全面向 Apache ShardingSphere 定义的顶层接口进行定制化扩展，而无需改动内核代码。
-### L3 生态层
+#### L3 生态层
用于对接和融入现有数据库生态，包括数据库协议、SQL 解析器和存储适配器，分别对应于 Apache ShardingSphere
以数据库协议提供服务的方式、SQL 方言操作数据的方式以及对接存储节点的数据库类型。
-# 部署形态
-
## 部署形态
+### 部署形态
+
Apache ShardingSphere 由 ShardingSphere-JDBC 和 ShardingSphere-Proxy 这 2
款既能够独立部署，又支持混合部署配合使用的产品组成。
它们均提供标准化的基于数据库作为存储节点的增量功能，可适用于如 Java 同构、异构语言、云原生等各种多样化的应用场景。
-### ShardingSphere-JDBC 独立部署
+#### ShardingSphere-JDBC 独立部署
ShardingSphere-JDBC 定位为轻量级 Java 框架，在 Java 的 JDBC 层提供的额外服务。
它使用客户端直连数据库，以 jar 包形式提供服务，无需额外部署和依赖，可理解为增强版的 JDBC 驱动，完全兼容 JDBC 和各种 ORM 框架。
@@ -146,7 +146,7 @@ ShardingSphere-JDBC 定位为轻量级 Java 框架，在 Java 的 JDBC 层提供
| 无中心化 | `是` | 否 |
| 静态入口 | `无` | 有 |
-### ShardingSphere-Proxy 独立部署
+#### ShardingSphere-Proxy 独立部署
ShardingSphere-Proxy 定位为透明化的数据库代理端，通过实现数据库二进制协议，对异构语言提供支持。
目前提供 MySQL 和 PostgreSQL 协议，透明化数据库操作，对 DBA 更加友好。
@@ -166,7 +166,7 @@ ShardingSphere-Proxy 定位为透明化的数据库代理端，通过实现数
| 无中心化 | 是 | `否` |
| 静态入口 | 无 | `有` |
-### 混合部署架构
+#### 混合部署架构
ShardingSphere-JDBC 采用无中心化架构，与应用程序共享资源，适用于 Java 开发的高性能的轻量级 OLTP 应用；
ShardingSphere-Proxy 提供静态入口以及异构语言的支持，独立于应用程序部署，适用于 OLAP 应用以及对分片数据库进行管理和运维的场景。
@@ -176,18 +176,18 @@ Apache ShardingSphere 是多接入端共同组成的生态圈。
-## 运行模式
+### 运行模式
Apache ShardingSphere 提供了两种运行模式，分别是单机模式和集群模式。
-### 单机模式
+#### 单机模式
能够将数据源和规则等元数据信息持久化，但无法将元数据同步至多个 Apache ShardingSphere 实例，无法在集群环境中相互感知。
通过某一实例更新元数据之后，会导致其他实例由于获取不到最新的元数据而产生不一致的错误。
适用于工程师在本地搭建 Apache ShardingSphere 环境。
-### 集群模式
+#### 集群模式
提供了多个 Apache ShardingSphere 实例之间的元数据共享和分布式场景下状态协调的能力。
它能够提供计算能力水平扩展和高可用等分布式系统必备的能力，集群环境需要通过独立部署的注册中心来存储元数据和协调节点状态。
diff --git a/docs/document/content/overview/_index.en.md
b/docs/document/content/overview/_index.en.md
index 8d52fac4fcf..1a683388169 100644
--- a/docs/document/content/overview/_index.en.md
+++ b/docs/document/content/overview/_index.en.md
@@ -9,9 +9,9 @@ This chapter mainly introduces what Apache ShardingSphere is,
as well as its des
For frequently asked questions, please refer to
[FAQ](https://github.com/apache/shardingsphere/wiki/FAQ).
-# What is ShardingSphere
+## What is ShardingSphere
-## Introduction
+### Introduction
Apache ShardingSphere is an open source ecosystem that allows you to transform
any database into a distributed database system.
The project includes a JDBC and a Proxy, and its core adopts a micro-kernel
and pluggable architecture.
@@ -22,13 +22,13 @@ Database Plus, the design philosophy of Apache
ShardingSphere, aims at building
It focuses on how to make full and reasonable use of the computing and storage
capabilities of existing databases rather than creating a brand new database.
It attaches greater importance to the collaboration between multiple databases
instead of the database itself.
-### ShardingSphere-JDBC
+#### ShardingSphere-JDBC
[](https://mvnrepository.com/artifact/org.apache.shardingsphere/shardingsphere-jdbc)
ShardingSphere-JDBC is a lightweight Java framework that provides additional
services at Java's JDBC layer.
-### ShardingSphere-Proxy
+#### ShardingSphere-Proxy
[](https://nightlies.apache.org/shardingsphere/)
[](/cn/downloads/)
@@ -36,7 +36,7 @@ ShardingSphere-JDBC is a lightweight Java framework that
provides additional ser
ShardingSphere-Proxy is a transparent database proxy, providing a database
server that encapsulates database binary protocol to support heterogeneous
languages.
-## Product Features
+### Product Features
| Feature | Definition |
| ----------------------- | ---------- |
@@ -49,7 +49,7 @@ ShardingSphere-Proxy is a transparent database proxy,
providing a database serve
| Data Encryption | Data Encryption is a basic way to ensure data
security. ShardingSphere provides a set of data encryption solutions that are
complete, secure, transparent, and with low transformation costs. |
| Shadow Database | In the full-link stress testing scenario,
ShardingSphere shadow DB is used for providing data isolation support for
complex testing work. The obtained testing result can accurately reflect the
system's true capacity and performance. |
-## Advantages
+### Advantages
- Ultimate Performance
@@ -79,42 +79,42 @@ It supports computing, storage, and smooth online
expansion, which can meet dive
It can provide users with flexibility thanks to custom systems based on
multi-level (kernel, feature, and ecosystem) plugin capabilities.
-## Roadmap
+### Roadmap
-## How to Contribute
+### How to Contribute
ShardingSphere became an [Apache](https://apache.org/index.html#projects-list)
Top-Level Project on April 16, 2020.
You are welcome to check out the mailing list and discuss via
[mail](mailto:[email protected]).
-# Design Philosophy
+## Design Philosophy
ShardingSphere adopts the database plus design philosophy, which is committed
to building the standards and ecology of the upper layer of the database and
supplementing the missing capabilities of the database in the ecology.
-## Connect: Create database upper level standard
+### Connect: Create database upper level standard
Through flexible adaptation of database protocols, SQL dialects, and database
storage, it can quickly build standards on top of multi-modal heterogeneous
databases, while providing standardized connection mode for applications
through built-in DistSQL.
-## Enhance: Database computing enhancement engine
+### Enhance: Database computing enhancement engine
It can further provide distributed capabilities and traffic enhancement
functions based on native database capabilities. The former can break through
the bottleneck of the underlying database in computing and storage, while the
latter provides more diversified data application enhancement capabilities
through traffic deformation, redirection, governance, authentication, and
analysis.
-## Pluggable: Building database function ecology
+### Pluggable: Building database function ecology
The pluggable architecture of Apache ShardingSphere is composed of three
layers - L1 Kernel Layer, L2 Feature Layer and L3 Ecosystem Layer.
-### L1 Kernel Layer
+#### L1 Kernel Layer
An abstraction of databases' basic capabilities.
All the components are required and the specific implementation method can be
replaced thanks to plugins.
It includes a query optimizer, distributed transaction engine, distributed
execution engine, permission engine and scheduling engine.
-### L2 Feature Layer
+#### L2 Feature Layer
Used to provide enhancement capabilities.
All components are optional, allowing you to choose whether to include zero or
multiple components.
@@ -122,18 +122,18 @@ Components are isolated from each other, and multiple
components can be used tog
It includes data sharding, read/write splitting, database high availability,
data encryption and shadow database and so on.
The user-defined feature can be fully customized and extended for the
top-level interface defined by Apache ShardingSphere without changing kernel
codes.
-### L3 Ecosystem Layer
+#### L3 Ecosystem Layer
It is used to integrate and merge the current database ecosystems.
The ecosystem layer includes database protocol, SQL parser and storage
adapter, corresponding to the way in which Apache ShardingSphere provides
services by database protocol, the way in which SQL dialect operates data, and
the database type that interacts with storage nodes.
-# Deployment
-
## Deployment
+### Deployment
+
Apache ShardingSphere includes two independent clients: ShardingSphere-JDBC &
ShardingSphere-Proxy. They all provide functions of data scale-out, distributed
transaction and distributed governance, applicable in a variety of scenarios
such as Java isomorphism, heterogeneous languages, and a cloud-native
environment.
-### Independent ShardingSphere-JDBC
+#### Independent ShardingSphere-JDBC
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.
@@ -154,7 +154,7 @@ It can be considered as an enhanced version of the JDBC
driver, which is fully c
| Decentralization | `Yes` | No |
| Static entry | `No` | Yes |
-### Independent ShardingSphere-Proxy
+#### Independent ShardingSphere-Proxy
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.
@@ -175,7 +175,7 @@ It can use any kind of terminal that is compatible with
MySQL or PostgreSQL prot
| Decentralization | Yes | `No` |
| Static entry | No | `Yes` |
-### Hybrid Architecture
+#### Hybrid Architecture
ShardingSphere-JDBC adopts a decentralized architecture, applicable to
high-performance light-weight OLTP applications developed with Java.
ShardingSphere-Proxy provides static entry and supports all languages,
applicable to OLAP applications and the sharding databases management and
operation situation.
@@ -185,11 +185,11 @@ By combining ShardingSphere-JDBC and
ShardingSphere-Proxy, and using the same re
-## Running Modes
+### Running Modes
Apache ShardingSphere provides two running modes: standalone mode and cluster
mode.
-### Standalone mode
+#### Standalone mode
It can achieve data persistence in terms of metadata information such as data
sources and rules,
but it is not able to synchronize metadata to multiple Apache ShardingSphere
instances or be aware of each other in a cluster environment.
@@ -197,7 +197,7 @@ Updating metadata through one instance causes
inconsistencies in other instances
It is ideal for engineers to build a ShardingSphere environment locally.
-### Cluster mode
+#### Cluster mode
It provides metadata sharing between multiple Apache ShardingSphere instances
and the capability to coordinate states in distributed scenarios.
