1 Star 0 Fork 19

javaeye_007 / sharding-jdbc-doc

Create your Gitee Account
Explore and code with more than 6 million developers,Free private repositories !:)
Sign up
This repository doesn't specify license. Without author's permission, this code is only for learning and cannot be used for other purposes.
Clone or download
Proposal.md 11.30 KB
Copy Edit Web IDE Raw Blame History
terrymanu authored 2018-05-08 20:48 . remove 01- 02- 03- from community doc

Sharding Proposal


Sharding is a distributed database middleware, focus on data sharding, read-write splitting, BASE transaction and database orchestration. It provides maximum compatibilities for applications by JDBC driver or database protocols proxy.


Sharding has good community in China, it has many end users, including companies and organizations.

We want to bring Sharding into Apache Software Foundation in order to build a global, diverse and stronger open source community.

Dangdang submits this proposal to donate Sharding's source codes and all related documentations to the Apache Software Foundation. The codes are already under Apache License Version 2.0.


Sharding started in Open Source on GitHub at year 2016. Because of data growth quickly on internet company, relational database can not afford any more, but developer and DBA still want use it to persist core data. Sharding is beginning with a JDBC driver to sharding data only (name as Sharding-JDBC) at Dangdang internal framework. It offers data sharding, read-write splitting, BASE transaction and database orchestration right now. Besides JDBC, proxy with database protocol is also supported, and sidecar feature is in our roadmap.

Sharding-JDBC has won TOP 20 most popular open source projects in China 2016.

Because in our roadmap, it should not base on JDBC only, proxy and sidecar features are not JDBC based, we want to rename it to Sharding after it accepted by Apache Software Foundation.


Relational database still plays a very important role on current application system. The maturity of production and surrounding ecosystem, friendliness of data query, the mastery degree of developers and DBAs, it cannot be completely replaced with NoSQL or NewSQL in the near future. But current relational database cannot support cloud native very well and unfriendliness for distributed system.

The final proposal of Sharding is let user use distributed databases as a single database. Sharding uses mesher to manage the databases scattered around the system. The interaction among the applications and the databases, which is concentrated in the mesher, is as complex and orderly as a cobweb. As the point, the concept of Database Mesh is similar with Service Mesh. The attention of Database Mesh focuses on how to connect the distributed data-access-layer and databases together. And it pays more attention to the interaction, which means the messy interaction among the applications and databases will be effectively organized. By using Database Mesh, applications and databases will form a large grid system, and they just need to be put into the right position on grid system accordingly, for they are all be governed by mesher.

Current Status


This project started from Dangdang at 2015 and opened on GitHub at 2016. At 2017 Jingdong recognized its value, and determined to sponsor. We set up the PMC team and committer team. The project has contributors and users from many companies. The new contributors are guided, discussed and reviewed by the existed PMC members. When they are ready, PMC will start a vote to promote him/her to become a member of PMC and Committer Team. See the details here. Contributions are always welcomed and highly valued.


Now we have set 2 development teams in JingDong and Dangdang for the project. CHINA TELECOM, Sohu, DataMan and Enniu are interesting on Sharding, We hope to grow the base of contributors by inviting all those who offer contributions and excel through the use of The Apache Way. Right now, we make use of github as code hosting as well as gitter for community communication.

Core Developers

The core developers are a diverse group of experienced open source developers and team leaders.

PMC members

  • 张亮, Liang Zhang, Java and architect expert, Jingdong

  • 曹昊, Hao Cao, Senior Architect, Dangdang

  • 吴晟, Sheng Wu, APM and tracing expert, Apache SkyWalking(incubator) creator & PMC member

  • 高洪涛, Hongtao Gao, Database and APM expert, Apache SkyWalking(incubator) PMC member

Committer members

  • 李广云, Guangyun Li, Java Expert, Antfin

  • 王文斌, Wenbin Wang, Technical manager, Kangda

  • 朱政科, Zhengke Zhu, Senior engineer, Hangzhou Enniu Network Technology Company Limited

  • 马晓光, Xiaoguang Ma, Senior engineer, huimai365

  • 刘泽剑, ZeJian Liu, IT Manager, ZeDaYiSheng

  • 张永伦, Yonglun Zhang, Senior engineer, Jingdong

  • 潘娟, Juan Pan, Senior DBA, Jingdong

Known Risks

Orphaned products

Two development teams in JingDong and Dangdang will continue to work on Sharding 100% of the time for the foreseeable future with others from the growing community as well. And Sharding is widely used in China by many companies and organizations. So the risk of Sharding becoming orphaned is low.

Inexperience with Open Source

The current core developers all work for a company that has led or contributed to many open source software projects, including Apache SkyWalking (Incubating), Apache Dubbo (Incubator), CNCF OpenTracing, Elastic-Job, and others. Therefore, there is low risk related to inexperience with open source software and processes.

Homogenous Developers

The current core developers work across a variety of organizations including Jingdong, Dangdang and some individual developers. While CHINA TELECOM, Sohu, DataMan and Enniu are interesting on Sharding, and we plan to encourage them to contribute and invite them to work together.

Reliance on Salaried Developers

Two of the core developers are paid by their employer to contribute to the Sharding project. We expect that Sharding development will continue with salaried developers, and are committed to growing the community to include non-salaried developers as well.

Relationships with Other Apache Products

Sharding team worked with the SkyWalking team to introduce an automatic prober of Sharding to send performance data to SkyWalking. Zookeeper is integrated as one of the service registration/discovery mechanisms.

A Excessive Fascination with the Apache Brand

The Sharding community acknowledges the value and recognition that the Apache brand would bring to the Sharding project. However, our primary interest is in the community building process and long-term stability that the Apache Software Foundation provides for its projects.


A complete set of Sharding documentations is provided on shardingjdbc.io in both English and Simplified Chinese.

Initial Source

The project consists of four distinct codebases: Core, Opentracing adapter, example and document. These have existed as separate git repositories.

Source and Intellectual Property Submission Plan

The code is currently Apache 2.0 license, and was verified to have no intellectual property or license issues before being released to open source by Dangdang in 2016. Dangdang will provide SGA and all committers will sign ICLA after the project join to incubator.

External Dependencies

All dependencies are managed using Apache Maven, none of the external libraries need to be packaged in a source distribution. Most of dependencies have Apache compatible licenses. But mysql and dbunit use GPL-2.0 and LGPL-2.1.

We will remove dbunit and mysql dependencies in future. Dbunit only for initialization data set during test case running. MySQL JDBC driver is using on MySQL Proxy to connect MySQL now, we will use MySQL protocol format only and use socket to connect MySQL in future, so it do not need MySQL JDBC driver any more.

Dependency License
guava Apache-2.0
commons-lang3 Apache-2.0
commons-pool Apache-2.0
commons-dbcp Apache-2.0
netty Apache-2.0
curator Apache-2.0
grpc Apache-2.0
lombok MIT
groovy Apache-2.0
snakeyaml Apache-2.0
gson Apache-2.0
spring-context-support Apache-2.0
spring-context-test Apache-2.0
spring-boot-starter Apache-2.0
spring-boot-configuration-processor Apache-2.0
spring-boot-starter-test Apache-2.0
slf4j MIT
logback EPL-1.0
junit EPL-1.0
hamcrest BSD 3-clause
mockito MIT
dbunit LGPL-2.1
h2 MPL-2.0/EPL-1.0
mysql GPL-2.0
postgresql BSD
mssql-jdbc MIT
HikariCP Apache-2.0

Required Resources

Git Repositories





Issue Tracking


Continuous Integration tool


Mailing Lists



Gitter https://gitter.im/Sharding-JDBC/shardingjdbc

Slack https://sharding.slack.com

Initial Committers

  • 张亮, Liang Zhang, zhangliang@apache.org

  • 曹昊, Hao Cao,

  • 吴晟, Sheng Wu, wusheng@apache.org

  • 高洪涛, Hongtao Gao, hanahmily@apache.org

  • 李广云, Guangyun Li,

  • 王文斌, Wenbin Wang,

  • 朱政科, Zhengke Zhu,

  • 马晓光, Xiaoguang Ma,

  • 刘泽剑, ZeJian Liu,

  • 张永伦, Yonglun Zhang,

  • 潘娟, Juan Pan,


  • Jingdong: Liang Zhang, Yonglun Zhang, Juan Pan

  • Dangdang: Hao Cao

  • Enniu: Zhengke Zhu

  • Individuals: Sheng Wu, Hongtao Gao, Guangyun Li, Wenbin Wang, ZeJian Liu, Xiaoguang Ma




Sponsoring Entity

We are requesting the Apache Incubator to sponsor this project.

Comment ( 0 )

Sign in for post a comment