Optional Plugins

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-etcd, etcd implementation of persistent definition of cluster mode configuration information
  • org.apache.shardingsphere:shardingsphere-cluster-mode-repository-zookeeper, the zookeeper implementation of the persistent definition of cluster mode configuration information
  • org.apache.shardingsphere:shardingsphere-jdbc-core, JDBC core
  • org.apache.shardingsphere:shardingsphere-db-protocol-core, database protocol core
  • org.apache.shardingsphere:shardingsphere-mysql-protocol, the MySQL implementation of the database protocol
  • org.apache.shardingsphere:shardingsphere-postgresql-protocol, the PostgreSQL implementation of the database protocol
  • org.apache.shardingsphere:shardingsphere-opengauss-protocol, the OpenGauss 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-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-core,Its built-in plugins referenceShardingSphere-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
  • Cluster mode configuration information persistence definition
    • org.apache.shardingsphere:shardingsphere-cluster-mode-repository-consul, Consul based persistence
  • XA transaction manager provider definition
    • org.apache.shardingsphere:shardingsphere-transaction-xa-narayana, XA distributed transaction manager based on Narayana
  • SQL translator
    • org.apache.shardingsphere:shardingsphere-sql-translator-jooq-provider, JooQ SQL translator
  • 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-testcontainers, Adaptation of jdbcURL for JDBC support of testcontainers-java

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 repository. Plugins in ShardingSphere Plugin repository would remain the same release plan with ShardingSphere, they can be retrieved at https://central.sonatype.com/, and install into ShardingSphere.