Apache ShardingSphere 开发文档 PDF 文档

Question

pache ShardingSphere 是一款分布式的数据库生态系统，可以将任意数据库转换为分布式数据库，并通过数据分片、弹性伸缩、加密等能力对原有数据库进行增强。

Apache ShardingSphere 设计哲学为 Database Plus，旨在构建异构数据库上层的标准和生态。它关注如何充分合理地利用数据库的计算和存储能力，而并非实现一个全新的数据库。它站在数据库的上层视角，关注它们之间的协作多于数据库自身。

概览
什么是 ShardingSphere
介绍
ShardingSphere-JDBC
ShardingSphere-Proxy
产品功能
产品优势
设计哲学
连接：打造数据库上层标准
增强：数据库计算增强引擎
可插拔：构建数据库功能生态
L1 内核层
L2 功能层
L3 生态层
部署形态
ShardingSphere-JDBC 独立部署
ShardingSphere-Proxy 独立部署
混合部署架构
运行模式
单机模式
集群模式
线路规划
如何参与
快速入门
ShardingSphere-JDBC
应用场景
使用限制
前提条件
操作步骤
ShardingSphere-Proxy
应用场景
使用限制
前提条件
操作步骤
功能
数据分片
背景
垂直分片
水平分片
挑战
目标
应用场景
海量数据高并发的 OLTP 场景
海量数据实时分析 OLAP 场景
相关参考
核心概念
表
逻辑表
真实表
绑定表
广播表
单表
数据节点
均匀分布
自定义分布
分片
分片键
分片算法
自动化分片算法
自定义分片算法
分片策略
强制分片路由
行表达式
分布式主键
使用限制
稳定支持
常规查询
子查询
分页查询
运算表达式中包含分片键
实验性支持
子查询
跨库关联查询
不支持
CASE WHEN
分页查询
附录
分布式事务
背景
挑战
目标
原理介绍
LOCAL 事务
XA 事务
BASE 事务
应用场景
ShardingSphere XA 事务使用场景
ShardingSphere BASE 事务使用场景
ShardingSphere LOCAL 事务使用场景
相关参考
核心概念
XA 协议
使用限制
LOCAL 事务
支持项
不支持项
XA 事务
支持项
不支持项
BASE 事务
支持项
不支持项
附录
读写分离
背景
挑战
目标
应用场景
复杂的主从数据库架构
相关参考
核心概念
主库
从库
主从同步
负载均衡策略
使用限制
高可用
背景
挑战
目标
应用场景
相关参考
核心概念
高可用类型
动态读写分离
使用限制
支持项
不支持项
数据库网关
背景
挑战
目标
应用场景
核心概念
SQL 方言
使用限制
流量治理
背景
挑战
目标
应用场景
计算节点过载保护
存储节点限流
核心概念
熔断
限流
数据迁移
背景
挑战
目标
应用场景
相关参考
核心概念
节点
集群
源端
目标端
数据迁移作业
存量数据
增量数据
使用限制
支持项
不支持项
数据加密
背景
挑战
目标
应用场景
新上线业务
成熟业务
相关参考
核心概念
逻辑列
密文列
查询辅助列
模糊查询列
明文列
使用限制
附录
影子库
背景
挑战
目标
应用场景
相关参考
核心概念
生产库
影子库
影子算法
使用限制
基于 Hint 的影子算法
基于列的影子算法
可观察性
背景
挑战
目标
应用场景
监控仪表盘
应用性能监控
应用链路追踪
相关参考
核心概念
Agent
APM
Tracing
Metrics
Logging
用户手册
ShardingSphere-JDBC
YAML 配置
简介
使用步骤
引入 Maven 依赖
配置 YAML
构建数据源
使用数据源
语法说明
模式配置
参数解释
单机模式
集群模式 (推荐)
注意事项
配置示例
单机模式
集群模式 (推荐)
相关参考
数据源配置
背景信息
参数解释
配置示例
规则配置
数据分片
背景信息
参数解释
操作步骤
配置示例
相关参考
读写分离
背景信息
参数解释
静态读写分离
动态读写分离
操作步骤
配置示例
相关参考
分布式事务
背景信息
参数解释
操作步骤
使用 LOCAL 模式
使用 XA 模式
使用 BASE 模式
高可用
背景信息
参数解释
配置示例
相关参考
数据加密
背景信息
参数解释
操作步骤
配置示例
相关参考
影子库
背景信息
参数解释
操作步骤
配置示例
相关参考
SQL 解析
背景信息
参数解释
操作步骤
配置示例
相关参考
SQL 翻译
配置项说明
混合规则
背景信息
参数解释
配置示例
算法配置
分片算法
加密算法
读写分离负载均衡算法
影子算法
高可用
JDBC 驱动
背景信息
参数解释
驱动类名称
URL 配置
操作步骤
配置示例
Java API
简介
使用步骤
引入 Maven 依赖
构建数据源
使用数据源
模式配置
背景信息
参数解释
Standalone 持久化配置
Cluster 持久化配置
注意事项
操作步骤
引入Maven 依赖。
配置示例
Standalone 运行模式
Cluster 运行模式 (推荐)
相关参考
数据源配置
背景信息
操作步骤
1. 引入 Maven 依赖
配置示例
规则配置
数据分片
背景信息
参数解释
配置入口
分片表配置
自动分片表配置
分片策略配置
标准分片策略配置
复合分片策略配置
Hint 分片策略配置
不分片策略配置
分布式序列策略配置
分片审计策略配置
操作步骤
配置示例
相关参考
读写分离
背景信息
参数解释
配置入口
主从数据源配置
操作步骤
配置示例
相关参考
分布式事务
配置入口
高可用
背景信息
参数解释
配置入口
数据源配置
监听心跳配置
数据库发现类型配置
操作步骤
相关参考
数据加密
背景信息
参数解释
配置入口
加密表规则配置
加密列规则配置
加解密算法配置
操作步骤
配置示例
相关参考
影子库
背景信息
参数解释
配置入口
影子数据源配置
影子表配置
影子算法配置
操作步骤
配置示例
相关参考
SQL 解析
背景信息
参数解释
本地缓存配置
操作步骤
配置示例
相关参考
SQL 翻译
配置入口
混合规则
背景信息
配置示例
算法配置
分片算法
加密算法
读写分离负载均衡算法
影子算法
高可用
Spring Boot Starter
简介
使用步骤
引入 Maven 依赖
配置 Spring Boot 属性
使用数据源
模式配置
参数解释
单机模式
集群模式 (推荐)
注意事项
操作步骤
配置示例
单机模式
集群模式 (推荐)
相关参考
数据源配置
背景信息
使用本地数据源
使用 JNDI 数据源
参数解释
使用本地数据源
使用 JNDI 数据源
操作步骤
1. 引入 MAVEN 依赖
配置示例
使用本地数据源
使用 JNDI 数据源
规则配置
数据分片
背景信息
参数解释
操作步骤
配置示例
相关参考
读写分离
背景信息
参数解释
静态读写分离
动态读写分离
操作步骤
配置示例
相关参考
高可用
背景信息
参数解释
操作步骤
配置示例
相关参考
数据加密
背景信息
参数解释
操作步骤
配置示例
相关参考
影子库
背景信息
参数解释
操作步骤
配置示例
相关参考
SQL 解析
背景信息
参数解释
操作步骤
配置示例
相关参考
混合规则
背景信息
参数解释
配置示例
算法配置
分片算法
加密算法
读写分离负载均衡算法
影子算法
高可用
Spring 命名空间
简介
使用步骤
引入 Maven 依赖
配置 Spring Bean
配置项说明
配置示例
使用数据源
模式配置
背景信息
参数解释
单机模式
集群模式 (推荐)
注意事项
操作步骤
配置示例
单机模式
集群模式
相关参考
数据源配置
背景信息
操作步骤
1. 引入 MAVEN 依赖
配置示例
规则配置
数据分片
背景信息
参数解释
操作步骤
配置示例
相关参考
读写分离
背景信息
参数解释
操作步骤
配置示例
相关参考
高可用
背景信息
参数解释
操作步骤
1. 引入 MAVEN 依赖
配置示例
相关参考
数据加密
背景信息
参数解释
操作步骤
配置示例
相关参考
影子库
背景信息
参数解释
配置入口
可配置属性：
影子数据源配置：
影子表配置：
影子算法配置：
操作步骤
配置示例
相关参考
SQL解析
背景信息
参数解释
操作步骤
配置示例
相关参考
混合规则
背景信息
配置示例
算法配置
分片算法
加密算法
读写分离负载均衡算法
影子算法
高可用
特殊 API
数据分片
强制路由
背景信息
操作步骤
配置示例
使用 Hint 分片
规则配置
获取 HintManager
添加分片键值
清除分片键值
完整代码示例
使用 SQL 注释的方式
使用规范
完整示例
相关参考
读写分离
强制路由
背景信息
操作步骤
配置示例
使用 Hint 强制主库路由
使用手动编程的方式
获取 HintManager
设置主库路由
清除分片键值
完整代码示例
使用 SQL 注释的方式
使用规范
完整示例
分布式事务
使用 Java API
背景信息
前提条件
操作步骤
配置示例
使用 Spring Boot Starter
背景信息
操作步骤
配置示例
配置事务类型
使用分布式事务
使用 Spring 命名空间
背景信息
操作步骤
配置示例
配置事务管理器
使用分布式事务
Atomikos 事务
背景信息
配置示例
配置事务类型
配置 Atomikos
数据恢复
Narayana 事务
背景信息
前提条件
操作步骤
配置示例
配置 Narayana
设置 XA 事务类型
Bitronix 事务
背景信息
前提条件
操作步骤
配置示例
配置 XA 事务类型
配置 Bitronix （可省略）
Seata 事务
背景信息
操作步骤
配置示例
启动 Seata Server
创建 undo_log 表
修改配置
不支持项
DataSource 接口
Connection 接口
Statement 和 PreparedStatement 接口
ResultSet 接口
JDBC 4.1
ShardingSphere-Proxy
启动手册
使用二进制发布包
背景信息
前提条件
操作步骤
配置示例
使用 Docker
背景信息
注意事项
操作步骤
配置示例
构建 GraalVM Native Image(Alpha)
背景信息
注意事项
前提条件
操作步骤
使用 Helm
背景信息
前提条件
操作步骤
在线安装
源码安装
卸载
参数解释
治理节点配置项
治理节点 ZooKeeper 配置项
计算节点 ShardingSphere-Proxy 配置项
配置示例
添加依赖
添加 Bitronix 依赖
添加 Bitronix 依赖包
jar 文件下载地址
添加 Narayana 依赖
添加 Narayana 依赖包
jar 文件下载地址
YAML 配置
权限
背景信息
参数解释
配置示例
ALL_PERMITTED
DATABASE_PERMITTED
相关参考
属性配置
背景信息
参数解释
配置示例
规则配置
背景信息
参数解释
注意事项
DistSQL
定义
相关概念
RDL
RQL
RAL
RUL
对系统的影响
之前
之后
使用限制
原理介绍
相关参考
语法
语法规则
标识符
字面量
RDL 语法
存储单元定义
语法说明
参数解释
注意事项
示例
规则定义
数据分片
语法说明
Sharding Table Rule
Sharding Table Reference Rule
Broadcast Table Rule
示例
Sharding Table Rule
Sharding Table Reference Rule
Broadcast Table Rule
单表
定义
示例
读写分离
语法说明
参数解释
注意事项
示例
数据库发现
语法说明
参数解释
注意事项
示例
创建 discoveryRule 时同时创建 discoveryType 和 discoveryHeartbeat
数据加密
语法说明
参数解释
注意事项
示例
影子库压测
语法说明
参数解释
注意事项
示例
RQL 语法
存储单元查询
语法说明
返回值说明
示例
规则查询
数据分片
语法说明
Sharding Table Rule
Sharding Table Reference Rule
Broadcast Table Rule
Sharding Table Rule
Sharding Algorithms
Unused Sharding Algorithms
Sharding Auditors
Unused Sharding Auditors
Sharding Key Generators
Unused Sharding Key Generators
Default Sharding Strategy
Sharding Table Nodes
Sharding Table Reference Rule
Broadcast Table Rule
Sharding Table Rule
Sharding Table Reference Rule
Broadcast Table Rule
单表
语法说明
返回值说明
Single Table Storage Unit
Single Table
Single Table Rule Count
示例
读写分离
语法说明
参数解释
返回值说明
示例
数据库发现
语法说明
返回值说明
DB Discovery Rule
DB Discovery Type
DB Discovery Heartbeat
示例
数据加密
语法说明
返回值说明
示例
影子库压测
语法说明
返回值说明
Shadow Rule
Shadow Table Rule
Shadow Algorithms
Shadow Rule status
示例
RAL 语法
强制路由
数据迁移
熔断
全局规则
其他
注意事项
RUL 语法
SQL 工具
使用
前置工作
创建数据库
资源操作
规则操作
注意事项
数据分片
存储单元操作
规则操作
读写分离
存储单元操作
规则操作
数据加密
存储单元操作
规则操作
数据库发现
存储单元操作
规则操作
影子库压测
存储单元操作
规则操作
数据迁移
简介
运行部署
背景信息
前提条件
操作步骤
使用手册
MySQL 使用手册
环境要求
权限要求
完整流程示例
前提条件
操作步骤
PostgreSQL 使用手册
环境要求
权限要求
完整流程示例
前提条件
操作步骤
openGauss 使用手册
环境要求
权限要求
完整流程示例
前提条件
操作步骤
可观察性
源码编译
agent 配置
ShardingSphere-Proxy 中使用
通过非容器环境使用
通过容器环境使用
Metrics
可选插件
会话管理
相关操作
查看会话
杀掉会话
通用配置
属性配置
背景信息
参数解释
操作步骤
配置示例
内置算法
简介
使用方式
元数据持久化仓库
背景信息
参数解释
数据库持久化
ZooKeeper 持久化
Etcd 持久化
Nacos 持久化
Consul 持久化
操作步骤
配置示例
分片算法
背景信息
参数解释
自动分片算法
取模分片算法
基于 CosId 的取模分片算法
哈希取模分片算法
基于分片容量的范围分片算法
基于分片边界的范围分片算法
自动时间段分片算法
标准分片算法
行表达式分片算法
时间范围分片算法
基于 CosId 的固定时间范围的分片算法
基于 CosId 的雪花ID固定时间范围的分片算法
复合分片算法
复合行表达式分片算法
Hint 分片算法
Hint 行表达式分片算法
自定义类分片算法
操作步骤
配置示例
相关参考
分布式序列算法
背景信息
参数解释
雪花算法
NanoID
UUID
CosId
CosId-Snowflake
操作步骤
配置示例
负载均衡算法
背景信息
参数解释
轮询负载均衡算法
随机负载均衡算法
权重负载均衡算法
事务随机负载均衡算法
事务轮询负载均衡算法
事务权重负载均衡算法
固定副本随机负载均衡算法
固定副本轮询负载均衡算法
固定副本权重负载均衡算法
固定主库负载均衡算法
操作步骤
配置示例
相关参考
加密算法
背景信息
参数解释
MD5 加密算法
AES 加密算法
RC4 加密算法
SM3 加密算法
SM4 加密算法
操作步骤
配置示例
相关参考
影子算法
背景信息
参数解释
列影子算法
列值匹配算法
列正则表达式匹配算法
Hint 影子算法
简单 Hint 匹配影子算法
配置示例
SQL 翻译
原生 SQL 翻译器
使用 JooQ 的 SQL 翻译器
分片审计算法
背景信息
参数解释
DML_SHARDING_CONDITIONS 算法
操作步骤
配置示例
错误码
SQL 错误码
内核异常
元数据
数据
语法
连接
事务
锁
审计
集群
迁移
DistSQL
功能异常
数据分片
读写分离
数据库高可用
SQL 方言转换
流量治理
数据加密
影子库
其他异常
服务器错误码
开发者手册
运行模式
StandalonePersistRepository
全限定类名
定义
已知实现
ClusterPersistRepository
全限定类名
定义
已知实现
GovernanceWatcher
全限定类名
定义
已知实现
配置
RuleBuilder
全限定类名
定义
已知实现
YamlRuleConfigurationSwapper
全限定类名
定义
已知实现
ShardingSphereYamlConstruct
全限定类名
定义
已知实现
内核
SQLRouter
全限定类名
定义
已知实现
SQLRewriteContextDecorator
全限定类名
定义
已知实现
SQLExecutionHook
全限定类名
定义
已知实现
ResultProcessEngine
全限定类名
定义
已知实现
数据源
DatabaseType
全限定类名
定义
已知实现
DialectSchemaMetaDataLoader
全限定类名
定义
已知实现
DataSourcePoolMetaData
全限定类名
定义
已知实现
DataSourcePoolActiveDetector
全限定类名
定义
已知实现
SQL 解析
DatabaseTypedSQLParserFacade
全限定类名
定义
已知实现
SQLVisitorFacade
全限定类名
定义
已知实现
代理端
DatabaseProtocolFrontendEngine
全限定类名
定义
已知实现
AuthorityProvideAlgorithm
全限定类名
定义
已知实现
数据分片
ShardingAlgorithm
全限定类名
定义
已知实现
KeyGenerateAlgorithm
全限定类名
定义
已知实现
ShardingAuditAlgorithm
全限定类名
定义
已知实现
DatetimeService
全限定类名
定义
已知实现
读写分离
ReadQueryLoadBalanceAlgorithm
全限定类名
定义
已知实现
高可用
DatabaseDiscoveryProviderAlgorithm
全限定类名
定义
已知实现
分布式事务
ShardingSphereTransactionManager
全限定类名
定义
已知实现
XATransactionManagerProvider
全限定类名
定义
已知实现
XADataSourceDefinition
全限定类名
定义
已知实现
DataSourcePropertyProvider
全限定类名
定义
已知实现
SQL 检查
全限定类名
定义
已知实现
数据加密
EncryptAlgorithm
全限定类名
定义
已知实现
影子库
ShadowAlgorithm
全限定类名
定义
已知实现
可观察性
PluginBootService
全限定类名
定义
已知实现
PluginDefinitionService
全限定类名
定义
已知实现
测试手册
整合测试
模块测试
性能测试
集成测试
设计
测试用例
测试环境
测试引擎
使用指南
测试用例配置
环境配置
Native 环境配置
Docker 环境配置
运行测试引擎
配置测试引擎运行环境
运行调试模式
运行 Docker 模式
远程 debug Docker 容器中的 Proxy 代码
注意事项
性能测试
Sysbench ShardingSphere Proxy 空 Rules 性能测试
测试目的
测试环境搭建
服务器信息
数据库
压测工具
ShardingSphere-Proxy
bin/start.sh
config.yaml
测试阶段
环境准备
压测命令
压测报告分析
压测过程中值得关注的点
BenchmarkSQL ShardingSphere Proxy 分片性能测试
测试目的
测试方法
测试工具微调
移除外键与 extraHistID
压测环境或参数建议
建议使用 Java 17 运行 ShardingSphere
ShardingSphere 数据分片建议
PostgreSQL JDBC URL 参数建议
ShardingSphere Proxy server.yaml 参数建议
附录
BenchmarkSQL 数据分片参考配置
BenchmarkSQL 5.0 PostgreSQL 语句列表
Create tables
Create indexes
New Order 业务
Payment 业务
Order Status 业务
Stock level 业务
Delivery BG 业务
模块测试
SQL 解析测试
数据准备
SQL数据
断言数据
SQL 改写测试
目标
测试
Scaling 集成测试
测试目的
测试环境
使用指南
环境配置
测试用例
运行测试用例
Native 环境启动
Docker环境启动
技术参考
数据兼容性
数据库网关
管控
注册中心数据结构
/rules
/props
/metadata/databaseName/versions/{versionNumber}/dataSources
/metadata/databaseName/versions/{versionNumber}/rules
/metadata/databaseName/schemas/{schemaName}/tables
/nodes/compute_nodes
/nodes/storage_nodes
数据分片
SQL 解析
SQL 路由
SQL 改写
SQL 执行
结果归并
查询优化
解析引擎
抽象语法树
SQL 解析引擎
历史
功能点
API使用
路由引擎
分片路由
直接路由
标准路由
笛卡尔路由
广播路由
全库表路由
全库路由
全实例路由
单播路由
阻断路由
改写引擎
正确性改写
标识符改写
补列
分页修正
批量拆分
优化改写
单节点优化
流式归并优化
执行引擎
连接模式
内存限制模式
连接限制模式
自动化执行引擎
准备阶段
执行阶段
归并引擎
遍历归并
排序归并
分组归并
聚合归并
分页归并
分布式事务
导览
XA 事务
开启全局事务
执行真实分片SQL
提交或回滚事务
Seata 柔性事务
引擎初始化
开启全局事务
执行真实分片SQL
提交或回滚事务
数据迁移
原理说明
执行阶段说明
准备阶段
存量数据迁移阶段
增量数据同步阶段
流量切换阶段
相关参考
数据加密
处理流程详解
整体架构
加密规则
加密处理过程
解决方案详解
新上线业务
已上线业务改造
中间件加密服务优势
加密算法解析
EncryptAlgorithm
影子库
原理介绍
DML 语句
DDL 语句
相关参考
可观察性
原理说明
DistSQL
语法
RDL 语法
存储单元定义
REGISTER STORAGE UNIT
描述
语法
特别说明
示例
保留字
相关链接
ALTER STORAGE UNIT
描述
语法
补充说明
示例
保留字
相关链接
UNREGISTER STORAGE UNIT
描述
语法
补充说明
示例
保留字
相关链接
规则定义
数据库发现
CREATE DB_DISCOVERY RULE
描述
语法定义
补充说明
示例
保留字
相关链接
ALTER DB_DISCOVERY RULE
描述
语法定义
补充说明
示例
保留字
相关链接
DROP DB_DISCOVERY RULE
描述
语法定义
补充说明
示例
保留字
相关链接
DROP DB_DISCOVERY HEARTBEAT
描述
语法定义
补充说明
示例
保留字
相关链接
DROP DB_DISCOVERY TYPE
描述
语法定义
补充说明
示例
保留字
相关链接
数据加密
CREATE ENCRYPT RULE
描述
语法定义
补充说明
示例
创建数据加密规则
保留字
相关链接
ALTER ENCRYPT RULE
说明
语法
Supplement
示例
保留字
相关链接
DROP ENCRYPT RULE
说明
语法
示例
保留字
相关链接
读写分离
CREATE READWRITE_SPLITTING RULE
描述
语法定义
补充说明
示例
创建静态读写分离规则
创建动态读写分离规则
保留字
相关链接
ALTER READWRITE_SPLITTING RULE
描述
语法定义
补充说明
示例
修改静态读写分离规则
修改动态读写分离规则
保留字
相关链接
DROP READWRITE_SPLITTING RULE
描述
语法定义
补充说明
示例
保留字
相关链接
影子库压测
CREATE SHADOW RULE
描述
语法定义
补充说明
示例
保留字
相关链接
ALTER SHADOW RULE
描述
语法定义
补充说明
示例
保留字
相关链接
DROP SHADOW RULE
描述
语法定义
补充说明
示例
保留字
相关链接
CREATE DEFAULT SHADOW ALGORITHM
描述
语法定义
补充说明
示例
保留字
相关链接
ALTER DEFAULT SHADOW ALGORITHM
描述
语法定义
补充说明
示例
保留字
相关链接
DROP DEFAULT SHADOW ALGORITHM
描述
语法定义
补充说明
示例
保留字
相关链接
DROP SHADOW ALGORITHM
描述
语法定义
补充说明
示例
保留字
相关链接
分片
CREATE SHARDING TABLE RULE
描述
语法定义
补充说明
示例
1.标准分片规则
2.自动分片规则
保留字
相关链接
ALTER SHARDING TABLE RULE
描述
语法定义
补充说明
示例
1.标准分片规则
2.自动分片规则
保留字
相关链接
DROP SHARDING TABLE RULE
描述
语法定义
补充说明
示例
保留字
相关链接
CREATE DEFAULT SHARDING STRATEGY
描述
语法定义
补充说明
示例
保留字
相关链接
ALTER DEFAULT SHARDING STRATEGY
描述
语法定义
补充说明
示例
保留字
相关链接
DROP DEFAULT SHARDING STRATEGY
描述
语法定义
补充说明
示例
保留字
CREATE SHARDING AUDITOR
描述
语法定义
补充说明
示例
创建分片审计器
保留字
相关链接
DROP SHARDING KEY GENERATOR
描述
语法定义
补充说明
示例
保留字
相关链接
DROP SHARDING ALGORITHM
描述
语法定义
补充说明
示例
保留字
相关链接
CREATE SHARDING TABLE REFERENCE RULE
描述
语法定义
补充说明
示例
1.创建关联关系
2.创建多个关联关系
保留字
相关链接
ALTER SHARDING TABLE REFERENCE RULE
描述
语法定义
补充说明
示例
1.创建关联关系
2.创建多个关联关系
保留字
相关链接
DROP SHARDING TABLE REFERENCE RULE
描述
语法定义
补充说明
示例
保留字
相关链接
CREATE BROADCAST TABLE RULE
描述
语法定义
补充说明
示例
创建广播规则
保留字
相关链接
DROP BROADCAST TABLE RULE
描述
语法定义
补充说明
示例
保留字
相关链接
单表
SET DEFAULT SINGLE TABLE STORAGE UNIT
描述
语法定义
补充说明
示例
保留字
相关链接
RQL 语法
存储单元查询
SHOW STORAGE UNITS
描述
语法
特别说明
返回值说明
示例
保留字
相关链接
规则查询
数据库发现
SHOW DB_DISCOVERY RULES
描述
语法
补充说明
返回值说明
示例
保留字
相关链接
SHOW DB_DISCOVERY TYPES
描述
语法
补充说明
返回值说明
示例
保留字
相关链接
SHOW DB_DISCOVERY HEARTBEATS
描述
语法
补充说明
返回值说明
示例
保留字
相关链接
COUNT DB_DISCOVERY RULE
描述
语法
补充说明
返回值说明
示例
保留字
相关链接
数据加密
SHOW ENCRYPT RULES
描述
语法
补充说明
返回值说明
示例
保留字
相关链接
SHOW ENCRYPT TABLE RULE
描述
语法
补充说明
返回值说明
示例
保留字
相关链接
COUNT ENCRYPT RULE
描述
语法
补充说明
返回值说明
示例
保留字
相关链接
读写分离
SHOW READWRITE_SPLITTING RULES
描述
语法
补充说明
返回值说明
示例
保留字
相关链接
COUNT READWRITE_SPLITTING RULE
描述
语法
补充说明
返回值说明
示例
保留字
相关链接
影子库压测
SHOW SHADOW RULE
描述
语法
补充说明
返回值说明
示例
保留字
相关链接
SHOW SHADOW TABLE RULE
描述
语法
补充说明
返回值说明
示例
保留字
相关链接
SHOW SHADOW ALGORITHM
描述
语法
补充说明
返回值说明
示例
保留字
相关链接
COUNT SHADOW RULE
描述
语法
补充说明
返回值说明
示例
保留字
相关链接
分片
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 RULES USED KEY GENERATOR
描述
语法
补充说明
返回值说明
示例
保留字
相关链接
SHOW SHARDING TABLE RULES USED AUDITOR
描述
语法
补充说明
返回值说明
示例
保留字
相关链接
SHOW SHARDING TABLE REGERENCE RULES
描述
语法
补充说明
返回值说明
示例
保留字
相关链接
SHOW BROADCAST TABLE RULE
描述
语法定义
补充说明
返回值说明
示例
保留字
相关链接
COUNT SHARDING RULE
描述
语法
补充说明
返回值说明
示例
保留字
相关链接
单表
SHOW DEFAULT SINGLE TABLE STORAGE UNIT
描述
语法
补充说明
返回值说明
示例
保留字
相关链接
SHOW SINGLE TABLE
描述
语法
补充说明
返回值说明
示例
保留字
相关链接
COUNT SINGLE_TABLE RULE
描述
语法
补充说明
返回值说明
示例
保留字
相关链接
RAL 语法
熔断
ALTER READWRITE_SPLITTING RULE ENABLE/DISABLE
描述
语法定义
补充说明
示例
保留字
相关链接
SHOW COMPUTE NODES
描述
语法
返回值说明
示例
保留字
相关链接
SHOW STATUS FROM READWRITE_SPLITTING RULE
描述
语法
补充说明
返回值说明
示例
保留字
相关链接
ENABLE/DISABLE COMPUTE NODE
描述
语法定义
补充说明
示例
保留字
相关链接
LABEL|RELABEL COMPUTE NODE
描述
语法
补充说明
示例
保留字
相关链接
UNLABEL COMPUTE NODE
描述
语法
补充说明
示例
保留字
相关链接
全局规则
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
描述
示例
保留字
相关链接
强制路由
SET READWRITE_SPLITTING HINT SOURCE
描述
示例
保留字
相关链接
SET SHARDING HINT DATABASE_VALUE
描述
示例
保留字
相关链接
ADD SHARDING HINT DATABASE_VALUE
描述
示例
保留字
相关链接
ADD SHARDING HINT TABLE_VALUE
描述
示例
保留字
相关链接
CLEAR HINT
描述
语法
补充说明
示例
保留字
相关链接
SHOW HINT STATUS
描述
语法
示例
保留字
相关链接
数据迁移
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 BY
描述
语法
补充说明
示例
保留字
相关链接
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 TABLE METADATA FROM STORAGE UNIT
描述
语法
补充说明
示例
保留字
相关链接
SHOW TABLE METADATA
描述
语法
返回值说明
补充说明
示例
保留字
相关链接
EXPORT DATABASE CONFIGURATION
描述
语法
补充说明
示例
保留字
相关链接
IMPORT DATABASE CONFIGURATION
描述
语法
补充说明
示例
保留字
相关链接
SHOW RULES USED STORAGE UNIT
描述
语法
返回值说明
补充说明
示例
保留字
相关链接
RUL 语法
PARSE SQL
描述
语法
返回值说明
示例
保留字
相关链接
FORMAT SQL
描述
语法
返回值说明
示例
保留字
相关链接
PREVIEW SQL
描述
语法
返回值说明
示例
保留字
相关链接
保留字
RDL
基础保留字
资源定义
规则定义
分片
单表
读写分离
数据加密
数据库发现
影子压测
RQL
基础保留字
资源定义
规则定义
分片
单表
补充说明
基础架构
FAQ
JDBC
JDBC 为什么配置了某个数据连接池的 spring-boot-starter（比如 druid）和 shardingsphere-jdbc-spring-boot-starter 时，系统启动会报错？
JDBC 使用 Spring 命名空间时找不到 xsd?
JDBC 引入 shardingsphere-transaction-xa-core 后，如何避免 spring-boot 自动加载默认的 JtaTransactionManager？
Proxy
Proxy Windows 环境下，运行 ShardingSphere-Proxy，找不到或无法加载主类 org.apache.shardingsphere.proxy.Bootstrap，如何解决？
Proxy 在使用 ShardingSphere-Proxy 的时候，如何动态在添加新的逻辑库？
Proxy 在使用 ShardingSphere-Proxy 时，怎么使用合适的工具连接到 ShardingSphere-Proxy？
Proxy 使用 Navicat 等第三方数据库工具连接 ShardingSphere-Proxy 时，如果 ShardingSphere-Proxy 没有创建 Database 或者没有添加 Storage Unit，连接失败？
分片
分片 Cloud not resolve placeholder … in string value … 异常的解决方法?
分片 inline 表达式返回结果为何出现浮点数？
分片 如果只有部分数据库分库分表，是否需要将不分库分表的表也配置在分片规则中？
分片 指定了泛型为 Long 的 SingleKeyTableShardingAlgorithm，遇到 ClassCastException: Integer can not cast to Long?
[分片、PROXY] 实现 StandardShardingAlgorithm 自定义算法时，指定了 Comparable 的具体类型为 Long, 且数据库表中字段类型为 bigint，出现 ClassCastException: Integer can not cast to Long 异常。
分片 ShardingSphere 提供的默认分布式自增主键策略为什么是不连续的，且尾数大多为偶数？
分片 如何在 inline 分表策略时，允许执行范围查询操作（BETWEEN AND、>、<、>=、<=）？
分片 为什么我实现了 KeyGenerateAlgorithm 接口，也配置了 Type，但是自定义的分布式主键依然不生效？
分片 ShardingSphere 除了支持自带的分布式自增主键之外，还能否支持原生的自增主键？
数据加密
数据加密 JPA 和 数据加密无法一起使用，如何解决？
DistSQL
DistSQL 使用 DistSQL 添加数据源时，如何设置自定义的 JDBC 连接参数或连接池属性？
DistSQL 使用 DistSQL 删除资源时，出现 Resource [xxx] is still used by [SingleTableRule]。
DistSQL 使用 DistSQL 添加资源时，出现 Failed to get driver instance for jdbcURL=xxx。
其他
其他 如果 SQL 在 ShardingSphere 中执行不正确，该如何调试？
其他 阅读源码时为什么会出现编译错误? IDEA 不索引生成的代码？
其他 使用 SQLSever 和 PostgreSQL 时，聚合列不加别名会抛异常？
其他 Oracle 数据库使用 Timestamp 类型的 Order By 语句抛出异常提示 “Order by value must implements Comparable”?
其他 Windows 环境下，通过 Git 克隆 ShardingSphere 源码时为什么提示文件名过长，如何解决？
其他 Type is required 异常的解决方法?
其他 服务启动时如何加快 metadata 加载速度？
其他 ANTLR 插件在 src 同级目录下生成代码，容易误提交，如何避免？
其他 使用 Proxool 时分库结果不正确？
其他 使用 Spring Boot 2.x 集成 ShardingSphere 时，配置文件中的属性设置不生效？
下载
最新版本
Apache ShardingSphere - 版本: 5.2.1 ( 发布日期: Oct 18th, 2022 )
全部版本
校验版本

下载地址：https://www.wenjiangs.com/wp-content/uploads/2023/01/shardingsphere_docs_cn.zip