Apache Shardingsphere (Incubating)

Clone this repo:
  1. 9bd46e7 Fix metric image path. (#5896) by xiaoyu · 4 days ago master
  2. bf2ddeb Update user-manual/configuration/java-api (#5895) by Liang Zhang · 4 days ago
  3. 04eb9c4 fixes document link (#5891) by Haoran Meng · 4 days ago
  4. 8291b4a Optimize disable proxy instance with UI # control-panel-cluster (#5883) by Haoran Meng · 4 days ago
  5. c31b758 Add metric document. (#5888) by xiaoyu · 4 days ago

ShardingSphere - Distributed Database Middleware Ecosphere

Official website: https://shardingsphere.apache.org/

License Gitter GitHub release Stargazers over time

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

Document

EN doc CN doc

Overview

Apache ShardingSphere is an open-source ecosystem consisted of a set of distributed database middleware solutions, including 3 independent products, JDBC, Proxy & Sidecar (Planning). 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 ShardingSphere begin to focus on pluggable architecture from version 5.x, features can be embedded into project flexibility. Currently, the features such as data sharding, read-write splitting, multi replica, data encrypt, shadow test, and SQL dialects / database protocols such as MySQL, PostgreSQL, SQLServer, Oracle supported are all weaved by plugins. Developers can customize their own ShardingSphere just like building lego blocks. There are lots of SPI extensions for Apache ShardingSphere now and increase continuously.

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

Welcome communicate with community via mail list.

ShardingSphere Scope

ShardingSphere-JDBC

Maven Status

ShardingSphere-JDBC defines itself as a lightweight Java framework that provides extra service at Java JDBC layer. With the 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 JDBC, such as JPA, Hibernate, Mybatis, Spring JDBC Template or direct use of JDBC.
  • Support any third-party database connection pool, such as DBCP, C3P0, BoneCP, Druid, HikariCP.
  • Support any kind of JDBC standard database: MySQL, Oracle, SQLServer, PostgreSQL and any SQL92 followed databases.

ShardingSphere-JDBC Architecture

ShardingSphere-Proxy

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 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 client end that is compatible with MySQL and PostgreSQL protocol.

ShardingSphere-Proxy Architecture

ShardingSphere-Sidecar(TODO)

ShardingSphere-Sidecar (TODO) defines itself as a cloud native database agent of the Kubernetes environment, in charge of all the access to the database in the form of sidecar. It provides a mesh layer interacting with the 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 the 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 the mesh layer.

ShardingSphere-Sidecar Architecture

ShardingSphere-JDBCShardingSphere-ProxyShardingSphere-Sidecar
DatabaseAnyMySQL/PostgreSQLMySQL/PostgreSQL
Connections Count CostHighLowHigh
Supported LanguagesJava OnlyAnyAny
PerformanceLow lossRelatively High lossLow loss
DecentralizationYesNoNo
Static EntryNoYesNo

Hybrid Architecture

ShardingSphere-JDBC adopts 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 ecosphere consists of multiple endpoints together. Through a mixed use of ShardingSphere-JDBC and ShardingSphere-Proxy and unified sharding strategy by the same registry center, ShardingSphere can build an 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

Features

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

  • Distributed Governance
  • Data migration & Scale out
  • Tracing & Observability Supported
  • Data Encryption

How to Build

Build Apache ShardingSphere

./mvnw clean install -Prelease

Artifact:

shardingsphere-distribution/shardingsphere-src-distribution/target/apache-shardingsphere-${latest.release.version}-src.zip  # 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

Build ShardingSphere-UI

cd shardingsphere-ui
./mvnw clean install -Prelease

Artifact:

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

Landscapes