MySQL :: MySQL NDB 集群 API 开发者指南 :: 3.2.8 备份函数

3.2.8 备份函数

本节提供有关 MGM API 中提供的用于启动和停止 NDB 集群备份的函数的信息。

ndb_mgm_start_backup()

描述

此函数用于启动 NDB 集群的备份。

签名

int ndb_mgm_start_backup
    (
      NdbMgmHandle          handle,
      int                   wait,
      unsigned int*         id,
      struct ndb_mgm_reply* reply
    )

参数

此函数需要以下四个参数

管理服务器 handle（一个 NdbMgmHandle）。
一个 wait 标志，具有以下可能的值
- 0：不等待备份确认。
- 1：等待备份开始。
- 2：等待备份完成。
创建具有备份 ID id 的备份。（这也是函数的返回值。）

如果 wait 设置为 0，则不返回备份 id。
指向 ndb_mgm_reply 结构的指针，用于容纳 reply。

返回值

成功时，返回备份 ID (id)。如果失败，则函数返回 -1。

ndb_mgm_start_backup2()

描述

此函数用于启动 NDB 集群的备份。它与 ndb_mgm_start_backup() 相同，只是它还指定了要用于下一次备份的值。

签名

int ndb_mgm_start_backup
    (
      NdbMgmHandle          handle,
      int                   wait,
      unsigned int*         id,
      struct ndb_mgm_reply* reply,
      unsigned int          nextBackupId
    )

参数

此函数需要以下五个参数

管理服务器 handle（一个 NdbMgmHandle）。
一个 wait 标志，具有以下可能的值
- 0：不等待备份确认。
- 1：等待备份开始。
- 2：等待备份完成。
创建具有备份 ID id 的备份。（这也是函数的返回值。）

如果 wait 设置为 0，则不返回备份 id。
指向 ndb_mgm_reply 结构的指针，用于容纳 reply。
下一次备份的 ID 设置为 nextBackupID + 1 的值。

返回值

成功时，返回作为 id 传递的备份 ID。否则，函数返回 -1。

ndb_mgm_start_backup3()

描述

此函数用于启动 NDB 集群的备份。它与 ndb_mgm_start_backup2() 相同，但添加了一个参数，用于指定备份的状态是与备份开始时集群的状态匹配，还是与备份完成时集群的状态匹配。

签名

int ndb_mgm_start_backup
    (
      NdbMgmHandle          handle,
      int                   wait,
      unsigned int*         id,
      struct ndb_mgm_reply* reply,
      unsigned int          nextBackupId,
      unsigned int          backupPoint
    )

参数

此函数需要以下六个参数

管理服务器 handle（一个 NdbMgmHandle）。
一个 wait 标志，具有以下可能的值
- 0：不等待备份确认。
- 1：等待备份开始。
- 2：等待备份完成。
创建具有备份 ID id 的备份。（这也是函数的返回值。）

如果 wait 设置为 0，则不返回备份 id。
指向 ndb_mgm_reply 结构的指针，用于容纳 reply。
下一次备份的 ID 设置为 nextBackupID + 1 的值。
如果备份的状态应该反映备份开始时集群的状态，则 backupPoint 为 1；如果备份的状态应该反映备份完成时集群的状态，则为 0。使用 1 等效于使用 SNAPSHOTSTART 调用 ndb_mgm 客户端的 START BACKUP 命令；使用 0 等效于使用 SNAPSHOTEND 调用该命令。

返回值

成功时，返回作为 id 传递的备份 ID。否则，函数返回 -1。

ndb_mgm_start_backup4()

描述

此函数用于启动 NDB 集群的备份。它与 ndb_mgm_start_backup3() 相同，只是它使用提供的指定长度的密码生成加密备份。

此函数是在 NDB 8.0.22 中添加的。

签名

int ndb_mgm_start_backup
    (
      NdbMgmHandle          handle,
      int                   wait,
      unsigned int*         id,
      struct ndb_mgm_reply* reply,
      unsigned int          nextBackupId,
      unsigned int          backupPoint,
      const char*           password,
      unsigned int          password_length
    )

参数

此函数需要以下八个参数

管理服务器 handle（一个 NdbMgmHandle）。
一个 wait 标志，具有以下可能的值
- 0：不等待备份确认。
- 1：等待备份开始。
- 2：等待备份完成。
创建具有备份 ID id 的备份。（这也是函数的返回值。）

如果 wait 设置为 0，则不返回备份 id。
指向 ndb_mgm_reply 结构的指针，用于容纳 reply。
下一次备份的 ID 设置为 nextBackupID + 1 的值。
如果备份的状态应该反映备份开始时集群的状态，则 backupPoint 为 1；如果备份的状态应该反映备份完成时集群的状态，则为 0。使用 1 等效于使用 SNAPSHOTSTART 调用 ndb_mgm 客户端的 START BACKUP 命令；使用 0 等效于使用 SNAPSHOTEND 调用该命令。
用于保护加密备份的密码。这是一个长度不超过 256 个字符的字符串；密码字符串中可以使用任何可打印的 ASCII 字符，但 !、'、"、$、%、\ 和 ^ 除外。
密码的长度。

可以指定空密码，但不建议这样做。

返回值

成功时，返回作为 id 传递的备份 ID。否则，函数返回 -1。

ndb_mgm_abort_backup()

描述

此函数用于停止 NDB 集群备份。

签名

int ndb_mgm_abort_backup
    (
      NdbMgmHandle          handle,
      unsigned int          id,
      struct ndb_mgm_reply* reply)

参数

此函数接受 3 个参数

一个 NdbMgmHandle。
要中止的备份的 id。
指向 ndb_mgm_reply 结构的指针。

返回值

如果出现错误，此函数返回 -1。