backupOffline()

语法

backupOffline( [options] )

备份数据库。

参数描述

1. options 格式

   属性名	描述	格式
   GroupID	指定备份的复制组 ID，缺省为所有复制组	GroupID: 1000 或 GroupID: [1000, 1001]
   GroupName	指定备份的复制组名，缺省为所有复制组	GroupName: "data1" 或 GroupName: ["data1", "data2"]
   Name	备份名称，缺省为 “YYYY-MM-DD-HH:mm:SS” 时间格式的备份名	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_"
   EnableDateDir	是否开启日期子目录功能，如果开启则会自动根据当前日期创建 “YYYY-MM-DD” 的子目录，缺省为 false	EnableDateDir: false
   Description	备份描述	Description: "First backup"
   EnsureInc	是否开启增量备份，缺省为 false	EnsureInc: false
   OverWrite	存在同名备份是否覆盖，缺省为 false	OverWrite: false
   Compressed	是否开启数据压缩，缺省为 true	Compressed: true
   CompressionType	压缩格式类型，取值"lz4"、"snappy"和"zlib"，缺省为 "snappy"	CompressionType: "zlib"
   BackupLog	当全量备份时是否需要备份所有日志，缺省为 false	BackupLog: false

返回值

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

版本

v1.2及以上版本。
v2.8.2及以上版本增加 Compressed、CompressionType 和 BackupLog 参数。

示例

对数据库节点进行全量备份

> db.backupOffline( { Name: "FullBackup1" } )
> db.listBackup()
{
  "Version": 2,
  "Name": "FullBackup1",
  "ID": 0,
  "NodeName": "susetzb:11830",
  "GroupName": "db1",
  "EnsureInc": false,
  "BeginLSNOffset": 0,
  "EndLSNOffset": 195652068,
  "StartTime": "2015-10-20-16:52:42",
  "LastLSN": 195652020,
  "LastLSNCode": 1845751176,
  "HasError": false
}
Return 1 row(s).