Documentation Home
MySQL NDB Cluster API Developer Guide
Download this Manual ndb_mgm_start_backup()

Description.  This function is used to initiate a backup of an NDB Cluster.


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

Parameters.  This function requires 4 parameters:

  • A management server handle (an NdbMgmHandle).

  • A wait flag, with the following possible values:

    • 0: Do not wait for confirmation of the backup.

    • 1: Wait for the backup to be started.

    • 2: Wait for the backup to be completed.

  • A backup id to be returned by the function.


    No backup id is returned if wait is set equal to 0.

  • A pointer to an ndb_mgm_reply structure to accommodate a reply.

Return value.  In the event of failure, the function returns -1.