更新日期：2024年09月11日
sword GCILobWrite2(
GCISvcCtx *svchp,
GCIError *errhp,
GCILobLocator *locp,
gbsub8 *byte_amtp,
gbsub8 *char_amtp,
gbsub8 offset,
void *bufp,
gbsub8 buflen,
ub1 piece,
void *ctxp,
GCICallbackLobWrite2 (cbfp)
(void *ctxp,
void *bufp,
oraub8 *lenp,
ub1 *piecep
void **changed_bufpp,
oraub8 *changed_lenp
),
ub2 csid,
ub1 csfrm
)；
GBase 8s GCI 接口使用指南
南大通用数据技术股份有限公司 78
写入内容到一个大对象中，暂不支持大于4G的LOB对象。
参数
输入
/输出
svchp
输入/输出
上下文句柄指针
errhp
输入/输出
错误信息句柄，该接口调用失败时，错误信息会保存在错误句
柄中
locp
输入/输出
存储大对象描述符指针
byte_amtp
输入/输出
该参数为输入输出参数，当调用函数时，该参数表明想写入的字
节数，当函数执行完成后，GCI 会回填实际写入的字节数.对于
CLOB，仅在char_amtp 为零时使用
char_amtp
输入/输出
对于CLOB,该参数表示想读取的字节数，函数执行完以后，该参数
为实际读到的字节数
offset
输入
从大对象开始位置到当前位置的偏移量，以字节为单位
bufp
输入
存放要写的数据缓冲区指针
buflen
输入
bufp参数指向的缓冲区大小
piece
输入
正在写入缓冲区的哪一部分。此参数的默认值为
GCI_ONE_PIECE，表示将缓冲区写入单个块中。
对于分段或回调模式可以使GCI_FIRST_PIECE，
GCI_NEXT_PIECE，和GCI_LAST_PIECE
ctxp
输入
回调函数的参数，可以NULL
cbfp
输入
可以注册的回调函数，可以在逐段写入LOB 数据。如果是
NULL，则使用标准轮询方法。
回调函数必须返回GCI_CONTINUE 才能继续读取。如果返回
任何其他错误代码，则将终止LOB 写入。
回调采用以下参数：
ctxp（输入）
回调函数的参数。可以NULL。
bufp (输入/输出)
片段的缓冲区指针。
lenp (输入/输出)
缓冲区（输入）中数据的长度（以字节为单位）。
piecep(输出)
哪一块：GCI_NEXT_PIECE 或GCI_LAST_PIECE。
changed_bufpp(输出)
保留参数，目前不适用(仅用于和Oracle 调用保持兼容)
changed_lenp(输出)
保留参数，目前不适用(仅用于和Oracle 调用保持兼容)
csid
输入
保留参数，目前不适用(仅用于和Oracle调用保持兼容)
csfrm
输入
保留参数，目前不适用(仅用于和Oracle调用保持兼容)
如果执行成功，返回 GCI_SUCCESS，否则返回 GCI_ERROR。
打印gs_probackup 版本。
gs_probackup -V|--version
gs_probackup version
显示gs_probackup 命令的摘要信息。如果指定了gs_probackup 的子命令，则显示可用
于此子命令的参数的详细信息。
gs_probackup -?|--help
gs_probackup help [command]
初始化备份路径_backup-path_中的备份目录，
该目录将存储已备份的内容。
如果备份路
径_backup-path_已存在，则_backup-path_必须为空目录。
gs_probackup init -B backup-path [--help]
在备份路径_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]
在备份路径_backup-path_内删除指定实例相关的备份内容。
gs_probackup del-instance -B backup-path --instance=instance_name
[--help]
将指定的连接、压缩、日志等相关设置添加到pg_probackup.conf 配置文件中，或修改
已设置的值。不推荐手动编辑pg_probackup.conf 配置文件。
gs_probackup set-config -B backup-path --instance=instance_name
[-D pgdata-path] [-E external-directories-paths] [--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]
GBase 8c 工具参考手册
南大通用数据技术股份有限公司
268
将备份相关设置添加到backup.control 配置文件中，或修改已设置的值。
gs_probackup set-backup -B backup-path --instance=instance_name -i backup-id
[--note=text] [pinning_options]
[--help]
显示位于备份目录中的pg_probackup.conf 配置文件的内容。
可以通过指定--format=json
选项，以json 格式显示。默认情况下，显示为纯文本格式。
gs_probackup show-config -B backup-path --instance=instance_name
[--format=plain|json]
[--help]
显示备份目录的内容。如果指定了instance_name 和backup_id，
则显示该备份的详细信
息。可以通过指定--format=json 选项，以json 格式显示。默认情况下，备份目录的内容
显示为纯文本格式。
gs_probackup show -B backup-path
[--instance=instance_name [-i backup-id]] [--archive] [--format=plain|json]
[--help]
创建指定实例的备份。
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] [-t rwtimeout]
[logging_options] [retention_options] [compression_options]
[connection_options] [remote_options] [pinning_options]
[--help]
从备份目录_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]
GBase 8c 工具参考手册
南大通用数据技术股份有限公司
269
[recovery_options] [remote_options] [logging_options]
[--help]
将指定的增量备份与其父完全备份之间的所有增量备份合并到父完全备份。
父完全备份
将接收所有合并的数据，而已合并的增量备份将作为冗余被删除。
gs_probackup merge -B backup-path --instance=instance_name -i backup_id
[-j threads_num] [--progress] [logging_options]
[--help]
删除指定备份，或删除不满足当前保留策略的备份。
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]
验证恢复数据库所需的所有文件是否存在且未损坏。如果未指定_instance_name_，
gs_probackup 将验证备份目录中的所有可用备份。
如果指定_instance_name_而不指定任
何附加选项，gs_probackup 将验证此备份实例的所有可用备份。如果指定了
_instance_name_并且指定_backup-id_或恢复目标相关选项，
gs_probackup 将检查是否可
以使用这些选项恢复数据库。
gs_probackup validate -B backup-path
[--instance=instance_name] [-i backup-id]
[-j threads_num] [--progress] [--skip-block-validation]
[--recovery-target-time=time | --recovery-target-xid=xid |
--recovery-target-lsn=lsn | --recovery-target-name=target-name]
[--recovery-target-inclusive=boolean]
[logging_options]
[--help]