This is an automated email from the ASF dual-hosted git repository.
jianglongtao 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 713e46fb382 Update the outdated list of optional components for JDBC
and Proxy (#37735)
713e46fb382 is described below
commit 713e46fb382ca744018c38932b4f56304da40406
Author: Ling Hengqian <[email protected]>
AuthorDate: Wed Jan 14 16:44:09 2026 +0800
Update the outdated list of optional components for JDBC and Proxy (#37735)
* Update the outdated list of optional components for JDBC and Proxy
* Fixes typo
* Fixes typo again
---
.../optional-plugins/_index.cn.md | 97 ++++++++++++----------
.../optional-plugins/_index.en.md | 94 +++++++++++----------
.../optional-plugins/_index.cn.md | 73 +++++++++-------
.../optional-plugins/_index.en.md | 88 +++++++++++---------
4 files changed, 190 insertions(+), 162 deletions(-)
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/optional-plugins/_index.cn.md
b/docs/document/content/user-manual/shardingsphere-jdbc/optional-plugins/_index.cn.md
index 077ddb6442b..8c3669058ba 100644
---
a/docs/document/content/user-manual/shardingsphere-jdbc/optional-plugins/_index.cn.md
+++
b/docs/document/content/user-manual/shardingsphere-jdbc/optional-plugins/_index.cn.md
@@ -7,52 +7,57 @@ ShardingSphere 默认情况下仅包含核心 SPI 的实现，在 Git Source 存
实现的插件未包含在内。可在 https://central.sonatype.com/ 进行检索。
所有插件对应的 SPI 和 SPI 的已有实现类均可在
https://shardingsphere.apache.org/document/current/cn/dev-manual/ 检索。
-
-下以 `groupId:artifactId` 的表现形式列出 ShardingSphere-JDBC 所有的内置插件。
-
-- `org.apache.shardingsphere:shardingsphere-authority-core`，用户权限加载逻辑核心
-- `org.apache.shardingsphere:shardingsphere-cluster-mode-core`，集群模式配置信息持久化定义核心
-- `org.apache.shardingsphere:shardingsphere-db-discovery-core`，高可用核心
-- `org.apache.shardingsphere:shardingsphere-encrypt-core`，数据加密核心
-- `org.apache.shardingsphere:shardingsphere-infra-context`， Context
的内核运行与元数据刷新机制
-- `org.apache.shardingsphere:shardingsphere-mask-core`，数据脱敏核心
-- `org.apache.shardingsphere:shardingsphere-database-exception-mysql`， 数据库网关的
MySQL 实现
-- `org.apache.shardingsphere:shardingsphere-parser-core`， SQL 解析核心
--
`org.apache.shardingsphere:shardingsphere-database-exception-postgresql`，数据库网关的
PostgreSQL 实现
-- `org.apache.shardingsphere:shardingsphere-readwrite-splitting-core`，读写分离核心
-- `org.apache.shardingsphere:shardingsphere-shadow-core`，影子库核心
-- `org.apache.shardingsphere:shardingsphere-sharding-core`，数据分片核心
-- `org.apache.shardingsphere:shardingsphere-single-core`，单表（所有的分片数据源中仅唯一存在的表）核心
-- `org.apache.shardingsphere:shardingsphere-sql-federation-core`，联邦查询执行器核心
-- `org.apache.shardingsphere:shardingsphere-sql-parser-mysql`， SQL 解析的 MySQL
方言实现
-- `org.apache.shardingsphere:shardingsphere-sql-parser-postgresql`， SQL 解析的
PostgreSQL 方言实现
-- `org.apache.shardingsphere:shardingsphere-sql-parser-opengauss`， SQL 解析的
OpenGauss 方言实现
-- `org.apache.shardingsphere:shardingsphere-sql-parser-oracle`， SQL 解析的 Oracle
方言解析实现
-- `org.apache.shardingsphere:shardingsphere-sql-parser-sqlserver`， SQL 解析的 SQL
Server 方言实现
-- `org.apache.shardingsphere:shardingsphere-sql-parser-doris`， SQL 解析的 Doris
方言实现
-- `org.apache.shardingsphere:shardingsphere-sql-parser-presto`， SQL 解析的 Presto
方言实现
-- `org.apache.shardingsphere:shardingsphere-sql-parser-sql92`， SQL 解析的 SQL 92
方言实现
--
`org.apache.shardingsphere:shardingsphere-standalone-mode-core`，单机模式配置信息持久化定义核心
--
`org.apache.shardingsphere:shardingsphere-standalone-mode-repository-jdbc-h2`，单机模式配置信息持久化定义的
H2 实现
-- `org.apache.shardingsphere:shardingsphere-traffic-core`，流量治理核心
-- `org.apache.shardingsphere:shardingsphere-transaction-core`， XA 分布式事务管理器核心
-
-如果 ShardingSphere-JDBC 需要使用可选插件，需要在 Maven Central 下载包含其 SPI 实现的 JAR 和其依赖的 JAR。
-
-下以 `groupId:artifactId` 的表现形式列出所有的可选插件。
-
-- 集群模式配置信息持久化定义
- -
`org.apache.shardingsphere:shardingsphere-cluster-mode-repository-zookeeper`，基于
Zookeeper 的持久化实现
- - `org.apache.shardingsphere:shardingsphere-cluster-mode-repository-etcd`，基于
Etcd 的持久化实现
-- XA 分布式事务管理器
- - `org.apache.shardingsphere:shardingsphere-transaction-xa-narayana`，基于
Narayana 的 XA 分布式事务管理器
+如果 `org.apache.shardingsphere:shardingsphere-jdbc` 需要使用可选插件，需要在 Maven Central
下载包含其 SPI 实现的 JAR 和其依赖的 JAR。
+
+下以 `groupId:artifactId` 的表现形式，列出所有可选插件。
+
+- 数据库方言适配
+ - `org.apache.shardingsphere:shardingsphere-jdbc-dialect-postgresql`，面向
Postgres 的方言与兼容性适配
+ - `org.apache.shardingsphere:shardingsphere-jdbc-dialect-mysql`，面向 MySQL
的方言与兼容性适配
+ - `org.apache.shardingsphere:shardingsphere-jdbc-dialect-sqlserver`，面向 MS
SQL Server 的方言与兼容性适配
+ - `org.apache.shardingsphere:shardingsphere-jdbc-dialect-mariadb`，面向 MariaDB
的方言与兼容性适配
+ - `org.apache.shardingsphere:shardingsphere-jdbc-dialect-presto`，面向 Presto
的方言与兼容性适配
+ - `org.apache.shardingsphere:shardingsphere-jdbc-dialect-oracle`，面向 Oracle
Database Free 和 Oracle-XE 的方言与兼容性适配
+ - `org.apache.shardingsphere:shardingsphere-jdbc-dialect-firebird`，面向
Firebird 的方言与兼容性适配
+ - `org.apache.shardingsphere:shardingsphere-jdbc-dialect-clickhouse`，面向
Clickhouse 的方言与兼容性适配
+ - `org.apache.shardingsphere:shardingsphere-jdbc-dialect-opengauss`，面向
openGauss 的方言与兼容性适配
+ - `org.apache.shardingsphere:shardingsphere-jdbc-dialect-doris`，面向 Doris FE
的方言与兼容性适配
+ - `org.apache.shardingsphere:shardingsphere-jdbc-dialect-hive`，面向
HiveServer2 的方言与兼容性适配
+- 数据源连接池
+ -
`org.apache.shardingsphere:shardingsphere-infra-data-source-pool-hikari`，提供
`dataSources.<data_source_name>.dataSourceClassName=com.zaxxer.hikari.HikariDataSource`
的连接池创建与属性适配实现
+- 权限与认证实现
+ - `org.apache.shardingsphere:shardingsphere-authority-simple`，提供
`authority.privilege.type=ALL_PERMITTED` 的权限与认证实现
+ - `org.apache.shardingsphere:shardingsphere-authority-database`，提供
`authority.privilege.type=DATABASE_PERMITTED` 的权限与认证实现
+- 分布式事务
+ - `org.apache.shardingsphere:shardingsphere-transaction-xa-atomikos`，提供
`transaction.providerType=Atomikos` 的分布式事务实现
+ - `org.apache.shardingsphere:shardingsphere-transaction-xa-narayana`，提供
`transaction.providerType=Narayana` 的分布式事务实现
+ - `org.apache.shardingsphere:shardingsphere-transaction-base-seata-at`，提供
`transaction.providerType=Seata` 的分布式事务实现
+- SQL 翻译
+ -
`org.apache.shardingsphere:shardingsphere-sql-translator-native-provider`，提供
`sqlTranslator.type=Native` 的 SQL 翻译实现
+- 配置与元数据持久化仓库
+ -
`org.apache.shardingsphere:shardingsphere-standalone-mode-repository-memory`，提供
`mode.repository.type=Memory` 的配置与元数据持久化仓库实现
+ -
`org.apache.shardingsphere:shardingsphere-standalone-mode-repository-jdbc`，提供
`mode.repository.type=JDBC` 的配置与元数据持久化仓库实现
+ -
`org.apache.shardingsphere:shardingsphere-cluster-mode-repository-zookeeper`，提供
`mode.repository.type=ZooKeeper` 的配置与元数据持久化仓库实现
+ - `org.apache.shardingsphere:shardingsphere-cluster-mode-repository-etcd`，提供
`mode.repository.type=etcd` 的配置与元数据持久化仓库实现
+- 配置加载器
+ - `org.apache.shardingsphere:shardingsphere-infra-url-classpath`，提供
`jdbc:shardingsphere:classpath:` 的 JDBC URL 实现
+ - `org.apache.shardingsphere:shardingsphere-infra-url-absolutepath`，提供
`jdbc:shardingsphere:absolutepath:` 的 JDBC URL 实现
+ - `org.apache.shardingsphere:shardingsphere-infra-url-zookeeper`，提供
`jdbc:shardingsphere:zookeeper:` 的 JDBC URL 实现
+ - `org.apache.shardingsphere:shardingsphere-infra-url-etcd`，提供
`jdbc:shardingsphere:etcd:` 的 JDBC URL 实现
+- 功能核心
+ - `org.apache.shardingsphere:shardingsphere-sharding-core`，提供 `!SHARDING`
的功能核心实现
+ - `org.apache.shardingsphere:shardingsphere-broadcast-core`，提供 `!BROADCAST`
的功能核心实现
+ - `org.apache.shardingsphere:shardingsphere-readwrite-splitting-core`，提供
`!READWRITE_SPLITTING` 的功能核心实现
+ - `org.apache.shardingsphere:shardingsphere-shadow-core`，提供 `!SHADOW` 的功能核心实现
+ - `org.apache.shardingsphere:shardingsphere-encrypt-core`，提供 `!ENCRYPT`
的功能核心实现
+ - `org.apache.shardingsphere:shardingsphere-mask-core`，提供 `!MASK` 的功能核心实现
- 行表达式
- - `org.apache.shardingsphere:shardingsphere-infra-expr-espresso`，基于 GraalVM
Truffle 的 Espresso 实现的使用 Groovy 语法的行表达式
-- 数据库类型识别
- - `org.apache.shardingsphere:shardingsphere-infra-database-hive`， 对 Hive 的
jdbcURL 的识别适配，元数据加载实现
- - `org.apache.shardingsphere:shardingsphere-infra-database-presto`， 对 Presto
的 jdbcURL 的识别适配，元数据加载实现
-- SQL 解析
- - `org.apache.shardingsphere:shardingsphere-parser-sql-engine-clickhouse`，
SQL 解析的 ClickHouse 方言实现
- - `org.apache.shardingsphere:shardingsphere-parser-sql-engine-hive`， SQL 解析的
Hive 方言实现
+ - `org.apache.shardingsphere:shardingsphere-infra-expr-espresso`，提供
`<ESPRESSO>` 的行表达式实现
+- 功能核心的增强
+ - `org.apache.shardingsphere:shardingsphere-sharding-mysql`，为
`shardingsphere-sharding-core` 的功能核心提供面向 MySQL 的增强与适配
+- 时间服务
+ -
`org.apache.shardingsphere:shardingsphere-database-time-service`，通过连接数据库并执行
“取当前时间” 的 SQL 来提供统一时间戳，供分片等路由逻辑使用
+- GraalVM Native Image
+ - `org.apache.shardingsphere:shardingsphere-infra-reachability-metadata`，为
`oracle/graal` 提供面向 ShardingSphere 的 GraalVM Reachability Metadata
除了以上可选插件外，ShardingSphere 社区开发者还贡献了大量的插件实现，可以在 [ShardingSphere
Plugin](https://github.com/apache/shardingsphere-plugin)
仓库中查看插件的使用说明，ShardingSphere Plugin 仓库中的插件会和 ShardingSphere 保持相同的发布节奏，可以手动打包安装到
ShardingSphere 中。
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/optional-plugins/_index.en.md
b/docs/document/content/user-manual/shardingsphere-jdbc/optional-plugins/_index.en.md
index 26efc2f5841..c28f342cdd7 100644
---
a/docs/document/content/user-manual/shardingsphere-jdbc/optional-plugins/_index.en.md
+++
b/docs/document/content/user-manual/shardingsphere-jdbc/optional-plugins/_index.en.md
@@ -8,51 +8,57 @@ Implemented plugins are not included. Retrievable at
https://central.sonatype.co
SPI and existing implementation classes of SPI corresponding to all plugins
can be retrieved at
https://shardingsphere.apache.org/document/current/cn/dev-manual/.
-All the built-in plugins for ShardingSphere-JDBC are listed below in the form
of 'groupId:artifactId'.
+If `org.apache.shardingsphere:shardingsphere-jdbc` requires optional plugins,
you need to download the JAR containing its SPI implementation and its
dependencies from Maven Central.
-- `org.apache.shardingsphere:shardingsphere-authority-core`, the user
authority to load the logical core
-- `org.apache.shardingsphere:shardingsphere-cluster-mode-core`, the persistent
definition core of cluster mode configuration information
-- `org.apache.shardingsphere:shardingsphere-db-discovery-core`, high
availability core
-- `org.apache.shardingsphere:shardingsphere-encrypt-core`, data encryption core
-- `org.apache.shardingsphere:shardingsphere-infra-context`, the kernel
operation and metadata refresh mechanism of Context
-- `org.apache.shardingsphere:shardingsphere-mask-core`, data masking core
-- `org.apache.shardingsphere:shardingsphere-database-exception-mysql`, MySQL
implementation of database gateway
-- `org.apache.shardingsphere:shardingsphere-parser-core`, SQL parsing core
-- `org.apache.shardingsphere:shardingsphere-database-exception-postgresql`,
PostgreSQL implementation of database
-- `org.apache.shardingsphere:shardingsphere-readwrite-splitting-core`,
read-write splitting core
-- `org.apache.shardingsphere:shardingsphere-shadow-core`, shadow library core
-- `org.apache.shardingsphere:shardingsphere-sharding-core`, data sharding core
-- `org.apache.shardingsphere:shardingsphere-single-core`, single-table (only
the only table that exists in all sharded data sources) core
-- `org.apache.shardingsphere:shardingsphere-sql-federation-core`, federation
query executor core
-- `org.apache.shardingsphere:shardingsphere-sql-parser-mysql`, MySQL dialect
implementation of SQL parsing
-- `org.apache.shardingsphere:shardingsphere-sql-parser-postgresql`, PostgreSQL
dialect implementation of SQL parsing
-- `org.apache.shardingsphere:shardingsphere-sql-parser-opengauss`, OpenGauss
dialect implementation of SQL parsing
-- `org.apache.shardingsphere:shardingsphere-sql-parser-oracle`, Oracle dialect
implementation of SQL parsing
-- `org.apache.shardingsphere:shardingsphere-sql-parser-sqlserver`, SQL Server
dialect implementation of SQL parsing
-- `org.apache.shardingsphere:shardingsphere-sql-parser-doris`， Doris dialect
implementation of SQL parsing
-- `org.apache.shardingsphere:shardingsphere-sql-parser-presto`， Presto dialect
implementation of SQL parsing
-- `org.apache.shardingsphere:shardingsphere-sql-parser-sql92`,the SQL 92
dialect implementation of SQL parsing
-- `org.apache.shardingsphere:shardingsphere-standalone-mode-core`, the
persistence definition core of single-machine mode configuration information
--
`org.apache.shardingsphere:shardingsphere-standalone-mode-repository-jdbc-h2`,
H2 implementation of persistent definition of configuration information in
stand-alone mode
-- `org.apache.shardingsphere:shardingsphere-traffic-core`, traffic governance
core
-- `org.apache.shardingsphere:shardingsphere-transaction-core`, XA Distributed
Transaction Manager Core
+The following lists all optional plugins in the format of `groupId:artifactId`.
-If ShardingSphere-JDBC needs to use optional plugins, you need to download the
JAR containing its SPI implementation and its dependent JARs from Maven Central.
-
-All optional plugins are listed below in the form of `groupId:artifactId`.
-
-- Cluster mode configuration information persistence definition
- -
`org.apache.shardingsphere:shardingsphere-cluster-mode-repository-zookeeper`,
Zookeeper based persistence
- - `org.apache.shardingsphere:shardingsphere-cluster-mode-repository-etcd`,
Etcd based persistence
-- XA transaction manager provider definition
- - `org.apache.shardingsphere:shardingsphere-transaction-xa-narayana`, XA
distributed transaction manager based on Narayana
-- Row Value Expressions definition
- - `org.apache.shardingsphere:shardingsphere-infra-expr-espresso`，Row Value
Expressions that uses the Groovy syntax based on GraalVM Truffle's Espresso
implementation
-- Database type identification
- - `org.apache.shardingsphere:shardingsphere-infra-database-hive`, Adaptation
of jdbcURL for `JDBC support` of Hive, and metadata loading implementation
- - `org.apache.shardingsphere:shardingsphere-infra-database-presto`,
Adaptation of jdbcURL for `JDBC support` of Presto, and metadata loading
implementation
-- SQL parsing
- - `org.apache.shardingsphere:shardingsphere-parser-sql-engine-clickhouse`,
ClickHouse dialect implementation of SQL parsing
- - `org.apache.shardingsphere:shardingsphere-parser-sql-engine-hive`， Hive
dialect implementation of SQL parsing
+- Database dialect adaptation
+ - `org.apache.shardingsphere:shardingsphere-jdbc-dialect-postgresql`,
dialect and compatibility adaptation for Postgres
+ - `org.apache.shardingsphere:shardingsphere-jdbc-dialect-mysql`, dialect and
compatibility adaptation for MySQL
+ - `org.apache.shardingsphere:shardingsphere-jdbc-dialect-sqlserver`, dialect
and compatibility adaptation for MS SQL Server
+ - `org.apache.shardingsphere:shardingsphere-jdbc-dialect-mariadb`, dialect
and compatibility adaptation for MariaDB
+ - `org.apache.shardingsphere:shardingsphere-jdbc-dialect-presto`, dialect
and compatibility adaptation for Presto
+ - `org.apache.shardingsphere:shardingsphere-jdbc-dialect-oracle`, dialect
and compatibility adaptation for Oracle Database Free and Oracle-XE
+ - `org.apache.shardingsphere:shardingsphere-jdbc-dialect-firebird`, dialect
and compatibility adaptation for Firebird
+ - `org.apache.shardingsphere:shardingsphere-jdbc-dialect-clickhouse`,
dialect and compatibility adaptation for Clickhouse
+ - `org.apache.shardingsphere:shardingsphere-jdbc-dialect-opengauss`, dialect
and compatibility adaptation for openGauss
+ - `org.apache.shardingsphere:shardingsphere-jdbc-dialect-doris`, dialect and
compatibility adaptation for Doris FE
+ - `org.apache.shardingsphere:shardingsphere-jdbc-dialect-hive`, dialect and
compatibility adaptation for HiveServer2
+- Data Source Connection Pool
+ - `org.apache.shardingsphere:shardingsphere-infra-data-source-pool-hikari`,
provides connection pool creation and property adaptation implementation for
`dataSources.<data_source_name>.dataSourceClassName=com.zaxxer.hikari.HikariDataSource`
+- Permissions and authentication implementation
+ - `org.apache.shardingsphere:shardingsphere-authority-simple`, provides
permission and authentication implementation with
`authority.privilege.type=ALL_PERMITTED`
+ - `org.apache.shardingsphere:shardingsphere-authority-database`, provides
permission and authentication implementation with
`authority.privilege.type=DATABASE_PERMITTED`
+- Distributed transactions
+ - `org.apache.shardingsphere:shardingsphere-transaction-xa-atomikos`,
provides distributed transaction implementation for
`transaction.providerType=Atomikos`
+ - `org.apache.shardingsphere:shardingsphere-transaction-xa-narayana`,
provides distributed transaction implementation for
`transaction.providerType=Narayana`
+ - `org.apache.shardingsphere:shardingsphere-transaction-base-seata-at`,
provides distributed transaction implementation for
`transaction.providerType=Seata`
+- SQL Translation
+ - `org.apache.shardingsphere:shardingsphere-sql-translator-native-provider`,
provides SQL translation implementation with `sqlTranslator.type=Native`
+- Configuration and metadata persistence repository
+ -
`org.apache.shardingsphere:shardingsphere-standalone-mode-repository-memory`,
provides configuration and metadata persistence repository implementation for
`mode.repository.type=Memory`
+ -
`org.apache.shardingsphere:shardingsphere-standalone-mode-repository-jdbc`,
provides configuration and metadata persistence repository implementation for
`mode.repository.type=JDBC`
+ -
`org.apache.shardingsphere:shardingsphere-cluster-mode-repository-zookeeper`,
provides configuration and metadata persistence repository implementation for
`mode.repository.type=ZooKeeper`
+ - `org.apache.shardingsphere:shardingsphere-cluster-mode-repository-etcd`,
provides configuration and metadata persistence repository implementation for
`mode.repository.type=etcd`
+- Configuration loader
+ - `org.apache.shardingsphere:shardingsphere-infra-url-classpath`, provides
JDBC URL implementation of `jdbc:shardingsphere:classpath:`
+ - `org.apache.shardingsphere:shardingsphere-infra-url-absolutepath`,
provides JDBC URL implementation of `jdbc:shardingsphere:absolutepath:`
+ - `org.apache.shardingsphere:shardingsphere-infra-url-zookeeper`, provides
JDBC URL implementation of `jdbc:shardingsphere:zookeeper:`
+ - `org.apache.shardingsphere:shardingsphere-infra-url-etcd`, provides JDBC
URL implementation of `jdbc:shardingsphere:etcd:`
+- Feature core
+ - `org.apache.shardingsphere:shardingsphere-sharding-core`, provides core
implementation of the `!SHARDING` feature
+ - `org.apache.shardingsphere:shardingsphere-broadcast-core`, provides core
implementation of the `!BROADCAST` feature
+ - `org.apache.shardingsphere:shardingsphere-readwrite-splitting-core`,
provides core implementation of the `!READWRITE_SPLITTING` feature
+ - `org.apache.shardingsphere:shardingsphere-shadow-core`, provides core
implementation of the `!SHADOW` feature
+ - `org.apache.shardingsphere:shardingsphere-encrypt-core`, provides core
implementation of the `!ENCRYPT` feature
+ - `org.apache.shardingsphere:shardingsphere-mask-core`, provides core
implementation of the `!MASK` feature
+- Row Value Expressions
+ - `org.apache.shardingsphere:shardingsphere-infra-expr-espresso`, provides
row value expression implementation for `<ESPRESSO>`
+- Enhancement of the feature core
+ - `org.apache.shardingsphere:shardingsphere-sharding-mysql`, provides
MySQL-oriented enhancements and adaptations for the core functionality of
`shardingsphere-sharding-core`
+- Time service
+ - `org.apache.shardingsphere:shardingsphere-database-time-service`, provides
a unified timestamp by connecting to the database and executing an SQL query to
retrieve the current time, which is used by routing logic such as sharding
+- GraalVM Native Image
+ - `org.apache.shardingsphere:shardingsphere-infra-reachability-metadata`,
provides GraalVM Reachability Metadata for ShardingSphere for `oracle/graal`
In addition to the above optional plugins, ShardingSphere community developers
have contributed a number of plugin implementations. These plugins can be found
in [ShardingSphere Plugins](https://github.com/apache/shardingsphere-plugin)
repository. Plugins in ShardingSphere Plugin repository would remain the same
release plan with ShardingSphere, you can build plugin jar by yourself, and
install into ShardingSphere.
diff --git
a/docs/document/content/user-manual/shardingsphere-proxy/optional-plugins/_index.cn.md
b/docs/document/content/user-manual/shardingsphere-proxy/optional-plugins/_index.cn.md
index 506c5249f91..f5077bc37a3 100644
---
a/docs/document/content/user-manual/shardingsphere-proxy/optional-plugins/_index.cn.md
+++
b/docs/document/content/user-manual/shardingsphere-proxy/optional-plugins/_index.cn.md
@@ -7,42 +7,51 @@ ShardingSphere 默认情况下仅包含核心 SPI 的实现，在 Git Source 存
实现的插件未包含在内。可在 https://central.sonatype.com/ 进行检索。
所有插件对应的 SPI 和 SPI 的已有实现类均可在
https://shardingsphere.apache.org/document/current/cn/dev-manual/ 检索。
-
-下以 `groupId:artifactId` 的表现形式列出 ShardingSphere-Proxy 所有的内置插件。
-
--
`org.apache.shardingsphere:shardingsphere-cluster-mode-repository-zookeeper`，集群模式配置信息持久化定义的
ZooKeeper 实现
--
`org.apache.shardingsphere:shardingsphere-cluster-mode-repository-etcd`，集群模式配置信息持久化定义的
Etcd 实现
-- `org.apache.shardingsphere:shardingsphere-jdbc`， JDBC 模块
-- `org.apache.shardingsphere:shardingsphere-database-protocol-core`，数据库协议核心
-- `org.apache.shardingsphere:shardingsphere-protocol-mysql`，数据库协议的 MySQL 实现
-- `org.apache.shardingsphere:shardingsphere-protocol-postgresql`，数据库协议的
PostgreSQL 实现
-- `org.apache.shardingsphere:shardingsphere-protocol-opengauss`，数据库协议的
openGauss 实现
-- `org.apache.shardingsphere:shardingsphere-protocol-firebird`，数据库协议的 Firebird
实现
-- `org.apache.shardingsphere:shardingsphere-proxy-frontend-core`，用于
ShardingSphere-Proxy 解析与适配访问数据库的协议
-- `org.apache.shardingsphere:shardingsphere-proxy-frontend-mysql`，用于
ShardingSphere-Proxy 解析与适配访问数据库的协议的 MySQL 实现
-- `org.apache.shardingsphere:shardingsphere-proxy-frontend-postgresql`，用于
ShardingSphere-Proxy 解析与适配访问数据库的协议的 PostgreSQL 实现
-- `org.apache.shardingsphere:shardingsphere-proxy-frontend-opengauss`，用于
ShardingSphere-Proxy 解析与适配访问数据库的协议的 openGauss 实现
-- `org.apache.shardingsphere:shardingsphere-proxy-frontend-firebird`，用于
ShardingSphere-Proxy 解析与适配访问数据库的协议的 Firebird 实现
-- `org.apache.shardingsphere:shardingsphere-proxy-backend-core`，
ShardingSphere Proxy 的后端核心模块
--
`org.apache.shardingsphere:shardingsphere-standalone-mode-core`，单机模式配置信息持久化定义核心
-
-对于核心的
`org.apache.shardingsphere:shardingsphere-jdbc`，其内置插件参考[ShardingSphere-JDBC
可选插件](/cn/user-manual/shardingsphere-jdbc/optional-plugins/)。
-
如果 ShardingSphere-Proxy 需要使用可选插件，需要在 Maven Central 下载包含其 SPI 实现的 JAR 和其依赖的 JAR。
下以 `groupId:artifactId` 的表现形式列出所有的可选插件。
-- 单机模式配置信息持久化定义
- -
`org.apache.shardingsphere:shardingsphere-standalone-mode-repository-jdbc`，基于
JDBC 的持久化
-- XA 分布式事务管理器
- - `org.apache.shardingsphere:shardingsphere-transaction-xa-narayana`，基于
Narayana 的 XA 分布式事务管理器
+- 数据库方言适配
+ - `org.apache.shardingsphere:shardingsphere-proxy-dialect-postgresql`，面向
Postgres 的方言与兼容性适配
+ - `org.apache.shardingsphere:shardingsphere-proxy-dialect-mysql`，面向 MySQL
的方言与兼容性适配
+ - `org.apache.shardingsphere:shardingsphere-proxy-dialect-sqlserver`，面向 MS
SQL Server 的方言与兼容性适配
+ - `org.apache.shardingsphere:shardingsphere-proxy-dialect-mariadb`，面向
MariaDB 的方言与兼容性适配
+ - `org.apache.shardingsphere:shardingsphere-proxy-dialect-presto`，面向 Presto
的方言与兼容性适配
+ - `org.apache.shardingsphere:shardingsphere-proxy-dialect-oracle`，面向 Oracle
Database Free 和 Oracle-XE 的方言与兼容性适配
+ - `org.apache.shardingsphere:shardingsphere-proxy-dialect-firebird`，面向
Firebird 的方言与兼容性适配
+ - `org.apache.shardingsphere:shardingsphere-proxy-dialect-clickhouse`，面向
Clickhouse 的方言与兼容性适配
+ - `org.apache.shardingsphere:shardingsphere-proxy-dialect-opengauss`，面向
openGauss 的方言与兼容性适配
+ - `org.apache.shardingsphere:shardingsphere-proxy-dialect-doris`，面向 Doris FE
的方言与兼容性适配
+ - `org.apache.shardingsphere:shardingsphere-proxy-dialect-hive`，面向
HiveServer2 的方言与兼容性适配
+- 数据源连接池
+ -
`org.apache.shardingsphere:shardingsphere-infra-data-source-pool-hikari`，提供
`dataSources.<data_source_name>.dataSourceClassName=com.zaxxer.hikari.HikariDataSource`
的连接池创建与属性适配实现
+- 权限与认证实现
+ - `org.apache.shardingsphere:shardingsphere-authority-simple`，提供
`authority.privilege.type=ALL_PERMITTED` 的权限与认证实现
+ - `org.apache.shardingsphere:shardingsphere-authority-database`，提供
`authority.privilege.type=DATABASE_PERMITTED` 的权限与认证实现
+- 分布式事务
+ - `org.apache.shardingsphere:shardingsphere-transaction-xa-atomikos`，提供
`transaction.providerType=Atomikos` 的分布式事务实现
+ - `org.apache.shardingsphere:shardingsphere-transaction-xa-narayana`，提供
`transaction.providerType=Narayana` 的分布式事务实现
+ - `org.apache.shardingsphere:shardingsphere-transaction-base-seata-at`，提供
`transaction.providerType=Seata` 的分布式事务实现
+- SQL 翻译
+ -
`org.apache.shardingsphere:shardingsphere-sql-translator-native-provider`，提供
`sqlTranslator.type=Native` 的 SQL 翻译实现
+- 配置与元数据持久化仓库
+ -
`org.apache.shardingsphere:shardingsphere-standalone-mode-repository-memory`，提供
`mode.repository.type=Memory` 的配置与元数据持久化仓库实现
+ -
`org.apache.shardingsphere:shardingsphere-standalone-mode-repository-jdbc`，提供
`mode.repository.type=JDBC` 的配置与元数据持久化仓库实现
+ -
`org.apache.shardingsphere:shardingsphere-cluster-mode-repository-zookeeper`，提供
`mode.repository.type=ZooKeeper` 的配置与元数据持久化仓库实现
+ - `org.apache.shardingsphere:shardingsphere-cluster-mode-repository-etcd`，提供
`mode.repository.type=etcd` 的配置与元数据持久化仓库实现
- 行表达式
- - `org.apache.shardingsphere:shardingsphere-infra-expr-espresso`，基于 GraalVM
Truffle 的 Espresso 实现的使用 Groovy 语法的行表达式
-- 数据库类型识别
- - `org.apache.shardingsphere:shardingsphere-infra-database-hive`， 对 Hive 的
jdbcURL 的识别适配，元数据加载实现
- - `org.apache.shardingsphere:shardingsphere-infra-database-presto`， 对 Presto
的 jdbcURL 的识别适配，元数据加载实现
-- SQL 解析
- - `org.apache.shardingsphere:shardingsphere-parser-sql-engine-clickhouse`，
SQL 解析的 ClickHouse 方言实现
- - `org.apache.shardingsphere:shardingsphere-parser-sql-engine-hive`， SQL 解析的
Hive 方言实现
+ - `org.apache.shardingsphere:shardingsphere-infra-expr-espresso`，提供
`<ESPRESSO>` 的行表达式实现
+- DistSQL
+ - `org.apache.shardingsphere:shardingsphere-sharding-distsql-handler`，提供
`!SHARDING` 相关 DistSQL 的执行端能力
+ - `org.apache.shardingsphere:shardingsphere-broadcast-distsql-handler`，提供
`!BROADCAST` 相关 DistSQL 的执行端能力
+ -
`org.apache.shardingsphere:shardingsphere-readwrite-splitting-distsql-handler`，提供
`!READWRITE_SPLITTING` 相关 DistSQL 的执行端能力
+ - `org.apache.shardingsphere:shardingsphere-shadow-distsql-handler`，提供
`!SHADOW` 相关 DistSQL 的执行端能力
+ - `org.apache.shardingsphere:shardingsphere-encrypt-distsql-handler`，提供
`!ENCRYPT` 相关 DistSQL 的执行端能力
+ - `org.apache.shardingsphere:shardingsphere-mask-distsql-handler`，提供 `!MASK`
相关 DistSQL 的执行端能力
+- 功能核心的增强
+ - `org.apache.shardingsphere:shardingsphere-sharding-mysql`，为
`shardingsphere-sharding-core` 提供面向 MySQL 的增强与适配
+ -
`org.apache.shardingsphere:shardingsphere-data-pipeline-feature-sharding`，为
`MIGRATION` 相关 DistSQL 提供分片场景的集成能力
+- 时间服务
+ -
`org.apache.shardingsphere:shardingsphere-database-time-service`，通过连接数据库并执行
“取当前时间” 的 SQL 来提供统一时间戳，供分片等路由逻辑使用
除了以上可选插件外，ShardingSphere 社区开发者还贡献了大量的插件实现，可以在 [ShardingSphere
Plugin](https://github.com/apache/shardingsphere-plugin)
仓库中查看插件的使用说明，ShardingSphere Plugin 仓库中的插件会和 ShardingSphere 保持相同的发布节奏，可以手动打包安装到
ShardingSphere 中。
diff --git
a/docs/document/content/user-manual/shardingsphere-proxy/optional-plugins/_index.en.md
b/docs/document/content/user-manual/shardingsphere-proxy/optional-plugins/_index.en.md
index ab9c6d86715..eebd93a65b4 100644
---
a/docs/document/content/user-manual/shardingsphere-proxy/optional-plugins/_index.en.md
+++
b/docs/document/content/user-manual/shardingsphere-proxy/optional-plugins/_index.en.md
@@ -4,45 +4,53 @@ weight = 6
+++
ShardingSphere only includes the implementation of the core SPI by default,
and there is a part of the SPI that contains third-party dependencies in Git
Source
-Implemented plugins are not included. Retrievable at
https://central.sonatype.com/.
-
-SPI and existing implementation classes of SPI corresponding to all plugins
can be retrieved at
https://shardingsphere.apache.org/document/current/cn/dev-manual/.
-
-All the built-in plugins for ShardingSphere-Proxy are listed below in the form
of 'groupId:artifactId'.
-
--
`org.apache.shardingsphere:shardingsphere-cluster-mode-repository-zookeeper`,
the ZooKeeper implementation of the persistent definition of cluster mode
configuration information
-- `org.apache.shardingsphere:shardingsphere-cluster-mode-repository-etcd`,
Etcd implementation of persistent definition of cluster mode configuration
information
-- `org.apache.shardingsphere:shardingsphere-jdbc`, JDBC module
-- `org.apache.shardingsphere:shardingsphere-database-protocol-core`, database
protocol core
-- `org.apache.shardingsphere:shardingsphere-protocol-mysql`, the MySQL
implementation of the database protocol
-- `org.apache.shardingsphere:shardingsphere-protocol-postgresql`, the
PostgreSQL implementation of the database protocol
-- `org.apache.shardingsphere:shardingsphere-protocol-opengauss`, the OpenGauss
implementation of the database protocol
-- `org.apache.shardingsphere:shardingsphere-protocol-firebird`, the Firebird
implementation of the database protocol
-- `org.apache.shardingsphere:shardingsphere-proxy-frontend-core`, used by
ShardingSphere-Proxy to parse and adapt the protocol for accessing the database
-- `org.apache.shardingsphere:shardingsphere-proxy-frontend-mysql`, a MySQL
implementation for ShardingSphere-Proxy to parse and adapt the protocol for
accessing the database
-- `org.apache.shardingsphere:shardingsphere-proxy-frontend-postgresql`, a
PostgreSQL implementation for ShardingSphere-Proxy to parse and adapt the
protocol for accessing the database
-- `org.apache.shardingsphere:shardingsphere-proxy-frontend-opengauss`, an
openGauss implementation for ShardingSphere-Proxy to parse and adapt the
protocol for accessing the database
-- `org.apache.shardingsphere:shardingsphere-proxy-frontend-firebird`, an
Firebird implementation for ShardingSphere-Proxy to parse and adapt the
protocol for accessing the database
-- `org.apache.shardingsphere:shardingsphere-proxy-backend-core`, the backend
core for ShardingSphere Proxy
-- `org.apache.shardingsphere:shardingsphere-standalone-mode-core`, the
persistence definition core of single-machine mode configuration information
-
-For the core `org.apache.shardingsphere:shardingsphere-jdbc`,Its built-in
plugins reference[ShardingSphere-JDBC Optional
Plugins](/en/user-manual/shardingsphere-jdbc/optional-plugins/).
-
-If ShardingSphere Proxy needs to use optional plugins, you need to download
the JAR containing its SPI implementation and its dependent JARs from Maven
Central.
-
-All optional plugins are listed below in the form of `groupId:artifactId`.
-
-- Standalone mode configuration information persistence definition
- -
`org.apache.shardingsphere:shardingsphere-standalone-mode-repository-jdbc`,
JDBC based persistence
-- XA transaction manager provider definition
- - `org.apache.shardingsphere:shardingsphere-transaction-xa-narayana`, XA
distributed transaction manager based on Narayana
-- Row Value Expressions definition
- - `org.apache.shardingsphere:shardingsphere-infra-expr-espresso`，Row Value
Expressions that uses the Groovy syntax based on GraalVM Truffle's Espresso
implementation
-- Database type identification
- - `org.apache.shardingsphere:shardingsphere-infra-database-hive`, Adaptation
of jdbcURL for `JDBC support` of Hive, and metadata loading implementation
- - `org.apache.shardingsphere:shardingsphere-infra-database-presto`,
Adaptation of jdbcURL for `JDBC support` of Presto, and metadata loading
implementation
-- SQL parsing
- - `org.apache.shardingsphere:shardingsphere-parser-sql-engine-clickhouse`,
ClickHouse dialect implementation of SQL parsing
- - `org.apache.shardingsphere:shardingsphere-parser-sql-engine-hive`， Hive
dialect implementation of SQL parsing
+Implemented plugins are not included. Retrievable at
https://central.sonatype.com/ .
+
+SPI and existing implementation classes of SPI corresponding to all plugins
can be retrieved at
https://shardingsphere.apache.org/document/current/cn/dev-manual/ .
+
+The following lists all optional plugins in the format of `groupId:artifactId`.
+
+- Database dialect adaptation
+ - `org.apache.shardingsphere:shardingsphere-proxy-dialect-postgresql`,
dialect and compatibility adaptation for Postgres
+ - `org.apache.shardingsphere:shardingsphere-proxy-dialect-mysql`, dialect
and compatibility adaptation for MySQL
+ - `org.apache.shardingsphere:shardingsphere-proxy-dialect-sqlserver`,
dialect and compatibility adaptation for MS SQL Server
+ - `org.apache.shardingsphere:shardingsphere-proxy-dialect-mariadb`, dialect
and compatibility adaptation for MariaDB
+ - `org.apache.shardingsphere:shardingsphere-proxy-dialect-presto`, dialect
and compatibility adaptation for Presto
+ - `org.apache.shardingsphere:shardingsphere-proxy-dialect-oracle`, dialect
and compatibility adaptation for Oracle Database Free and Oracle-XE
+ - `org.apache.shardingsphere:shardingsphere-proxy-dialect-firebird`, dialect
and compatibility adaptation for Firebird
+ - `org.apache.shardingsphere:shardingsphere-proxy-dialect-clickhouse`,
dialect and compatibility adaptation for Clickhouse
+ - `org.apache.shardingsphere:shardingsphere-proxy-dialect-opengauss`,
dialect and compatibility adaptation for openGauss
+ - `org.apache.shardingsphere:shardingsphere-proxy-dialect-doris`, dialect
and compatibility adaptation for Doris FE
+ - `org.apache.shardingsphere:shardingsphere-proxy-dialect-hive`, dialect and
compatibility adaptation for HiveServer2
+- Data Source Connection Pool
+ - `org.apache.shardingsphere:shardingsphere-infra-data-source-pool-hikari`,
provides connection pool creation and property adaptation implementation for
`dataSources.<data_source_name>.dataSourceClassName=com.zaxxer.hikari.HikariDataSource`
+- Permissions and authentication implementation
+ - `org.apache.shardingsphere:shardingsphere-authority-simple`, provides
permission and authentication implementation with
`authority.privilege.type=ALL_PERMITTED`
+ - `org.apache.shardingsphere:shardingsphere-authority-database`, provides
permission and authentication implementation with
`authority.privilege.type=DATABASE_PERMITTED`
+- Distributed transactions
+ - `org.apache.shardingsphere:shardingsphere-transaction-xa-atomikos`,
provides distributed transaction implementation for
`transaction.providerType=Atomikos`
+ - `org.apache.shardingsphere:shardingsphere-transaction-xa-narayana`,
provides distributed transaction implementation for
`transaction.providerType=Narayana`
+ - `org.apache.shardingsphere:shardingsphere-transaction-base-seata-at`,
provides distributed transaction implementation for
`transaction.providerType=Seata`
+- SQL Translation
+ - `org.apache.shardingsphere:shardingsphere-sql-translator-native-provider`,
provides SQL translation implementation with `sqlTranslator.type=Native`
+- Configuration and metadata persistence repository
+ -
`org.apache.shardingsphere:shardingsphere-standalone-mode-repository-memory`,
provides configuration and metadata persistence repository implementation for
`mode.repository.type=Memory`
+ -
`org.apache.shardingsphere:shardingsphere-standalone-mode-repository-jdbc`,
provides configuration and metadata persistence repository implementation for
`mode.repository.type=JDBC`
+ -
`org.apache.shardingsphere:shardingsphere-cluster-mode-repository-zookeeper`,
provides configuration and metadata persistence repository implementation for
`mode.repository.type=ZooKeeper`
+ - `org.apache.shardingsphere:shardingsphere-cluster-mode-repository-etcd`,
provides configuration and metadata persistence repository implementation for
`mode.repository.type=etcd`
+- Row Value Expressions
+ - `org.apache.shardingsphere:shardingsphere-infra-expr-espresso`, provides
row value expression implementation for `<ESPRESSO>`
+- DistSQL
+ - `org.apache.shardingsphere:shardingsphere-sharding-distsql-handler`,
provides execution capabilities for DistSQL related to `!SHARDING`
+ - `org.apache.shardingsphere:shardingsphere-broadcast-distsql-handler`,
provides execution capabilities for DistSQL related to `!BROADCAST`
+ -
`org.apache.shardingsphere:shardingsphere-readwrite-splitting-distsql-handler`,
provides execution capabilities for DistSQL related to `!READWRITE_SPLITTING`
+ - `org.apache.shardingsphere:shardingsphere-shadow-distsql-handler`,
provides execution capabilities for DistSQL related to `!SHADOW`
+ - `org.apache.shardingsphere:shardingsphere-encrypt-distsql-handler`,
provides execution capabilities for DistSQL related to `!ENCRYPT`
+ - `org.apache.shardingsphere:shardingsphere-mask-distsql-handler`, provides
execution capabilities for DistSQL related to `!MASK`
+- Enhancement of the feature core
+ - `org.apache.shardingsphere:shardingsphere-sharding-mysql`, provides
MySQL-oriented enhancements and adaptations for the core functionality of
`shardingsphere-sharding-core`
+ - `org.apache.shardingsphere:shardingsphere-data-pipeline-feature-sharding`,
provides integration capabilities for sharding scenarios in DistSQL related to
`MIGRATION`
+- Time service
+ - `org.apache.shardingsphere:shardingsphere-database-time-service`, provides
a unified timestamp by connecting to the database and executing an SQL query to
retrieve the current time, which is used by routing logic such as sharding
In addition to the above optional plugins, ShardingSphere community developers
have contributed a number of plugin implementations. These plugins can be found
in [ShardingSphere Plugins](https://github.com/apache/shardingsphere-plugin)
repository. Plugins in ShardingSphere Plugin repository would remain the same
release plan with ShardingSphere, you can build plugin jar by yourself, and
install into ShardingSphere.
