Mycat比较重要的配置文件有三个,分别是server.xml、schema.xml和rule.xml。
server.xml
server.xml是配置Mycat系统参数的,包括sql统计、sql解析长度、事务开关、端口号、是否采用Zookeeper协调切换,以及Mycat用户密码等信息。
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mycat:server SYSTEM "server.dtd">
<mycat:server xmlns:mycat="http://io.mycat/">
<system>
<property name="useSqlStat">0</property> <!-- 1为开启实时统计、0为关闭 -->
<property name="useGlobleTableCheck">0</property> <!-- 1为开启全局表一致性检测、0为关闭 -->
<property name="sequnceHandlerType">2</property> <!-- 指定mycat全局序列的类型:0位本地文件方式;1位数据库方式;2位时间戳序列方式,默认是0-->
<property name="useCompression">1</property> <!--1为开启mysql压缩协议-->
<property name="fakeMySQLVersion">5.6.20</property> <!--设置模拟的MySQL版本号-->
<property name="processorBufferChunk">40960</property>
<property name="processors">1</property>
<property name="processorExecutor">32</property>
<!--默认为type 0: DirectByteBufferPool | type 1 ByteBufferArena-->
<property name="processorBufferPoolType">0</property>
<!--默认是65535 64K 用于sql解析时最大文本长度 -->
<property name="maxStringLiteralLength">65535</property>
<property name="sequnceHandlerType">0</property>
<property name="backSocketNoDelay">1</property>
<property name="frontSocketNoDelay">1</property>
<property name="processorExecutor">16</property>
<property name="serverPort">8066</property> <property name="managerPort">9066</property>
<property name="idleTimeout">300000</property> <property name="bindIp">0.0.0.0</property>
<property name="frontWriteQueueSize">4096</property> <property name="processors">32</property>
<!--分布式事务开关,0为不过滤分布式事务,1为过滤分布式事务(如果分布式事务内只涉及全局表,则不过滤),2为不过滤分布式事务,但是记录分布式事务日志-->
<property name="handleDistributedTransactions">0</property>
<!--off heap for merge/order/group/limit 1开启 0关闭-->
<property name="useOffHeapForMerge">1</property>
<!--单位为m-->
<property name="memoryPageSize">1m</property>
<!--单位为k-->
<property name="spillsFileBufferSize">1k</property>
<property name="useStreamOutput">0</property>
<!--单位为m-->
<property name="systemReserveMemorySize">384m</property>
<!--是否采用zookeeper协调切换 -->
<property name="useZKSwitch">true</property>
</system>
<!-- 全局SQL防火墙设置 -->
<firewall>
<whitehost>
<host host="127.0.0.1" user="mycat"/>
<host host="127.0.0.2" user="mycat"/>
</whitehost>
<blacklist check="false">
</blacklist>
</firewall>
<user name="root">
<property name="password">123456</property>
<property name="schemas">TESTDB</property>
<!-- 表级 DML 权限设置 -->
<privileges check="false">
<schema name="TESTDB" dml="0110" >
<table name="tb01" dml="0000"></table>
<table name="tb02" dml="1111"></table>
</schema>
</privileges>
</user>
<user name="user">
<property name="password">user</property>
<property name="schemas">TESTDB</property>
<property name="readOnly">true</property>
</user>
</mycat:server>
如上所示,在个配置文件中,system标签下的即为系统参数,可以在做性能优化的时候修改。user标签是定义Mycat用户,上面的配置中配置了两个用户,分别是root和user,name属性是配置名称,password属性配置该用户的登录密码,schemas数据配置用户有权限的逻辑库,如果要配置多个,用英文逗号分隔。如上,root和user用户都对应的逻辑库是TESTDB,root用户还配置了DML权限,而user用户多配置了readOnly属性为true,则表示user用户对TESTDB逻辑库是只读的,该属性默认是false。
schema.xml
schema.xml是配置逻辑库的,包括逻辑表、分片规则、分片节点、关联规则等信息。
<?xml version="1.0"?>
<!DOCTYPE mycat:schema SYSTEM "schema.dtd">
<mycat:schema xmlns:mycat="http://io.mycat/">
<schema name="TESTDB" checkSQLschema="false" sqlMaxLimit="100">
<!-- travelrecord表,分片的数据节点是dn1,2,3三个节点,分片规则是auto-sharding-long -->
<table name="travelrecord" dataNode="dn1,dn2,dn3" rule="auto-sharding-long" />
<!-- user表,分布的数据节点是dn1,2两个,没有设置分片规则,两个数据节点数据相同 -->
<table name="user" dataNode="dn1,dn2"/>
<!-- gender表是全局表,在dn1,2两个节点上都有备份 -->
<table name="gender" primaryKey="id" type="global" dataNode="dn1,dn2" />
<table name="company" primaryKey="ID" dataNode="dn1,dn2,dn3" rule="mod-long" />
<table name="goods" primaryKey="ID" type="global" dataNode="dn1,dn2" />
<!-- random sharding using mod sharind rule -->
<table name="hotnews" primaryKey="ID" autoIncrement="true" dataNode="dn1,dn2,dn3" rule="mod-long" />
<table name="employee" primaryKey="ID" dataNode="dn1,dn2" rule="sharding-by-intfile" />
<!-- customer表,主键是id,数据以auto-sharding-long分片规则分布在dn1,2,3三个数据节点上 -->
<table name="customer" primaryKey="ID" dataNode="dn1,dn2,dn3" rule="auto-sharding-long">
<!-- orders表和customer是多对一的关系,以customer_id字段和customer的id字段外键关联 -->
<childTable name="orders" primaryKey="ID" joinKey="customer_id" parentKey="id">
<!-- order_items表和orders是多对一的关系,以order_id字段和orders的id字段外键关联 -->
<childTable name="order_items" joinKey="order_id" parentKey="id" />
</childTable>
<childTable name="customer_addr" primaryKey="ID" joinKey="customer_id" parentKey="id" />
</table>
</schema>
<!-- 配置数据节点,这里配置的都是本地的,每个数据节点对应着一个物理库 -->
<dataNode name="dn1" dataHost="localhost1" database="db1" />
<dataNode name="dn2" dataHost="localhost1" database="db2" />
<dataNode name="dn3" dataHost="localhost1" database="db3" />
<!-- 配置分片主机,主要配置连接物理库的信息,这里连接的本地mysql库 -->
<dataHost name="localhost1" maxCon="1000" minCon="10" balance="0"
writeType="0" dbType="mysql" dbDriver="native" switchType="1" slaveThreshold="100">
<!-- 做心跳检测,默认每10秒检测一次,当检测不到心跳时,会再次连续发起心跳检测,如果同样还是检测不到,则判定节点宕机 -->
<heartbeat>select user()</heartbeat>
<!-- writeHost配置的是写节点,如果要配置读写分离,可以配置下面注释掉的readHost -->
<writeHost host="hostM1" url="localhost:3306" user="root" password="123456">
<!-- can have multi read hosts -->
<!-- <readHost host="hostS2" url="192.168.1.200:3306" user="root" password="xxx" /> -->
</writeHost>
</dataHost>
</mycat:schema>
这里是以mysql为例,schema标签即配置逻辑库,name属性定义逻辑库的名字。table标签配置逻辑库中的逻辑表,name属性定义逻辑表名,dataNode属性配置该逻辑表要分布的分片节点,rule属性定义该逻辑表以哪种分片方式进行分片,type属性配置改逻辑表是否属于全局表。childTable标签是配置子表的标签,按照关系型数据库中表关系,如果两个表之间有一对多的关系,即可配置成父子表,name属性同样定义子表名称,joinKey属性表示子表中和父表做关联的字段,parentKey属性表示与父表中关联的字段,如上所示,customer表和orders表是一对多的关系,以主键id和orders表中的customer_id字段进行关联。dataNode标签用来配置分片节点,dataHost属性表示分片节点所在的分片主机,database对应的是MySQL物理库中的库名。dataHost节点配置分片主机的信息,name属性表示分片主机的名称,对应dataNode节点的dataHost属性,heartbeat节点是做心跳检测,writeHost和readHost标签是用来配置读、写数据库节点的。
rule.xml
rule.xml主要是配置分片节规则的,但是分片规则光靠rule.xml配置是不够的,rule.xml主要是配置分片规则的名称,字段等信息,具体的分片算法是在conf下的那些txt文件中的。
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mycat:rule SYSTEM "rule.dtd">
<mycat:rule xmlns:mycat="http://io.mycat/">
<tableRule name="rule1">
<rule>
<columns>id</columns>
<algorithm>func1</algorithm>
</rule>
</tableRule>
<tableRule name="rule2">
<rule>
<columns>user_id</columns>
<algorithm>func1</algorithm>
</rule>
</tableRule>
<tableRule name="sharding-by-intfile">
<rule>
<columns>sharding_id</columns>
<algorithm>hash-int</algorithm>
</rule>
</tableRule>
<tableRule name="auto-sharding-long">
<rule>
<columns>id</columns>
<algorithm>rang-long</algorithm>
</rule>
</tableRule>
<tableRule name="mod-long">
<rule>
<columns>id</columns>
<algorithm>mod-long</algorithm>
</rule>
</tableRule>
<tableRule name="sharding-by-murmur">
<rule>
<columns>id</columns>
<algorithm>murmur</algorithm>
</rule>
</tableRule>
<tableRule name="crc32slot">
<rule>
<columns>id</columns>
<algorithm>crc32slot</algorithm>
</rule>
</tableRule>
<tableRule name="sharding-by-month">
<rule>
<columns>create_time</columns>
<algorithm>partbymonth</algorithm>
</rule>
</tableRule>
<tableRule name="latest-month-calldate">
<rule>
<columns>calldate</columns>
<algorithm>latestMonth</algorithm>
</rule>
</tableRule>
<tableRule name="auto-sharding-rang-mod">
<rule>
<columns>id</columns>
<algorithm>rang-mod</algorithm>
</rule>
</tableRule>
<tableRule name="jch">
<rule>
<columns>id</columns>
<algorithm>jump-consistent-hash</algorithm>
</rule>
</tableRule>
<function name="murmur"
class="io.mycat.route.function.PartitionByMurmurHash">
<property name="seed">0</property><!-- 默认是0 -->
<property name="count">2</property><!-- 要分片的数据库节点数量,必须指定,否则没法分片 -->
<property name="virtualBucketTimes">160</property><!-- 一个实际的数据库节点被映射为这么多虚拟节点,默认是160倍,也就是虚拟节点数是物理节点数的160倍 -->
<!-- <property name="weightMapFile">weightMapFile</property> 节点的权重,没有指定权重的节点默认是1。以properties文件的格式填写,以从0开始到count-1的整数值也就是节点索引为key,以节点权重值为值。所有权重值必须是正整数,否则以1代替 -->
<!-- <property name="bucketMapPath">/etc/mycat/bucketMapPath</property>
用于测试时观察各物理节点与虚拟节点的分布情况,如果指定了这个属性,会把虚拟节点的murmur hash值与物理节点的映射按行输出到这个文件,没有默认值,如果不指定,就不会输出任何东西 -->
</function>
<function name="crc32slot"
class="io.mycat.route.function.PartitionByCRC32PreSlot">
<property name="count">2</property><!-- 要分片的数据库节点数量,必须指定,否则没法分片 -->
</function>
<function name="hash-int"
class="io.mycat.route.function.PartitionByFileMap">
<property name="mapFile">partition-hash-int.txt</property>
</function>
<function name="rang-long"
class="io.mycat.route.function.AutoPartitionByLong">
<property name="mapFile">autopartition-long.txt</property>
</function>
<function name="mod-long" class="io.mycat.route.function.PartitionByMod">
<!-- how many data nodes -->
<property name="count">3</property>
</function>
<function name="func1" class="io.mycat.route.function.PartitionByLong">
<property name="partitionCount">8</property>
<property name="partitionLength">128</property>
</function>
<function name="latestMonth"
class="io.mycat.route.function.LatestMonthPartion">
<property name="splitOneDay">24</property>
</function>
<function name="partbymonth"
class="io.mycat.route.function.PartitionByMonth">
<property name="dateFormat">yyyy-MM-dd</property>
<property name="sBeginDate">2015-01-01</property>
</function>
<function name="rang-mod" class="io.mycat.route.function.PartitionByRangeMod">
<property name="mapFile">partition-range-mod.txt</property>
</function>
<function name="jump-consistent-hash" class="io.mycat.route.function.PartitionByJumpConsistentHash">
<property name="totalBuckets">3</property>
</function>
</mycat:rule>
tableRule标签是配置分片规则,name属性是分片规则的名称,对应schema.xml文件中table标签下的rule属性。rule标签是具体规则,columns标签表示按照哪一列进行分片,例如id列,algrithm标签配置的是分片算法,对应的conf下的txt名称。function标签同样是配置分片规则,name是规则名称,class对应分片算法类。
以上是Mycat主要的配置文件,详细说明可以参考Mycat官网的指南。