Retro
Eye care
Haitian
Deep
Dark
Default
current
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.5.
DB Gateway
Core Concept
Limitations
3.6.
Traffic Governance
Core Concept
3.7.
Data Migration
Core Concept
Limitations
3.8.
Encryption
Core Concept
Limitations
Appendix with SQL operator
3.9.
Shadow
Core Concept
Limitations
3.10.
Observability
Core Concept
3.11.
Data Masking
Core Concept
Limitations
4.
User Manual
4.1.
ShardingSphere-JDBC
YAML Configuration
Mode
Data Source
Rules
Sharding
Readwrite-splitting
Distributed Transaction
Encryption
Shadow DB
SQL-parser
SQL Translator
Mixed Rules
Cache for Sharding Route
Data Masking
Algorithm
JDBC Driver
Spring Boot
Spring Namespace
Java API
Mode
Data Source
Rules
Sharding
Readwrite-splitting
Distributed Transaction
Encryption
Shadow DB
SQL Parser
SQL Translator
Mixed Rules
Data Masking
Algorithm
Special API
Sharding
Hint
Readwrite Splitting
Hint
Transaction
Use Java API
Atomikos Transaction
Bitronix Transaction
Narayana Transaction
Seata Transaction
Unsupported Items
4.2.
ShardingSphere-Proxy
Startup
Use Binary Tar
Build GraalVM Native Image(Alpha)
Use Docker
Use Helm
Add dependencies
Add Bitronix dependencies
Add Narayana dependencies
Yaml Configuration
Authorization
Properties
Rules
DistSQL
Syntax
RDL Syntax
Storage Unit Definition
REGISTER STORAGE UNIT
ALTER STORAGE UNIT
UNREGISTER STORAGE UNIT
Rule Definition
Database Discovery
CREATE DB_DISCOVERY RULE
ALTER DB_DISCOVERY RULE
DROP DB_DISCOVERY RULE
DROP DB_DISCOVERY HEARTBEAT
DROP DB_DISCOVERY TYPE
Encrypt
CREATE ENCRYPT RULE
ALTER ENCRYPT RULE
DROP ENCRYPT RULE
Mask
CREATE MASK RULE
ALTER MASK RULE
DROP MASK RULE
Readwrite-Splitting
CREATE READWRITE_SPLITTING RULE
ALTER READWRITE_SPLITTING RULE
DROP READWRITE_SPLITTING 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
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
CREATE BROADCAST TABLE RULE
DROP BROADCAST TABLE RULE
Single Table
SET DEFAULT SINGLE TABLE STORAGE UNIT
RQL Syntax
Storage Unit Query
SHOW STORAGE UNITS
Rule Query
Database Discovery
SHOW DB_DISCOVERY RULES
SHOW DB_DISCOVERY TYPES
SHOW DB_DISCOVERY HEARTBEATS
COUNT DB_DISCOVERY RULE
Encrypt
SHOW ENCRYPT RULES
COUNT ENCRYPT RULE
Mask
SHOW MASK RULES
COUNT MASK RULE
Readwrite-Splitting
SHOW READWRITE_SPLITTING RULES
COUNT READWRITE_SPLITTING RULE
Shadow
SHOW SHADOW RULE
SHOW SHADOW TABLE RULE
SHOW SHADOW ALGORITHM
COUNT SHADOW RULE
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 RULES
SHOW BROADCAST TABLE RULE
COUNT SHARDING RULE
Single Table
SHOW DEFAULT SINGLE TABLE STORAGE UNIT
SHOW SINGLE TABLE
COUNT SINGLE_TABLE RULE
RAL Syntax
CIRCUIT BREAKER
ALTER READWRITE_SPLITTING RULE ENABLE/DISABLE
SHOW COMPUTE NODES
SHOW STATUS FROM READWRITE_SPLITTING RULE
ENABLE/DISABLE COMPUTE NODE
LABEL|RELABEL COMPUTE NODES
UNLABEL COMPUTE NODES
GLOBAL RULE
SHOW AUTHORITY RULE
SHOW TRANSACTION RULE
SHOW SQL_PARSER RULE
ALTER TRANSACTION RULE
ALTER SQL_PARSER RULE
CREATE TRAFFIC RULE
ALTER TRAFFIC RULE
SHOW TRAFFIC RULE
DROP TRAFFIC RULE
HINT
SET READWRITE_SPLITTING HINT SOURCE
ADD SHARDING HINT DATABASE_VALUE
SET SHARDING HINT DATABASE_VALUE
ADD SHARDING HINT TABLE_VALUE
CLEAR HINT
SHOW HINT STATUS
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
STOP MIGRATION CHECK
START MIGRATION CHECK
STOP MIGRATION
START MIGRATION
ROLLBACK MIGRATION
COMMIT MIGRATION
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
EXPORT DATABASE CONFIGURATION
IMPORT DATABASE CONFIGURATION
SHOW RULES USED STORAGE UNIT
RUL Syntax
PARSE SQL
FORMAT SQL
PREVIEW SQL
Reserved word
Usage
Sharding
Readwrite_splitting
DB Discovery
Encrypt
Shadow
MASK
Data Migration
Build
Manual
Observability
Optional Plugins
Session Management
Logging Configuration
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
4.4.
Error Code
SQL Error Code
Server Error Code
5.
Dev Manual
5.1.
Mode
5.2.
Configuration
5.3.
Kernel
5.4.
DataSource
5.5.
SQL Parser
5.6.
Proxy
5.7.
Data Sharding
5.8.
Readwrite-splitting
5.10.
Distributed Transaction
5.11.
SQL Checker
5.12.
Encryption
5.13.
Shadow DB
5.14.
Observability
5.15.
Data Masking
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 Integration 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
Download PDF
Rule Definition
This chapter describes the syntax of rule definition.
