Mycat系列—常用的分片规则

1、分片枚举

通过在配置文件中配置可能的枚举 id，自己配置分片，本规则适用于特定的场景，比如有些业务需要按照省份或区县来做保存，而全国省份区县固定的，这类业务使用本条规则，配置如下：

<tableRule name="sharding-by-intfile">
    <rule>
        <columns>user_idcolumns>
        <algorithm>hash-intalgorithm>
    rule>
tableRule>
<function name="hash-int" class="org.opencloudb.route.function.PartitionByFileMap">
    <property name="mapFile">partition-hash-int.txtproperty>
    <property name="type">0property>
    <property name="defaultNode">0property>
function>

partition-hash-int.txt 配置：

10000=0
10010=1
DEFAULT_NODE=1

配置说明：

• columns：标识将要分片的表字段；
• algorithm：分片函数。

其中分片函数配置中：

• mapFile：标识配置文件名称；
• type：默认值为 0，0 表示 Integer，非零表示 String。

所有的节点配置都是从 0 开始， 0 代表节点 1。

/**
* defaultNode 默认节点:小于 0 表示不设置默认节点，大于等于 0 表示设置默认节点
* 默认节点的作用：枚举分片时，如果碰到不识别的枚举值，就让它路由到默认节点
* 如果不配置默认节点（defaultNode 值小于 0 表示不配置默认节点），碰到
* 不识别的枚举值就会报错，
* like this：can’t find datanode for sharding column:column_name val:ffffffff
*/

2、固定分片 hash 算法

本条规则类似于十进制的求模运算，区别在于是二进制的操作,是取 id 的二进制低 10 位，即 id 二进制 &1111111111。

此算法的优点在于如果按照 10 进制取模运算，在连续插入 1-10 时候 1-10 会被分到 1-10 个分片，增大了插入的事务控制难度，而此算法根据二进制则可能会分到连续的分片，减少插入事务事务控制难度。

<tableRule name="rule1">
    <rule>
        <columns>user_idcolumns>
        <algorithm>func1algorithm>
    rule>
tableRule>
<function name="func1" class="org.opencloudb.route.function.PartitionByLong">
    <property name="partitionCount">2,1property>
    <property name="partitionLength">256,512property>
function>

配置说明：

• columns：标识将要分片的表字段；
• algorithm：分片函数；
• partitionCount：分片个数列表；
• partitionLength：分片范围列表。

分区长度：

• 默认为最大 2^n=1024 ，即最大支持 1024 分区。

约束：

• count，length 两个数组的长度必须是一致的；
• 1024 = sum((count[i]*length[i])). count 和 length 两个向量的点积恒等于 1024。

用法例子：

• 本例的分区策略：希望将数据水平分成 3 份，前两份各占 25%，第三份占 50%。（故本例非均匀分区）

// |<———————1024———————————>|
// |<—-256—>|<—-256—>|<———-512————->|
// | partition0 | partition1 | partition2 |
// | 共 2 份,故 count[0]=2 | 共 1 份，故 count[1]=1 |
int[] count = new int[] { 2, 1 };
int[] length = new int[] { 256, 512 };
PartitionUtil pu = new PartitionUtil(count, length);

如果需要平均分配设置：平均分为 4 分片，partitionCount*partitionLength=1024。

name="func1" class="org.opencloudb.route.function.PartitionByLong">
    <property name="partitionCount">4property>
    <property name="partitionLength">256property>

3、范围约定

此分片适用于，提前规划好分片字段某个范围属于哪个分片。

<tableRule name="auto-sharding-long">
    <rule>
        <columns>user_idcolumns>
        <algorithm>rang-longalgorithm>
    rule>
tableRule>
<function name="rang-long" class="org.opencloudb.route.function.AutoPartitionByLong">
    <property name="mapFile">autopartition-long.txtproperty>
    <property name="defaultNode">0property>
function>

配置说明：

• columns：标识将要分片的表字段；
• algorithm：分片函数；

rang-long 函数中：

• mapFile 代表配置文件路径；
• defaultNode：超过范围后的默认节点。

所有的节点配置都是从 0 开始，及 0 代表节点 1，此配置非常简单，即预先制定可能的 id 范围到某个分片：

# range start-end ,data node index
# K=1000,M=10000.
0-500M=0
500M-1000M=1
1000M-1500M=2

或

0-10000000=0
10000001-20000000=1

4、取模

此规则为对分片字段求摸运算。

<tableRule name="mod-long">
    <rule>
        <columns>user_idcolumns>
        <algorithm>mod-longalgorithm>
    rule>
tableRule>
<function name="mod-long" class="org.opencloudb.route.function.PartitionByMod">
    
    <property name="count">3property>
function>

配置说明：

• columns：标识将要分片的表字段；
• algorithm：分片函数；

此种配置非常明确，即根据 id 进行十进制求模预算，相比固定分片 hash，此种在批量插入时可能存在批量插入单事务插入多数据分片，增大事务一致性难度。

5、按日期（天）分片

此规则为按天分片。

<tableRule name="sharding-by-date">
    <rule>
        <columns>create_timecolumns>
        <algorithm>sharding-by-datealgorithm>
    rule>
tableRule>
<function name="sharding-by-date" class="org.opencloudb.route.function.PartitionByDate">
    <property name="dateFormat">yyyy-MM-ddproperty>
    <property name="sBeginDate">2014-01-01property>
    <property name="sEndDate">2014-01-02property>
    <property name="sPartionDay">10property>
function>

配置说明：

• columns ：标识将要分片的表字段；
• algorithm ：分片函数；
• dateFormat ：日期格式；
• sBeginDate ：开始日期；
• sEndDate：结束日期；
• sPartionDay ：分区天数，即默认从开始日期算起，分隔 10 天一个分区。

如果配置了 sEndDate 则代表数据达到了这个日期的分片后后循环从开始分片插入。

Assert.assertEquals(true, 0 == partition.calculate(“2014-01-01”));
Assert.assertEquals(true, 0 == partition.calculate(“2014-01-10”));
Assert.assertEquals(true, 1 == partition.calculate(“2014-01-11”));
Assert.assertEquals(true, 12 == partition.calculate(“2014-05-01”));

6、取模范围约束

此种规则是取模运算与范围约束的结合，主要为了后续数据迁移做准备，即可以自主决定取模后数据的节点分布。

<tableRule name="sharding-by-pattern">
    <rule>
        <columns>user_idcolumns>
        <algorithm>sharding-by-patternalgorithm>
    rule>
tableRule>
<function name="sharding-by-pattern" class="org.opencloudb.route.function.PartitionByPattern">
    <property name="patternValue">256property>
    <property name="defaultNode">2property>
    <property name="mapFile">partition-pattern.txtproperty>
function>

partition-pattern.txt

# id partition range start-end ,data node index
###### first host configuration
1-32=0
33-64=1
65-96=2
97-128=3
######## second host configuration
129-160=4
161-192=5
193-224=6
225-256=7
0-0=7

配置说明：

• columns ：标识将要分片的表字段；
• algorithm ：分片函数；
• patternValue：即求模基数；
• defaoultNode：默认节点，如果配置了默认，则不会按照求模运算；
• mapFile：配置文件路径。

配置文件中，1-32 即代表 id%256 后分布的范围，如果在 1-32 则在分区 1，其他类推，如果 id 非数据，则会分配在 defaoultNode 默认节点。

String idVal = “0”;
Assert.assertEquals(true, 7 == autoPartition.calculate(idVal));
idVal = “45a”;
Assert.assertEquals(true, 2 == autoPartition.calculate(idVal));

7、截取数字做 hash 求模范围约束

此种规则类似于取模范围约束，此规则支持数据符号字母取模。

<tableRule name="sharding-by-prefixpattern">
    <rule>
        <columns>user_idcolumns>
        <algorithm>sharding-by-prefixpatternalgorithm>
    rule>
tableRule>
<function name="sharding-by-pattern" class="org.opencloudb.route.function.PartitionByPrefixPattern">
    <property name="patternValue">256property>
    <property name="prefixLength">5property>
    <property name="mapFile">partition-pattern.txtproperty>
function>

partition-pattern.txt

# range start-end ,data node index
# ASCII
# 8-57=0-9 阿拉伯数字
# 64、65-90=@、A-Z
# 97-122=a-z
###### first host configuration
1-4=0
5-8=1
9-12=2
13-16=3
###### second host configuration
17-20=4
21-24=5
25-28=6
29-32=7
0-0=7

配置说明：

• columns ：标识将要分片的表字段；
• algorithm ：分片函数；
• patternValue：求模基数；
• prefixLength：ASCII 截取的位数；
• mapFile：配置文件路径。

配置文件中，1-32 即代表 id%256 后分布的范围，如果在 1-32 则在分区 1，其他类推。

此种方式类似方式 6，只不过采取的是将列种获取前 prefixLength 位列所有 ASCII 码的和进行求模。

sum%patternValue ,获取的值，在范围内的分片数，

String idVal=“gf89f9a”;
Assert.assertEquals(true, 0==autoPartition.calculate(idVal));
idVal=“8df99a”;
Assert.assertEquals(true, 4==autoPartition.calculate(idVal));
idVal=“8dhdf99a”;
Assert.assertEquals(true, 3==autoPartition.calculate(idVal));

8、应用指定

此规则是在运行阶段有应用自主决定路由到那个分片。

<tableRule name="sharding-by-substring">
    <rule>
        <columns>user_idcolumns>
        <algorithm>sharding-by-substringalgorithm>
    rule>
tableRule>
<function name="sharding-by-substring" class="org.opencloudb.route.function.PartitionDirectBySubString">
    <property name="startIndex">0property>
    <property name="size">2property>
    <property name="partitionCount">8property>
    <property name="defaultPartition">0property>
function>

配置说明：

• columns ：标识将要分片的表字段；
• algorithm ：分片函数；

此方法为直接根据字符子串（必须是数字）计算分区号（由应用传递参数，显式指定分区号）。

例如：id=05-100000002，在此配置中代表根据 id 中从 startIndex=0，开始，截取 siz=2 位数字即 05，05 就是获取的分区，如果没传默认分配到 defaultPartition。

9、截取数字 hash 解析

此规则是截取字符串中的 int 数值 hash 分片。

<tableRule name="sharding-by-stringhash">
    <rule>
        <columns>user_idcolumns>
        <algorithm>sharding-by-stringhashalgorithm>
    rule>
tableRule>
<function name="sharding-by-stringhash" class="org.opencloudb.route.function.PartitionByString">
    <property name="partitionLength">512property>
    <property name="partitionCount">2property>
    <property name="hashSlice">0:2property>
function>

配置说明：

• columns ：标识将要分片的表字段；
• algorithm ：分片函数；

函数中：

• partitionLength：代表字符串；
• hash：求模基数；
• partitionCount：分区数；
• hashSlice ：hash 预算位，即根据子字符串中 int 值 hash 运算。0 means str.length(), -1 means str.length()-1。

/**
* “2” -> (0,2)
* “1:2” -> (1,2)
* “1:” -> (1,0)
* “-1:” -> (-1,0)
* “:-1” -> (0,-1)
* “:” -> (0,0)
*/

例子：

String idVal=null;
rule.setPartitionLength("512");
rule.setPartitionCount("2");
rule.init();
rule.setHashSlice("0:2");
// idVal = "0";
// Assert.assertEquals(true, 0 == rule.calculate(idVal));
// idVal = "45a";
// Assert.assertEquals(true, 1 == rule.calculate(idVal));
// last 4
rule = new PartitionByString();
rule.setPartitionLength("512");
rule.setPartitionCount("2");
rule.init();
//last 4 characters
rule.setHashSlice("-4:0");
idVal = "aaaabbb0000";
Assert.assertEquals(true, 0 == rule.calculate(idVal));
idVal = "aaaabbb2359";
Assert.assertEquals(true, 0 == rule.calculate(idVal));

10、一致性 hash

一致性 hash 预算有效解决了分布式数据的扩容问题。

<tableRule name="sharding-by-murmur">
    <rule>
        <columns>user_idcolumns>
        <algorithm>murmuralgorithm>
    rule>
tableRule>
<function name="murmur" class="org.opencloudb.route.function.PartitionByMurmurHash">
    
    <property name="seed">0property>
    
    <property name="count">2property>
    
    <property name="virtualBucketTimes">160property>
    
    <property name="weightMapFile">weightMapFileproperty>
    
    <property name="bucketMapPath">/etc/mycat/bucketMapPathproperty> 
function>

11、按单月小时拆分

此规则是单月内按照小时拆分，最小粒度是小时，可以一天最多 24 个分片，最少 1 个分片，一个月完后下月从头开始循环。每个月月尾，需要手工清理数据。

<tableRule name="sharding-by-hour">
    <rule>
        <columns>create_timecolumns>
        <algorithm>sharding-by-houralgorithm>
    rule>
tableRule>
<function name="sharding-by-hour" class="org.opencloudb.route.function.LatestMonthPartion">
    <property name="splitOneDay">24property>
function>

配置说明：

• columns： 拆分字段，字符串类型（yyyymmddHH）;
• splitOneDay ： 一天切分的分片数。

LatestMonthPartion partion = new LatestMonthPartion();
partion.setSplitOneDay(24);
Integer val = partion.calculate("2015020100");
assertTrue(val == 0);
val = partion.calculate("2015020216");
assertTrue(val == 40);
val = partion.calculate("2015022823");
assertTrue(val == 27 * 24 + 23);
Integer[] span = partion.calculateRange("2015020100", "2015022823");
assertTrue(span.length == 27 * 24 + 23 + 1);
assertTrue(span[0] == 0 && span[span.length - 1] == 27 * 24 + 23);
span = partion.calculateRange("2015020100", "2015020123");
assertTrue(span.length == 24);
assertTrue(span[0] == 0 && span[span.length - 1] == 23);

12、范围求模分片

先进行范围分片计算出分片组，组内再求模。

优点可以避免扩容时的数据迁移，又可以一定程度上避免范围分片的热点问题。综合了范围分片和求模分片的优点，分片组内使用求模可以保证组内数据比较均匀，分片组之间是范围分片，可以兼顾范围查询。

最好事先规划好分片的数量，数据扩容时按分片组扩容，则原有分片组的数据不需要迁移。由于分片组内数
据比较均匀，所以分片组内可以避免热点数据问题。

<tableRule name="auto-sharding-rang-mod">
    <rule>
        <columns>idcolumns>
        <algorithm>rang-modalgorithm>
    rule>
tableRule>
<function name="rang-mod" class="org.opencloudb.route.function.PartitionByRangeMod">
    <property name="mapFile">partition-range-mod.txtproperty>
    <property name="defaultNode">21property>
function>

配置说明：

• columns ：标识将要分片的表字段；
• algorithm ：分片函数；

rang-mod 函数中：

• mapFile：代表配置文件路径；
• defaultNode：超过范围后的默认节点顺序号，节点从 0 开始。

partition-range-mod.txt

# 以下配置一个范围代表一个分片组，=号后面的数字代表该分片组所拥有的分片的数量。
# range start-end ,data node group size
0-200M=5 //代表有 5 个分片节点
200M1-400M=1
400M1-600M=4
600M1-800M=4
800M1-1000M=6

13、日期范围 hash 分片

思想与范围求模一致，当由于日期在取模会有数据集中问题，所以改成 hash 方法。

先根据日期分组，再根据时间 hash 使得短期内数据分布的更均匀。

优点可以避免扩容时的数据迁移，又可以一定程度上避免范围分片的热点问题。要求日期格式尽量精确些，不然达不到局部均匀的目的

<tableRule name="rangeDateHash">
    <rule>
        <columns>col_datecolumns>
        <algorithm>range-date-hashalgorithm>
    rule>
tableRule>
<function name="range-date-hash" class="org.opencloudb.route.function.PartitionByRangeDateHash">
    <property name="sBeginDate">2014-01-01 00:00:00property>
    <property name="sPartionDay">3property>
    <property name="dateFormat">yyyy-MM-dd HH:mm:ssproperty>
    <property name="groupPartionSize">6property>
function>

• sPartionDay：代表多少天分一个分片；
• groupPartionSize：代表分片组的大小。

14、冷热数据分片

根据日期查询日志数据 冷热数据分布 ，最近 n 个月的到实时交易库查询，超过 n 个月的按照 m 天分片。

<tableRule name="sharding-by-date">
    <rule>
        <columns>create_timecolumns>
        <algorithm>sharding-by-hotdatealgorithm>
    rule>
tableRule>
<function name="sharding-by-hotdate" class="org.opencloudb.route.function.PartitionByHotDate">
    <property name="dateFormat">yyyy-MM-ddproperty>
    <property name="sLastDay">10property>
    <property name="sPartionDay">30property>
function>

15、自然月分片

按月份列分区 ，每个自然月一个分片，格式 between 操作解析的范例。

<tableRule name="sharding-by-month">
    <rule>
        <columns>create_timecolumns>
        <algorithm>sharding-by-monthalgorithm>
    rule>
tableRule>
<function name="sharding-by-month" class="org.opencloudb.route.function.PartitionByMonth">
    <property name="dateFormat">yyyy-MM-ddproperty>
    <property name="sBeginDate">2014-01-01property>
function>

配置说明：

• columns： 分片字段，字符串类型；
• dateFormat ： 日期字符串格式；
• sBeginDate ： 开始日期。

PartitionByMonth partition = new PartitionByMonth();
partition.setDateFormat("yyyy-MM-dd");
partition.setsBeginDate("2014-01-01");
partition.init();
Assert.assertEquals(true, 0 == partition.calculate("2014-01-01"));
Assert.assertEquals(true, 0 == partition.calculate("2014-01-10"));
Assert.assertEquals(true, 0 == partition.calculate("2014-01-31"));
Assert.assertEquals(true, 1 == partition.calculate("2014-02-01"));
Assert.assertEquals(true, 1 == partition.calculate("2014-02-28"));
Assert.assertEquals(true, 2 == partition.calculate("2014-03-1"));
Assert.assertEquals(true, 11 == partition.calculate("2014-12-31"));
Assert.assertEquals(true, 12 == partition.calculate("2015-01-31"));
Assert.assertEquals(true, 23 == partition.calculate("2015-12-31"));