金仓数据库KingbaseES运维工具参考手册（2. 通用环境变量参数文件）

通用环境参数文件是指SupTools 目录下的suptools.ini文件。该参数文件包含SupTools目录下工具的通用配置，包括：bin 目录、lib 目录、数据库连接配置等。在使用SupTools工具前，必须根据用户的实际环境修改suptools.ini文件。

参数文件适用方式：参数文件使用INI格式，存储工具集中使用的环境变量值。根据部署主机的安全规则，可以不存储数据库用户的口令，工具使用交互方式输入数据库用户口令。

参数文件说明：

参数组	参数名	参数说明
通用参数组general	HOME_PATH	KingbaseES平台的安装目录
	BIN_PATH	ksql等工具的目录
	LD_LIBRARY_PATH	库文件目录
数据库连接组connect	HOST	数据库主机IP
	USER	数据库用户
	PORT	数据库端口
	DATABASE	数据库名
数据库集群组cluster	POOL_PORT	数据库集群端口
	IP_LIST	集群的主从节点集合，以逗号分割的IP地址组合
数据库备份组backup	RMAN_PATH	物理备份集的存储目录
	DUMP_PATH	逻辑备份集的存储目录
	DB_LIST	可进行逻辑备份的数据库集合，以逗号分割的数据库名组合
	KEEP_TIME	备份结果集的保留份数
数据库巡检组check	CHECK_LEVEL	数据库巡检的等级，月度或季度模式（MONTH OR QUARTER）
	MODE	数据库的模式，单机或集群（singal or cluster）
	STATRESET	重置统计信息
问题诊断辅助工具diagtool	SLEEPSECONDS	检测工作的停顿时长，默认10秒

参数文件(单机用例)样例：

########################################################################
# This Script is used to check OS AND KINGBASE info;
# Before used the script ,you should set some parameters according to your env;
#########################################################################

[general]
# General parameters
# KingbaseES
HOME_PATH=/opt/Kingbase/ES/V8R6
# KingbaseES
BIN_PATH=/opt/Kingbase/ES/V8R6/Server/bin
#LIBPATH
LD_LIBRARY_PATH=/opt/Kingbase/ES/V8R6/Server/lib:$LD_LIBRARY_PATH

[connect]
# connection parameters
HOST=127.0.0.1
USER=system
PORT=54307
DATABASE=test

[cluster]
#DATABASE POOL_PORT
#POOL_PORT=9999
#DATABASE IPADDR LIST
#IP_LIST=192.168.20.20,192.168.20.201

[backup]
# THE PATH OF RMAN BACKUP DIRECTORY
RMAN_PATH=/home/kingbase/backup/rmanbackup
# THE PATH OF DUMP BACKUP DIRECTORY
DUMP_PATH=/home/kingbase/backup/dumpbackup
#BACKUP DATABASE LIST
DB_LIST=kingbase,bak01,db01
KEEP_TIME=7

[check]
# CHECK_LEVEL（MONTH OR QUARTER）
CHECK_LEVEL=QUARTER
# DATABASE TYPE(CLUSTER OR SINGAL)
MODE=SINGAL
#重置统计信息
STATRESET=off

[diagtool]
#sleep times between two operation , default 10 second
SLEEPSECONDS=10

参数文件(集群用例)样例：

########################################################################
# This Script is used to check OS AND KINGBASE info;
# Before used the script ,you should set some parameters according to your env;
#########################################################################

[general]
# General parameters
# KingbaseES HOME_PATH until Cluster Name
HOME_PATH=/home/kingbase/cluster/project1/cluster1
# KingbaseES
BIN_PATH=/home/kingbase/cluster/project1/cluster1/kingbase/bin
#LIBPATH
LD_LIBRARY_PATH=/home/kingbase/cluster/project1/cluster1/kingbase/lib:$LD_LIBRARY_PATH

[connect]
# connection parameters
HOST=127.0.0.1
USER=system
PORT=54321
DATABASE=test

[cluster]
#DATABASE POOL_PORT
POOL_PORT=9999
#DATABASE IPADDR LIST
IP_LIST=192.168.20.20,192.168.20.201

[backup]
# THE PATH OF RMAN BACKUP DIRECTORY
RMAN_PATH=/home/kingbase/backup/rmanbackup
# THE PATH OF DUMP BACKUP DIRECTORY
DUMP_PATH=/home/kingbase/backup/dumpbackup
#BACKUP DATABASE LIST
DB_LIST=kingbase,bak01,db01
KEEP_TIME=7

[check]
# CHECK_LEVEL（MONTH OR QUARTER）
CHECK_LEVEL=QUARTER
# DATABASE TYPE(CLUSTER OR SINGAL)
MODE=CLUSTER
#重置统计信息
STATRESET=off

[diagtool]
#sleep times between two operation , default 10 second
SLEEPSECONDS=10