backup()

    语法

    db.backup([options])

    类别

    Sdb

    备份数据库。

    参数描述

    • ( 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” 时间格式的备份名。
    • Path ( String )：备份路径，缺省为配置参数指定的备份路径。 该路径支持通配符 （%g/%G: group name, %h/%H: host name, %s/%S: service name）。 当在协调节点上执行命令使用该参数时，需要使用通配符，以避免所有的节点往同一个路径下进行操作而导致未知IO错误。

    格式：

    • IsSubDir ( Bool )：上述 Path 参数所配置的路径是否为配置参数指定的备份路径的子目录，如果为true，则真实的备份目录为：" 配置参数中指定的备份目录 / Path目录 "。 缺省为 false。

    格式：IsSubDir: false

    格式：Prefix: "%gbk"

    • EnableDateDir ( Bool )：是否开启日期子目录功能，如果开启则会自动根据当前日期创建 “YYYY-MM-DD” 的子目录，缺省为 false。

    格式：EnableDateDir: false

    • Description ( String )：备份描述。

    格式：Description: "First backup"

    • EnsureInc ( Bool )：是否开启增量备份，缺省为 false。

    格式：

    • OverWrite ( Bool )：存在同名备份是否覆盖，缺省为 false。
    • Compressed ( Bool )：是否开启数据压缩，缺省为 true。

    格式：Compressed: true

    • CompressionType ( String )：压缩格式类型，取值"lz4"、"snappy"和"zlib"，缺省为 "snappy"。

    格式：CompressionType: "zlib"

    • BackupLog ( Bool )：当全量备份时是否需要备份所有日志，缺省为 false。

    格式：BackupLog: false

    返回值

    成功：返回新集合的对象。

    失败：抛出异常。

    backup()函数常见异常如下：

    版本

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

    示例