myCat schema.xml详解

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

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

1. <?xml version="1.0"?>
2. <!DOCTYPE mycat:schema SYSTEM "schema.dtd">
3. <mycat:schema xmlns:mycat="http://org.opencloudb/" >
4.  
5. <schema name="TESTDB" checkSQLschema="false" sqlMaxLimit="100">
6. <!-- auto sharding by id (long) -->
7. <table name="travelrecord" dataNode="dn1,dn2,dn3" rule="auto-sharding-long" />
8.  
9. <!-- global table is auto cloned to all defined data nodes ,so can join
10. with any table whose sharding node is in the same data node -->
11. <table name="company" primaryKey="ID" dataNode="dn3,dn2,dn1" rule="mod-long"/>
12. <table name="goods" primaryKey="ID" type="global" dataNode="dn1,dn2" />
13. <!-- random sharding using mod sharind rule -->
14. <table name="hotnews" primaryKey="ID" dataNode="dn1,dn2,dn3"
15. rule="mod-long" />
16. <!-- <table name="dual" primaryKey="ID" dataNode="dnx,dnoracle2" type="global"
17. needAddLimit="false"/> <table name="worker" primaryKey="ID" dataNode="jdbc_dn1,jdbc_dn2,jdbc_dn3"
18. rule="mod-long" /> -->
19. <table name="employee" primaryKey="ID" dataNode="dn1,dn2"
20. rule="sharding-by-intfile" />
21. <table name="customer" primaryKey="ID" dataNode="dn1,dn2"
22. rule="sharding-by-intfile">
23. <childTable name="orders" primaryKey="ID" joinKey="customer_id"
24. parentKey="id">
25. <childTable name="order_items" joinKey="order_id"
26. parentKey="id" />
27. </childTable>
28. <childTable name="customer_addr" primaryKey="ID" joinKey="customer_id"
29. parentKey="id" />
30. </table>
31. <!-- <table name="oc_call" primaryKey="ID" dataNode="dn1$0-743" rule="latest-month-calldate"
32. /> -->
33. </schema>
34. <!-- <dataNode name="dn1$0-743" dataHost="localhost1" database="db$0-743"
35. /> -->
36. <dataNode name="dn1" dataHost="localhost1" database="db1" />
37. <dataNode name="dn2" dataHost="localhost1" database="db2" />
38. <dataNode name="dn3" dataHost="localhost1" database="db3" />
39. <!--<dataNode name="dn4" dataHost="sequoiadb1" database="SAMPLE" />
40. <dataNode name="jdbc_dn1" dataHost="jdbchost" database="db1" />
41. <dataNode name="jdbc_dn2" dataHost="jdbchost" database="db2" />
42. <dataNode name="jdbc_dn3" dataHost="jdbchost" database="db3" /> -->
43. <dataHost name="localhost1" maxCon="1000" minCon="10" balance="0"
44. writeType="0" dbType="mysql" dbDriver="native" switchType="1"  slaveThreshold="100">
45. <heartbeat>select user()</heartbeat>
46. <!-- can have multi write hosts -->
47. <writeHost host="hostM1" url="10.202.4.39:3306" user="root"
48. password="sf123456">
49. <!-- can have multi read hosts -->
50. <!--<readHost host="hostS2" url="192.168.1.200:3306" user="root" password="xxx" />-->
51. </writeHost>
52. <!--<writeHost host="hostS1" url="localhost:3316" user="root"-->
53. <!--password="123456" />-->
54. <!-- <writeHost host="hostM2" url="localhost:3316" user="root" password="123456"/> -->
55. </dataHost>
56. <!--
57. <dataHost name="sequoiadb1" maxCon="1000" minCon="1" balance="0" dbType="sequoiadb" dbDriver="jdbc">
58. <heartbeat> </heartbeat>
59. <writeHost host="hostM1" url="sequoiadb://1426587161.dbaas.sequoialab.net:11920/SAMPLE" user="jifeng" password="jifeng"></writeHost>
60. </dataHost>
61.  
62.  <dataHost name="oracle1" maxCon="1000" minCon="1" balance="0" writeType="0" dbType="oracle" dbDriver="jdbc"> <heartbeat>select 1 from dual</heartbeat>
63. <connectionInitSql>alter session set nls_date_format='yyyy-mm-dd hh24:mi:ss'</connectionInitSql>
64. <writeHost host="hostM1" url="jdbc:oracle:thin:@127.0.0.1:1521:nange" user="base" password="123456" > </writeHost> </dataHost>
65.  
66. <dataHost name="jdbchost" maxCon="1000" minCon="1" balance="0" writeType="0" dbType="mongodb" dbDriver="jdbc">
67. <heartbeat>select user()</heartbeat>
68. <writeHost host="hostM" url="mongodb://192.168.0.99/test" user="admin" password="123456" ></writeHost> </dataHost>
69.  
70. <dataHost name="sparksql" maxCon="1000" minCon="1" balance="0" dbType="spark" dbDriver="jdbc">
71. <heartbeat> </heartbeat>
72. <writeHost host="hostM1" url="jdbc:hive2://feng01:10000" user="jifeng" password="jifeng"></writeHost> </dataHost> -->
73.  
74. <!-- <dataHost name="jdbchost" maxCon="1000" minCon="10" balance="0" dbType="mysql"
75. dbDriver="jdbc"> <heartbeat>select user()</heartbeat> <writeHost host="hostM1"
76. url="jdbc:mysql://localhost:3306" user="root" password="123456"> </writeHost>
77. </dataHost> -->
78. </mycat:schema>

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.Drive

writeHost readHost

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