Logo
参数

参数 #

集群生态工具参数 #

SphereEx-Boot 命令行参数列表 #

集群

命令含义参数
download下载 ShardingSphere-Proxy, Zookeeper, Database driver 安装包–type [proxy|zk|driver] Option proxy or zk or driver
–proxy-url TEXT Proxy download url
–zk-url TEXT Zookeeper download url
–driver-url TEXT Database driver download url
–output-dir TEXT Output dir, Default current directory
–help
init快速初始化集群操作的配置文件-n, –name TEXT name of cluster [required]
–user TEXT install user
–password TEXT install password
–proxy-file PATH package file of proxy
–proxy-conf-dir PATH config file directory of proxy
–proxy-agent-conf-file PATH config file of agent
–proxy-depend-file PATH depend file of proxy，for example, database driver. for example: –proxy-depend-file /root/mysql-connector-java-5.1.47.jar
–proxy-install-dir TEXT install directory of proxy
–proxy-port INTEGER start port of proxy
–proxy-overwrite TEXT overwrite if install directory already exists
–proxy-host TEXT proxy host ip,can be entered multiple times，for example: –proxy-host 10.0.1.1 –proxy-host 10.0.1.2
–zk-file PATH package file of ZooKeeper
–zk-conf-file PATH zoo.cfg file of zookeeper
–zk-install-dir TEXT install directory of zookeeper
–zk-data-dir TEXT data directory of zookeeper
–zk-port INTEGER clientPort of zookeeper
–zk-overwrite TEXT overwrite if install directory already exists
–zk-host TEXT ZooKeeper host ip, can be entered multiple times, for example: –zk-host 10.0.1.1 –zk-host 10.0.1.2
–download [all|proxy|zk|driver] Download related installation packages
–proxy-url TEXT Proxy download url
–zk-url TEXT ZooKeeper download url
–driver-url TEXT Database driver download url
–help Show this message and exit.
install根据配置文件安装集群(proxy 或者 zk)n, –name TEXT Cluster name [required]
–host TEXT Host and port value. For example: 127.0.0.1 Specify the machine for this IP, 127.0.0.1:3307 Specify the node for this IP port
–force The existing installation directory will be overwritten
–type [proxy|zk] Option proxy or zk
–help Show this message and exit.
list展示已经被安装过的集群
scale通过文件或者参数对集群的proxy做扩容-n, –name TEXT Name of cluster to be expanded, Required -f, –file PATH Configuration file of cluster
–host TEXT Deployment machine IP
–port INTEGER Start port of proxy or zookeeper
–install-dir TEXT Install directory of proxy or zookeeper
–agent-conf-file PATH Proxy agent config file
–overwrite [yes|no] Overwrite if install directory already exists
–help Show this message and exit.
start启动集群的proxy或zk-n, –name TEXT Cluster name [required]
–with-agent Is Flag, Start with agent
–host TEXT Host and port value, For example 127.0.0.1 or 127.0.0.1:3307
–type [proxy
status查看集群proxy或者zk的状态-n, –name TEXT Cluster name [required]
–host TEXT Host and port value, For example 127.0.0.1 or 27.0.0.1:3307
–type [proxy|zk] Option proxy or zk
–help Show this message and exit.
stop停止集群或者zk-n, –name TEXT Cluster name [required]
–host TEXT Host and port value, For example 127.0.0.1 or 27.0.0.1:3307
–type [proxy|zk] Option proxy or zk
–help Show this message and exit.
uninstall卸载集群或者zk-n, –name TEXT Cluster name [required]
–host TEXT Host and port value, For example 127.0.0.1 or 27.0.0.1:3307
–type [proxy|zk] Option proxy or zk
–force Confirm forced uninstall
–help Show this message and exit.

集群组件

命令含义参数
install目前仅能安装prometheus–type [prometheus] Specify component type, default prometheus
-f, –file PATH Specify profile
-t, –template Export configuration template
–user TEXT Install user
–password TEXT Install password
–install-dir TEXT Install directory
–package PATH Installation package
–host TEXT Host ip
–help Show this message and exit.
uninstall目前仅能卸载prometheus–type [prometheus] Specify component type, default prometheus
–user TEXT Install user
–password TEXT Install password
–install-dir TEXT Installed directory
–host TEXT Host ip
–help Show this message and exit.

集群配置文件

命令含义参数
add添加cluster配置文件
-f, –file PATH Cluster configuration file [required]
–force If a cluster with the same name exists, do you want to overwrite the configuration

–help Show this message and exit.
check校验cluster配置文件 可以选择-f或者-n
-f, –file PATH Cluster configuration file
-n, –name TEXT Cluster name
–help Show this message and exit.
delete删除cluster配置文件
–force Force delete configuration of cluster!
–help Show this message and exit.
info展示配置文件内容
-n, –name TEXT Cluster name [required]
–detail flag, detail info of the cluster configuration
–help Show this message and exit.
template导出全部配置模板或者扩容配置模板
–type [full

镜像

命令含义参数
clone下载依赖
-r, –requirement Output spex dependent.
-o, –output-dir PATH Output directory, Default current directory.
–help Show this message and exit.

管理 SphereEx-Console

命令含义参数
install安装console-c, –config PATH Console configuration file [required]
-n, –name TEXT Console name [required]
–help Show this message and exit.
uninstall卸载console-n, –name TEXT Console name [required]
–help Show this message and exit.
list列出已经安装的console列表
export导出安装配置文件模板–output TEXT Output to the path
–help Show this message and exit.
backup备份console使用的mysql库数据 保存到console同级安装目录下 在console安装的上一层 不会因为卸载console被删除-n, –name TEXT Console name [required]
–help Show this message and exit.

集群组件参数列表 #

使用组件过程中的配置的参数

  • 监控中心启动参数
--web.listen-address=:9090  # 监听端口
--web.enable-lifecycle  # 开启热加载 可以通过命令热加载新建监控
  • 监控插件 mysql-exporter 启动参数
--web.listen-address=":{listen_port}"  # 监听端口
--config.my-cnf="{conf}" # 上面内容的配置文件
  • 监控插件 zookeeper-exporter启动参数
-bind-addr=":{listen_port}"  # 监听端口
-zookeeper="{zk_host}"  # 监控的zk host:port
  • 监控插件 Node_exporter 启动参数
--web.listen-address=":{listen_port}  # 监听端口

集群参数列表 #

名称数据类型说明默认值动态生效
agent_plugins_enabledboolean是否启用 agent plugin 插件。 TRUE/FALSETRUE否
kernel_executor_sizeint用于设置任务处理线程池的大小。每个 ShardingSphereDataSource 使用一个独立的线程池，同一个 JVM 的不同数据源不共享线程池。infinite否
max_connections_size_per_queryint一次查询请求在每个数据库实例中所能使用的最大连接数。1是
proxy_frontend_flush_thresholdint在 ShardingSphere-Proxy 中设置传输数据条数的 IO 刷新阈值。128是
proxy_backend_query_fetch_sizeintProxy 后端与数据库交互的每次获取数据行数（使用游标的情况下）。数值增大可能会增加 ShardingSphere Proxy 的内存使用。默认值为 -1，代表设置为 JDBC 驱动的最小值。-1是
proxy_frontend_executor_sizeintProxy 前端 Netty 线程池线程数量，默认值 0 代表使用 Netty 默认值。0否
proxy_frontend_max_connectionsint允许连接 Proxy 的最大客户端数量，默认值 0 代表不限制。0是
proxy_default_portStringProxy 通过配置文件指定默认端口。3307否
proxy_netty_backlogintProxy 通过配置文件指定默认netty back_log参数。1024否
proxy_frontend_database_protocol_typeStringProxy 前端协议类型，支持 MySQL, PostgreSQL, KingbaseES,openGauss""否
proxy_instance_typeStringProxy 实例类型，可选项：Proxy、SphereEx:Proxy，Proxy 表示云上部署类型，SphereEx:Proxy 表示本地部署类型Proxy否
sql_showboolean是否在系统日志中打印 SQL。
打印 SQL 可以帮助开发者快速定位系统问题。日志内容包含：逻辑 SQL，真实 SQL 和 SQL 解析结果。
如果开启配置，日志将使用 Topic ShardingSphere-SQL，系统日志级别是 INFO。		false是
sql_simpleboolean是否在系统日志中打印简单风格的 SQL。false是
slow_query_logboolean是否开启慢查询 TRUE/FALSEfalse是
long_query_timeint慢查询阈值单位ms10是
general_query_logboolean是否开启全量日志（审计日志） TRUE/FALSEfalse是
system_log_levelString当前计算节点（proxy）的系统日志等级 DEBUG、INFO、WARN、ERRORINFO是
system_log_patternString当前计算节点（proxy）的系统日志格式 日志格式可参考Logback Layouts[%-5level] %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %logger{36} - %msg%n｜是
storage_node_heartbeat_interval_millisecondsint用于配置存储节点可用性检测间隔，单位毫秒，默认为 0。如果配置等于 0，则关闭存储节点可用性检测功能。0是
storage_node_heartbeat_retry_timesint用于配置存储节点可用性检测重试次数，默认为 3。0是
meta_data_consistency_enabledboolean用于控制是否开启proxy的 DDL 和 RDL 一致性更新true是
proxy_meta_data_collector_enabledboolean用于开启定时任务线程的元数据信息收集TRUE否
cached_connectionsint后端缓存的连接数量 0 只读0否
check_table_metadata_enabledboolean在程序启动和更新时，是否检查分片元数据的结构一致性。false是
cdc_decrypt_enabledbooleanCDC 传输明文到客户端false是
cdc_server_portStringCDC 默认端口33071否
ghost_ddl_auto_cutoverbooleanOnline DDL 使用影子表方式执行时的切换模式，自动切换模式。禁用则需要手动执行 COMMIT DDL 完成切换true是
ghost_ddl_drop_tablebooleanOnline DDL 使用影子表方式执行时，执行完成是否删除原表false是
ghost_ddl_row_thresholdStringDDL 触发使用影子表方式执行的行数阈值1000000是
proxy_ddl_strategyStringOnline DDL 的执行模式。开启一致性后才会进入online流程，可选参数：ONLINE、DIRECT、AUTO。ONLINE：proxy 干预并保障 ddl 是 online 执行的，如果用户指定了instant 参数并且底层是 mysql8.0 则会使用 instant 方式执行；如果用户未指定 instant 参数并且底层是 mysql8.0 则会使用 instant 方式执行，如果不是 mysql8.0 则使用在线拷贝数据的方式执行； DIRECT ：proxy 干预一致性但是直接下发语句到db执行ddl；AUTO：依据用户配置由 proxy 决定 online、instant、在线拷贝数据的方式执行DIRECT是
insert_select_batch_sizeStringinsert select 任务一次执行的数据条数1000是
proxy_frontend_ssl_enabledbooleanProxy 前端启用 SSL/TLS。false否
proxy_frontend_ssl_cert_fileStringPEM 格式的 X.509 证书链文件。当没有设置证书和私钥文件时，ShardingSphere-Proxy 会生成一个临时的 RSA 密钥对和一个自签名的 X.509 证书。""否
proxy_frontend_ssl_key_fileStringPEM 格式的 PKCS#8 私钥文件。""否
proxy_frontend_ssl_versionString要启用的 SSL/TLS 协议。空白以使用默认值。TLSv1.2,TLSv1.3否
proxy_frontend_ssl_cipherString按偏好顺序启用的密码套件。用逗号分隔的多密码套件。空白以使用默认值。""否
system_schema_metadata_enabledboolean内部参数，是否自动加载系统表true是
init_sqlString配置 sql 预热脚本的路径、支持从 apollo、相对路径、绝对路径读取是
instance_connection_enabledboolean是否启用数据库实例连接（仅 MySQL 生效）true是
meta_data_consistency_timeout_millisecondsint元数据一致性刷新的最大时长，单位（ms）600000是

特殊说明 支持动态修改的属性可以立即生效，不支持动态修改的属性需要重启后生效。 参数配置可以通过修改计算节点的 yaml 文件配置重启生效，其中参数的下划线"_“需要换成中横线”-";