Distributed SQL transaction & query engine for data sharding, scaling, encryption, and more - on any database.

Clone this repo:
  1. 6860e62 Remove useless CreateDatabaseStatementContext (#32109) by Liang Zhang · 5 hours ago master
  2. 45995d1 Remove useless KillStatementContext (#32108) by Liang Zhang · 7 hours ago
  3. 9515331 Refactor : Refactor the stale timeout days from 30 to 7 (#32107) by 孙念君 Nianjun Sun · 9 hours ago
  4. 658bd34 Refactor CommonSQLStatementContext (#32106) by Liang Zhang · 20 hours ago
  5. 2f4d877 Use mock SQLStatement for test cases (#32105) by Liang Zhang · 20 hours ago

Distributed SQL transaction & query engine for data sharding, scaling, encryption, and more - on any database.

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

GitHub Release Lines of Code

Quality Gate Status Technical Debt Maintainability Rating Security Rating codecov

OpenSSF Best Practices

Slack Gitter

Twitter

Stargazers Over TimeContributors Over Time
Stargazers Over TimeContributor over time

OVERVIEW

Apache ShardingSphere is a distributed SQL transaction & query engine that allows for data sharding, scaling, encryption, and more - on any database. Our community's guiding development concept is Database Plus for creating a complete ecosystem that allows you to transform any database into a distributed database system.

It focuses on repurposing existing databases, by placing a standardized upper layer above existing and fragmented databases, rather than creating a new database.

The goal is to provide unified database services and minimize or eliminate the challenges caused by underlying databases' fragmentation. This results in applications only needing to communicate with a single standardized service.

The concepts at the core of the project are Connect, Enhance and Pluggable.

  • Connect: Flexible adaptation of database protocol, SQL dialect and database storage. It can quickly connect applications and heterogeneous databases.
  • 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 analyze, QoS and observability).
  • Pluggable: Leveraging the micro kernel and 3 layers pluggable mode, features and database ecosystem can be embedded flexibly. Developers can customize their ShardingSphere just like building with LEGO blocks.

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

So far, ShardingSphere has been used by over 10,000 projects on GitHub.

DOCUMENTATION📜

EN doc CN doc

For full documentation & more details, visit: Docs

CONTRIBUTION🚀🧑💻

For guides on how to get started and setup your environment, contributor & committer guides, visit: Contribution Guidelines

Team

We deeply appreciate community contributors for their dedication to Apache ShardingSphere.

COMMUNITY & SUPPORT💝🖤

:link: Mailing List. Best for: Apache community updates, releases, changes.

:link: GitHub Issues. Best for: larger systemic questions/bug reports or anything development related.

:link: GitHub Discussions. Best for: technical questions & support, requesting new features, proposing new features.

:link: Slack channel. Best for: instant communications and online meetings, sharing your applications.

:link: Twitter. Best for: keeping up to date on everything ShardingSphere.

:link: LinkedIn. Best for: professional networking and career development with other ShardingSphere contributors.

STATUS👀

:white_check_mark: Version 5.5.0: released :tada:

🔗 For the release notes, follow this link to the relevant GitHub page.

:soon: Version 5.5.1

We are currently working towards our 5.5.1 milestone. Keep an eye on the milestones page of this repo to stay up to date.

How it Works

Apache ShardingSphere includes 2 independent products: JDBC & Proxy. They all provide functions of data scale-out, distributed transaction and distributed governance, applicable in a variety of situations such as Java-based isomorphism, heterogeneous language and Cloud-Native.

ShardingSphere-JDBC

Maven Status

A lightweight Java framework providing 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.

:link: For more details, follow this link to the official website.

ShardingSphere-Proxy

Nightly-Download Download Docker Pulls

A transparent database proxy, providing a database server that encapsulates the database binary protocol to support heterogeneous languages. Friendlier to DBAs, the MySQL and PostgreSQL version now provided can use any kind of terminal.

:link: For more details, follow this link to the official website.

Hybrid Architecture

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

Through the combination of ShardingSphere-JDBC & ShardingSphere-Proxy together with a unified sharding strategy by the same registry center, the ShardingSphere ecosystem can build an application system suitable to all kinds of scenarios.

:link: More details can be found following this link to the official website.

Solution

Solutions/FeaturesDistributed DatabaseData SecurityDatabase GatewayStress Testing
Data ShardingData EncryptionHeterogeneous Databases SupportedShadow Database
Read/write SplittingRow Authority (TODO)SQL Dialect Translate (TODO)Observability
Distributed TransactionSQL Audit (TODO)
Elastic Scale-outSQL Firewall (TODO)
High Availability

Roadmap

Roadmap

How to Build Apache ShardingSphere

Check out Wiki section for details on how to build Apache ShardingSphere and a full guide on how to get started and setup your local dev environment.

Landscapes