MyCat配置文件详解

schema.xml

schema.xml 是mycat重要的配置文件之一，管理者mycat的逻辑库、表、分片规则、DataNode以及DataSource。想要了解使用mycat就要弄清楚schema里面的标签含义，下面将介绍一下schema里面的详细内容。

首先 mycat自带的schema.xml 如下所示：

7. rule="mod-long" />
   rule="sharding-by-intfile" />
   rule="sharding-by-intfile">
   parentKey="id">
   parentKey="id" />
   parentKey="id" />
16. writeType="0" dbType="mysql" dbDriver="native" switchType="1"  slaveThreshold="100">
17. select user()
20. password="sf123456">

1、schema 标签

1. <schema name="TESTDB" checkSQLschema="false" sqlMaxLimit="100" dataNode="dn1,dn2,dn3" >

• schema

  schema标签用来定义mycat实例中的逻辑库，mycat可以有多个逻辑库，每个逻辑库都有自己的相关配置。可以使用schema标签来划分这些不同的逻辑库。

        如果不配置schema标签，所有表的配置会属于同一个默认的逻辑库。

        逻辑库的概念和MySql的database的概念一样，我们在查询两个不同逻辑库中的表的时候，需要切换到该逻辑库下进行查询。

注意：进行查询的时候需要在server.xml配置相关用户权限信息 ，这个随后讲解

• dataNode

        该标签用于绑定逻辑库到某个具体的database上。

• checkSQLschema 

    当该值为true时，例如我们执行语句select * from TESTDB.company 。mycat会把语句修改为 select * from company 去掉TESTDB。

• sqlMaxLimit 

    当该值设置为某个数值时，每条执行的sql语句，如果没有加上limit语句，Mycat会自动加上对应的值。不写的话，默认返回所有的值。

需要注意的是，如果运行的schema为非拆分库的，那么该属性不会生效。需要自己sql语句加limit。

2、table 标签

1. <table name="travelrecord" dataNode="dn1,dn2,dn3" rule="auto-sharding-long" />

table标签定义了mycat中的逻辑表，所有需要拆分的表都需要在这个标签中定义。

• name属性

    name属性代表了逻辑表的表名，同一个schema中name标签中定义的名字必须唯一。如同我们在数据库执行create table 命令指定的名字一样。

• dataNode属性

    定义这个逻辑表所属的dataNode，该属性的值需要和dataNode标签中的name值相对应。如果需要定义的dn非常多，可以使用如下方法定义

1. <table name="travelrecord" dataNode="multipleDn$0-99,multipleDn2$100-199" rule="auto-sharding- long" >table>

1. <dataNode name="multipleDn" dataHost="localhost1" database="db$0-99" >dataNode>
2. <dataNode name="multipleDn2" dataHost="localhost1" database=" db$0-99" >dataNode>

    database属性所指的真实databas name需要在mysql中存在，比如上面例子中，我们需要在mysql中建立名称为dbs0到dbs99的database 。

• rule属性

    该属性指定逻辑表使用的规则名字，规则名字在rule.xml中定义，必须与tableRule标签中name属性对应。

• ruleRequired属性

    该属性用于指定是否绑定分片规则，如果配置为true，但是没有配置具体rule时候，就会报错

• primaryKey属性

该属性代表了，逻辑表对应真实表的主键。例如：分片的规则是使用非主键进行分片的，那么在使用主键查询的时候，就会发送查询语句到所有配置的DN上，如果使用该属性配置真实表的主键，那么mycat会缓存主键与具体DN的信息，那么再次使用非主键进行查询的时候就不会进行广播式的查询，就会直接发送语句给具体的DN，但是尽管配置该属性，如果缓存并没有命中的话，还是会发送语句给具体的DN 来获取数据。

• type属性

该属性定义了逻辑表的类型，目前逻辑表只有全局表和普通表。

全局表： global

普通表：无

• autoIncrement属性

    mysql对非自增长主键，使用last_insert_id() 是不会返回结果的，只会返回0.所以，只有定义了自增长主键的表，才可以用last_insert_id()返回主键值。

    mycat提供了自增长主键功能，但是对应的mysql节点上数据表，没有auto_increment,那么在mycat层调用last_insert_id()也是不会返回结果的。

    如果使用这个功能，最好配合使用数据库模式的全局序列。

• needAddLimit 

指定表是否需要自动的在每个语句后面加上limit限制，由于使用了分库分表，数据量有时候会特别庞大，这时候执行查询语句，忘记加上limt就会等好久，所以mycat自动为我们加上了limit 100，这个属性默认为true，可以自己设置为false禁用。

3、dataNode标签

1. <dataNode name="dn1" dataHost="localhost1" database="db1" />

    datanode标签定义了mycat中的数据节点，也就是我们所说的数据分片。一个datanode标签就是一个独立的数据分片。

    例子中的表述的意思为，使用名字为localhost1数据库实例上的db1物理数据库，这就组成一个数据分片，最后我们用dn1来标示这个分片。

• name：定义数据节点的名字，这个名字需要唯一。我们在table标签上用这个名字来建立表与分片对应的关系
  

• dataHost

用于定义该分片属于哪个数据库实例，属性与datahost标签上定义的name对应

• database

用于定义该分片属于数据库实例上 的具体库。

4、dataHost标签

这个标签直接定义了具体数据库实例，读写分离配置和心跳语句。

name

唯一标示dataHost标签，供上层使用

maxCon

指定每个读写实例连接池的最大连接。

minCon

指定每个读写实例连接池的最小连接，初始化连接池的大小

• balance

负载均称类型

0：不开启读写分离机制，所有读操作都发送到当前可用的writeHost上

1：全部的readHost与stand by writeHost参与select语句的负载均衡，简单的说，当双主双从模式（M1-S1，M2-S2 并且M1 M2互为主备），正常情况下，M2,S1,S2都参与select语句的负载均衡。

2：所有读操作都随机的在writeHost、readHost上分发

3：所有读请求随机的分发到writeHst对应的readHost执行，writeHost不负担读写压力。（1.4之后版本有）

• writeType属性

负载均衡类型。

0：所有的写操作发送到配置的第一个writeHost，第一个挂了切换到第二个。切换记录在文件dnindex.properties

1：所有的鞋操作都随机的发送到配置的writeHost，1.5以后版本废弃不推荐。

• switchType属性

-1不自动切换

1 默认值 自动切换

2 基于MySql主从同步的状态决定是否切换

心跳语句为 show slave status

3 基于mysql galary cluster 的切换机制（适合集群）1.4.1

心跳语句为 show status like 'wsrep%'

• dbType

指定后端链接的数据库类型目前支持二进制的mysql协议，还有其他使用jdbc链接的数据库，例如：mongodb，oracle，spark等

• dbDriver属性

指定连接后段数据库使用的driver，目前可选的值有native和JDBC。使用native的话，因为这个值执行的是二进制的mysql协议，所以可以使用mysql和maridb，其他类型的则需要使用JDBC驱动来支持。

如果使用JDBC的话需要符合JDBC4标准的驱动jar 放到mycat\lib目录下，并检查驱动jar包中包括如下目录结构文件 META-INF\services\java.sql.Driver。  在这个文件写上具体的driver类名，例如com.mysql.jdbc.Driver

writeHost readHost

指定后端数据库的相关配置给mycat，用于实例化后端连接池。

server.xml

server.xml几乎保存了所有mycat需要的系统配置信息。其在代码内直接的映射类为SystemConfig类。现在就对这个文件中的配

置，一一介绍。

user标签

 <user name="test">
 <property name="password">testproperty>
 <property name="schemas">TESTDBproperty>
 <property name="readOnly">trueproperty>
 user>

server.xml中的标签本就不多，这个标签主要用于定义登录mycat的用户和权限。例如上面的例子中，我定义了一个用户，用户
名为test、密码也为test，可访问的schema也只有TESTDB一个。
如果我在schema.xml中定义了多个schema，那么这个用户是无法访问其他的schema。在mysql客户端看来则是无法使用use切
换到这个其他的数据库。如果使用了use命令，则mycat会报出这样的错误提示：
ERROR 1044 (HY000): Access denied for user 'test' to database 'xxx'
这个标签嵌套的property标签则是具体声明的属性值，正如上面的例子。我们可以修改user标签的name属性来指定用户名；修
改password内的文本来修改密码；修改readOnly为true 或false来限制用户是否只是可读的；修改schemas内的文本来控制用户可
放问的schema；修改schemas内的文本来控制用户可访问的schema，同时访问多个schema的话使用 , 隔开，例如:
TESTDB,db1,db2

system标签

这个标签内嵌套的所有property标签都与系统配置有关，请注意，下面我会省去标签property直接使用这个标签的name属性内
的值来介绍这个属性的作用。
defaultSqlParser属性
由于mycat最初是时候Foundation DB的sql解析器，而后才添加的Druid的解析器。所以这个属性用来指定默认的解析器。目前
的可用的取值有：druidparser和 fdbparser。使用的时候可以选择其中的一种，目前一般都使用druidparser。
processors属性
这个属性主要用于指定系统可用的线程数，默认值为Runtime.getRuntime().availableProcessors()方法返回的值。主要影响
processorBufferPool、processorBufferLocalPercent、processorExecutor属性。NIOProcessor的个数也是由这个属性定义的，
所以调优的时候可以适当的调高这个属性。
processorBufferChunk属性
这个属性指定每次分配Socket Direct Buffer的大小，默认是4096个字节。这个属性也影响buffer pool的长度。
processorBufferPool属性
这个属性指定bufferPool计算 比例值。由于每次执行NIO读、写操作都需要使用到buffer，系统初始化的时候会建立一定长度的
buffer池来加快读、写的效率，减少建立buffer的时间。
Mycat中有两个主要的buffer池:
- BufferPool
- ThreadLocalPool
BufferPool由ThreadLocalPool组合而成，每次从BufferPool中获取buffer都会优先获取ThreadLocalPool中的buffer，未命中之
后才会去获取BufferPool中的buffer。也就是说ThreadLocalPool是作为BufferPool的二级缓存，每个线程内部自己使用的。当
然，这其中还有一些限制条件需要线程的名字是由$_开头。然而，BufferPool上的buffer则是每个NIOProcessor都共享的。
默认这个属性的值为： 默认bufferChunkSize(4096) * processors属性 *　1000
BufferPool的总长度 = bufferPool / bufferChunk。
若bufferPool不是bufferChunk的整数倍，则总长度为前面计算得出的商 + 1
假设系统线程数为4，其他都为属性的默认值，则：
bufferPool ＝　4096 *　4 * 1000
BufferPool的总长度 : 4000 = 16384000 / 4096
processorBufferLocalPercent属性
前面提到了ThreadLocalPool。这个属性就是用来控制分配这个pool的大小用的，但其也并不是一个准确的值，也是一个比例
值。这个属性默认值为100。
线程缓存百分比 = bufferLocalPercent / processors属性。
例如，系统可以同时运行4个线程，使用默认值，则根据公式每个线程的百分比为25。最后根据这个百分比来计算出具体的
ThreadLocalPool的长度公式如下：
ThreadLocalPool的长度 = 线程缓存百分比 * BufferPool长度 / 100
假设BufferPool的长度为 4000，其他保持默认值。
那么最后每个线程建立上的ThreadLocalPool的长度为： 1000 = 25 * 4000 / 100
processorExecutor属性
这个属性主要用于指定NIOProcessor上共享的businessExecutor固定线程池大小。mycat在需要处理一些异步逻辑的时候会把任
务提交到这个线程池中。新版本中这个连接池的使用频率不是很大了，可以设置一个较小的值。
sequnceHandlerType属性
指定使用Mycat全局序列的类型。0为本地文件方式，1为数据库方式。默认是使用本地文件方式，文件方式主要只是用于测试使
用。
TCP连接相关属性
StandardSocketOptions.SO_RCVBUF
StandardSocketOptions.SO_SNDBUF
StandardSocketOptions.TCP_NODELAY
以上这三个属性，分别由：
frontSocketSoRcvbuf 默认值： 1024 * 1024
frontSocketSoSndbuf 默认值： 4 * 1024 * 1024
frontSocketNoDelay 默认值： 1
backSocketSoRcvbuf 默认值： 4 * 1024 * 1024
backSocketSoSndbuf 默认值： 1024 * 1024
backSocketNoDelay 默认值： 1
各自设置前后端TCP连接参数。Mycat在每次建立前、后端连接的时候都会使用这些参数初始化连接。可以按系统要求适当的调
整这些buffer的大小。TCP连接参数的定义，可以查看Javadoc。
Mysql连接相关属性
初始化mysql前后端连接所涉及到的一些属性：
packetHeaderSize : 指定Mysql协议中的报文头长度。默认4。
maxPacketSize : 指定Mysql协议可以携带的数据最大长度。默认16M。
idleTimeout : 指定连接的空闲超时时间。某连接在发起空闲检查下，发现距离上次使用超过了空闲时间，那么这个连接会被回
收，就是被直接的关闭掉。默认30分钟。
charset : 连接的初始化字符集。默认为utf8。
txIsolation : 前端连接的初始化事务隔离级别，只在初始化的时候使用，后续会根据客户端传递过来的属性对后端数据库连接进
行同步。默认为REPEATED_READ。
sqlExecuteTimeout:SQL执行超时的时间，Mycat会检查连接上最后一次执行SQL的时间，若超过这个时间则会直接关闭这连接。
默认时间为300秒。
周期间隔相关属性
mycat中有几个周期性的任务来异步的处理一些我需要的工作。这些属性就在系统调优的过程中也是比不可少的。
processorCheckPeriod : 清理NIOProcessor上前后端空闲、超时和关闭连接的间隔时间。默认是1秒。
dataNodeIdleCheckPeriod : 对后端连接进行空闲、超时检查的时间间隔，默认是60秒。
dataNodeHeartbeatPeriod : 对后端所有读、写库发起心跳的间隔时间，默认是10秒。
服务相关属性
这里介绍一个与服务相关的属性，主要会影响外部系统对myact的感知。
bindIp : mycat服务监听的IP地址，默认值为0.0.0.0。
serverPort : 定义mycat的使用端口，默认值为8066。
managerPort : 定义mycat的管理端口，默认值为9066。

rule.xml

rule.xml里面就定义了我们对表进行拆分所涉及到的规则定义。我们可以灵活的对表使用不同的分片算法，或者对表使用相同的
算法但具体的参数不同。这个文件里面主要有tableRule和function这两个标签。在具体使用过程中可以按照需求添加tableRule

和function。

tableRule标签

这个标签定义表规则。
定义的表规则，在schema.xml：

 <tableRule name="rule1">
 <rule>
 <columns>idcolumns>
 <algorithm>func1algorithm>
 rule>
 tableRule>

name 属性指定唯一的名字，用于标识不同的表规则。
内嵌的rule标签则指定对物理表中的哪一列进行拆分和使用什么路由算法。
columns 内指定要拆分的列名字。
algorithm 使用function标签中的name属性。连接表规则和具体路由算法。当然，多个表规则可以连接到同一个路由算法上。
标签内使用。让逻辑表使用这个规则进行分片。

function标签

 <function name="hash-int"
 class="org.opencloudb.route.function.PartitionByFileMap">
 <property name="mapFile">partition-hash-int.txtproperty>
 function>

name 指定算法的名字。
class 制定路由算法具体的类名字。
property 为具体算法需要用到的一些属性。