Skip to content
Switch branches/tags

Latest commit



Failed to load latest commit information.

ShardingSphere - Build criterion and ecosystem above multi-model databases

Official Website:

License GitHub release

Twitter Slack Gitter

Stargazers Over Time

Stargazers Over Time

Contributors Over Time

Contributors Over Time

Build Status codecov snyk Maintainability

OpenTracing-1.0 Badge Skywalking Tracing


EN doc CN doc


Apache ShardingSphere is positioned as Database Plus, which aims to build criterion and ecosystem above multi-model databases. It focuses on how to reuse existing database, rather than creating a new database. ShardingSphere focuses on the upper layer of databases, pays more attention on cooperation between databases rather than database itself.

Link, Enhance and Pluggable is the core concepts of Apache ShardingSphere.

  • Link:Flexible adaptation of database protocol, SQL dialect and database storage, it can link applications and multi-mode heterogeneous databases quickly;
  • 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 analyse (Qos and observability);
  • Pluggable:Use micro kernel and 3 layers pluggable mode, to make features and database ecosystem can be embedded flexibility. Developers can customize their ShardingSphere just like building blocks.

ShardingSphere became an Apache Top-Level Project on April 16, 2020.

You are welcome to communicate with the community via the mailing list and interact via the ShardingSphere Slack.


Apache ShardingSphere including 3 independent products: JDBC, Proxy & Sidecar (Planning). 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.


Maven Status

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.

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, Druid, HikariCP. Supports any kind of JDBC standard database: MySQL, Oracle, SQLServer, PostgreSQL and any SQL92 followed databases.

ShardingSphere-JDBC Architecture


Download Docker Pulls

ShardingSphere-Proxy defines itself as a transparent database proxy, providing a database server that encapsulates database binary protocol to support heterogeneous languages. Friendlier to DBAs, the MySQL version now provided can use any kind of terminal (such as MySQL Command Client, MySQL Workbench, etc.) that is compatible of MySQL protocol to operate data.

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.

ShardingSphere-Proxy Architecture

ShardingSphere-JDBC ShardingSphere-Proxy
Database Any MySQL/PostgreSQL
Connections Count Cost High Low
Supported Languages Java Only Any
Performance Low loss Relatively High loss
Decentralization Yes No
Static Entry No Yes

Hybrid Architecture

ShardingSphere-JDBC adopts a decentralized architecture, applicable to high-performance light-weight OLTP application developed with Java. ShardingSphere-Proxy provides static entry and all languages support, applicable for OLAP application and the sharding databases management and operation situation.

ShardingSphere is an ecosystem consisting of multiple endpoints together. Through a mixed use of ShardingSphere-JDBC and ShardingSphere-Proxy and a unified sharding strategy by the same registry center, ShardingSphere can build an application system that is applicable to all kinds of scenarios. Architects can adjust the system architecture to the most applicable one to their needs to conduct business more freely.

ShardingSphere Hybrid Architecture


Distributed Database

  • Data Sharding
  • Readwrite-splitting
  • Distributed Transaction
  • Elastic Scale-out
  • Distributed Highly Available

Data Security

  • Data Encrypt
  • Row Authority (TODO)
  • SQL Audit (TODO)
  • SQL Firewall (TODO)

Database Gateway

  • Multi-model Databases supported
  • SQL Dialect Translate(TODO)

Stress Testing

  • Shadow Database
  • Observability (Tracing and Metrics)

How to Build

Build Apache ShardingSphere

./mvnw clean install -Prelease


shardingsphere-distribution/shardingsphere-src-distribution/target/apache-shardingsphere-${latest.release.version}  # Source code package of Apache ShardingSphere
shardingsphere-distribution/shardingsphere-jdbc-distribution/target/apache-shardingsphere-${latest.release.version}-shardingsphere-jdbc-bin.tar.gz  # Binary package of ShardingSphere-JDBC
shardingsphere-distribution/shardingsphere-proxy-distribution/target/apache-shardingsphere-${latest.release.version}-shardingsphere-proxy-bin.tar.gz  # Binary package of ShardingSphere-Proxy
shardingsphere-distribution/shardingsphere-scaling-distribution/target/apache-shardingsphere-${latest.release.version}-shardingsphere-scaling-bin.tar.gz  # Binary package of ShardingSphere-Scaling

Build ShardingSphere-UI

git clone
cd shardingsphere-ui
./mvnw clean install -Prelease


shardingsphere-ui/shardingsphere-ui-distribution/shardingsphere-ui-bin-distribution/target/apache-shardingsphere-${latest.release.version}-shardingsphere-ui-bin.tar.gz  # Binary package of ShardingSphere-UI





Apache ShardingSphere enriches the CNCF CLOUD NATIVE Landscape.