语法格式
显示帮助信息
python upgrade.py --help | -?
手动升级
python upgrade.py -t { upgrade-type | pretest | precheck | prepare | replace | start | upgrade | sync | dbcheck | flush } --package=path_to_package_file --backupdir=path_to_backup [--GSDB_HOME=path_to_gsdb_home] [--GSDB_DATA=path_to_data_dir] [-f cmd_config_file]
手动降级
python upgrade.py -t { upgrade-type | pretest | precheck | prepare | replace | start | upgrade | sync | restart | upgrade-view | checkpoint | dbcheck | flush } --package=path_to_package_file --backupdir=path_to_backup [--GSDB_HOME=path_to_gsdb_home] [--GSDB_DATA=path_to_data_dir] [-f cmd_config_file]
手动回滚
python upgrade.py -t { rollback-check | rollback | rollback-clean } --backupdir=path_to_backup [--GSDB_HOME=path_to_gsdb_home] [--GSDB_DATA=path_to_data_dir] [-f cmd_config_file]
自动升/降级前检查环境。
python upgrade.py -s pre-check --config-file=CONFIG_FILE [--upgrade-mode=ha|single] [-f cmd_config_file]
自动升/降级
python upgrade.py -s run --config-file=CONFIG_FILE [--auto-rollback=true|false] [--upgrade-mode=ha|single] [-f cmd_config_file]
自动升/降级后清理环境
python upgrade.py -s cleanup --config-file=CONFIG_FILE [--upgrade-mode=ha|single] [-f cmd_config_file]
自动回滚
python upgrade.py -s { rollback-check | rollback } --config-file=CONFIG_FILE [--upgrade-mode=ha|single] [-f cmd_config_file]
参数说明
参数
说明
--help
显示帮助页面。
-t
指定执行的功能。
取值范围：upgrade-type、pretest、precheck、prepare、replace、start、upgrade、sync、restart、upgrade-view、checkpoint、dbcheck、flush、rollback-check、rollback、rollback-clean。单句只能指定一个功能。
HA和单机手动升/降级时是必选参数，并且不能缺省。
HA和单机自动升/降级时是不可选参数。
--GSDB_HOME
指定安装目录，即bin和Lib所在目录，支持输入一个路径。
HA和单机手动升/降级时是可选参数，并且该参数可缺省，若缺省，采用环境变量中GSDB_HOME，若环境变量无GSDB_HOME则报错。
HA和单机自动升/降级时是不可选参数。
--GSDB_DATA
指定数据文件目录，支持输入相同的bin对应的多个data路径，同时升/降级。
HA和单机手动升/降级时是可选参数，此时该参数可缺省，若缺省，采用环境变量中GSDB_DATA的值作为该参数的值，只能升级数据文件目录为环境变量GSDB_DATA的值的数据库，若环境变量无GSDB_DATA则报错。
HA和单机自动升/降级时是不可选参数。
--package
新版本的安装包名称，需要指定绝对路径。
HA和单机手动升/降级时是必选参数，并且该参数不能缺省。
HA和单机自动升/降级时是不可选参数。
--backupdir
指定备份文件夹，即升/降级过程中，备份的旧版本系统表空间、admin、lib等存放的位置，支持脚本创建。
HA和单机手动升/降级时是必选参数，并且该参数不能缺省。
HA和单机自动升/降级时是不可选参数。
-P
指定工具通过用户名和密码连接数据库。命令行执行过程中，会提示输入连接数据库的用户名和密码，用户名是SYS，密码是SYS用户的出厂密码Changeme_123。
可选参数，并且该参数可缺省，若缺省，则通过免密登录连接数据库。
--config-file
指定升级配置文件。
单机自动升/降级的升/降级文件中仅配置一条节点信息即可；HA自动升/降级的升/降级文件中需要包含每个节点的配置信息，每个节点的配置信息单独成行，并且第一行的配置信息必须是执行升级命令节点的配置信息。""=""后面的配置信息，必须严格按照顺序“升级包路径，数据库安装路径，备份路径，数据库实例的数据文件目录”配置。
升级配置文件格式如下：
IP=package_path,app_path,backup_path,data_path [, ...]
IP是节点IP。
package_path表示升/降级包的绝对路径。
app_path表示数据库安装路径。
backup_path表示升/降级过程中备份文件的存储路径。
data_path表示数据库实例路径，可指定多个数据库实例路径，使用逗号隔开。
升级配置文件示例（假设要升/降级的数据库环境包含两个节点，并且执行升级命令节点IP是192.168.0.1）：
192.168.0.1=/opt/gaussdb/GAUSSDB100-V300R001C00-DATABASE-EULER20SP8-64bit.tar.gz,/home/gaussdba/app,/home/gaussdba/backup,/home/gaussdba/data192.168.0.2=/opt/gaussdb/GAUSSDB100-V300R001C00-DATABASE-EULER20SP8-64bit.tar.gz,/home/gaussdba/app,/home/gaussdba/backup,/home/gaussdba/data
HA和单机手动升/降级时是不可选参数。
HA和单机自动升/降级时是必选参数。
-s
指定一键式升级步骤，支持pre-check，run，rollback-check，rollback，cleanup。
HA和单机手动升/降级时是不可选参数。
HA和单机自动升/降级时是必选参数。
--packtype
指定升级包类型。
取值范围：run、package。默认值是package。
可选参数。
--upgrade-mode
指定升级模式。
取值范围：ha、single。默认为single。
HA和单机手动升/降级时是不可选参数。
HA和单机自动升/降级时是可选参数。
--auto-rollback
指定是否自动回滚。
取值范围：true、false。默认值是true。
HA和单机手动升/降级时是不可选参数。
HA和单机自动升/降级时是可选参数。
-f
指定参数配置文件的路径和文件名。
手动升/降级时，可将--GSDB_HOME、--GSDB_DATA、--package、--backupdir、-P这五个参数以及对应的参数值配置在一个文件中；自动升级时，可将--packtype、--upgrade-mode、--auto-rollabck、--config-file、-P这五个参数以及对应的参数值配置在一个文件中。该文件称之为参数配置文件。
升/降级时可直接在升/降级命令中分别指定这些参数的值；也可使用-f参数指定参数配置文件，此时升/降级命令中无需再重复指定已写入该配置文件中的参数。
手动升/降级参数配置文件示例：
GSDB_HOME=valueGSDB_DATA=valuepackage=valuebackupdir=valueinteractive=TRUE/FALSE
自动升/降级参数配置文件示例：
packtype=run/packageupgrade-mode=ha/singleauto-rollabck=TRUE/FALSEconfig-file=valueinteractive=TRUE/FALSE
其中，-P参数在参数配置文件中用interactive表示。指定-P参数，则interactive=TRUE；-P参数缺省，则interactive=FALSE。
可选参数。
