文档中心

removeBackup()

语法

db.removeBackup( [options] )

删除数据库备份。

参数描述

参数名 参数类型 描述 是否必填
options Json 对象 设定备份名、复制组、备份路径等参数

options 格式

属性名 描述 格式
GroupID 备份的复制组 ID,缺省为所有复制组 GroupID:1000 或 GroupID:[1000, 1001]
GroupName 备份的复制组名,缺省为所有复制组 GroupName:"data1" 或 GroupName:["data1", "data2"]
Name 备份名称,缺省删除所有备份 Name:"backup-2014-1-1"
Path 备份路径,缺省为配置参数指定的备份路径。该路径支持通配符(%g/%G: group name, %h/%H: host name, %s/%S:service name)。当在协调节点上执行命令使用该参数时,需要使用通配符,以避免所有的节点往同一个路径下进行操作而导致未知IO错误。 Path:"/opt/sequoiadb/backup/%g"
IsSubDir 上述 Path 参数所配置的路径是否为配置参数指定的备份路径的子目录,如果为true,则真实的备份目录为:" 配置参数中指定的备份目录 / Path目录 ";缺省为 false。 IsSubDir:false
Prefix 备份前缀名,支持通配符(%g,%G,%h,%H,%s,%S),缺省为空 Prefix:"%g_bk_"
ID 备份 ID,-1表示该名字的所有备份, 缺少为 -1 ID: -1

返回值

无返回值,出错抛异常,并输出错误信息,可以通过 getLastErrMsg() 获取错误信息 或 通过 getLastError() 获取错误码。关于错误处理可以参考常见错误处理指南

错误

常见错误可参考错误码

版本

v2.8.2及以上版本增加 ID 参数。

示例

  • 删除数据库中备份名为“backup-2014-1-1”的备份信息

    > db.removeBackup({Name:"backup-2014-1-1"})
回到顶部