linghengqian commented on code in PR #37735: URL: https://github.com/apache/shardingsphere/pull/37735#discussion_r2688948154
########## 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-simple`, provides permission and authentication implementation with `authority.privilege.type=DATABASE_PERMITTED` Review Comment: Fixed. ########## 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-simple`，提供 `authority.privilege.type=DATABASE_PERMITTED` 的权限与认证实现 Review Comment: Fixed. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
