gs_backup

背景信息

openGauss部署成功后，在数据库运行的过程中，会遇到各种问题及异常状态。openGauss提供了gs_backup工具帮助openGauss备份、恢复重要数据、显示帮助信息和版本号信息。

前提条件

可以正常连接openGauss数据库。
在进行还原时，需要保证各节点备份目录中存在备份文件。
需以操作系统用户omm执行gs_backup命令。

语法

备份数据库主机

gs_backup -t backup --backup-dir=BACKUPDIR [-h HOSTNAME] [--parameter] [--binary] [--all] [-l LOGFILE]

恢复数据库主机

gs_backup -t restore --backup-dir=BACKUPDIR [-h HOSTNAME] [--parameter] [--binary] [--all] [-l LOGFILE] [--force]

显示帮助信息
```
gs_backup -? | --help
```
显示版本号信息
```
gs_backup -V | --version
```

参数说明

gs_backup参数可以分为如下几类：

备份数据库主机参数：
- -h
  指定存储备份文件的主机名称。
  取值范围：主机名称。如果不指定主机名称，则备份当前集群。
- --backup-dir=BACKUPDIR
  备份文件保存路径。
- --parameter
  备份参数文件，不指定--parameter、--binary、--all参数时默认只备份参数文件。
- --binary
  备份app目录下的二进制文件。
- --all
  备份app目录下的二进制文件、pg_hba.conf和postgsql.conf文件。
- -l
  指定日志文件及存放路径。
  默认值：$GAUSSLOG/om/gs_backup-YYYY-MM-DD_hhmmss.log
恢复数据库主机参数：
- -h
  指定需要恢复主机的名称。
  取值范围：主机名称。如果不指定主机，则恢复对应的备份节点。
- --backup-dir=BACKUPDIR
  恢复文件提取路径。
- --parameter
  恢复参数文件，不指定--parameter、--binary、--all参数时默认只恢复参数文件。
- --binary
  恢复二进制文件。
- --all
  恢复二进制和参数文件。
- -l
  指定日志文件及存放路径。
  默认值：$GAUSSLOG/om/gs_backup-YYYY-MM-DD_hhmmss.log
- --force
  节点的静态文件丢失之后强行restore，仅限--all或者--binary参数使用时才生效。
其他参数：
- -?, --help
  显示帮助信息。
- -V, --version
  显示版本号信息。

示例

使用gs_backup脚本备份数据库主机。

gs_backup -t backup --backup-dir=/opt/software/gaussdb/backup_dir -h plat1 --parameter
Backing up openGauss.
Parsing configuration files.
Successfully parsed the configuration file.
Performing remote backup.
Remote backup succeeded.
Successfully backed up openGauss.

使用gs_backup脚本恢复数据库主机。

gs_backup -t restore --backup-dir=/opt/software/gaussdb/backup_dir -h plat1 --parameter
Restoring openGauss.
Parsing the configuration file.
Successfully parsed configuration files.
Performing remote restoration.
Remote restoration succeeded.
Successfully restored openGauss.