openGauss数据库源码解析系列文章——备份恢复机制：openGauss增量备份技术（上）_opengauss 备份命令

增量备份的主要逻辑在gs_probackup工具中实现，一些备份原理和前面介绍的全量物理备份相似，下面主要介绍gs_probackup工具的代码实现逻辑。源代码在src\bin\pg_probackup目录下，gs_probackup是一个独立的二进制工具，有自己的主函数，主函数在pg_probackup.cpp文件中。主函数是增量备份处理的一个框架，开始时调用pgBackupInit初始化当前备份的元数据信息，然后调用init_config初始化实例的备份配置信息，解析备份子命令和命令行参数，根据子命令调用子命令的处理函数进行处理。

10.2.1  gs_probackup子命令

gs_probackup支持的功能、子命令和处理函数如下。

（1） 打印gs_probackup版本，代码如下：

gs_probackup -V|--version
gs_probackup version

这个子命令没有处理函数，直接打印显示当前版本号。

（2） 显示gs_probackup命令的帮助信息。如果指定了gs_probackup的子命令，则显示可用于此子命令的参数的详细信息。代码如下：

gs_probackup -?|--help

gs_probackup help [command]

处理函数为help_command和help_pg_probackup。

（3） 初始化备份路径backup-path中的备份目录，该目录将存储备份的内容。如果备份路径backup-path已存在，则backup-path必须为空目录。代码如下：

gs_probackup init -B backup-path [--help]

处理函数为do_init。

（4） 在备份路径backup-path内初始化一个新的备份实例，并生成pg_probackup.conf配置文件，该文件保存了指定数据目录pgdata-path的gs_probackup设置。代码如下：

gs_probackup add-instance -B backup-path -D pgdata-path --instance=instance_name
[-E external-directories-paths]
[remote_options]
[--help]

处理函数为do_add_instance。

（5） 在备份路径backup-path内删除指定实例相关的备份内容，代码如下：

gs_probackup del-instance -B backup-path --instance=instance_name
[--help]

处理函数为do_delete_instance。

（6） 将指定的连接、压缩、日志等相关设置添加到pg_probackup.conf配置文件中，或修改已设置的值，不要手动编辑pg_probackup.conf配置文件。代码如下：

gs_probackup set-config -B backup-path --instance=instance_name
[-D pgdata-path] [-E external-directories-paths] [--restore-command=cmdline] [--archive-timeout=timeout]
[--retention-redundancy=retention-redundancy] [--retention-window=retention-window] [--wal-depth=wal-depth]
[--compress-algorithm=compress-algorithm] [--compress-level=compress-level]
[-d dbname] [-h hostname] [-p port] [-U username]
[logging_options] [remote_options]
[--help]

处理函数为do_set_config。

（7） 将备份相关设置添加到backup.control配置文件中，或修改已设置的值。代码如下：

gs_probackup set-backup -B backup-path --instance=instance_name -i backup-id
[--note=text] [pinning_options]
[--help]

处理函数为do_set_backup。

（8） 显示位于备份目录中的pg_probackup.conf配置文件的内容。可以通过指定–format=json选项，以json格式显示。默认情况下，显示为纯文本格式，代码如下：

gs_probackup show-config -B backup-path --instance=instance_name
[--format=plain|json]
[--help]

处理函数为do_show_config。

（9） 显示备份目录的内容。如果指定了instance_name和backup_id，则显示该备份的详细信息。可以通过指定–format=json选项，以json格式显示。默认情况下，备份目录的内容显示为纯文本格式，代码如下：

gs_probackup show -B backup-path
[--instance=instance_name [-i backup-id]] [--archive] [--format=plain|json]
[--help]

处理函数为do_show。

（10） 创建指定实例的备份，代码如下：

gs_probackup backup -B backup-path --instance=instance_name -b backup-mode
[-D pgdata-path] [-C] [-S slot-name] [--temp-slot] [--backup-pg-log] [-j threads_num] [--progress]
[--no-validate] [--skip-block-validation] [-E external-directories-paths] [--no-sync] [--note=text]
[--archive-timeout=timeout]
[logging_options] [retention_options] [compression_options]
[connection_options] [remote_options] [pinning_options]
[--help]

处理函数为do_backup。

（11） 从备份目录backup-path中的备份副本恢复指定实例。如果指定了恢复目标选项，gs_probackup将查找最近的备份并将其还原到指定的恢复目标。否则，使用最近一次备份，代码如下：

gs_probackup restore -B backup-path --instance=instance_name
[-D pgdata-path] [-i backup_id] [-j threads_num] [--progress] [--force] [--no-sync] [--no-validate] [--skip-block-validation]
[--external-mapping=OLDDIR=NEWDIR] [-T OLDDIR=NEWDIR] [--skip-external-dirs] [-I incremental_mode]
[recovery_options] [remote_options] [logging_options]
[--help]

处理函数为do_restore_or_validate。

（12） 将指定的增量备份与其父完全备份之间的所有增量备份合并到父完全备份。父完全备份将接收所有合并的数据，而已合并的增量备份将作为冗余被删除。代码如下：

gs_probackup merge -B backup-path --instance=instance_name -i backup_id
[-j threads_num] [--progress] [logging_options]
[--help]

处理函数为do_merge。

（13） 删除指定备份，或删除不满足当前保留策略的备份，代码如下：

gs_probackup delete -B backup-path --instance=instance_name
[-i backup-id | --delete-expired | --merge-expired | --status=backup_status]
[--delete-wal] [-j threads_num] [--progress]
[--retention-redundancy=retention-redundancy] [--retention-window=retention-window]
[--wal-depth=wal-depth] [--dry-run]
[logging_options]
[--help]

感谢每一个认真阅读我文章的人，看着粉丝一路的上涨和关注，礼尚往来总是要有的：

①　2000多本Python电子书（主流和经典的书籍应该都有了）

②　Python标准库资料（最全中文版）

③　项目源码（四五十个有趣且经典的练手项目及源码）

④　Python基础入门、爬虫、web开发、大数据分析方面的视频（适合小白学习）

⑤ Python学习路线图（告别不入流的学习）

网上学习资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。

需要这份系统化学习资料的朋友，可以戳这里无偿获取

一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！