Retro
Eye care
Haitian
Deep
Dark
Default
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
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
Algorithm
JDBC Driver
Java API
Mode
Data Source
Rules
Sharding
Readwrite-splitting
Distributed Transaction
Encryption
Shadow DB
SQL Parser
SQL Translator
Mixed Rules
Algorithm
Spring Boot Starter
Mode
Data Source
Rules
Sharding
Readwrite splitting
Encryption
Shadow DB
SQL Parser
Mixed Rules
Algorithm
Spring Namespace
Mode
Data Source
Rules
Sharding
Readwrite-splitting
Encryption
Shadow DB
SQL Parser
Mixed Rules
Algorithm
Special API
Sharding
Hint
Readwrite Splitting
Hint
Transaction
Use Java API
Use Spring Boot Starter
Use Spring Namespace
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
Resource Definition
Rule Definition
Sharding
Single Table
Readwrite-Splitting
DB Discovery
Encrypt
Shadow
RQL Syntax
Resource Query
Rule Query
Sharding
Single Table
Readwrite-Splitting
DB Discovery
Encrypt
Shadow
RAL Syntax
RUL Syntax
Usage
Sharding
Readwrite_splitting
Encrypt
DB Discovery
Shadow
Data Migration
Build
Manual
Observability
Optional Plugins
Session Management
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
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
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.
Scaling 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.
Shadow
7.9.
Oberservability
7.10.
DistSQL
Syntax
RDL Syntax
Resource Definition
ADD RESOURCE
ALTER RESOURCE
DROP RESOURCE
Rule Definition
Database Discovery
CREATE DB_DISCOVERY RULE
CREATE DB_DISCOVERY TYPE
CREATE DB_DISCOVERY HEARTBEAT
Encrypt
CREATE ENCRYPT RULE
Readwrite-Splitting
CREATE READWRITE_SPLITTING RULE
Shadow
CREATE SHADOW RULE
CREATE SHADOW ALGORITHM
CREATE DEFAULT SHADOW ALGORITHM
Sharding
CREATE SHARDING TABLE RULE
ALTER SHARDING TABLE RULE
CREATE SHARDING ALGORITHM
CREATE DEFAULT SHARDING STRATEGY
CREATE SHARDING BINDING TABLE RULE
CREATE SHARDING BROADCAST TABLE RULE
CREATE SHARDING AUDITOR
CREATE SHARDING KEY GENERATOR
Single Table
ALTER DEFAULT SINGLE TABLE RULE
CREATE DEFAULT SINGLE TABLE RULE
DROP DEFAULT SINGLE TABLE RULE
RQL Syntax
Resource Query
SHOW DATABASE RESOURCES
SHOW UNUSED RESOURCE
SHOW RULES USED RESOURCE
Rule Query
Sharding
SHOW SHARDING TABLE RULE
SHOW SHARDING ALGORITHMS
SHOW UNUSED SHARDING ALGORITHMS
RAL Syntax
Reserved word
7.11.
Architecture
8.
FAQ
9.
Downloads
Download PDF
ShardingSphere
>
Reference
>
DistSQL
>
Syntax
>
RDL Syntax
> Rule Definition
This chapter describes the syntax of rule definition.
Previous
Next