Skip to content
Distributed database middleware
Java ANTLR JavaScript TSQL Vue CSS Other
Branch: dev
Clone or download
betterjava and terrymanu support hint in sharding-proxy (#3002)
* add hint for sharding-proxy

* change editor setting and reformat

* change editor setting and reformat

* refactor hint command executor in sharding-proxy

* add NoArgsConstructor Annotation

* format indents for empty lines

* refactor hint command for sharding-proxy
Latest commit f4145ce Sep 18, 2019
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github update git template Jul 12, 2019
.mvn add jvm config Aug 2, 2019
sharding-core support hint in sharding-proxy (#3002) Sep 18, 2019
sharding-distribution fix sharding-ui-distribution error temporarily. Sep 9, 2019
sharding-integration-test For #3032, add missing mysql test cases for select with comments. (#3048 Sep 17, 2019
sharding-jdbc Fixes #2432 (#3050) Sep 17, 2019
sharding-opentracing [maven-release-plugin] prepare for next development iteration Aug 17, 2019
sharding-orchestration Add Config Center (#3020) Sep 17, 2019
sharding-proxy support hint in sharding-proxy (#3002) Sep 18, 2019
sharding-spring Feature#2601 Check RoutingResult. (#3021) Sep 17, 2019
sharding-sql-test For #3032, add missing mysql test cases for select escape. (#3042) Sep 16, 2019
sharding-transaction Merge pull request #2970 from apache/4.0.0-RC2-release Sep 4, 2019
sharding-ui sharding-ui-frontend add unit test (#3039) Sep 18, 2019
src/resources add shardingsphere-distribution module Mar 20, 2019
.gitignore update .gitignore Mar 20, 2019 update Code of Conduct Nov 12, 2018 Repair incorrect link in Mar 22, 2019
LICENSE Initial commit Jan 18, 2016
NOTICE add NOTICE Mar 21, 2019 rm travis && and jenkins badge Sep 5, 2019 rm travis && and jenkins badge Sep 5, 2019 update release notes Aug 9, 2019
jenkinsfile for coverage Aug 19, 2019
pom.xml Merge remote-tracking branch 'origin/dev' into dev Sep 10, 2019

ShardingSphere - Distributed Database Middleware Ecosphere

Official website:

License Gitter GitHub release Stargazers over time

Total Lines Build Status Coverage Status Codacy Badge snyk OpenTracing-1.0 Badge Skywalking Tracing


EN doc CN doc


ShardingSphere is an open-source ecosystem consisted of a set of distributed database middleware solutions, including 2 independent products, Sharding-JDBC & Sharding-Proxy & Sharding-Sidecar (todo). They all provide functions of data sharding, distributed transaction and database orchestration, applicable in a variety of situations such as Java isomorphism, heterogeneous language and cloud native.

Aiming at reasonably making full use of the computation and storage capacity of database in distributed system, ShardingSphere defines itself as a middleware, rather than a totally new type of database. As the cornerstone of many enterprises, relational database still takes a huge market share. Therefore, at current stage, we prefer to focus on its increment instead of a total overturn.

Apache releases is beginning from version 4.0.0

ShardingSphere Scope


Maven Status

Sharding-JDBC defines itself as a lightweight Java framework that provides extra service at Java JDBC layer. With client end connecting directly to the database, it provides service in the form of 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 Java, such as JPA, Hibernate, Mybatis, Spring JDBC Template or direct use of JDBC.
  • Based on any third-party database connection pool, such as DBCP, C3P0, BoneCP, Druid, HikariCP.
  • Support any kind of database that conforms to JDBC standard: MySQL, Oracle, SQLServer and PostgreSQL for now.

Sharding-JDBC Architecture


Download Docker Pulls

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

  • Totally transparent to applications, it can be used directly as MySQL and PostgreSQL.
  • Applicable to any kind of compatible of client end that is compatible of MySQL and PostgreSQL protocol.

Sharding-Proxy Architecture


Sharding-Sidecar (TODO) defines itself as a cloud native database agent of Kubernetes environment, in charge of all the access to database in the form of sidecar. It provides a mesh layer interacting with database, we call this as Database Mesh.

Database Mesh emphasizes on how to connect distributed database access application with the database. Focusing on interaction, it effectively organizes the interaction between messy applications and database. The application and database that use Database Mesh to visit database will form a large grid system, where they just need to be put into the right position accordingly. They are all governed by mesh layer.

Sharding-Sidecar Architecture

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

Hybrid Architecture

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

ShardingSphere is an ecosphere consists of multiple endpoints together. Through mixed use of Sharding-JDBC and Sharding-Proxy and unified sharding strategy by same registry center, ShardingSphere can build application system applicable to all kinds of scenarios. Architects can adjust the system architecture to the most applicable one to current business more freely.

ShardingSphere Hybrid Architecture


Data Sharding

  • Database sharding & Table sharding
  • Read-write splitting
  • Sharding strategy customization
  • Centre-less Distributed primary key

Distributed Transaction

  • Unified Transaction API
  • XA transaction
  • BASE transaction

Database Orchestration

  • Dynamic Configuration
  • Orchestration & Governance
  • Data Encryption
  • Tracing & Observability
  • Elastic scaling out (Planning)

Project Status


How to Build

Install maven and run command:

mvn clean install -Prelease


sharding-distribution/sharding-jdbc-distribution/target/apache-shardingsphere-incubating-${latest.release.version}-sharding-jdbc-bin.tar.gz: Binary package of Sharding-JDBC
sharding-distribution/sharding-proxy-distribution/target/apache-shardingsphere-incubating-${latest.release.version}-sharding-proxy-bin.tar.gz: Binary package of Sharding-Proxy
sharding-distribution/shardingsphere-src-distribution/target/apache-shardingsphere-incubating-${latest.release.version} Source code package of ShardingSphere
You can’t perform that action at this time.