MySQL NDB Cluster API Developer Guide
This section provides information about the functions provided in the MGM API for starting and stopping NDB Cluster backups.
This function is used to initiate a backup of an NDB Cluster.
int ndb_mgm_start_backup ( NdbMgmHandlehandle
, intwait
, unsigned int*id
, struct ndb_mgm_reply*reply
)
This function requires the four parameters listed here:
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.
Create the backup having backup ID
id
. (This is also the
function's return value.)
No backup id
is returned
if wait
is set equal to
0.
A pointer to an
ndb_mgm_reply
structure to accommodate a
reply
.
On success, the backup ID
(id
). In the event of
failure, the function returns -1
.
This function is used to initiate a backup of an NDB
Cluster. It is the same as
ndb_mgm_start_backup()
,
except that it additionally specifies a value to be used
for the next backup taken.
int ndb_mgm_start_backup ( NdbMgmHandlehandle
, intwait
, unsigned int*id
, struct ndb_mgm_reply*reply
, unsigned intnextBackupId
)
This function requires the five parameters listed here:
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.
Create the backup having backup ID
id
. (This is also the
function's return value.)
No backup id
is returned
if wait
is set equal to
0.
A pointer to an
ndb_mgm_reply
structure to accommodate a
reply
.
The ID of the next backup taken is set to the value
of
.
nextBackupID
+ 1
On success, the backup ID passed as
id
. Otherwise, the function
returns -1
.
This function is used to initiate a backup of an NDB
Cluster. It is the same as
ndb_mgm_start_backup2()
,
but adds an argument for specifying whether the the
state of the backup matches that of the cluster when the
backup is started, or when it is completed.
int ndb_mgm_start_backup ( NdbMgmHandlehandle
, intwait
, unsigned int*id
, struct ndb_mgm_reply*reply
, unsigned intnextBackupId
, unsigned intbackupPoint
)
This function requires the six parameters listed here:
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.
Create the backup having backup ID
id
. (This is also the
function's return value.)
No backup id
is returned
if wait
is set equal to
0.
A pointer to an
ndb_mgm_reply
structure to accommodate a
reply
.
The ID of the next backup taken is set to the value
of
.
nextBackupID
+ 1
backupPoint
is 1 if the
state of the backup should reflect that of the
cluster the time when the backup is started, or 0 if
its state should reflect that of the cluster when
the backup is complete. Using 1 is equivalent to
invoking the ndb_mgm client
START BACKUP
command with SNAPSHOTSTART
; 0 is
equivalent to invoking the command with
SNAPSHOTEND
.
On success, the backup ID passed as
id
. Otherwise, the function
returns -1
.
This function is used to initiate a backup of an NDB
Cluster. It is the same as
ndb_mgm_start_backup3()
,
except that it produces an encrypted backup using the
password provided of the length specified.
This function was added in NDB 8.0.22.
int ndb_mgm_start_backup ( NdbMgmHandlehandle
, intwait
, unsigned int*id
, struct ndb_mgm_reply*reply
, unsigned intnextBackupId
, unsigned intbackupPoint
, const char*password
, unsigned intpassword_length
)
This function requires the eight parameters listed here:
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.
Create the backup having backup ID
id
. (This is also the
function's return value.)
No backup id
is returned
if wait
is set equal to
0.
A pointer to an
ndb_mgm_reply
structure to accommodate a
reply
.
The ID of the next backup taken is set to the value
of
.
nextBackupID
+ 1
backupPoint
is 1 if the
state of the backup should reflect that of the
cluster the time when the backup is started, or 0 if
its state should reflect that of the cluster when
the backup is complete. Using 1 is equivalent to
invoking the ndb_mgm client
START BACKUP
command with SNAPSHOTSTART
; 0 is
equivalent to invoking the command with
SNAPSHOTEND
.
A password used to protect the encrypted backup.
This is a string of up to 256 characters in length;
any printable ASCII characters can be used in the
password string with the exception of
!
, '
,
"
, $
,
%
, \
, and
^
.
The length of the password.
It is possible to specify an empty password, but this is not recommended.
On success, the backup ID passed as
id
. Otherwise, the function
returns -1
.
This function is used to stop an NDB Cluster backup.
int ndb_mgm_abort_backup ( NdbMgmHandlehandle
, unsigned intid
, struct ndb_mgm_reply*reply
)
This function takes 3 parameters:
An NdbMgmHandle
.
The id
of the backup to
be aborted.
A pointer to an
ndb_mgm_reply
structure.
In case of an error, this function returns
-1
.