Mycat核心配置之schema.xml

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

一、<schema> 标签

 schema 标签用于定义 Mycat 实例中的逻辑库。Mycat 可以有多个逻辑库，每个逻辑库都有自己的相关配置。可以使用 <schema> 来划分这些不同的逻辑库，在源码的映射类为 io.mycat.config.model.SchemaConfig 类。

<schema name="TESTDB"></schema>

 schema 标签的相关属性：

属性名	值类型	必需	默认值	说明
name	string	是		逻辑库名称
checkSQLschema	boolean		false	是否去掉 sql 中的默认逻辑库名
sqlMaxLimit	int		-1	sql 的返回结果集的最大行数
dataNode	string			用于绑定逻辑库到某个具体的 database 上
randomDataNode	string

 各属性的具体说明：

• checkSQLschema 属性
   当该值设置为 true 时，如果我们的执行语句是 select * from TESTDB.travel_record，则 Mycat 会把语句写改为 select * from travel_record，即表示把 schema 名称的字符去掉，避免发送到后端数据执行时报如下异常。

    ERROR 1146 (42S02): Table 'testdb.travelrecord' doesn't exist
  

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

• sqlMaxLimit 属性
   当该值为自然数，且被执行的 SQL 语句中不含 limit 关键字时，Mycat 会自动加上所对应的值，例如此属性的值是 100，则执行 select * from travel_record 的返回结果与执行 select * from travel_record limit 100 返回结果相同。

  如果不设置该值，Mycat 默认会把查询到的信息全部都展示出来，造成过多的输出。所以，在正常使用中，还是建议加上一个值，用于减少过多的数据返回。

   当然，SQL 语句中也可以显式的指定 limit 的大小，不受该属性的约束。

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

• dataNode 属性
   表示与该逻辑库默认绑定的数据节点（数据库实例——database）。所有没有通过 <table> 标签绑定到其他数据节点的表都会走该数据节点。

  这里注意没有配置在分片里面的表无法显示在查看工具里，但是可以正常使用。

<table> 标签

 <Table> 定义了 Mycat 中的逻辑表，所有需要拆分的表都需要在这个标签中定义。如下代码块所示，同一个 schema 标签内可定义个多个逻辑表，但逻辑表的名称必须唯一，在源码的映射类为 io.mycat.config.model.TableConfig 类。

<schema name="TESTDB">
    <table name="travel_record" dataNode="dn1,dn2,dn3" rule="auto-sharding-long"></table>
    <table name="multipleDn1" dataNode="dn1,dn2,dn3" rule="auto-sharding-long"></table>
</schema>

 table 标签的相关属性：

属性名称	值类型	必需	默认值	说明
name	string	是		逻辑表名称
nameSuffix	string			逻辑表名前缀（1.6 版本新特性）
dataNode	string	是		本逻辑表分布在哪些 dataNode 上
rule	string			分片规则名称
ruleRequired	boolean		false	是否绑定有分片规则
primaryKey	string		null	主键，用于之后路由分析，以及启用自增长主键
type	string		null	是否为global
autoIncrement	boolean		false	是否主键自增
subTables	string
needAddLimit	boolean		true	是否需要加返回结果集限制

• name 属性
   逻辑表的名称，这个名称就如同在数据库中执行create table命令指定的名称一样，同一个 schema 标签中定义的逻辑表名称必须唯一。
• dataNode 属性
   定义这个逻辑表所属的 dataNode，该属性的值需要和 <dataNode> 中 name 属性的值相对应。如果需要定义的数据节点过多，可以使用如下的方法减少配置：

  <table name="travel_record" dataNode="multipleDn$0-99,multipleDn2$100-199" rule="auto-sharding-long"></table>
  <dataNode name="multipleDn$0-99" dataHost="localhost1" database="db$0-99"></dataNode>
  <dataNode name="multipleDn2$100-199" dataHost="localhost1" database=" db$100-199"></dataNode>
  

   这里需要注意的是 database 属性所指定的真实 database name 需要在后面添加一个$符号，例如上面的例子中，表示需要在真实的 mysql 上建立名称为 db0 到 db199 的 database。
• rule 属性
   该属性用于指定逻辑表要使用的分片规则名字，规则名字在 rule.xml 中定义，必须与 <tableRule> 中 name 属性值对应。
• ruleRequired 属性
   该属性用于指定表是否绑定分片规则，如果配置为 true，但没有配置具体 rule 的话，程序会报错。
• primaryKey 属性
   逻辑表对应真实表的主键。例如：分片的规则是使用非主键进行分片的，那么在使用主键查询的时候，就会发送查询语句到所有配置的数据节点上。如果使用该属性配置真实表的主键，那么 Mycat 会缓存主键与具体的数据节点信息，再次使用非主键进行查询时，就不会进行广播式的查询，就只会接发送语句给具体的数据节点，但是尽管配置该属性，如果缓存并没有命中的话，还是会发送语句给具体的数据节点，来获取数据。
• type 属性
   该属性定义了逻辑表的类型，目前逻辑表只有“全局表”和“普通表”两种类型。对应的配置：
  • 全局表：global。
  • 普通表：非 global 即可。
• 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 属性
   目前 1.6 版本开始支持分表，并且 dataNode 在分表条件下只能配置一个，分表条件下不支持各种条件的 join 语句。使用方式是添加 subTables=“t_order$1-2,t_order3”
• needAddLimit 属性
   指定表是否需要自动的在每个语句后面加上 limit 限制。由于使用了分库分表，数据量有时会特别巨大，这时候执行查询语句，如果恰巧又忘记了加上数量限制的话，那么将查询出所有的数据出来。所以，Mycat 就自动的为我们加上 LIMIT 100。当然，如果语句中有 limit，就不会再次添加了。

<childTable> 标签

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

<schema name="TESTDB">
    <table name="travel_record" dataNode="dn$1-3">
        <childTable name="company" joinKey="id" parentKey="parent_id"/>
    </table>
</schema>

 <childTable> 的相关属性：

属性名	值类型	必需	默认值	说明
name	string	是		子表的表名
joinKey	string	是		插入子表的时候会使用这个列的值查找父表存储的数据节点
parentKey	string	是		与父表建立关联关系的列名
primaryKey	string			该表对应的真实主键
needAddLimit	boolean			是否需要为 sql 自动添加 limit 关键字
autoIncrement	boolean		false	是否主键自增

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

二、<dataNode> 标签

 <dataNode>定义了 Mycat 中的数据节点，也就是我们通常所说的数据分片。一个 <dataNode> 就是一个独立的数据分片，在源码的映射类为 io.mycat.config.model.DataNodeConfig 类。

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

将名为 localhost1 节点上数据库实例为 db1 的物理库标记成名为 dn1 的独立数据分片。

 <dataNode> 的相关属性：

属性名	值类型	必需	说明
name	string	是	数据节点名称，须保证唯一
dataHost	string	是	该分片节点所属的节点主机
database	string	是	真实的 database 名称

 属性释义：

• name 属性
   定义数据节点的名字（须保证唯一），我们需要在 <table> 上引用这个名称，来建立表与分片对应的关系。
• dataHost 属性
   该属性用于定义该分片属于哪个数据库实例，属性值是引用自 <dataHost> 上定义的 name 属性。
• database 属性
   该属性用于定义该分片属于哪个具体数据库实例上的具体库。

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

三、<dataHost> 标签

 作为 schema.xml 中最后的一个标签，该标签在 Mycat 逻辑库中也是作为最底层的标签存在，直接定义了具体的数据库实例、读写分离配置和心跳语句，在源码的映射类是 io.mycat.config.model.DataHostConfig 类。

<dataHost name="dn1" balance="0" dbDriver="native" dbType="mysql" maxCon="10" minCon="100">
    <heartbeat>select 1 from dual</heartbeat>
    <writeHost host="hostM1" url="master1:3306" user="root" password="123456">
        <readHost host="hostS1" url="slave1:3306" user="root" password="123456"/>
    </writeHost>
</dataHost>

 <dataHost> 标签的相关属性：

属性名	值类型	必需	默认值	说明
name	string	是		节点主机的唯一标识，供其他标签使用
maxCon	int	是	128	读写连接池的最大连接数
minCon	int	是	10	读写连接池的最小/初始连接数
balance	int	是	0	负载均衡类型
balanceType	int		0	负载均衡策略
dbType	string	是		后端数据库类型
dbDriver	string	是		连接后端数据库使用的驱动
writeType	int		0	写类型
switchType	int		-1	切换类型
slaveThreshold	int		-1	从库延迟界限
tempReadHostAvailable	int		0	写节点宕机时，临时读节点是否可用
notSwitch	string		0

 属性释义：

• balance 属性
   负载均衡类型，目前的取值有 4 中：
  • balance=“0”，不开启读写分离机制，所有读操作都发送到当前可用的 writeHost 上。
  • balance=“1”，全部的 readHost 与 stand by writeHost 参与 select 语句的负载均衡，简单地说，当说双主从模式（M1 -> S1，M2 -> S2，并且 M1 与 M2 互为主备），正常情况下，M2、S1、S2 都参与 select 语句的负载均衡。
  • balance=“2”，所有读操作都随机的在 writeHost、readHost 上分发。
  • balance=“3”，（1.4+ 版本特性）所有读请求随机的分发到 writeHost 对应的 readHost 执行，writeHost 不负担读压力。
• balanceType 属性
  • 0 表示随机。
  • 1 表示加权轮询。
  • 2 表示最少活跃数。
• writeType 属性
   负载均衡类型，目前的取值有 2 种：
  • writeType=“0”，所有写操作发送到配置的第一个 writeHost，第一个挂了切到还存活的第二个 writeHost，重新启动后以切换后的为准，切换信息记录在 dnindex.properties 配置文件。
  • writeType=“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 属性
   指定连接后端数据库使用的驱动，目前可选的值有 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。
• tempReadHostAvailable 属性
   如果属性值大于 0 则表示在写节点宕机时，临时的读服务依然可用，即如果配置了这个属性，<writeHost> 下面的 <readHost> 仍旧可用，默认 0 可配置（0、1）。

<heartbeat> 标签

 这个标签内指明用于和后端数据库进行心跳检查的语句。例如，MySQL 可以使用 select user()，Oracle 可以使用 select 1 from dual 等。

<dataHost name="dn1" balance="0" dbDriver="native" dbType="mysql" maxCon="10" minCon="100">
    <heartbeat>select user()</heartbeat>
</dataHost>

Mycat 1.4 版本的主从切换的心跳语句必须是：show slave status

<connectionInitSql> 标签

 当使用 Oracle 数据库时，需要执行的初始化 SQL 语句就放到这里面来。例如：

<dataHost name="dn1" balance="0" dbDriver="jdbc" dbType="oracle" maxCon="10" minCon="100">
    <heartbeat>select 1 from dual</heartbeat>
    <connectionInitSql>alter session set nls_date_format='yyyy-mm-dd hh24:mi:ss'</connectionInitSql>
</dataHost>

<writeHost> 标签、<readHost> 标签

 这两个标签都是指定后端数据库的相关配置给 Mycat，用于实例化后端连接池。唯一不同的是：<writeHost> 指定写实例、<readHost> 指定读实例，组合这些读写实例来满足系统的要求。

<dataHost name="dn1" balance="0" dbDriver="native" dbType="mysql" maxCon="10" minCon="100">
    <writeHost host="hostM1" url="master1:3306" user="root" password="123456">
        <readHost host="hostS1" url="slave1:3306" user="root" password="123456"/>
    </writeHost>
</dataHost>

 在一个 <dataHost> 内可以定义多个 <writeHost> 和 <readHost>。但是，如果 <writeHost> 指定的后端数据库宕机，那么这个 <writeHost> 绑定的所有 <readHost> 都将不可用。另一方面，由于这个 <writeHost> 宕机系统会自动的检测到，并切换到备用的 <writeHost> 上去。
 <writeHost> 和 <readHost> 的属性相同，这里就一起介绍。

属性名	值类型	必需	默认值	说明
host	string	是		用于标识不同实例，一般writeHost使用 M1；readHost 用 S1
url	string	是		后端实例连接地址，如果是使用 native 的 dbDriver，则一般为 localhost:3306 形式； 在使用 jdbc 时，则可写为：jdbc:mysql://localhost:3306
user	string	是		后端存储实例需要的用户名称
password	string	是		后端存储实例需要的密码
weight	string		0	权重。配置在 <readhost> 中作为读节点的权重（1.4+ 版本生效）
usingDecrypt	string		0	是否对密码加密