schema.xml
Schema.xml 作为 MyCat 中重要的配置文件之一，管理着 MyCat 的逻辑库、表、分片规则、DataNode 以
及 DataSource。弄懂这些配置，是正确使用 MyCat 的前提。这里就一层层对该文件进行解析。
schema 标签
相关属性：
| 属性名 | 类型 | 数量限制 |
|---|---|---|
| dataNode | String | 0…1 |
| checkSQLschema | Boolean | 1 |
| sqlMaxLimit | Integer | 1 |
dataNode
该属性用于绑定逻辑库到某个具体的 database 上，1.3 版本如果配置了 dataNode，则不可以配置分片表，
1.4 可以配置默认分片，只需要配置需要分片的表即可。
checkSQLschema
验证是否为mycat配置的schema，不是数数据库的具体schema
sqlMaxLimit
当该值设置为某个数值时。每条执行的 SQL 语句，如果没有加上 limit 语句，MyCat 也会自动的加上所对应
的值。
table 标签
table 标签的相关属性：
| 属性名 | 类型 | 数量限制 |
|---|---|---|
| name | String | 1 |
| dataNode | String | 1…* |
| rule | String | 0…1 |
| ruleRequired | Boolean | 0…1 |
| primaryKey | String | 1 |
| type | String | 0…1 |
| autoIncrement | Boolean | 0…1 |
| subTables | String | 1 |
| needAddLimit | Boolean | 0…1 |
name
定义逻辑表的表名，这个名字就如同我在数据库中执行 create table 命令指定的名字一样，同个 schema 标
签中定义的名字必须唯一。
dataNode
定义这个逻辑表所属的 dataNode, 该属性的值需要和 dataNode 标签中 name 属性的值相互对应。
多个dataNode可以如下配置
<table name="travelrecord" dataNode="multipleDn$0-99,multipleDn2$100-199" rule="auto-shardinglong" ></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></dataNode>
rule
该属性用于指定逻辑表要使用的规则名字，规则名字在 rule.xml 中定义，必须与 tableRule 标签中 name 属
性属性值一一对应。
ruleRequired
该属性用于指定表是否绑定分片规则，如果配置为 true，但没有配置具体 rule 的话 ，程序会报错。
primaryKey
该逻辑表对应真实表的主键，MyCat 会缓存主键与具体 DN 的信息，那么再次使用非主键进行查询的时候就不会进行广播式的查询，就会直接发送语句给具体的 DN，尽量配置该属性，如果缓存并没有命中的话，还是会发送语句给具体的 DN，来获得数据。
type
该属性定义了逻辑表的类型，目前逻辑表只有“全局表”和”普通表”两种类型。
- 全局表：global。
- 普通表：不指定该值为 globla 的所有表。
autoIncrement
mysql对非增长主键使用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 限制。
childTable标签
childTable 标签用于定义 E-R 分片的子表。通过标签上的属性与父表进行关联。
| 属性名 | 值 | 数量限制 |
|---|---|---|
| name | String | 1 |
| joinKey | String | 1 |
| parentKey | String | 1 |
| primaryKey | String | 0…1 |
| needAddLimit | Boolean | 0…1 |
name
定义子表的表名
joinKey
插入子表的时候会使用这个列的值查找父表存储的数据节点
parentKey
属性指定的值一般为与父表建立关联关系的列名。程序首先获取 joinkey 的值，再通过 parentKey 属性指定
的列名产生查询语句，通过执行该语句得到父表存储在哪个分片上。从而确定子表存储的位置。
primaryKey
该逻辑表对应真实表的主键，MyCat 会缓存主键与具体 DN 的信息，那么再次使用非主键进行查询的时候就不会进行广播式的查询，就会直接发送语句给具体的 DN，尽量配置该属性，如果缓存并没有命中的话，还是会发送语句给具体的 DN，来获得数据。
needAddLimit
指定表是否需要自动的在每个语句后面加上 limit 限制。
dataNode 标签
dataNode 标签定义了 MyCat 中的数据节点，也就是我们通常说所的数据分片。一个 dataNode 标签就是
一个独立的数据分片。
| 属性名 | 值 | 数量限制 |
|---|---|---|
| name | String | 1 |
| dataHost | String | 1 |
| database | String | 1 |
name
定义数据节点的名字，这个名字需要是唯一的，需要在 table 标签上应用这个名字，来建立表与分片对
应的关系。
dataHost
该属性用于定义该分片属于哪个数据库实例的，属性值是引用 dataHost 标签上定义的 name 属性。
database
该属性用于定义该分片属性哪个具体数据库实例上的具体库，因为这里使用两个纬度来定义分片，就是：实
例+具体的库。因为每个库上建立的表和表结构是一样的。所以这样做就可以轻松的对表进行水平拆分。
dataHost 标签
| 属性名 | 值 | 数量限制 |
|---|---|---|
| name | String | 1 |
| maxCon | Integer | 1 |
| minCon | Integer | 1 |
| balance | Integer | 1 |
| writeType | Integer | 1 |
| dbType | String | 1 |
| dbDriver | String | 1 |
name
唯一标识 dataHost 标签，供上层的标签使用。
maxCon
指定每个读写实例连接池的最大连接。也就是说，标签内嵌套的 writeHost、readHost 标签都会使用这个属
性的值来实例化出连接池的最大连接数。
minCon
指定每个读写实例连接池的最小连接，初始化连接池的大小。
balance
负载均衡类型，目前的取值有 3 种：
- 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”，所有读请求随机的分发到 wiriterHost 对应的 readhost 执行，writerHost 不负担读压
力，注意 balance=3 只在 1.4 及其以后版本有，1.3 没有。
writeType
负载均衡类型，目前的取值有 3 种：
- writeType=“0”, 所有写操作发送到配置的第一个 writeHost，第一个挂了切到还生存的第二个
writeHost，重新启动后已切换后的为准，切换记录在配置文件中:dnindex.properties . - writeType=“1”，所有写操作都随机的发送到配置的 writeHost，1.5 以后废弃不推荐。switchType 属
dbType
指定后端连接的数据库类型，目前支持二进制的 mysql 协议，还有其他使用 JDBC 连接的数据库。
dbDriver
指定连接后端数据库使用的 Driver，目前可选的值有 native 和 JDBC。
- **native：**执行的是二进制的 mysql 协议，所以可以使用 mysql 和 maridb，1.6 版本开始支持 postgresql 的 native 原始协议。
- **JDBC：**需要将符合 JDBC 4 标准的驱动 JAR 包放到 MYCAT\lib 目录下，并检查驱动 JAR 包中包括如下目录结构的文件：META-INF\services\java.sql.Driver。
switchType
- -1 表示不自动切换
- 1默认值，自动切换
- 2 基于 MySQL 主从同步的状态决定是否切换，心跳语句为 show slave status
- 基于 MySQL galary cluster 的切换机制（适合集群）（1.4.1）心跳语句为 show status like ‘wsrep%’
tempReadHostAvailable
如果配置了这个属性 writeHost 下面的 readHost 仍旧可用，默认 0 可配置（0、1）。
heartbeat
指明用于和后端数据库进行心跳检查的语句。MYSQL 可以使用 select user()，Oracle 可以使用 select 1 from dual 。
这个标签还有一个 connectionInitSql 属性，主要是当使用 Oracla 数据库时，需要执行的初始化 SQL 语句就这个放到这里面来。例如：alter session set nls_date_format=‘yyyy-mm-dd hh24:mi:ss’
1.4 主从切换的语句必须是：show slave status
writeHost 标签、readHost 标签
这两个标签都指定后端数据库的相关配置给 mycat，用于实例化后端连接池。唯一不同的是，writeHost 指
定写实例、readHost 指定读实例，组着这些读写实例来满足系统的要求。
在一个 dataHost 内可以定义多个 writeHost 和 readHost。但是，如果 writeHost 指定的后端数据库宕机，
那么这个 writeHost 绑定的所有 readHost 都将不可用。另一方面，由于这个 writeHost 宕机系统会自动的检测
到，并切换到备用的 writeHost 上去。
| 属性名 | 值 | 数量限制 |
|---|---|---|
| host | String | 1 |
| url | String | 1 |
| user | String | 1 |
| password | String | 1 |
| user | String | 1 |
| weight | String | 1 |
| usingDecrypt | String | 1 |
host
用于标识不同实例，一般 writeHost 我们使用M1，readHost 我们用S1。
url
后端实例连接地址，如果是使用 native 的 dbDriver，则一般为 address:port 这种形式。用 JDBC 或其他的
dbDriver，则需要特殊指定。当使用 JDBC 时则可以这么写：jdbc:mysql://localhost:3306/。
user
后端存储实例需要的用户名。
password
后端存储实例需要的密码。
weight
权重 配置在 readhost 中作为读节点的权重
usingDesrypt
是否对密码加密默认 0 否 如需要开启配置 1，同时使用加密程序对密码加密，加密命令为：
java -cp Mycat-server-1.4.1-dev.jar io.mycat.util.DecryptUtil 1:host:user:password
//Mycat-server-1.4.1-dev.jar 为 mycat download 下载目录的 jar
//1:host:user:password 中 1 为 db 端加密标志，host 为 dataHost
server.xml
user 标签
<user name="test">
<property name="password">test</property>
<property name="schemas">TESTDB</property>
<property name="readOnly">true</property>
<property name="benchmark">11111</property>
<property name="usingDecrypt">1</property>
<privileges check="false">
<schema name="TESTDB" dml="0010" showTables="custome/mysql">
<table name="tbl_user" dml="0110"></table>
<table name="tbl_dynamic" dml="1111"></table>
</schema>
</privileges>
</user>
这个标签主要用于定义登录 mycat 的用户和权限。
user
数据库用户名
password
数据库密码
readOnly
数据库是否可读
schemas
控制可访问的schema，访问多个schema用,分割
<property name="schemas">TESTDB,db1,db2</property>
benchmark
benchmark 基准, 当前端的整体 connection 数达到基准值时, 对来自该账户的请求开始拒绝连接，0 或不设
表示不限制
<property name="benchmark">1000</property>
usingDecrypt
是否对密码加密默认 0 否 如需要开启配置 1，同时使用加密程序对密码加密
//Mycat-server-1.4.1-dev.jar 为 mycat download 下载目录的 jar
//1:host:user:password 中 0 为前端加密标志
java -cp Mycat-server-1.4.1-dev.jar io.mycat.util.DecryptUtil 0:user:password
privileges
对用户的 schema 及 下级的 table 进行精细化的 DML 权限控制，privileges 节点中的 check 属性是用于标识是否开启 DML 权限检查， 默认 false 标识不检查，当然 privileges 节点不配置，等同 check=false, 由于 Mycat 一个用户的schemas 属性可配置多个 schema ，所以 privileges 的下级节点 schema 节点同样可配置多个，对多库多表进行细粒度的 DML 权限控制
**dml：**表示insert、update、select、delete，0000表示禁止curd
<user name="zhuam">
<property name="password">111111</property>
<property name="schemas">TESTDB,TESTDB1</property>
<!-- 表级权限: Table 级的 dml(curd)控制，未设置的 Table 继承 schema 的 dml -->
<!-- TODO: 非 CURD SQL 语句, 透明传递至后端 -->
<privileges check="true">
<schema name="TESTDB" dml="0110" >
<table name="table01" dml="0111"></table>
<table name="table02" dml="1111"></table>
</schema>
<schema name="TESTDB1" dml="0110">
<table name="table03" dml="1110"></table>
<table name="table04" dml="1010"></table>
</schema>
</privileges>
</user>
system标签
这个标签内嵌套的所有 property 标签都与系统配置有关，请注意，下面我会省去标签 property 直接使用这
个标签的 name 属性内的值来介绍这个属性的作用。
charset
设置字符集
<system>
<property name="charset">utf8</property>
</system>
如果需要配置 utf8mb4 等特殊字符集可以在
index_to_charset.properties 配置中
配置数据库短的字符集 ID=字符集
例如：
224=utf8mb4
配置字符集的时候一定要坚持 mycat 的字符集与数据库端的字符集是一致的，可以通过变量来查询：
show variables like 'collation_%';
show variables like 'character_set_%';
defaultSqlParser
sql默认解析器，目前只有druidparser
processors
这个属性主要用于指定系统可用的线程数，默认值为机器 CPU 核心线程数,主要影响 processorBufferPool、processorBufferLocalPercent、processorExecutor 属性，NIOProcessor 的个数也是由这个属性定义的，所以调优的时候可以适当的调高这个属性。
processorBufferChunk
这个属性指定每次分配 Socket Direct Buffer 的大小，默认是 4096 个字节。这个属性也影响 buffer pool 的
长度。如果一次性获取的数过大 buffer 不够用 经常出现警告，则可以适当调大。
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
processorBufferLocalPercent
用来控制分配这个 ThreadLocalPool 的大小用的，但其也并不是一个准确的值，也是一个比例值。这个属性默认值为 100。
processorExecutor
指定 NIOProcessor 上共享的 businessExecutor 固定线程池大小。
sequnceHandlerType
指定使用 Mycat 全局序列的类型
- **0：**本地文件方式
- 1： 为数据库方式
- 2： 为时间戳序列方式
- 3： 为分布式ZK ID 生成器
- 4： 为 zk 递增 id 生成
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 的大小。
Mysql 连接相关属性
初始化 mysql 前后端连接所涉及到的一些属性：
- **packetHeaderSize：**指定 Mysql 协议中的报文头长度。默认 4。
- **maxPacketSize：**指定 Mysql 协议可以携带的数据最大长度。默认 16M。
- **idleTimeout：**指定连接的空闲超时时间。某连接在发起空闲检查下，发现距离上次使用超过了空闲时间，那
么这个连接会被回收，就是被直接的关闭掉。默认 30 分钟，单位毫秒。 - **charset：**连接的初始化字符集。默认为 utf8。
- **txIsolation：**前端连接的初始化事务隔离级别，只在初始化的时候使用，后续会根据客户端传递过来的属性对
后端数据库连接进行同步。默认为 REPEATED_READ，设置值为数字默认 3。- READ_UNCOMMITTED = 1;
- READ_COMMITTED = 2;
- REPEATED_READ = 3;
- SERIALIZABLE = 4;
- sqlExecuteTimeout:SQL 执行超时的时间，Mycat 会检查连接上最后一次执行 SQL 的时间，若超过这个时
间则会直接关闭这连接。默认时间为 300 秒，单位秒。
心跳属性
- **processorCheckPeriod：**清理 NIOProcessor 上前后端空闲、超时和关闭连接的间隔时间。默认是 1 秒，单
位毫秒。 - **dataNodeIdleCheckPeriod：**对后端连接进行空闲、超时检查的时间间隔，默认是 300 秒，单位毫秒。
- **dataNodeHeartbeatPeriod：**对后端所有读、写库发起心跳的间隔时间，默认是 10 秒，单位毫秒。
服务相关属性
- bindIp : mycat 服务监听的 IP 地址，默认值为 0.0.0.0。
- serverPort : 定义 mycat 的使用端口，默认值为 8066。
fakeMySQLVersion
mycat 模拟的 mysql 版本号，默认值为 5.6 版本，如非特需，不要修改这个值，目前支持设置 5.5,5.6 版本，其
他版本可能会有问题。 此特性从 1.6 版本开始支持。
全局表一致性检测
<property name="useGlobleTableCheck">0</property> <!-- 1 为开启全加班一致性检测、0 为关闭 -->
此特性从 1.6 版本开始支持
分布式事务开关
<!--分布式事务开关，0 为不过滤分布式事务，1 为过滤分布式事务（如果分布式事务内只涉及全局表，则不过滤），2 为不过滤分布
式事务,但是记录分布式事务日志-->
<property name="handleDistributedTransactions">0</property>
主要应用场景，主要为了控制是否允许跨库事务。此特性从 1.6 版本开始支持。
Off Heap for Mycat
此特性从 1.6 版本开始支持。
<!--off heap for merge/order/group/limit 1 开启 0 关闭-->
<property name="useOffHeapForMerge">1</property>
-
使用非堆内存(Direct Memory)处理跨分片结果集的 Merge/order by/group by/limit。
-
通过 server.xml 中的 useOffHeapForMerge 参数配置是否启用非堆内存处理跨分片结果集
-
Mycat 内存分层管理:
- 结果集处理内存；
- 系统预留内存；
- 网络处理内存共三块。
其中网络处理内存部分全部为 Direct Memory，结果集内存分为 Direct Memory 和 HeapMemory。
但目前仅使用 Direct Memory。系统预留内存为 On Heap Memory。JVM 参数，必须设置- XX:MaxDirectMemorySize 和 -Xmx -
使用 TimeSort 和 RadixSort，跨分片结果集合并排序使用 PriorityQueue，其中经测试 RadixSort 适合
LONG，INT，SHORT,Float，Double，String 数据类型排序，性能优越。 -
Java obj 连续内存存取，二进制序列化和反序列化，使用缓存友好的数据结构 Map 和 Row。
-
支持内存和外存并存的排序方式，结果集排序可以达上亿规模。此时应注意:
- 此时前端和后端空闲连接超时检测时间应该设置大些，避免空闲检测关闭 front 或者 backend
connection,造成 Mysqlclient 连接丢失时结果集无法正确。 - 设置-Xmn 值尽可能大些，新生代使用 UseParallelGC 垃圾回收器，-Xss 设置 512K 比较合适，物理内
存足够时，MaxDirectMemorySize 尽可能设置大些，可以加快结果集处理时间
- 此时前端和后端空闲连接超时检测时间应该设置大些，避免空闲检测关闭 front 或者 backend
rule.xml
rule.xml 里面就定义了我们对表进行拆分所涉及到的规则定义。我们可以灵活的对表使用不同的分片算法，
或者对表使用相同的算法但具体的参数不同。这个文件里面主要有 tableRule 和 function 这两个标签。在具体使
用过程中可以按照需求添加 tableRule 和 function。
tableRule 标签
这个标签定义表规则。
<tableRule name="rule1">
<rule>
<columns>id</columns>
<algorithm>func1</algorithm>
</rule>
</tableRule>
- name 属性指定唯一的名字，用于标识不同的表规则。
- columns 内指定要拆分的列名字。
- algorithm 使用 function 标签中的 name 属性。连接表规则和具体路由算法。
function 标签
<function name="hash-int" class="io.mycat.route.function.PartitionByFileMap">
<property name="mapFile">partition-hash-int.txt</property>
</function>
- name 指定算法的名字。
- class 制定路由算法具体的类名字。
扫一扫
337
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
