Author: jstephens
Date: 2006-06-28 03:42:27 +0200 (Wed, 28 Jun 2006)
New Revision: 2533
Log:
MGM API backup functions.
Modified:
trunk/ndbapi/mgm-api.xml
Modified: trunk/ndbapi/mgm-api.xml
===================================================================
--- trunk/ndbapi/mgm-api.xml 2006-06-28 01:20:30 UTC (rev 2532)
+++ trunk/ndbapi/mgm-api.xml 2006-06-28 01:42:27 UTC (rev 2533)
@@ -571,7 +571,7 @@
<title>Description</title>
<para>
- This funciton is used to retrieve the next log event, using
+ This function is used to retrieve the next log event, using
the event's data to fill in the supplied
<literal>ndb_logevent</literal> structure.
</para>
@@ -1242,7 +1242,7 @@
<title>Parameters</title>
<para>
- This funciton takes two arguments:
+ This function takes two arguments:
<itemizedlist>
@@ -1546,7 +1546,7 @@
<title>Description</title>
<para>
- This funciton retrieves the number of the port used by the
+ This function retrieves the number of the port used by the
connection.
</para>
@@ -3361,14 +3361,241 @@
<section id="mgm-api-functions-backup">
- <title>COntrolling Backups</title>
+ <title>Controlling Backups</title>
-<!-- <abstract> -->
+ <abstract>
- <para></para>
+ <para>
+ This section covers the functions provided in the MGM API for
+ starting and stopping backups.
+ </para>
-<!-- </abstract> -->
+ </abstract>
+ <section id="mgm-api-ndb-mgm-start-backup">
+
+ <title><literal>ndb_mgm_start_backup()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This function is used to initiate a backup of a MySQL
+ Cluster.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+int ndb_mgm_start_backup
+ (
+ NdbMgmHandle <replaceable>handle</replaceable>,
+ int <replaceable>wait</replaceable>,
+ unsigned int* <replaceable>id</replaceable>,
+ struct ndb_mgm_reply* <replaceable>reply</replaceable>
+ )
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ This function requires 4 parameters:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ A management server <replaceable>handle</replaceable>
+ (an <literal>NdbMgmHandle</literal>).
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ A <replaceable>wait</replaceable> flag, with the
+ following possible values:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <literal>0</literal>: Do not wait for
+ confirmation of the backup.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>1</literal>: Wait for the backup to be
+ started.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>2</literal>: Wait for the backup to be
+ completed.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ A backup <replaceable>id</replaceable> to be returned
+ by the function.
+ </para>
+
+ <note>
+ <para>
+ No backup <replaceable>id</replaceable> is returned
+ if <replaceable>wait</replaceable> is set equal to
+ 0.
+ </para>
+ </note>
+ </listitem>
+
+ <listitem>
+ <para>
+ A pointer to an <literal>ndb_mgm_reply</literal>
+ structure to accomodate a
+ <replaceable>reply</replaceable>. See
+ <xref linkend="struct-ndb-mgm-reply"/>.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ In the event of failure, the function returns
+ <literal>-1</literal>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="mgm-api-ndb-mgm-abort-backup">
+
+ <title><literal>ndb_mgm_abort_backup()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This function is used to stop a Cluster backup.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+int ndb_mgm_abort_backup
+ (
+ NdbMgmHandle <replaceable>handle</replaceable>,
+ unsigned int <replaceable>id</replaceable>,
+ struct ndb_mgm_reply* <replaceable>reply</replaceable>)
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ This function takes 3 parameters:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ An <literal>NdbMgmHandle</literal>.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The <replaceable>id</replaceable> of the backup to be
+ aborted.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ A pointer to an <literal>ndb_mgm_reply</literal>
+ structure.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ In case an error, this function returns
+ <literal>-1</literal>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
</section>
<section id="mgm-api-functions-single-user-mode">
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r2533 - trunk/ndbapi | jon | 28 Jun |
