Mycatschema.xml配置详解

致敬大佬！！！

原文：https://www.jianshu.com/p/4e15cad5ce6a

Mycat的schema.xml配置详解

1.schema.xml是干什么用的?

Schema.xml 作为 MyCat 中重要的配置文件之一，管理着 MyCat 的逻辑库、表、分片规则、 DataNode 以及 DataSource。弄懂这些配置，是正确使用 MyCat 的前提。

xml结构:

<?xml version="1.0?>

<!DOCTYPE mycat:schema SYSTEM "schema.dtd">

<mycat:schema xmlns:mycat="http://io.mycat/">

</mycat:schema>

1.1schema 标签

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

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

<schema name="USERDB checkSQLschema="false" sqlMaxLimit="100" datanode="dn3,dn4">

 <table name="eg_user" dataNode="dn1,dn2" rule="auto-sharing-long"></table>

</schema>

<schema name="ORDERDB checkSQLschema="false" sqlMaxLimit="100">

<table name="eg_order" dataNode="dn3,dn4" rule="auto-sharing-long"></table>

</schema>

如上所示的配置就配置了两个不同的逻辑库，逻辑库的概念和 MYSQL 数据库中 Database 的概念相同，我们在查询这两个不同的逻辑库中表的时候需要切换到该逻辑库下才可以查询到所需要的表。

1.1.1schema标签属性详解

name属性:

逻辑数据库的名称

dataNode属性：

dataNode指定了逻辑数据库对应物理数据库节点，逻辑库下的表默认都走schema配置的database，但是如1.1中的eg_user表，在table标签中也配置dataNode属性，则eg_user表不走schema默认的dn3,dn4,而是走自己的dn1,dn2

checkSQLschema属性:

当该值设置为 true 时，如果我们执行语句(select * from USERDB.eg_user)则 MyCat 会把语句修改为(select * from eg_user)。即把表示 schema 的字符去掉，避免发送到后端数据库执行时报**（ERROR1146 (42S02): Table ‘ USERDB.eg_user’ doesn’ t exist）。

不过，即使设置该值为 true ，如果语句所带的是并非是 schema 指定的名字，例如：**select * from db1.eg_user;** 那么 MyCat 并不会删除 db1 这个字段，如果没有定义该库的话则会报错，所以在提供 SQL语句的最好是不带这个字段

总结: 该字段就是用户执行sql语句时，是否检查表明的schema，实际上与SQL语句语法是有重提的，强烈建议将该字段设置为false;

sqlMaxLimit属性:

当该值设置为某个数值时。每条执行的 SQL 语句，如果没有加上 limit 语句，MyCat 也会自动的加上所对应的值。例如设置值为 100，执行**select * from USERDB.eg_user;**的效果为和执行**select * from USERDB.eg_userlimit 100;**相同。如果没有设置该值的话，MyCat 默认会把查询到的信息全部都展示出来，造成过多的输出。所以，在正常使用中，还是建议加上一个值，用于减少过多的数据返回。当然 SQL 语句中也显式的指定 limit 的大小，不受该属性的约束。

PS：需要注意的是，如果运行的 schema 为非拆分库的，那么该属性不会生效。需要手动添加 limit 语句。

1.2table 标签

<table name="eg_user" dataNode="dn1,dn2" rule="auto-sharing-long"></table>

name属性:

定义逻辑表的表名，这个名字就如同我在数据库中执行 create table 命令指定的名字一样，同个 schema 标签中定义的名字必须唯一

dataNode 属性：

定义这个逻辑表所属的 dataNode, 该属性的值需要和 dataNode 标签中 name 属性的值相互对应。如果需要定义的 dn 过多可以使用如下的方法减少配置

<table name="eg_user" dataNode="multipleDn$0-99,multipleDn2$100-199" rule="auto-shardinglong" >

<!--数据节点配置-->

<dataNode name="multipleDn" dataHost="localhost1" database="db$0-99" >

<dataNode name="multipleDn2" dataHost="localhost1" database=" db$0-199" >

这里需要注意的是 database 属性所指定的真实 database name 需要在后面添加一个，例如上面的例子中，我需要在真实的 mysql 上建立名称为 dbs0 到 dbs99 的 database。

rule 属性:

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

ruleRequired 属性:

该属性用于指定表是否绑定分片规则,如果配置为 true,但没有配置具体 rule 的话,程序会报错。

primaryKey 属性:

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

type 属性:

该属性定义了逻辑表的类型，目前逻辑表只有“全局表”和”普通表”两种类型。对应的配置：

·全局表：global

·普通表：不指定该值为 globla 的所有表。

autoIncrement 属性:

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

mycat 目前提供了自增长主键功能，但是如果对应的 mysql 节点上数据表，没有定义 auto_increment，那么在 mycat 层调用 last_insert_id()也是不会返回结果的。由于 insert 操作的时候没有带入分片键，mycat 会先取下这个表对应的全局序列，然后赋值给分片键。这样才能正常的插入到数据库中，最后使用 last_insert_id()才会返回插入的分片键值。如果要使用这个功能最好配合使用数据库模式的全局序列。使用 autoIncrement=“ true” 指定这个表有使用自增长主键，这样 mycat 才会不抛出分片键找不到的异常。使用 autoIncrement=“ false” 来禁用这个功能，当然你也可以直接删除掉这个属性。默认就是禁用的。

subTables属性:

使用方式添加 subTables="t_order$1-2,t_order3"

目前分表 1.6 以后开始支持 并且 dataNode 在分表条件下只能配置一个，分表条件下不支持各种条件的join 语句

needAddLimit 属性:

指定表是否需要自动的在每个语句后面加上 limit 限制。由于使用了分库分表，数据量有时会特别巨大。这时候执行查询语句，如果恰巧又忘记了加上数量限制的话。那么查询所有的数据出来，也够等上一小会儿的。所以，mycat 就自动的为我们加上 LIMIT 100。当然，如果语句中有 limit，就不会在次添加了。这个属性默认为 true,你也可以设置成 false`禁用掉默认行为

1.3childTable 标签

childTable 标签用于定义 E-R 分片的子表。通过标签上的属性与父表进行关联

主要是用于跨分片表连接查询,mycat不能够，需要设置childTable

<table name="customer" primaryKey="ID" dataNode="dn1,dn2" rule="sharding-by-intfile">

<childTable name="orders" primaryKey="ID" joinKey="customer_id" parentKey="id">

<childTable name="order_items" primaryKey="ID" joinKey="order_id" parentKey="id" />

<childTable name="customer_addr" primaryKey="ID" joinKey="customer_id" parentKey="id" />

</table>

name 属性:

定义子表的表名;

joinKey 属性:

插入子表的时候会使用这个列的值查找父表存储的数据节点。

parentKey 属性:

属性指定的值一般为与父表建立关联关系的列名。程序首先获取 joinkey 的值，再通过parentKey属性指定的列名产生查询语句，通过执行该语句得到父表存储在哪个分片上。从而确定子表存储的位置

primaryKey 属性:

同 table 标签所描述的。

needAddLimit 属性:

同 table 标签所描述的。

1.4dataNode 标签:

<dataNode name="dn1" dataHost="lch3307" database="db1" />

dataNode标签定义了 MyCat 中的数据节点，也就是我们通常说所的数据分片。一个dataNode标签就是一个独立的数据分片。例子中所表述的意思为：使用名字为 lch3307 数据库实例上的 db1 物理数据库，这就组成一个数据分片，最后，我们使用名字 dn1 标识这个分

name 属性:

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

dataHost 属性:

该属性用于定义该分片属于哪个数据库实例的，属性值是引用 dataHost 标签上定义的 name 属性。

database 属性:

该属性用于定义该分片属性哪个具体数据库实例上的具体库，因为这里使用两个维度来定义分片，就是：实例+具体的库。因为每个库上建立的表和表结构是一样的。所以这样做就可以轻松的对表进行水平拆分。

1.5dataHost 标签：

作为 Schema.xml 中最后的一个标签，该标签在 mycat 逻辑库中也是作为最底层的标签存在，直接定义了具体的数据库实例、读写分离配置和心跳语句。现在我们就解析下这个标签。

<dataHost name="localhost1" maxCon="1000" minCon="10" balance="0"

writeType="0" dbType="mysql" dbDriver="native">

<heartbeat>select user()</heartbeat>

<writeHost host="hostM1" url="localhost:3306" user="root" password="123456" />

<readHost host="hostS2" url="localhost:3306" user="root" password="123456"/>

</writeHost>

<writeHost host="hostS1" url="localhost:3316" user="root" password="123456" />

</dataHost>  

name 属性：

唯一标识 dataHost 标签，供上层的标签使用。

maxCon 属性:

指定每个读写实例连接池的最大连接。也就是说，标签内嵌套的 writeHost、 readHost 标签都会使用这个属性的值来实例化出连接池的最大连接数。

minCon 属性:

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

balance 属性：

负载均衡类型，目前的取值有 3 种：

1. balance="0", 不开启读写分离机制，所有读操作都发送到当前可用的 writeHost 上。

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

3. balance="2"，所有读操作都随机的在 writeHost、 readhost 上分发。

4. balance="3"，所有读请求随机的分发到 wiriterHost 对应的 readhost 执行，writerHost 不负担读压力，注意 balance=3 只在 1.4 及其以后版本有，1.3 没有。

writeType 属性：

负载均衡类型，目前的取值有 3 种：

1. writeType="0", 所有写操作发送到配置的第一个 writeHost，第一个挂了切 到还生存的第二个writeHost，重新启动后已切换后的为准，切换记录在 配置文件中:dnindex.properties .

2. writeType="1"，所有写操作都随机的发送到配置的 writeHost，1.5 以后废 弃不推荐。

dbType 属性：

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

dbDriver 属性：

指定连接后端数据库使用的 Driver，目前可选的值有 native 和 JDBC。使用 native 的话，因为这个值执行的是二进制的 mysql 协议，所以可以使用 mysql 和 maridb。其他类型的数据库则需要使用 JDBC 驱动来支持。从 1.6 版本开始支持 postgresql 的 native 原始协议,如果使用 JDBC 的话需要将符合 JDBC 4 标准的驱动 JAR 包放到 MYCAT\lib 目录下，并检查驱动 JAR 包中包括如下目录结构的文件：META-INF\services\java.sql.Driver。在这个文件内写上具体的 Driver 类名，例如：com.mysql.jdbc.Driver

switchType 属性：

-1 表示不自动切换

1 默认值，自动切换

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

心跳语句为 show slave status,select 1+1,select user()

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

心跳语句为 show status like ‘wsrep%’.

tempReadHostAvailable 属性：

如果配置了这个属性 writeHost 下面的 readHost 仍旧可用，默认 0 可配置 （0、 1）

1.6heartbeat 标签

这个标签内指明用于和后端数据库进行心跳检查的语句。例如,MYSQL 可以使用 select user()，Oracle 可以使用 select 1 from dual 等。这个标签还有一个 connectionInitSql 属性，主要是当使用 Oracla 数据库时，需要执行的初始化 SQL 语句就这个放到这里面来。例如：alter session set nls_date_format='yyyy-mm-dd hh24:mi:ss'

1.7writeHost 标签、 readHost 标签

这两个标签都指定后端数据库的相关配置给 mycat，用于实例化后端连接池。唯一不同的是，writeHost 指定写实例、 readHost 指定读实例，组着这些读写实例来满足系统的要求。在一个 dataHost 内可以定义多个 writeHost 和 readHost。但是，如果 writeHost 指定的后端数据库宕机，那么这个 writeHost 绑定的所有 readHost 都将不可用。另一方面，由于这个 writeHost 宕机系统会自动的检测到，并切换到备用的 writeHost 上去。这两个标签的属性相同，这里就一起介绍

host 属性:

用于标识不同实例，一般 writeHost 我们使用*M1，readHost 我们用*S1。

url 属性:

后端实例连接地址，如果是使用 native 的 dbDriver，则一般为 address:port 这种形式。用 JDBC 或其他的dbDriver，则需要特殊指定。当使用 JDBC 时则可以这么写：jdbc:mysql://localhost:3306/。

user 属性:

后端存储实例需要的用户名字

password 属性:

后端存储实例需要的密码

weight 属性:

权重 配置在 readhost 中作为读节点的权重（1.4 以后）

usingDecrypt 属性:

是否对密码加密默认 0 否 如需要开启配置 1，同时使用加密程序对密码加密，加密命令为：

执行 mycat jar 程序（1.4.1 以后）：