名称
backup - 备份数据库。
语法
db.backup([options])
类别
Sdb
描述
备份数据库。
参数描述
-
options
( Object, 选填 )options
参数可以设置备份的属性,如指定设定备份名,指定复制组,备份方式等。 可组合使用options
的如下选项:-
GroupID
( Array ):指定备份的复制组 ID,缺省为所有复制组。格式:
GroupID:1000
或GroupID:[1000, 1001]
-
GroupName
( String ):指定备份的复制组名,缺省为所有复制组。格式:
GroupName: "data1"
或GroupName: ["data1", "data2"]
-
Name
( String ):备份名称,缺省为 “YYYY-MM-DD-HH:mm:SS” 时间格式的备份名。格式:
Name: "backup-2014-1-1"
-
Path
( String ):备份路径,缺省为配置参数指定的备份路径。 该路径支持通配符 (%g/%G: group name, %h/%H: host name, %s/%S: service name)。 当在协调节点上执行命令使用该参数时,需要使用通配符,以避免所有的节点往同一个路径下进行操作而导致未知IO错误。格式:
Path: "/opt/sequoiadb/backup/%g"
-
IsSubDir
( Bool ):上述Path
参数所配置的路径是否为配置参数指定的备份路径的子目录,如果为true,则真实的备份目录为:" 配置参数中指定的备份目录 /Path
目录 "。 缺省为 false。格式:
IsSubDir: false
-
Prefix
( String ):备份前缀名,支持通配符(%g,%G,%h,%H,%s,%S),缺省为空。格式:
Prefix: "%g_bk_"
-
EnableDateDir
( Bool ):是否开启日期子目录功能,如果开启则会自动根据当前日期创建 “YYYY-MM-DD” 的子目录,缺省为 false。格式:
EnableDateDir: false
-
Description
( String ):备份描述。格式:
Description: "First backup"
-
EnsureInc
( Bool ):是否开启增量备份,缺省为 false。格式:
EnsureInc: false
-
OverWrite
( Bool ):存在同名备份是否覆盖,缺省为 false。格式:
OverWrite: false
-
Compressed
( Bool ):是否开启数据压缩,缺省为 true。格式:
Compressed: true
-
CompressionType
( String ):压缩格式类型,取值"lz4"、"snappy"和"zlib",缺省为 "snappy"。格式:
CompressionType: "zlib"
-
BackupLog
( Bool ):当全量备份时是否需要备份所有日志,缺省为 false。格式:
BackupLog: false
-