Retro
Eye care
Haitian
Deep
Dark
Default
current
5.4.1
5.4.0
5.3.2
5.3.1
5.3.0
5.2.1
5.2.0
5.1.2
5.1.1
5.1.0
5.0.0
4.1.1
4.1.0
4.0.1
4.0.0
3.1.0
3.0.0
2.0.3
2.0.2
2.0.1
2.0.0
1.5.4
1.5.3
1.5.2
1.5.1
1.5.0
1.4.2
1.4.1
1.4.0
1.3.3
1.3.2
1.3.1
1.3.0
1.2.1
1.2.0
1.1.0
1.0.1
1.0.0
English
简体中文
1.
Overview
2.
Quick Start
2.1.
ShardingSphere-JDBC
2.2.
ShardingSphere-Proxy
3.
Features
3.1.
Sharding
Core Concept
Limitations
Appendix with SQL operator
3.2.
Distributed Transaction
Core Concept
Limitations
Appendix with SQL operator
3.3.
Readwrite-splitting
Core Concept
Limitations
3.4.
DB Gateway
Core Concept
Limitations
3.5.
Traffic Governance
Core Concept
3.6.
Data Migration
Core Concept
Limitations
3.7.
Encryption
Core Concept
Limitations
Appendix with SQL operator
3.8.
Data Masking
Core Concept
Limitations
3.9.
Shadow
Core Concept
Limitations
3.10.
Observability
Core Concept
3.11.
SQL Federation
Limitations
4.
User Manual
4.1.
ShardingSphere-JDBC
YAML Configuration
Mode
Data Source
Rules
Sharding
Broadcast Table
Readwrite-splitting
Distributed Transaction
Encryption
Data Masking
Shadow DB
SQL-parser
SQL Translator
Mixed Rules
Cache for Sharding Route
Single Table
SQL Federation
Algorithm
JDBC Driver
Known Implementation
Spring Boot
Spring Namespace
Java API
Mode
Data Source
Rules
Sharding
Broadcast Table
Readwrite-splitting
Distributed Transaction
Encryption
Data Masking
Shadow DB
SQL Parser
SQL Translator
Mixed Rules
Cache for Sharding Route
Single Table
SQL-federation
Algorithm
Special API
Sharding
Hint
Readwrite-splitting
Hint
Transaction
Use Java API
Atomikos Transaction
Narayana Transaction
Seata Transaction
Optional Plugins
Unsupported Items
Observability
GraalVM Native Image
4.2.
ShardingSphere-Proxy
Startup
Use Binary Tar
Build GraalVM Native Image(Alpha)
Use Docker
Use Helm
Add dependencies
Add Narayana dependencies
Yaml Configuration
Authentication & Authorization
Properties
Rules
Data Source
DistSQL
Syntax
RDL Syntax
Storage Unit Definition
REGISTER STORAGE UNIT
ALTER STORAGE UNIT
UNREGISTER STORAGE UNIT
Rule Definition
Sharding
CREATE SHARDING TABLE RULE
ALTER SHARDING TABLE RULE
DROP SHARDING TABLE RULE
CREATE DEFAULT SHARDING STRATEGY
ALTER DEFAULT SHARDING STRATEGY
DROP DEFAULT SHARDING STRATEGY
DROP SHARDING KEY GENERATOR
DROP SHARDING ALGORITHM
CREATE SHARDING TABLE REFERENCE RULE
ALTER SHARDING TABLE REFERENCE RULE
DROP SHARDING TABLE REFERENCE RULE
Broadcast Table
CREATE BROADCAST TABLE RULE
DROP BROADCAST TABLE RULE
Single Table
LOAD SINGLE TABLE
UNLOAD SINGLE TABLE
SET DEFAULT SINGLE TABLE STORAGE UNIT
Readwrite-Splitting
CREATE READWRITE_SPLITTING RULE
ALTER READWRITE_SPLITTING RULE
DROP READWRITE_SPLITTING RULE
Encrypt
CREATE ENCRYPT RULE
ALTER ENCRYPT RULE
DROP ENCRYPT RULE
Mask
CREATE MASK RULE
ALTER MASK RULE
DROP MASK RULE
Shadow
CREATE SHADOW RULE
ALTER SHADOW RULE
DROP SHADOW RULE
CREATE DEFAULT SHADOW ALGORITHM
ALTER DEFAULT SHADOW ALGORITHM
DROP DEFAULT SHADOW ALGORITHM
DROP SHADOW ALGORITHM
RQL Syntax
Storage Unit Query
SHOW STORAGE UNITS
Rule Query
Sharding
SHOW SHARDING TABLE RULE
SHOW SHARDING ALGORITHMS
SHOW UNUSED SHARDING ALGORITHMS
SHOW DEFAULT SHARDING STRATEGY
SHOW SHARDING KEY GENERATORS
SHOW UNUSED SHARDING KEY GENERATORS
SHOW SHARDING AUDITORS
SHOW UNUSED SHARDING AUDITORS
SHOW SHARDING TABLE NODES
SHOW SHARDING TABLE NODES
SHOW SHARDING TABLE RULES USED KEY GENERATOR
SHOW SHARDING TABLE RULES USED AUDITOR
SHOW SHARDING TABLE REFERENCE RULE
COUNT SHARDING RULE
Broadcast Table
SHOW BROADCAST TABLE RULE
COUNT BROADCAST RULE
Single Table
SHOW SINGLE TABLE
SHOW DEFAULT SINGLE TABLE STORAGE UNIT
COUNT SINGLE_TABLE RULE
SHOW UNLOADED SINGLE TABLES
Readwrite-Splitting
SHOW READWRITE_SPLITTING RULE
COUNT READWRITE_SPLITTING RULE
Encrypt
SHOW ENCRYPT RULES
COUNT ENCRYPT RULE
Mask
SHOW MASK RULES
COUNT MASK RULE
Shadow
SHOW SHADOW RULE
SHOW SHADOW TABLE RULES
SHOW SHADOW ALGORITHMS
SHOW DEFAULT SHADOW ALGORITHM
COUNT SHADOW RULE
RAL Syntax
GLOBAL RULE
SHOW AUTHORITY RULE
SHOW TRANSACTION RULE
ALTER TRANSACTION RULE
SHOW SQL_PARSER RULE
Alter SQL_PARSER Rule
SHOW TRAFFIC RULE
ALTER TRAFFIC RULE
SHOW SQL_FEDERATION RULE
ALTER SQL_FEDERATION RULE
CIRCUIT BREAKER
ALTER READWRITE_SPLITTING RULE ENABLE/DISABLE
SHOW STATUS FROM READWRITE_SPLITTING RULE
SHOW COMPUTE NODES
ENABLE/DISABLE COMPUTE NODE
LABEL|RELABEL COMPUTE NODES
UNLABEL COMPUTE NODES
MIGRATUION
SHOW MIGRATION RULE
ALTER MIGRATION RULE
REGISTER MIGRATION SOURCE STORAGE UNIT
UNREGISTER MIGRATION SOURCE STORAGE UNIT
SHOW MIGRATION SOURCE STORAGE UNITS
MIGRATE TABLE INTO
SHOW MIGRATION LIST
SHOW MIGRATION STATUS
SHOW MIGRATION CHECK ALGORITHM
CHECK MIGRATION
SHOW MIGRATION CHECK STATUS
START MIGRATION CHECK
STOP MIGRATION CHECK
START MIGRATION
STOP MIGRATION
COMMIT MIGRATION
ROLLBACK MIGRATION
PLUGIN
SHOW PLUGINS OF SPI
SHOW SHARDING ALGORITHM PLUGINS
SHOW LOAD BALANCE ALGORITHM PLUGINS
SHOW ENCRYPT ALGORITHM PLUGINS
SHOW MASK ALGORITHM PLUGINS
SHOW SHADOW ALGORITHM PLUGINS
SHOW KEY GENERATE ALGORITHM PLUGINS
SHOW COMPUTE NODE INFO
SHOW COMPUTE NODE MODE
SET DIST VARIABLE
SHOW DIST VARIABLE
REFRESH TABLE METADATA
REFRESH DATABASE METADATA FROM GOVERNANCE CENTER
SHOW TABLE METADATA
SHOW RULES USED STORAGE UNIT
EXPORT DATABASE CONFIGURATION
IMPORT DATABASE CONFIGURATION
CONVERT YAML CONFIGURATION
RUL Syntax
PARSE SQL
FORMAT SQL
PREVIEW SQL
Reserved word
Usage
Sharding
Readwrite_splitting
Encrypt
MASK
Shadow
Data Migration
Build
Manual
Observability
Optional Plugins
Session Management
Logging Configuration
CDC
Build
Manual
4.3.
Common Configuration
Properties Configuration
Builtin Algorithm
Metadata Repository
Sharding Algorithm
Key Generate Algorithm
Load Balance Algorithm
Encryption Algorithm
Shadow Algorithm
SQL Translator
Sharding Audit Algorithm
Data Masking Algorithm
Row Value Expressions
SQL Hint
4.4.
Error Code
SQL Error Code
Server Error Code
5.
Dev Manual
5.1.
Mode
5.2.
SQL Parser
5.3.
Data Sharding
5.4.
Infra algorithm
5.5.
SQL Audit
5.6.
Encryption
5.7.
Data Masking
5.8.
Shadow DB
5.9.
Observability
6.
Test Manual
6.1.
Integration Test
6.2.
Performance Test
SysBench ShardingSphere-Proxy Empty Rule Performance Test
BenchmarkSQL ShardingSphere-Proxy Sharding Performance Test
6.3.
Module Test
SQL Parser Test
SQL Rewrite Test
6.4.
Pipeline E2E Test
7.
Reference
7.1.
Database Compatibility
7.2.
Database Gateway
7.3.
Management
7.4.
Sharding
Parse Engine
Route Engine
Rewrite Engine
Execute Engine
Merger Engine
7.5.
Transaction
XA Transaction
Seata BASE transaction
7.6.
Data Migration
7.7.
Encryption
7.8.
Mask
7.9.
Shadow
7.10.
Oberservability
7.11.
Architecture
8.
FAQ
9.
Downloads
Limitations
Limitations
Masked columns only support string types, not other non-string types.
