配置手册

数据源与分片配置示例

Sharding-Proxy支持多逻辑数据源，每个以config-前缀命名的yaml配置文件，即为一个逻辑数据源。以下是config-xxx.yaml的配置配置示例。

数据分片

dataSources:

  1. schemaName: sharding_db
  3. dataSources:
  4.   ds0: 
  5.     url: jdbc:mysql://localhost:3306/ds0
  6.     username: root
  7.     password: 
  8.     autoCommit: true
  9.     connectionTimeout: 30000
  10.     idleTimeout: 60000
  11.     maxLifetime: 1800000
  12.     maximumPoolSize: 65
  13.   ds1:
  14.     url: jdbc:mysql://localhost:3306/ds1
  15.     username: root
  16.     password: 
  17.     autoCommit: true
  18.     connectionTimeout: 30000
  19.     idleTimeout: 60000
  20.     maxLifetime: 1800000
  21.     maximumPoolSize: 65
  23. shardingRule:  
  24.   tables:
  25.     t_order: 
  26.       actualDataNodes: ds${0..1}.t_order${0..1}
  27.       databaseStrategy:
  28.         inline:
  29.           shardingColumn: user_id
  30.           algorithmExpression: ds${user_id % 2}
  31.       tableStrategy: 
  32.         inline:
  33.           shardingColumn: order_id
  34.           algorithmExpression: t_order${order_id % 2}
  35.       keyGeneratorColumnName: order_id
  36.     t_order_item:
  37.       actualDataNodes: ds${0..1}.t_order_item${0..1}
  38.       databaseStrategy:
  39.         inline:
  40.           shardingColumn: user_id
  41.           algorithmExpression: ds${user_id % 2}
  42.       tableStrategy:
  43.         inline:
  44.           shardingColumn: order_id
  45.           algorithmExpression: t_order_item${order_id % 2}  
  46.   bindingTables:
  47.     - t_order,t_order_item
  48.   defaultTableStrategy:
  49.     none:
  50.   defaultKeyGeneratorClassName: io.shardingsphere.core.keygen.DefaultKeyGenerator

读写分离

  1. schemaName: master_slave_db
  3. dataSources:
  4.   ds_master:
  5.     url: jdbc:mysql://localhost:3306/ds_master
  6.     username: root
  7.     password: 
  8.     autoCommit: true
  9.     connectionTimeout: 30000
  10.     idleTimeout: 60000
  11.     maxLifetime: 1800000
  12.     maximumPoolSize: 65
  13.   ds_slave0:
  14.     url: jdbc:mysql://localhost:3306/ds_slave0
  15.     username: root
  16.     password:
  17.     autoCommit: true
  18.     connectionTimeout: 30000
  19.     idleTimeout: 60000
  20.     maxLifetime: 1800000
  21.     maximumPoolSize: 65 
  22.   ds_slave1:
  23.     url: jdbc:mysql://localhost:3306/ds_slave1
  24.     username: root
  25.     password:
  26.     autoCommit: true
  27.     connectionTimeout: 30000
  28.     idleTimeout: 60000
  29.     maxLifetime: 1800000
  30.     maximumPoolSize: 65 
  32. masterSlaveRule:
  33.   name: ds_ms
  34.   masterDataSourceName: ds_master
  35.   slaveDataSourceNames: 
  36.     - ds_slave0
  37.     - ds_slave1

数据分片 + 读写分离

  1. schemaName: sharding_master_slave_db
  3. dataSources:
  4.   ds0:
  5.     url: jdbc:mysql://localhost:3306/ds0
  6.     username: root
  7.     password:
  8.     autoCommit: true
  9.     connectionTimeout: 30000
  10.     idleTimeout: 60000
  11.     maxLifetime: 1800000
  12.     maximumPoolSize: 65 
  13.   ds0_slave0:
  14.     url: jdbc:mysql://localhost:3306/ds0_slave0
  15.     username: root
  16.     password: 
  17.     autoCommit: true
  18.     connectionTimeout: 30000
  19.     idleTimeout: 60000
  20.     maxLifetime: 1800000
  21.     maximumPoolSize: 65
  22.   ds0_slave1:
  23.     url: jdbc:mysql://localhost:3306/ds0_slave1
  24.     username: root
  25.     password:
  26.     autoCommit: true
  27.     connectionTimeout: 30000
  28.     idleTimeout: 60000
  29.     maxLifetime: 1800000
  30.     maximumPoolSize: 65
  31.   ds1:
  32.     url: jdbc:mysql://localhost:3306/ds1
  33.     username: root
  34.     password: 
  35.     autoCommit: true
  36.     connectionTimeout: 30000
  37.     idleTimeout: 60000
  38.     maxLifetime: 1800000
  39.     maximumPoolSize: 65
  40.   ds1_slave0:
  41.     url: jdbc:mysql://localhost:3306/ds1_slave0
  42.     username: root
  43.     password: 
  44.     autoCommit: true
  45.     connectionTimeout: 30000
  46.     idleTimeout: 60000
  47.     maxLifetime: 1800000
  48.     maximumPoolSize: 65
  49.   ds1_slave1:
  50.     url: jdbc:mysql://localhost:3306/ds1_slave1
  51.     username: root
  52.     password:
  53.     autoCommit: true
  54.     connectionTimeout: 30000
  55.     idleTimeout: 60000
  56.     maxLifetime: 1800000
  57.     maximumPoolSize: 65 
  59. shardingRule:  
  60.   tables:
  61.     t_order: 
  62.       actualDataNodes: ms_ds${0..1}.t_order${0..1}
  63.       databaseStrategy:
  64.         inline:
  65.           shardingColumn: user_id
  66.           algorithmExpression: ms_ds${user_id % 2}
  67.       tableStrategy: 
  68.         inline:
  69.           shardingColumn: order_id
  70.           algorithmExpression: t_order${order_id % 2}
  71.       keyGeneratorColumnName: order_id
  72.     t_order_item:
  73.       actualDataNodes: ms_ds${0..1}.t_order_item${0..1}
  74.       databaseStrategy:
  75.         inline:
  76.           shardingColumn: user_id
  77.           algorithmExpression: ms_ds${user_id % 2}
  78.       tableStrategy:
  79.         inline:
  80.           shardingColumn: order_id
  81.           algorithmExpression: t_order_item${order_id % 2}  
  82.   bindingTables:
  83.     - t_order,t_order_item
  84.   broadcastTables:
  85.     - t_config
  87.   defaultDataSourceName: ds0
  88.   defaultTableStrategy:
  89.     none:
  90.   defaultKeyGeneratorClassName: io.shardingsphere.core.keygen.DefaultKeyGenerator
  92.   masterSlaveRules:
  93.       ms_ds0:
  94.         masterDataSourceName: ds0
  95.         slaveDataSourceNames:
  96.           - ds0_slave0
  97.           - ds0_slave1
  98.         loadBalanceAlgorithmType: ROUND_ROBIN
  99.         configMap:
  100.           master-slave-key0: master-slave-value0
  101.       ms_ds1:
  102.         masterDataSourceName: ds1
  103.         slaveDataSourceNames: 
  104.           - ds1_slave0
  105.           - ds1_slave1
  106.         loadBalanceAlgorithmType: ROUND_ROBIN
  107.         configMap:
  108.           master-slave-key1: master-slave-value1

全局配置示例

Sharding-Proxy使用conf/server.yaml配置注册中心、认证信息以及公用属性。

数据治理

  1. #省略数据分片和读写分离配置
  3. orchestration:
  4.   name: orchestration_ds
  5.   overwrite: true
  6.   registry:
  7.     namespace: orchestration
  8.     serverLists: localhost:2181

认证信息

  1. authentication:
  2.   username: root
  3.   password:

公用属性

  1. props:
  2.   executor.size: 16
  3.   sql.show: false

数据源与分片配置项说明

数据分片

  1. schemaName: #逻辑数据源名称
  3. dataSources: #数据源配置，可配置多个data_source_name
  4.   <data_source_name>: #与Sharding-JDBC配置不同，无需配置数据库连接池
  5.     url: #数据库url连接
  6.     username: #数据库用户名
  7.     password: #数据库密码
  8.     autoCommit: true #hikari连接池默认配置
  9.     connectionTimeout: 30000 #hikari连接池默认配置
  10.     idleTimeout: 60000 #hikari连接池默认配置
  11.     maxLifetime: 1800000 #hikari连接池默认配置
  12.     maximumPoolSize: 65 #hikari连接池默认配置
  14. shardingRule: #省略数据分片配置，与Sharding-JDBC配置一致

读写分离

  1. schemaName: #逻辑数据源名称
  3. dataSources: #省略数据源配置，与数据分片一致
  5. masterSlaveRule: #省略读写分离配置，与Sharding-JDBC配置一致

全局配置项说明

数据治理

与Sharding-JDBC配置一致。

Proxy属性

  1. #省略与Sharding-JDBC一致的配置属性
  2. props:
  3.   acceptor.size: #用于设置接收客户端请求的工作线程个数，默认为CPU核数*2
  4.   proxy.transaction.enabled: #是否开启事务, 目前仅支持XA事务，默认为不开启
  5.   proxy.opentracing.enabled: #是否开启链路追踪功能，默认为不开启。详情请参见[链路追踪](/cn/features/orchestration/apm/)
  6.   check.table.metadata.enabled: #是否在启动时检查分表元数据一致性，默认值: false

权限验证

用于执行登录Sharding Proxy的权限验证。配置用户名、密码后，必须使用正确的用户名、密码才可登录Proxy。

  1. authentication:
  2.    username: root
  3.    password:

Yaml语法说明

!! 表示实例化该类

- 表示可以包含一个或多个

[] 表示数组，可以与减号相互替换使用