pbm命令¶
pbmCLI是用于控制备份系统的命令行实用工具。本页描述pbm命令可用在Percona备份MongoDB。雷竞技下载官网
有关如何开始使用Percona Backup For M雷竞技下载官网ongoDB,请参见初始设置。
pbm帮助¶
返回有关的帮助信息pbm命令。
pbm配置¶
设置、更改或列出MongoDB配置的Perco雷竞技下载官网na Backup。
命令格式如下:
$pbm配置[<标记>][< >键]
该命令接受以下标志:
| 国旗 | 描述 |
|---|---|
——force-resync |
将备份列表与当前存储重新同步 |
——列表 |
列出当前设置 |
——=文件 |
从YAML文件上传配置信息 |
——=集合 |
设置一个新的配置选项值。属性中指定该选项< key.name =值>格式。 |
- o,——=文本 |
将输出格式显示为纯文本或JSON对象。支持的值:text, json |
PBM配置输出
{“pitr”:{“启用”:假,“oplogSpanMin”:0},“存储”:{“类型”:“文件系统”,“s3”:{“地区”:"",“endpointUrl”:"",“桶”:""},“蔚蓝”:{},“文件系统”:{“路径”:“< my-backup-dir >”}},“恢复”:{“batchSize”:500,“numInsertionWorkers”:10},“备份”:{}}
设置配置值
[{“关键”:“pitr.enabled”,“价值”:“真正的”}]
pbm备份¶
创建备份快照,并保存到远端备份存储。
命令格式如下:
$pbm备份[<标记>]
有关使用的更多信息pbm备份,请参阅开始备份
该命令接受以下标志:
| 国旗 | 描述 |
|---|---|
- t,——类型 |
备份类型。支持物理、逻辑(默认)、增量。如果没有指定,Percona Backu雷竞技下载官网p for MongoDB将进行逻辑备份。 请注意:增量物理备份技术预览功能。 |
——基础 |
仅用于增量备份。将备份设置为基数,并开始跟踪增量备份历史记录,以计算并保存后续增量备份的数据块差异。 |
——压缩 |
使用压缩创建备份。 支持的压缩方法: gzip,时髦的,lz4,s2,pgzip,zstd。默认值:s2的 没有一个值表示在备份期间不进行压缩。 |
——压缩等级 |
配置压缩级别0 ~ 10。默认值取决于使用的压缩方法。 |
- o,——=文本 |
将输出格式显示为纯文本或JSON对象。支持的价值观:文本,json |
——等待 |
等待备份完成。该标志阻止shell会话。 |
——ns = " database.collection " |
备份指定的名称空间-数据库和集合。中指定的值,可备份数据库中的所有集合——ns = "数据库。*”格式。在版本2.0.0中,备份只支持单个名称空间。 |
JSON输出
{“名称”:“< backup_name >”,“存储”:“< my-backup-dir >”}
pbm恢复¶
将数据库从指定的备份恢复到指定的时间点。根据备份类型,执行逻辑恢复或物理恢复。
命令格式如下:
$pbm恢复[<标记>][< backup_name >]
有关使用的更多信息pbm恢复,请参阅恢复备份。
该命令接受以下标志:
| 国旗 | 描述 |
|---|---|
——时间= |
将数据库恢复到指定的时间点。可用于逻辑恢复和if时间点恢复启用。 |
- w |
等待恢复完成。该标志阻止shell会话。 |
- o,——=文本 |
将输出格式显示为纯文本或JSON对象。支持的价值观:文本,json |
——base-snapshot |
将数据库从指定的备份恢复到指定的时间点。如果没有这个标志,恢复点将使用时间戳之前的最新备份。从1.6.0版本开始,Mo雷竞技下载官网ngoDB的Percona Backup中可用。 |
——replset-remapping |
为数据恢复/ oplog重播映射副本集名称。取值格式为to_name_1 = from_name_1 to_name_2 = from_name_2 |
——ns = " database.collection " |
恢复指定的名称空间-数据库和集合。若要恢复数据库中的所有集合,请将值指定为——ns = "数据库。*”。的——nsFlag接受多个名称空间作为逗号分隔的列表。例如,ns= " db1.*,db2.coll2,db3.coll1,db3.collX " |
恢复输出
{“名称”:“< restore_name >”“快照”:“< backup_name >”}
时间点恢复
{“名称”:“< restore_name >”,“时间点”:“< backup_name >”}
pbm describe-backup¶
备份的详细信息。
- 备份的名字
- 类型
- 状态
- 名称空间——在选择性备份期间备份的内容
- 大小
- 备份失败的错误消息
- 最后写入时间戳
- 最后写入时间——上一次写入的人类可读指示
- 最后转换时间—备份更改其状态的时间戳
- 集群信息:副本集名称、该副本集上的备份状态、是否用作配置服务器副本集、最近写入时间戳
- 副本集信息:名称,备份状态,最后写入时间戳和最后转换时间,
mongod安全选项,如果配置了加密。
命令格式如下:
$pbmdescribe-backup[< backup-name >][<标记>]
| 国旗 | 描述 |
|---|---|
- o,——=文本 |
将状态显示为纯文本或JSON对象。支持的价值观:文本,json |
JSON输出
{“名称”:“< backup_name >”,“opid”:“<字符串>”,“类型”:“逻辑”,“last_write_ts”:次助教国会议员,“last_transition_ts”:次助教国会议员,“last_write_time”:“2022 - 09 - 30 - t14:02:49z”,“last_transition_time”:“2022 - 09 - 30 - t14:02:54z”,“名称”:[“flight.booking”),“mongodb_version”:“<版本>”,“pbm_version”:“<版本>”,“状态”:“完成”,“大小”:470805945,“size_h”:“449.0 MiB”,“replset”:[{“名称”:“<名称>”,“状态”:“完成”,“last_write_ts”:次助教国会议员,“last_transition_ts”:次助教国会议员,“last_write_time”:“2022 - 09 - 30 - t14:02:49z”,“last_transition_time”:“2022 - 09 - 30 - t14:02:53z”}]}
pbm cancel-backup¶
取消正在运行的备份。备份列表中该备份被标记为已取消。
该命令接受以下标志:
| 国旗 | 描述 |
|---|---|
- o,——=文本 |
将输出格式显示为纯文本或JSON对象。支持的价值观:文本,json |
JSON输出
{“味精”:"备份取消已开始"}
pbm列表¶
提供备份列表。在1.3.4及更早版本中,该命令列出所有备份及其状态。备份状态如下:
- In progress -备份正在运行
- 已取消—备份已取消
- 错误-备份完成时出现错误
- 无状态表示备份已完成
从版本1.4.0开始,只列出成功完成的备份。执行命令,查看正在运行或失败的备份的当前信息pbm状态。
启用时间点恢复功能后pbm列表还提供恢复的有效时间范围和时间点恢复状态的列表。
命令格式如下:
$pbm列表[<标记>]
该命令接受以下标志:
| 国旗 | 描述 |
|---|---|
——恢复 |
显示最近N次恢复。从版本2.0开始,输出显示恢复名称而不是备份名称,因为可以从单个备份执行多个恢复。 |
——大小= 0 |
显示最近N个备份。它还提供恢复是否是选择性恢复的信息。 |
- o,——=文本 |
将输出格式显示为纯文本或JSON对象。支持的价值观:文本,json |
——无靠背的 |
显示在没有基本备份快照的情况下保存的时间点恢复oplog切片。从版本1.8.0开始提供。 |
——replset-remapping |
为数据恢复/ oplog重播映射副本集名称。取值格式为to_name_1 = from_name_1 to_name_2 = from_name_2 |
备份列表
{“快照”:[{“名称”:“< backup_name >”,“状态”:“完成”,“completeTS”:次助教国会议员,“pbmVersion”:“1.6.0”}),“pitr”:{“上”:假,“范围”:[{“范围”:{“开始”:次助教国会议员,“结束”:次助教国会议员}},{“范围”:{“开始”:次助教国会议员,“结束”:次助教国会议员},{“范围”:{“开始”:次助教国会议员,“结束”:次助教国会议员(no基地年代napshot)}}]}}
恢复历史
完全恢复
{“开始”:次助教国会议员,“状态”:“完成”,“类型”:“快照”,“快照”:“< backup_name >”,“名称”:“< restore_name >”}
选择性还原
{“开始”:次助教国会议员,“状态”:“完成”,“类型”:“快照”,“快照”:“< backup_name >”,“名称”:“< restore_name >”,“名称”:[“< database.collection >”]}
时间点恢复
{“开始”:次助教国会议员,“状态”:“完成”,“类型”:“pitr”,“快照”:“< backup_name >”,“时间点”:次助教国会议员,“名称”:“< restore_name >”}
选择性的时间点恢复
{“开始”:次助教国会议员,“状态”:“完成”,“类型”:“pitr”,“快照”:“< backup_name >”,“时间点”:次助教国会议员,“名称”:“< restore_name >”,“名称”:[“< database.collection >”]}]
pbm describe-restore¶
显示恢复的详细信息。
命令格式如下:
$pbmdescribe-restore[< restore-timestamp >][<标记>]
该命令接受以下标志:
| 国旗 | 描述 |
|---|---|
- c,——配置=配置 |
只对身体恢复。将MongoD雷竞技下载官网B的Percona Backup指向一个配置文件,这样它就可以从远程存储中读取恢复状态。例如,PBM description -restore -c /etc/pbm/conf. txtyaml < restore-name >。 |
- o,——=文本 |
将输出显示为纯文本(默认值)或JSON对象。支持的价值观:文本,json。 |
选择恢复状态
{“名称”:“< restore_name >”,“opid”:“字符串”,“备份”:“< backup_name >”,“类型”:“逻辑”,“状态”:“完成”,“ts_to_restore”:次助教国会议员,“time_to_restore”:“时间”,“名称”:[“<数据库。* >”]“replset”:[{“名称”:“卢比”,“状态”:“完成”,“last_transition_ts”:次助教国会议员,“last_transition_time”:“时间”},{“名称”:“rs0”,“last_transition_ts”:次助教国会议员,“last_transition_time”:“时间”},{“名称”:“cfg”,“状态”:“完成”,“last_transition_ts”:次助教国会议员,“last_transition_time”:“时间”}),}
物理恢复状态
{“名称”:“< restore_name >”,“opid”:“字符串”,“备份”:“< backup_name >”,“类型”:“物理”,“状态”:“完成”,“last_transition_ts”:次助教国会议员,“last_transition_time”:“时间”,“replset”:[{“名称”:“卢比”,“状态”:“完成”,“last_transition_ts”:次助教国会议员,“last_transition_time”:“时间戳”,“节点”:[{“名称”:“IP:端口”,“状态”:“完成”,“last_transition_ts”:次助教国会议员,“last_transition_time”:“时间戳”}]}),}
pbm delete-backup¶
删除指定的备份快照或所有早于指定时间的备份快照。无论使用的远端备份存储是什么,该命令都会删除未运行的备份。
命令格式如下:
$pbmdelete-backup[<标记>][<名称>]
该命令接受以下标志:
| 国旗 | 描述 |
|---|---|
——以上=时间戳 |
删除比指定的日期/时间更早的备份: - % Y - % M - H % DT %: % M: % S(例如2020-04-20T13:13:20)或- Y - % - % D %(例如:2020-04-20) |
——力 |
强制删除备份而不要求用户确认 |
pbm delete-pitr¶
删除时间点恢复生成的oplog切片。
命令格式如下:
pbmdelete-pitr[<标记>]
该命令接受以下标志:
| 国旗 | 描述 |
|---|---|
——一个,——所有 |
删除所有oplog |
——以上=时间戳 |
删除比指定的日期/时间更早的oplog切片: - % Y - % M - H % DT %: % M: % S(例如2020-04-20T13:13:20)或- Y - % - % D %(例如:2020-04-20)当您指定一个时间戳时,Percona Backup for 雷竞技下载官网MongoDB将其四舍五入以与最近的备份快照的完成时间保持一致,并删除该时间之前的oplog切片。因此,多余的切片会留下来。这样做是为了确保oplog的连续性。为了说明,PITR时间范围为 2021-08-11t11:16:21 - 2021-08-12t08:55:25备份快照为:[restore_to_time: 2021-08-12T08:50:06]2021-08-11T11:36:17Z 7.37MB [restore_to_time: 2021-08-11T11:36:38]假设您指定了时间戳 2021 - 08 - 11 - t19:16:21。最近的备份是2021-08-11T11:36:17Z 7.37KB [restore_to_time: 2021-08-11T11:36:38]。PBM将时间戳舍入为2021 - 08 - 11 - t11:36:38并删除此时间之前的所有切片。因此,您的PITR时间范围为2021-08-11t11:36:38 - 2021-08-12t09:00:25。请注意: 雷竞技下载官网Percona Backup for MongoDB不会删除最近一次备份之后的oplog切片。这样做是为了确保在某个时间点从备份快照恢复。例如,快照为 2021-07-20T07:05:23Z [restore_to_time: 2021-07-21T07:05:44]然后指定时间戳2021 - 07 - 20 - t07:05:45, 雷竞技下载官网Percona Backup for MongoDB只删除以前做的切片2021 - 07 - 20 - t07:05:23z。 |
——力 |
未经用户确认,强制删除oplog切片 |
- o,——从= json |
将输出显示为纯文本(默认值)或JSON对象。支持的价值观:文本,json。 |
pbm版本¶
显示MongoDB的Percona Bac雷竞技下载官网kup版本。
该命令接受以下标志:
| 国旗 | 描述 |
|---|---|
——短 |
只显示版本信息 |
——提交 |
只显示git提交信息 |
- o,——=文本 |
将输出显示为纯文本或JSON对象。支持的价值观:文本,json |
版本信息
{“版本”:“1.6.0”,“平台”:“linux / amd64”,“GitCommit”:“f9b9948bb8201ba1a6400f6558496934a0685efd”,“GitBranch”:“主要”,“BuildTime”:“2021 - 07 - 28 - _15:24_utc”,“GoVersion”:“go1.16.6”}
pbm状态¶
显示MongoDB的Percona Ba雷竞技下载官网ckup状态。显示信息包括:
pbm-agent进程版本和状态- 当前正在运行备份或恢复
- 备份存储在远程存储中
- 时间点恢复状态
- 时间点恢复的有效时间范围和数据大小
该命令接受以下标志:
| 国旗 | 描述 |
|---|---|
- o,——=文本 |
将状态显示为纯文本或JSON对象。支持的价值观:文本,json |
- s,——部分=部分 |
显示指定区段的状态。您可以传递几个标志来查看多个部分的状态。支持的值:cluster、pitr、running、backups。 |
——replset-remapping |
为数据恢复/ oplog重播映射副本集名称。取值格式为to_name_1 = from_name_1 to_name_2 = from_name_2 |
状态信息
{“备份”:{“类型”:“FS”,“路径”:“< my-backup-dir >”,“快照”:[...{“名称”:“< backup_name >”,“大小”:3143396168,“状态”:“完成”,“completeTS”:次助教国会议员,“pbmVersion”:“1.6.0”},),“pitrChunks”:{“pitrChunks”:[...{“范围”:{“开始”:次助教国会议员,“结束”:次助教国会议员}},{“范围”:{“开始”:次助教国会议员,“结束”:次助教国会议员(no基地年代napshot)!!!no备份f欧nd}},),“大小”:677901884}},“集群”:[{“rs”:“< replSet_name >”,“节点”:[{“主机”:“< replSet_name > / example.mongodb: 27017”,“代理”:“<版本>”,“ok”:真正的}]}),“pitr”:{“配置”:真正的,“运行”:假,“错误”:"Timestamp.000+0000 E [/example. "Mongodb:27017] [pitr] " },“运行”:{“类型”:“备份”,“名称”:“< backup_name >”,“startTS”:次助教国会议员,“状态”:“oplog备份”,“opID”:“6113 b631ea9ba5b815fee7c6”}}
pbm日志¶
显示所有日志信息pbm-agent流程。
命令格式如下:
$pbm日志[<标记>]
该命令接受以下标志:
| 国旗 | 描述 |
|---|---|
- t,——尾= 20 |
显示最后N项。默认情况下,输出显示最近20个条目。0表示显示所有日志消息。 |
- e,——事件=事件 |
显示按指定事件过滤的日志。支持事件: ——备份 -恢复 ——resyncBcpList ——pitr ——pitrestore ——删除 |
- o,——=文本 |
以文本(默认)或JSON格式显示日志信息。 支持的价值观: 文本,json |
- n,——节点=节点 |
显示指定节点或副本集的日志。 请按格式指定节点 replset(/主持人:端口) |
- f,——遵循 |
跟踪日志输出。允许动态查看日志 |
- s,——严重=我 |
显示按级别过滤的日志。 支持的级别从低到高分别为:D -调试、I -提示(默认)、W -警告、E -错误、F -致命。 输出包括指定的严重级别和所有更高的严重级别 |
——时区=时区 |
日志输出的时区。 支持的价值观: UTC(默认),当地的中的时区IANA时区格式(如。美国/ New_York) |
-我,——opid = opid |
显示正在进行的操作的日志。操作由OpID标识 |
- x,——额外的 |
以文本格式显示额外数据 |
中找到用法示例查看备份日志。
日志输出
[{“t”:"",“s”:3.,“rs”:“rs0”,“节点”:“example.mongodb.com: 27017”,“e”:"",“eobj”:"",“ep”:{“T”:0,“我”:0},“味精”:“倾听命令”},....]
pbm oplog-replay¶
允许在任何备份之上重播oplog:逻辑、物理、存储级快照(如EBS-snapshot),并将其恢复到特定的时间点。
要了解有关用法的更多信息,请参阅时间点恢复oplog重播。
命令格式如下:
$pbmoplog-replay[<标记>]
该命令接受以下标志:
| 国旗 | 描述 |
|---|---|
开始=时间戳 |
oplog重放的开始时间。 |
结束=时间戳 |
oplog重放的结束时间。 |
——replset-remapping |
为oplog重播映射复制集名称。取值格式为to_name_1 = from_name_1 to_name_2 = from_name_2。 |
技术预览功能尚未准备好供企业使用,并且不包括在通过SLA提供的支持中。它们包含在此版本中,以便用户可以在未来的GA版本中完整发布该特性之前提供反馈(或者如果认为该特性没有用处,则删除该特性)。这个功能可以从技术预览到GA进行更改(api, cli等)。↩
创建:2023年3月29日