分片算法

    取模分片算法

    类型:MOD

    可配置属性:

    哈希取模分片算法

    类型:HASH_MOD

    可配置属性:

    属性名称数据类型说明
    sharding-countint分片数量

    基于分片容量的范围分片算法

    类型:VOLUME_RANGE

    可配置属性:

    属性名称数据类型说明
    range-lowerlong范围下界,超过边界的数据会报错
    range-upperlong范围上界,超过边界的数据会报错
    sharding-volumelong分片容量

    基于分片边界的范围分片算法

    类型:BOUNDARY_RANGE

    可配置属性:

    属性名称数据类型说明
    sharding-rangesString分片的范围边界,多个范围边界以逗号分隔

    自动时间段分片算法

    类型:AUTO_INTERVAL

    可配置属性:

    行表达式分片算法

    使用 Groovy 的表达式,提供对 SQL 语句中的 和 IN 的分片操作支持,只支持单分片键。 对于简单的分片算法,可以通过简单的配置使用,从而避免繁琐的 Java 代码开发,如: t_user_$->{u_id % 8} 表示 t_user 表根据 u_id 模 8,而分成 8 张表,表名称为 t_user_0t_user_7。 详情请参见行表达式

    类型:INLINE

    可配置属性:

    属性名称数据类型说明默认值
    algorithm-expressionString分片算法的行表达式
    allow-range-query-with-inline-sharding (?)boolean是否允许范围查询。注意:范围查询会无视分片策略,进行全路由false

    时间范围分片算法

    此算法主动忽视了 datetime-pattern 的时区信息。 这意味着当 datetime-lower, datetime-upper 和传入的分片键含有时区信息时,不会因为时区不一致而发生时区转换。 当传入的分片键为 java.time.Instant 时存在特例处理,其会携带上系统的时区信息后转化为 的字符串格式,再进行下一步分片。

    类型:INTERVAL

    可配置属性:

    属性名称数据类型说明默认值
    datetime-patternString分片键的时间戳格式,必须遵循 Java DateTimeFormatter 的格式。例如:yyyy-MM-dd HH:mm:ss,yyyy-MM-dd 或 HH:mm:ss 等。但不支持与 java.time.chrono.JapaneseDate 相关的 Gy-MM 等
    datetime-lowerString时间分片下界值,格式与 datetime-pattern 定义的时间戳格式一致
    datetime-upper (?)String时间分片上界值,格式与 datetime-pattern 定义的时间戳格式一致当前时间
    sharding-suffix-patternString分片数据源或真实表的后缀格式,必须遵循 Java DateTimeFormatter 的格式,必须和 datetime-interval-unit 保持一致。例如:yyyyMM
    datetime-interval-amount (?)int分片键时间间隔,超过该时间间隔将进入下一分片1
    datetime-interval-unit (?)String分片键时间间隔单位,必须遵循 Java ChronoUnit 的枚举值。例如:MONTHSDAYS

    基于 CosId 的固定时间范围的分片算法

    基于 me.ahoo.cosid:cosid-core 的工具类实现的固定时间范围的分片算法。 当分片键为 JSR-310 的所含类或与时间相关的类,将转换为java.time.LocalDateTime后再做下一步分片。 参考 的讨论。

    类型:COSID_INTERVAL

    可配置属性:

    属性名称数据类型说明默认值
    zone-idString时区,必须遵循 java.time.ZoneId 的所含值。 例如:Asia/Shanghai
    logic-name-prefixString分片数据源或真实表的前缀格式
    datetime-lowerString时间分片下界值,格式与 yyyy-MM-dd HH:mm:ss 的时间戳格式一致
    datetime-upperString时间分片上界值,格式与 yyyy-MM-dd HH:mm:ss 的时间戳格式一致
    sharding-suffix-patternString分片数据源或真实表的后缀格式,必须遵循 Java DateTimeFormatter 的格式,必须和 datetime-interval-unit 保持一致。例如:yyyyMM
    datetime-interval-unitString分片键时间间隔单位,必须遵循 Java ChronoUnit 的枚举值。例如:MONTHS
    datetime-interval-amountint分片键时间间隔,超过该时间间隔将进入下一分片

    基于 CosId 的雪花ID固定时间范围的分片算法

    基于 的工具类实现的雪花ID固定时间范围的分片算法。 当分片键为 JSR-310 的所含类或与时间相关的类,将转换为java.time.LocalDateTime后再做下一步分片。 参考 的讨论。

    可配置属性:

    基于 CosId 的取模分片算法

    基于 me.ahoo.cosid:cosid-core 的工具类实现的取模分片算法。 参考 的讨论。

    类型:COSID_MOD

    可配置属性:

    属性名称数据类型说明
    modint分片数量
    logic-name-prefixString分片数据源或真实表的前缀格式

    复合行表达式分片算法

    详情请参见行表达式

    类型:COMPLEX_INLINE

    属性名称数据类型说明默认值
    sharding-columns (?)String分片列名称,多个列用逗号分隔。如不配置无法则不能校验
    algorithm-expressionString分片算法的行表达式
    allow-range-query-with-inline-sharding (?)boolean是否允许范围查询。注意:范围查询会无视分片策略,进行全路由false

    Hint 行表达式分片算法

    详情请参见。

    类型:HINT_INLINE

    属性名称数据类型说明默认值
    algorithm-expression (?)String分片算法的行表达式${value}

    通过配置分片策略类型和算法类名,实现自定义扩展。 CLASS_BASED 允许向算法类内传入额外的自定义属性,传入的属性可以通过属性名为 propsjava.util.Properties 类实例取出。 参考 Git 的 org.apache.shardingsphere.example.extension.sharding.algortihm.classbased.fixture.ClassBasedStandardShardingAlgorithmFixture

    类型:CLASS_BASED

    1. 使用数据分片时,在 shardingAlgorithms 属性下配置对应的数据分片算法即可;