元数据持久化仓库 :: ShardingSphere

元数据持久化仓库

背景信息

Apache ShardingSphere 为不同的运行模式提供了不同的元数据持久化方式，用户在配置运行模式的同时可以选择合适的方式来存储元数据。

参数解释

数据库持久化

provider 的可选值为 H2，MySQL，EmbeddedDerby，DerbyNetworkServer，HSQLDB。由于第三方的 Vulnerability Report 时常误报 H2 Database，避免在 ShardingSphere Standalone Mode 使用 H2 Database 可能是一种选择。讨论 provider 不为默认值 H2 的情况。

若 provider 设置为 MySQL，则要求存在已就绪的 MySQL Server。classpath 应包含 com.mysql:mysql-connector-j:9.0.0 的 Maven 依赖。
若 provider 设置为 EmbeddedDerby，则 Derby 数据库引擎将在与应用程序相同的 JVM 内运行。 classpath 应包含 org.apache.derby:derby:10.17.1.0 和 org.apache.derby:derbytools:10.17.1.0 的 Maven 依赖，且要求编译或运行下游项目的 JDK 版本大于或等于 JDK19。可能的配置如下。

mode:
  type: Standalone
  repository:
    type: JDBC
    props:
      provider: EmbeddedDerby
      jdbc_url: jdbc:derby:memory:config;create=true
      username:

若 provider 设置为 DerbyNetworkServer，则要求存在已就绪的 Derby Network Server。 Derby Network Server 不存在可用的 Docker Image，用户可能需要手动启动 Derby Network Server。 classpath 应包含 org.apache.derby:derbyclient:10.17.1.0 和 org.apache.derby:derbytools:10.17.1.0 的 Maven 依赖，且要求编译或运行下游项目的 JDK 版本大于或等于 JDK19。
若 provider 设置为 HSQLDB，则要求存在已就绪的采用 Server Modes 的 HyperSQL，或以 in-process database 的方式创建数据库。 classpath 应包含 classifier 为 jdk8 的 org.hsqldb:hsqldb:2.7.3 的 Maven 依赖。采用 Server Modes 的 HyperSQL 不存在可用的 Docker Image，用户可能需要手动启动 Server Modes 的 HyperSQL。若使用 mem: protocol 的 HyperSQL，则可能的配置如下，

mode:
  type: Standalone
  repository:
    type: JDBC
    props:
      provider: HSQLDB
      jdbc_url: jdbc:hsqldb:mem:config
      username: SA

类型：JDBC

适用模式：Standalone

可配置属性：

名称	数据类型	说明	默认值
provider	String	元数据存储类型	H2
jdbc_url	String	JDBC URL	jdbc:h2:mem:config;DB_CLOSE_DELAY=-1;DATABASE_TO_UPPER=false;MODE=MYSQL
username	String	账号	sa
password	String	密码

ZooKeeper 持久化

类型：ZooKeeper

适用模式：Cluster

可配置属性：

名称	数据类型	说明	默认值
retryIntervalMilliseconds	int	重试间隔毫秒数	500
maxRetries	int	客户端连接最大重试次数	3
timeToLiveSeconds	int	临时数据失效的秒数	60
operationTimeoutMilliseconds	int	客户端操作超时的毫秒数	500
digest	String	登录认证密码

Etcd 持久化

类型：Etcd

适用模式：Cluster

可配置属性：

名称	数据类型	说明	默认值
timeToLiveSeconds	long	临时数据失效的秒数	30
connectionTimeout	long	连接超时秒数	30

操作步骤

在 global.yaml 中配置 Mode 运行模式
配置元数据持久化仓库类型

配置示例

单机模式配置方式

mode:
  type: Standalone
  repository:
    type: JDBC
    props:
      provider: H2
      jdbc_url: jdbc:h2:mem:config;DB_CLOSE_DELAY=-1;DATABASE_TO_UPPER=false;MODE=MYSQL
      username: test
      password: Test@123

集群模式

mode:
  type: Cluster
  repository:
    type: zookeeper
    props:
      namespace: governance_ds
      server-lists: localhost:2181
      retryIntervalMilliseconds: 500
      timeToLiveSeconds: 60
      maxRetries: 3
      operationTimeoutMilliseconds: 500