Author: jstephens
Date: 2007-02-08 10:21:53 +0100 (Thu, 08 Feb 2007)
New Revision: 4854
Log:
Reformat.
Modified:
branches/telcos/refman-5.1/news-5.1.xml
trunk/ndbapi/mgm-api.xml
trunk/refman-5.0/releasenotes-es-5.0.xml
trunk/refman-5.1/news-5.1.xml
Modified: branches/telcos/refman-5.1/news-5.1.xml
===================================================================
--- branches/telcos/refman-5.1/news-5.1.xml 2007-02-08 09:18:33 UTC (rev 4853)
+++ branches/telcos/refman-5.1/news-5.1.xml 2007-02-08 09:21:53 UTC (rev 4854)
Changed blocks: 4, Lines Added: 27, Lines Deleted: 23; 3452 bytes
@@ -34,15 +34,17 @@
To insert a new changelog subsection, use the
<filename>TEMPLATE.news.xml</filename> template in the
<filename>refman-common</filename> directory.
- </remark><section id="news-5-1-15-ndb-6-1-2">
-
+ </remark>
+
+ <section id="news-5-1-15-ndb-6-1-2">
+
<title>Changes in release MySQL 5.1.15/NDB-6.1.2-beta (07 February 2007)</title>
-
+
<para role="release-level">
- This is a new Beta development release, fixing a recently discovered
- bug.
+ This is a new Beta development release, fixing a recently
+ discovered bug.
</para>
-
+
<para role="release-non-production">
<emphasis role="bold">NOTE</emphasis>: Although MySQL has worked
very hard to ensure a high level of quality, protect your data by
@@ -50,28 +52,30 @@
refer to our bug database at <ulink url="http://bugs.mysql.com/"/>
for more details about the individual bugs fixed in this version.
</para>
-
+
<para>
This is the third MySQL ¤t-series; Beta release. It is a
hotfix release, made to resolve a single critical issue which
- occurred in MySQL 5.1.15/NDB-6.1.1-beta. It incorporates
- all bugfixes and feature changes made in MySQL 5.1.14/NDB-6.1.0
- and MySQL 5.1.15/NDB-6.1.1. This version also incorporates all
+ occurred in MySQL 5.1.15/NDB-6.1.1-beta. It incorporates all
+ bugfixes and feature changes made in MySQL 5.1.14/NDB-6.1.0 and
+ MySQL 5.1.15/NDB-6.1.1. This version also incorporates all
bugfixes and feature changes which were added in the mainline
- 5.1.15 release; information about these can be found in
+ 5.1.15 release; information about these can be found in
<xref linkend="news-5-1-15"/>.
</para>
-
+
<important>
<formalpara>
<title>Upgrading to MySQL 5.1.15/NDB-6.1.2 from a previous release</title>
-
+
+
+
<para>
This release is not binary compatible with any previous
releases. This means that:
-
+
<itemizedlist>
-
+
<listitem>
<para>
You cannot perform an online upgrade to this release
@@ -81,7 +85,7 @@
cluster.
</para>
</listitem>
-
+
<listitem>
<para>
You must recompile any MySQL Cluster API applications
@@ -89,32 +93,32 @@
includes all NDB API and MGM API applications.
</para>
</listitem>
-
+
</itemizedlist>
</para>
</formalpara>
</important>
-
+
<para>
This release fixes a single critical bug:
</para>
-
+
<itemizedlist>
-
+
<listitem>
<para>
Using high node IDs could sometimes lead to incorrect memory
access and a subsequent forced shutdown of the cluster.
</para>
-
+
<para>
This issue was not entered into the MySQL Bugs database;
hence, there is no bug number associated with it.
</para>
</listitem>
-
+
</itemizedlist>
-
+
</section>
<section id="news-5-1-15-ndb-6-1-1">
Modified: trunk/ndbapi/mgm-api.xml
===================================================================
--- trunk/ndbapi/mgm-api.xml 2007-02-08 09:18:33 UTC (rev 4853)
+++ trunk/ndbapi/mgm-api.xml 2007-02-08 09:21:53 UTC (rev 4854)
Changed blocks: 144, Lines Added: 364, Lines Deleted: 364; 44777 bytes
@@ -269,21 +269,22 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
This function is used to listen to log events, which are
read from the return file descriptor. Events use a
text-based format, the same as in the cluster log.
</para>
-
</formalpara>
<formalpara>
-
<title>Signature</title>
+
+
<para>
<programlisting>
int ndb_mgm_listen_event
@@ -293,13 +294,13 @@
)
</programlisting>
</para>
-
</formalpara>
<formalpara>
-
<title>Parameters</title>
+
+
<para>
This function takes two arguments:
@@ -325,17 +326,16 @@
</itemizedlist>
</para>
-
</formalpara>
<formalpara>
-
<title>Return Value</title>
+
+
<para>
The file descriptor from which events are to be read.
</para>
-
</formalpara>
<!--
@@ -367,19 +367,20 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
This function is used to create a log event handle.
</para>
-
</formalpara>
<formalpara>
-
<title>Signature</title>
+
+
<para>
<programlisting>
NdbLogEventHandle ndb_mgm_create_logevent_handle
@@ -389,13 +390,13 @@
)
</programlisting>
</para>
-
</formalpara>
<formalpara>
-
<title>Parameters</title>
+
+
<para>
This function takes two arguments:
@@ -421,17 +422,16 @@
</itemizedlist>
</para>
-
</formalpara>
<formalpara>
-
<title>Return Value</title>
+
+
<para>
A log event handle.
</para>
-
</formalpara>
<!--
@@ -459,20 +459,21 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
Use this function to destroy a log event handle when there
is no further need for it.
</para>
-
</formalpara>
<formalpara>
-
<title>Signature</title>
+
+
<para>
<programlisting>
void ndb_mgm_destroy_logevent_handle
@@ -481,27 +482,26 @@
)
</programlisting>
</para>
-
</formalpara>
<formalpara>
-
<title>Parameters</title>
+
+
<para>
A pointer to a log event <replaceable>handle</replaceable>.
</para>
-
</formalpara>
<formalpara>
-
<title>Return Value</title>
+
+
<para>
<emphasis>None</emphasis>.
</para>
-
</formalpara>
<!--
@@ -529,15 +529,15 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
This function retrieves a file descriptor from an
<literal>NdbMgmLogEventHandle</literal>. It was implemented
in MySQL 5.1.12.
</para>
-
</formalpara>
<warning>
@@ -548,9 +548,10 @@
</warning>
<formalpara>
-
<title>Signature</title>
+
+
<para>
<programlisting>
int ndb_logevent_get_fd
@@ -559,28 +560,27 @@
)
</programlisting>
</para>
-
</formalpara>
<formalpara>
-
<title>Parameters</title>
+
+
<para>
A <literal>LogEventHandle</literal>.
</para>
-
</formalpara>
<formalpara>
-
<title>Return Value</title>
+
+
<para>
A file descriptor. In the event of failure,
<literal>-1</literal> is returned.
</para>
-
</formalpara>
<!--
@@ -608,21 +608,22 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
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>
-
</formalpara>
<formalpara>
-
<title>Signature</title>
+
+
<para>
<programlisting>
int ndb_logevent_get_next
@@ -633,13 +634,13 @@
)
</programlisting>
</para>
-
</formalpara>
<formalpara>
-
<title>Parameters</title>
+
+
<para>
Three parameters are expected by this functions:
@@ -667,13 +668,13 @@
</itemizedlist>
</para>
-
</formalpara>
<formalpara>
-
<title>Return Value</title>
+
+
<para>
The value returned by this function is interpreted as
follows:
@@ -709,7 +710,6 @@
<replaceable>logevent</replaceable> is not altered or
affected in any way.
</para>
-
</formalpara>
<!--
@@ -737,14 +737,14 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
This function retrieves the error code from the most recent
error.
</para>
-
</formalpara>
<note>
@@ -757,9 +757,10 @@
</note>
<formalpara>
-
<title>Signature</title>
+
+
<para>
<programlisting>
int ndb_logevent_get_latest_error
@@ -768,27 +769,26 @@
)
</programlisting>
</para>
-
</formalpara>
<formalpara>
-
<title>Parameters</title>
+
+
<para>
A log event handle.
</para>
-
</formalpara>
<formalpara>
-
<title>Return Value</title>
+
+
<para>
An error code.
</para>
-
</formalpara>
<!--
@@ -817,20 +817,21 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
Retrieves the text of the most recent error obtained while
trying to read log events.
</para>
-
</formalpara>
<formalpara>
-
<title>Signature</title>
+
+
<para>
<programlisting>
const char* ndb_logevent_get_latest_error_msg
@@ -839,27 +840,26 @@
)
</programlisting>
</para>
-
</formalpara>
<formalpara>
-
<title>Parameters</title>
+
+
<para>
A log event handle.
</para>
-
</formalpara>
<formalpara>
-
<title>Return Value</title>
+
+
<para>
The text of the error message.
</para>
-
</formalpara>
<!--
@@ -909,20 +909,21 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
This function is used to get the latest error code
associated with a given management server handle.
</para>
-
</formalpara>
<formalpara>
-
<title>Signature</title>
+
+
<para>
<programlisting>
int ndb_mgm_get_latest_error
@@ -931,23 +932,23 @@
)
</programlisting>
</para>
-
</formalpara>
<formalpara>
-
<title>Parameters</title>
+
+
<para>
An <literal>NdbMgMHandle</literal>.
</para>
-
</formalpara>
<formalpara>
-
<title>Return Value</title>
+
+
<para>
An error code corresponding to an
<literal>ndb_mgm_error</literal> value; see
@@ -956,7 +957,6 @@
<literal>ndb_mgm_get_latest_error_msg()</literal>; see
<xref linkend="ndb-mgm-get-latest-error-msg"/>.
</para>
-
</formalpara>
<!--
@@ -984,20 +984,21 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
This function is used to obtain the latest general error
message associated with an <literal>NdbMgmHandle</literal>.
</para>
-
</formalpara>
<formalpara>
-
<title>Signature</title>
+
+
<para>
<programlisting>
const char* ndb_mgm_get_latest_error_msg
@@ -1006,23 +1007,23 @@
)
</programlisting>
</para>
-
</formalpara>
<formalpara>
-
<title>Parameters</title>
+
+
<para>
An <literal>NdbMgmHandle</literal>.
</para>
-
</formalpara>
<formalpara>
-
<title>Return Value</title>
+
+
<para>
The error message text. More specific information can be
obtained using
@@ -1030,7 +1031,6 @@
<xref linkend="ndb-mgm-get-latest-error-desc"/>, for
details.
</para>
-
</formalpara>
<!--
@@ -1058,21 +1058,22 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
Get the most recent error description associated with an
<literal>NdbMgmHandle</literal>; this description provides
additional information regarding the error message.
</para>
-
</formalpara>
<formalpara>
-
<title>Signature</title>
+
+
<para>
<programlisting>
const char* ndb_mgm_get_latest_error_desc
@@ -1081,27 +1082,26 @@
)
</programlisting>
</para>
-
</formalpara>
<formalpara>
-
<title>Parameters</title>
+
+
<para>
An <literal>NdbMgmHandle</literal>.
</para>
-
</formalpara>
<formalpara>
-
<title>Return Value</title>
+
+
<para>
The error description text.
</para>
-
</formalpara>
<!--
@@ -1129,19 +1129,20 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
The function can be used to set the error output stream.
</para>
-
</formalpara>
<formalpara>
-
<title>Signature</title>
+
+
<para>
<programlisting>
void ndb_mgm_set_error_stream
@@ -1151,13 +1152,13 @@
)
</programlisting>
</para>
-
</formalpara>
<formalpara>
-
<title>Parameters</title>
+
+
<para>
This function requires two parameters:
@@ -1177,17 +1178,16 @@
</itemizedlist>
</para>
-
</formalpara>
<formalpara>
-
<title>Return Value</title>
+
+
<para>
<emphasis>None</emphasis>.
</para>
-
</formalpara>
<!--
@@ -1230,20 +1230,21 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
This function is used to create a handle to a management
server.
</para>
-
</formalpara>
<formalpara>
-
<title>Signature</title>
+
+
<para>
<programlisting>
NdbMgmHandle ndb_mgm_create_handle
@@ -1252,27 +1253,26 @@
)
</programlisting>
</para>
-
</formalpara>
<formalpara>
-
<title>Parameters</title>
+
+
<para>
<emphasis>None</emphasis>.
</para>
-
</formalpara>
<formalpara>
-
<title>Return Value</title>
+
+
<para>
An <literal>NdbMgmHandle</literal>.
</para>
-
</formalpara>
<!--
@@ -1300,20 +1300,21 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
This function can be used to set a name for the management
server handle, which is then reported in the Cluster log.
</para>
-
</formalpara>
<formalpara>
-
<title>Signature</title>
+
+
<para>
<programlisting>
void ndb_mgm_set_name
@@ -1323,13 +1324,13 @@
)
</programlisting>
</para>
-
</formalpara>
<formalpara>
-
<title>Parameters</title>
+
+
<para>
This function takes two arguments:
@@ -1350,17 +1351,16 @@
</itemizedlist>
</para>
-
</formalpara>
<formalpara>
-
<title>Return Value</title>
+
+
<para>
<emphasis>None</emphasis>.
</para>
-
</formalpara>
<!--
@@ -1388,19 +1388,20 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
This function destroys a management server handle
</para>
-
</formalpara>
<formalpara>
-
<title>Signature</title>
+
+
<para>
<programlisting>
void ndb_mgm_destroy_handle
@@ -1409,28 +1410,27 @@
)
</programlisting>
</para>
-
</formalpara>
<formalpara>
-
<title>Parameters</title>
+
+
<para>
A pointer to the <literal>NdbMgmHandle</literal> to be
destroyed.
</para>
-
</formalpara>
<formalpara>
-
<title>Return Value</title>
+
+
<para>
<emphasis>None</emphasis>.
</para>
-
</formalpara>
<!--
@@ -1474,14 +1474,14 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
This function retrieves the connectstring used for a
connection.
</para>
-
</formalpara>
<note>
@@ -1500,9 +1500,10 @@
</note>
<formalpara>
-
<title>Signature</title>
+
+
<para>
<programlisting>
const char* ndb_mgm_get_connectstring
@@ -1513,13 +1514,13 @@
)
</programlisting>
</para>
-
</formalpara>
<formalpara>
-
<title>Parameters</title>
+
+
<para>
This function takes three arguments:
@@ -1546,18 +1547,17 @@
</itemizedlist>
</para>
-
</formalpara>
<formalpara>
-
<title>Return Value</title>
+
+
<para>
The connectstring — this is the same value that is
pushed to the <replaceable>buffer</replaceable>.
</para>
-
</formalpara>
<!--
@@ -1585,20 +1585,21 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
This function gets the ID of the node to which the
connection is being (or was) made.
</para>
-
</formalpara>
<formalpara>
-
<title>Signature</title>
+
+
<para>
<programlisting>
int ndb_mgm_get_configuration_nodeid
@@ -1607,27 +1608,26 @@
)
</programlisting>
</para>
-
</formalpara>
<formalpara>
-
<title>Parameters</title>
+
+
<para>
A management server handle.
</para>
-
</formalpara>
<formalpara>
-
<title>Return Value</title>
+
+
<para>
A node ID.
</para>
-
</formalpara>
<!--
@@ -1655,20 +1655,21 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
This function retrieves the number of the port used by the
connection.
</para>
-
</formalpara>
<formalpara>
-
<title>Signature</title>
+
+
<para>
<programlisting>
int ndb_mgm_get_connected_port
@@ -1677,27 +1678,26 @@
)
</programlisting>
</para>
-
</formalpara>
<formalpara>
-
<title>Parameters</title>
+
+
<para>
An <literal>NdbMgmHandle</literal>.
</para>
-
</formalpara>
<formalpara>
-
<title>Return Value</title>
+
+
<para>
A port number.
</para>
-
</formalpara>
<!--
@@ -1725,20 +1725,21 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
This function is used to obtain the name of the host to
which the connection is made.
</para>
-
</formalpara>
<formalpara>
-
<title>Signature</title>
+
+
<para>
<programlisting>
const char* ndb_mgm_get_connected_host
@@ -1747,27 +1748,26 @@
)
</programlisting>
</para>
-
</formalpara>
<formalpara>
-
<title>Parameters</title>
+
+
<para>
A management server <replaceable>handle</replaceable>.
</para>
-
</formalpara>
<formalpara>
-
<title>Return Value</title>
+
+
<para>
A hostname.
</para>
-
</formalpara>
<!--
@@ -1795,19 +1795,20 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
Used to determine whether a connection has been established.
</para>
-
</formalpara>
<formalpara>
-
<title>Signature</title>
+
+
<para>
<programlisting>
int ndb_mgm_is_connected
@@ -1816,23 +1817,23 @@
)
</programlisting>
</para>
-
</formalpara>
<formalpara>
-
<title>Parameters</title>
+
+
<para>
A management server <replaceable>handle</replaceable>.
</para>
-
</formalpara>
<formalpara>
-
<title>Return Value</title>
+
+
<para>
This function returns an integer, whose value is interpreted
as follows:
@@ -1855,7 +1856,6 @@
</itemizedlist>
</para>
-
</formalpara>
<!--
@@ -1883,20 +1883,21 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
This function is used to set the connectstring for a
management server connection to a node.
</para>
-
</formalpara>
<formalpara>
-
<title>Signature</title>
+
+
<para>
<programlisting>
int ndb_mgm_set_connectstring
@@ -1906,13 +1907,13 @@
)
</programlisting>
</para>
-
</formalpara>
<formalpara>
-
<title>Parameters</title>
+
+
<para>
<literal>ndb_mgm_set_connectstring()</literal> takes two
parameters:
@@ -1981,18 +1982,17 @@
<xref linkend="ndb-mgm-get-connectstring"/> also uses this
format for connectstrings.
</para>
-
</formalpara>
<formalpara>
-
<title>Return Value</title>
+
+
<para>
This function returns <literal>-1</literal> in the event of
failure.
</para>
-
</formalpara>
<!--
@@ -2020,19 +2020,20 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
This function sets the connection node ID.
</para>
-
</formalpara>
<formalpara>
-
<title>Signature</title>
+
+
<para>
<programlisting>
int ndb_mgm_set_configuration_nodeid
@@ -2042,13 +2043,13 @@
)
</programlisting>
</para>
-
</formalpara>
<formalpara>
-
<title>Parameters</title>
+
+
<para>
This function requires two parameters:
@@ -2068,18 +2069,17 @@
</itemizedlist>
</para>
-
</formalpara>
<formalpara>
-
<title>Return Value</title>
+
+
<para>
This function returns <literal>-1</literal> in the event of
failure.
</para>
-
</formalpara>
<!--
@@ -2107,21 +2107,22 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
This function establishes a connection to a management
server specified by the connectstring set by
<xref linkend="ndb-mgm-set-connectstring"/>.
</para>
-
</formalpara>
<formalpara>
-
<title>Signature</title>
+
+
<para>
<programlisting>
int ndb_mgm_connect
@@ -2133,13 +2134,13 @@
)
</programlisting>
</para>
-
</formalpara>
<formalpara>
-
<title>Parameters</title>
+
+
<para>
This function takes 4 arguments:
@@ -2176,18 +2177,17 @@
</itemizedlist>
</para>
-
</formalpara>
<formalpara>
-
<title>Return Value</title>
+
+
<para>
This function returns <literal>-1</literal> in the event of
failure.
</para>
-
</formalpara>
<!--
@@ -2215,19 +2215,20 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
This function terminates a management server connection.
</para>
-
</formalpara>
<formalpara>
-
<title>Signature</title>
+
+
<para>
<programlisting>
int ndb_mgm_disconnect
@@ -2236,27 +2237,26 @@
)
</programlisting>
</para>
-
</formalpara>
<formalpara>
-
<title>Parameters</title>
+
+
<para>
An <literal>NdbMgmHandle</literal>.
</para>
-
</formalpara>
<formalpara>
-
<title>Return Value</title>
+
+
<para>
Returns <literal>-1</literal> if unable to disconnect.
</para>
-
</formalpara>
<!--
@@ -2299,14 +2299,14 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
This function is used to obtain the status of the nodes in
an <literal>NDB</literal> Cluster.
</para>
-
</formalpara>
<note>
@@ -2316,9 +2316,10 @@
</note>
<formalpara>
-
<title>Signature</title>
+
+
<para>
<programlisting>
struct ndb_mgm_cluster_state* ndb_mgm_get_status
@@ -2327,31 +2328,30 @@
)
</programlisting>
</para>
-
</formalpara>
<formalpara>
-
<title>Parameters</title>
+
+
<para>
This function takes a single parameter — a management
server <replaceable>handle</replaceable>.
</para>
-
</formalpara>
<formalpara>
-
<title>Return Value</title>
+
+
<para>
A pointer to an <literal>ndb_mgm_cluster_state</literal>
data structure. See
<xref linkend="struct-ndb-mgm-cluster-state"/>, for more
information.
</para>
-
</formalpara>
<!--
@@ -2387,9 +2387,10 @@
</abstract>
<formalpara>
-
<title>Starting, Stopping, and Restarting Nodes</title>
+
+
<para>
You can start, stop, and restart Cluster nodes using the
following functions:
@@ -2398,41 +2399,41 @@
<listitem>
<formalpara>
-
<title>Starting Nodes</title>
+
+
<para>
Use <literal>ndb_mgm_start()</literal>.
</para>
-
</formalpara>
</listitem>
<listitem>
<formalpara>
-
<title>Stopping Nodes</title>
+
+
<para>
Use <literal>ndb_mgm_stop()</literal>,
<literal>ndb_mgm_stop2()</literal>, or
<literal>ndb_mgm_stop3()</literal>.
</para>
-
</formalpara>
</listitem>
<listitem>
<formalpara>
-
<title>Restarting Nodes</title>
+
+
<para>
Use <literal>ndb_mgm_restart()</literal>,
<literal>ndb_mgm_restart2()</literal>, or
<literal>ndb_mgm_restart3()</literal>.
</para>
-
</formalpara>
</listitem>
@@ -2440,7 +2441,6 @@
These functions are detailed in the next few sections.
</para>
-
</formalpara>
<section id="ndb-mgm-start">
@@ -2452,9 +2452,10 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
This function can be used to start one or more Cluster
nodes. The nodes to be started must have been started with
@@ -2463,13 +2464,13 @@
<literal>START</literal> management command which actually
enables the node.
</para>
-
</formalpara>
<formalpara>
-
<title>Signature</title>
+
+
<para>
<programlisting>
int ndb_mgm_start
@@ -2480,13 +2481,13 @@
)
</programlisting>
</para>
-
</formalpara>
<formalpara>
-
<title>Parameters</title>
+
+
<para>
ndb_mgm_start() takes 3 parameters:
@@ -2515,18 +2516,17 @@
</itemizedlist>
</para>
-
</formalpara>
<formalpara>
-
<title>Return Value</title>
+
+
<para>
The number of nodes actually started; in the event of
failure, <literal>-1</literal> is returned.
</para>
-
</formalpara>
<!--
@@ -2554,19 +2554,20 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
This function stops one or more data nodes.
</para>
-
</formalpara>
<formalpara>
-
<title>Signature</title>
+
+
<para>
<programlisting>
int ndb_mgm_stop
@@ -2577,13 +2578,13 @@
)
</programlisting>
</para>
-
</formalpara>
<formalpara>
-
<title>Parameters</title>
+
+
<para>
ndb_mgm_stop() takes 3 parameters:
@@ -2618,18 +2619,17 @@
<replaceable>list</replaceable>, 0)</literal>. See
<xref linkend="ndb-mgm-stop2"/>.
</para>
-
</formalpara>
<formalpara>
-
<title>Return Value</title>
+
+
<para>
The number of nodes actually stopped; in the event of
failure, <literal>-1</literal> is returned.
</para>
-
</formalpara>
<!--
@@ -2657,21 +2657,22 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
Like <literal>ndb_mgm_stop()</literal>, this function stops
one or more data nodes. However, it offers the ability to
specify whether or not the nodes shut down gracefully.
</para>
-
</formalpara>
<formalpara>
-
<title>Signature</title>
+
+
<para>
<programlisting>
int ndb_mgm_stop2
@@ -2683,13 +2684,13 @@
)
</programlisting>
</para>
-
</formalpara>
<formalpara>
-
<title>Parameters</title>
+
+
<para>
ndb_mgm_stop2() takes 4 parameters:
@@ -2728,18 +2729,17 @@
</itemizedlist>
</para>
-
</formalpara>
<formalpara>
-
<title>Return Value</title>
+
+
<para>
The number of nodes actually stopped; in the event of
failure, <literal>-1</literal> is returned.
</para>
-
</formalpara>
<!--
@@ -2767,9 +2767,10 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
Like <literal>ndb_mgm_stop()</literal> and
<literal>ndb_mgm_stop2()</literal>, this function stops one
@@ -2779,13 +2780,13 @@
check to see whether disconnection is required prior to
stopping a node.
</para>
-
</formalpara>
<formalpara>
-
<title>Signature</title>
+
+
<para>
<programlisting>
int ndb_mgm_stop3
@@ -2798,13 +2799,13 @@
)
</programlisting>
</para>
-
</formalpara>
<formalpara>
-
<title>Parameters</title>
+
+
<para>
ndb_mgm_stop3() takes 5 parameters:
@@ -2854,18 +2855,17 @@
</itemizedlist>
</para>
-
</formalpara>
<formalpara>
-
<title>Return Value</title>
+
+
<para>
The number of nodes actually stopped; in the event of
failure, <literal>-1</literal> is returned.
</para>
-
</formalpara>
<!--
@@ -2893,20 +2893,21 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
This function can be used to restart one or more Cluster
data nodes.
</para>
-
</formalpara>
<formalpara>
-
<title>Signature</title>
+
+
<para>
<programlisting>
int ndb_mgm_restart
@@ -2917,13 +2918,13 @@
)
</programlisting>
</para>
-
</formalpara>
<formalpara>
-
<title>Parameters</title>
+
+
<para>
ndb_mgm_restart() takes 3 parameters:
@@ -2961,18 +2962,17 @@
See <xref linkend="ndb-mgm-restart2"/>, for more
information.
</para>
-
</formalpara>
<formalpara>
-
<title>Return Value</title>
+
+
<para>
The number of nodes actually restarted;
<literal>-1</literal> on failure.
</para>
-
</formalpara>
<!--
@@ -3000,9 +3000,10 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
Like <literal>ndb_mgm_restart()</literal>, this function can
be used to restart one or more Cluster data nodes. However,
@@ -3010,13 +3011,13 @@
restart options, including initial restart, waiting start,
and immediate (forced) restart.
</para>
-
</formalpara>
<formalpara>
-
<title>Signature</title>
+
+
<para>
<programlisting>
int ndb_mgm_restart2
@@ -3030,13 +3031,13 @@
)
</programlisting>
</para>
-
</formalpara>
<formalpara>
-
<title>Parameters</title>
+
+
<para>
ndb_mgm_restart2() takes 6 parameters:
@@ -3090,18 +3091,17 @@
</itemizedlist>
</para>
-
</formalpara>
<formalpara>
-
<title>Return Value</title>
+
+
<para>
The number of nodes actually restarted;
<literal>-1</literal> on failure.
</para>
-
</formalpara>
<!--
@@ -3129,9 +3129,10 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
Like <literal>ndb_mgm_restart2()</literal>, this function
can be used to cause an initial restart, waiting restart,
@@ -3140,13 +3141,13 @@
provides additional the additional options of checking
whether disconnection is required prior to the restart.
</para>
-
</formalpara>
<formalpara>
-
<title>Signature</title>
+
+
<para>
<programlisting>
int ndb_mgm_restart3
@@ -3161,13 +3162,13 @@
)
</programlisting>
</para>
-
</formalpara>
<formalpara>
-
<title>Parameters</title>
+
+
<para>
ndb_mgm_restart() takes 7 parameters:
@@ -3232,18 +3233,17 @@
</itemizedlist>
</para>
-
</formalpara>
<formalpara>
-
<title>Return Value</title>
+
+
<para>
The number of nodes actually restarted;
<literal>-1</literal> on failure.
</para>
-
</formalpara>
<!--
@@ -3287,14 +3287,14 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
This function is used to retrieve the cluster log severity
filter currently in force.
</para>
-
</formalpara>
<important>
@@ -3315,9 +3315,10 @@
</important>
<formalpara>
-
<title>Signature</title>
+
+
<para>
As of MySQL 5.1.14:
@@ -3340,13 +3341,13 @@
)
</programlisting>
</para>
-
</formalpara>
<formalpara>
-
<title>Parameters</title>
+
+
<para>
This function added two new parameters in MySQL 5.1.14.
@@ -3407,13 +3408,13 @@
</itemizedlist>
</para>
-
</formalpara>
<formalpara>
-
<title>Return Value</title>
+
+
<para>
This function's return type changed beginning with MySQL
5.1.14.
@@ -3454,7 +3455,6 @@
</itemizedlist>
</para>
-
</formalpara>
<!--
@@ -3483,19 +3483,20 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
This function is used to set a cluster log severity filter.
</para>
-
</formalpara>
<formalpara>
-
<title>Signature</title>
+
+
<para>
<programlisting>
int ndb_mgm_set_clusterlog_severity_filter
@@ -3507,13 +3508,13 @@
)
</programlisting>
</para>
-
</formalpara>
<formalpara>
-
<title>Parameters</title>
+
+
<para>
This function takes 4 parameters:
@@ -3550,18 +3551,17 @@
</itemizedlist>
</para>
-
</formalpara>
<formalpara>
-
<title>Return Value</title>
+
+
<para>
The function returns <literal>-1</literal> in the event of
failure.
</para>
-
</formalpara>
<!--
@@ -3594,9 +3594,10 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
This function, added in MySQL 5.1.16, is used to obtain log
category and level information. It replaces the older
@@ -3605,13 +3606,13 @@
thread-safe. (See later in this section for a brief
description of the deprecated version of the function.)
</para>
-
</formalpara>
<formalpara>
-
<title>Signature</title>
+
+
<para>
<programlisting>
int ndb_mgm_get_clusterlog_loglevel
@@ -3622,13 +3623,13 @@
)
</programlisting>
</para>
-
</formalpara>
<formalpara>
-
<title>Parameters</title>
+
+
<para>
<literal>ndb_mgm_get_clusterlog_loglevel()</literal> takes
the following parameters:
@@ -3661,18 +3662,17 @@
</itemizedlist>
</para>
-
</formalpara>
<formalpara>
-
<title>Return Value</title>
+
+
<para>
This function returns the number of returned loglevels or
<literal>-1</literal> in the event of an error.
</para>
-
</formalpara>
<note>
@@ -3721,20 +3721,21 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
This function is used to set the log category and levels for
the cluster log.
</para>
-
</formalpara>
<formalpara>
-
<title>Signature</title>
+
+
<para>
<programlisting>
int ndb_mgm_set_clusterlog_loglevel
@@ -3746,13 +3747,13 @@
struct ndb_mgm_reply* <replaceable>reply</replaceable>)
</programlisting>
</para>
-
</formalpara>
<formalpara>
-
<title>Parameters</title>
+
+
<para>
This function takes 5 parameters:
@@ -3795,18 +3796,17 @@
</itemizedlist>
</para>
-
</formalpara>
<formalpara>
-
<title>Return Value</title>
+
+
<para>
In the event of an error, this function returns
<literal>-1</literal>.
</para>
-
</formalpara>
<!--
@@ -3849,20 +3849,21 @@
</indexterm>
<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
@@ -3874,13 +3875,13 @@
)
</programlisting>
</para>
-
</formalpara>
<formalpara>
-
<title>Parameters</title>
+
+
<para>
This function requires 4 parameters:
@@ -3951,18 +3952,17 @@
</itemizedlist>
</para>
-
</formalpara>
<formalpara>
-
<title>Return Value</title>
+
+
<para>
In the event of failure, the function returns
<literal>-1</literal>.
</para>
-
</formalpara>
<!--
@@ -3990,19 +3990,20 @@
</indexterm>
<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
@@ -4012,13 +4013,13 @@
struct ndb_mgm_reply* <replaceable>reply</replaceable>)
</programlisting>
</para>
-
</formalpara>
<formalpara>
-
<title>Parameters</title>
+
+
<para>
This function takes 3 parameters:
@@ -4046,18 +4047,17 @@
</itemizedlist>
</para>
-
</formalpara>
<formalpara>
-
<title>Return Value</title>
+
+
<para>
In case an error, this function returns
<literal>-1</literal>.
</para>
-
</formalpara>
<!--
@@ -4102,20 +4102,21 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
This function is used to enter single-user mode on a given
node.
</para>
-
</formalpara>
<formalpara>
-
<title>Signature</title>
+
+
<para>
<programlisting>
int ndb_mgm_enter_single_user
@@ -4126,13 +4127,13 @@
)
</programlisting>
</para>
-
</formalpara>
<formalpara>
-
<title>Parameters</title>
+
+
<para>
This function takes 3 parameters:
@@ -4161,17 +4162,16 @@
</itemizedlist>
</para>
-
</formalpara>
<formalpara>
-
<title>Return Value</title>
+
+
<para>
Returns <literal>-1</literal> in the event of failure.
</para>
-
</formalpara>
<!--
@@ -4199,20 +4199,21 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
This function is used to exit single-user mode and to return
to normal operation.
</para>
-
</formalpara>
<formalpara>
-
<title>Signature</title>
+
+
<para>
<programlisting>
int ndb_mgm_exit_single_user
@@ -4222,13 +4223,13 @@
)
</programlisting>
</para>
-
</formalpara>
<formalpara>
-
<title>Parameters</title>
+
+
<para>
This function requires 2 arguments:
@@ -4248,17 +4249,16 @@
</itemizedlist>
</para>
-
</formalpara>
<formalpara>
-
<title>Return Value</title>
+
+
<para>
Returns <literal>-1</literal> in case of an error.
</para>
-
</formalpara>
<!--
@@ -4314,20 +4314,21 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
This is used to classify the different types of nodes in a
MySQL Cluster.
</para>
-
</formalpara>
<formalpara>
-
<title>Enumeration Values</title>
+
+
<para>
<informaltable>
<tgroup cols="2">
@@ -4360,7 +4361,6 @@
</tgroup>
</informaltable>
</para>
-
</formalpara>
</section>
@@ -4374,19 +4374,20 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
This type describes a Cluster node's status.
</para>
-
</formalpara>
<formalpara>
-
<title>Enumeration Values</title>
+
+
<para>
<informaltable>
<tgroup cols="2">
@@ -4439,7 +4440,6 @@
</tgroup>
</informaltable>
</para>
-
</formalpara>
</section>
@@ -4453,20 +4453,21 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
The values for this type are the error codes that may be
generated by MGM API functions.
</para>
-
</formalpara>
<formalpara>
-
<title>Enumeration Values</title>
+
+
<para>
<informaltable>
<tgroup cols="3">
@@ -4605,7 +4606,6 @@
</tgroup>
</informaltable>
</para>
-
</formalpara>
<para>
@@ -4623,21 +4623,22 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
These are the types of log event events available in the MGM
API, grouped by event category. (See
<xref linkend="ndb-mgm-event-category"/>.)
</para>
-
</formalpara>
<formalpara>
-
<title>Enumeration Values</title>
+
+
<para>
<informaltable>
<tgroup cols="3">
@@ -5006,7 +5007,6 @@
</tgroup>
</informaltable>
</para>
-
</formalpara>
</section>
@@ -5020,9 +5020,10 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
These are the log event severities used to filter the cluster
log by
@@ -5030,13 +5031,13 @@
and to filter listening to events by
<literal>ndb_mgm_listen_event()</literal>.
</para>
-
</formalpara>
<formalpara>
-
<title>Enumeration Values</title>
+
+
<para>
<informaltable>
<tgroup cols="2">
@@ -5091,7 +5092,6 @@
</tgroup>
</informaltable>
</para>
-
</formalpara>
<para>
@@ -5111,19 +5111,20 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
This type is used to describe log event errors.
</para>
-
</formalpara>
<formalpara>
-
<title>Enumeration Values</title>
+
+
<para>
<informaltable>
<tgroup cols="2">
@@ -5164,7 +5165,6 @@
</tgroup>
</informaltable>
</para>
-
</formalpara>
</section>
@@ -5178,9 +5178,10 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
These are the log event categories referenced in
<xref linkend="ndb-logevent-type"/>. They are also used by the
@@ -5188,13 +5189,13 @@
<literal>ndb_mgm_set_clusterlog_loglevel()</literal> and
<literal>ndb_mgm_listen_event()</literal>.
</para>
-
</formalpara>
<formalpara>
-
<title>Enumeration Values</title>
+
+
<para>
<informaltable>
<tgroup cols="2">
@@ -5258,7 +5259,6 @@
</tgroup>
</informaltable>
</para>
-
</formalpara>
<para>
@@ -5292,20 +5292,21 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
This structure models a Cluster log event, and is used for
storing and retrieving log event information.
</para>
-
</formalpara>
<formalpara>
-
<title>Definition</title>
+
+
<para>
<literal>ndb_logevent</literal> has 8 members, the first 7 of
which are shown in the following list:
@@ -5986,7 +5987,6 @@
</tgroup>
</informaltable>
</para>
-
</formalpara>
</section>
@@ -6000,19 +6000,20 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
Provides information on the status of a Cluster node.
</para>
-
</formalpara>
<formalpara>
-
<title>Definition</title>
+
+
<para>
This structure contains the following members:
@@ -6125,7 +6126,6 @@
</itemizedlist>
</para>
-
</formalpara>
</section>
@@ -6139,21 +6139,22 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
Provides information on the status of all Cluster nodes. This
structure is returned by
<literal>ndb_mgm_get_status()</literal>.
</para>
-
</formalpara>
<formalpara>
-
<title>Definition</title>
+
+
<para>
This structure has the following two members;
@@ -6186,7 +6187,6 @@
</itemizedlist>
</para>
-
</formalpara>
<para>
@@ -6204,20 +6204,21 @@
</indexterm>
<formalpara>
-
<title>Description</title>
+
+
<para>
Contains response information, consisting of a response code
and a corresponding message, from the management server.
</para>
-
</formalpara>
<formalpara>
-
<title>Definition</title>
+
+
<para>
This structure contains two members, as shown here:
@@ -6247,7 +6248,6 @@
</itemizedlist>
</para>
-
</formalpara>
<para>
Modified: trunk/refman-5.0/releasenotes-es-5.0.xml
===================================================================
--- trunk/refman-5.0/releasenotes-es-5.0.xml 2007-02-08 09:18:33 UTC (rev 4853)
+++ trunk/refman-5.0/releasenotes-es-5.0.xml 2007-02-08 09:21:53 UTC (rev 4854)
Changed blocks: 3, Lines Added: 4, Lines Deleted: 5; 1162 bytes
@@ -151,7 +151,6 @@
</para>
</listitem>
-
<listitem>
<para>
When <literal>SET PASSWORD</literal> was written to the binary
@@ -483,16 +482,16 @@
#24507)
</para>
</listitem>
-
+
<listitem>
<para>
<literal>NDB Cluster</literal>: A query with an
<literal>IN</literal> clause against an <literal>NDB</literal>
table employing explicit user-defined partitioning did not
- always return all matching rows. (Bug #25821)
+ always return all matching rows. (Bug #25821)
</para>
</listitem>
-
+
<listitem>
<para>
<literal>NDB Cluster</literal>: An <literal>UPDATE</literal>
@@ -1036,7 +1035,7 @@
</para>
<itemizedlist>
-
+
<listitem>
<para>
<literal>NDB Cluster</literal>: If the value set for
Modified: trunk/refman-5.1/news-5.1.xml
===================================================================
--- trunk/refman-5.1/news-5.1.xml 2007-02-08 09:18:33 UTC (rev 4853)
+++ trunk/refman-5.1/news-5.1.xml 2007-02-08 09:21:53 UTC (rev 4854)
Changed blocks: 10, Lines Added: 31, Lines Deleted: 31; 5641 bytes
@@ -75,43 +75,43 @@
<ulink url="http://www.mysql.com/network/advisors.html"/>.
</para>
-
<para>
Functionality added or changed:
</para>
<itemizedlist>
-
+
<listitem>
<para>
<literal>NDB Cluster</literal> (Cluster APIs): A new
<literal>ndb_mgm_get_clusterlog_loglevel()</literal> function
was added to the MGM API.
- </para>
-
+ </para>
+
<para>
- For more information, see <xref linkend="ndb-mgm-get-clusterlog-loglevel"/>.
+ For more information, see
+ <xref linkend="ndb-mgm-get-clusterlog-loglevel"/>.
</para>
</listitem>
-
+
<listitem>
<para>
- <literal>NDB Cluster</literal> (Cluster APIs) /
+ <literal>NDB Cluster</literal> (Cluster APIs) /
<emphasis role="bold">Incompatible change</emphasis>: The
<literal>AbortOption</literal> type is now a member of the
- <literal>NdbOperation</literal> class; its values and
- behavior have also changed.
+ <literal>NdbOperation</literal> class; its values and behavior
+ have also changed.
<literal>NdbTransaction::AbortOption</literal> can no longer
be used, and applications written against the NDB API may need
to be rewritten and recompiled to accomodate these changes.
</para>
-
+
<para>
See <xref linkend="class-ndboperation-abortoption"/>, for more
information.
</para>
</listitem>
-
+
<listitem>
<para>
<literal>NDB Cluster</literal>: Previously, when a data node
@@ -119,7 +119,8 @@
forced shutdown of the cluster. Now, when a data node fails to
start 7 consecutive times, the node will not start again until
it is started with the <option>--initial</option> option, and
- a warning to this effect is written to the error log. (Bug #25984)
+ a warning to this effect is written to the error log. (Bug
+ #25984)
</para>
</listitem>
@@ -130,7 +131,7 @@
added. (Bug #22025)
</para>
</listitem>
-
+
<listitem>
<para>
<literal>NDB Cluster</literal>: In the event that all cluster
@@ -138,21 +139,20 @@
<literal>ArbitrationRank=0</literal>,
<command>ndb_mgmd</command> now issues the following warning
when starting: <errortext>Cluster configuration warning:
- Neither MGM nor API nodes are configured with arbitrator,
- may cause complete cluster shutdown in case of host
- failure</errortext>. (Bug #23546)
+ Neither MGM nor API nodes are configured with arbitrator, may
+ cause complete cluster shutdown in case of host
+ failure</errortext>. (Bug #23546)
</para>
</listitem>
</itemizedlist>
-
<para>
Bugs fixed:
</para>
<itemizedlist>
-
+
<listitem>
<para>
<emphasis role="bold">Cluster APIs</emphasis> /
@@ -164,16 +164,16 @@
stored on disk. (Bug #25794)
</para>
</listitem>
-
+
<listitem>
<para>
- <literal>NDB Cluster</literal> (Replication): The error message
- <errortext>Last_Errno: 4294967295, Error in Write_rows
- event</errortext> now supplies a valid error code. (Bug
+ <literal>NDB Cluster</literal> (Replication): The error
+ message <errortext>Last_Errno: 4294967295, Error in Write_rows
+ event</errortext> now supplies a valid error code. (Bug
#19896)
</para>
</listitem>
-
+
<listitem>
<para>
<literal>NDB Cluster</literal> (Replication): Under some
@@ -181,23 +181,23 @@
slave SQL thread was still using it. (Bug #26015, Bug #26019)
</para>
</listitem>
-
+
<listitem>
<para>
<literal>NDB Cluster</literal>: A query with an
<literal>IN</literal> clause against an <literal>NDB</literal>
table employing explicit user-defined partitioning did not
- always return all matching rows. (Bug #25821)
+ always return all matching rows. (Bug #25821)
</para>
</listitem>
-
+
<listitem>
<para>
A memory leak could cause problems during a node or cluster
shutdown or failure. (Bug #25997)
</para>
</listitem>
-
+
<listitem>
<para>
<literal>NDB Cluster</literal>: An appropriate error message
@@ -205,7 +205,7 @@
space for the cluster to start. (Bug #25801)
</para>
</listitem>
-
+
<listitem>
<para>
<literal>NDB Cluster</literal>: An <literal>UPDATE</literal>
@@ -214,7 +214,7 @@
caused <command>mysqld</command> to crash. (Bug #25522)
</para>
</listitem>
-
+
<listitem>
<para>
<literal>NDB Cluster</literal>: A memory allocation failure in
@@ -222,7 +222,7 @@
crash. (Bug #25239)
</para>
</listitem>
-
+
<listitem>
<para>
<literal>NDB Cluster</literal>: In the event that cluster
@@ -2081,7 +2081,7 @@
</para>
<itemizedlist>
-
+
<listitem>
<para>
<literal>NDB Cluster</literal>: If the value set for
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r4854 - branches/telcos/refman-5.1 trunk/ndbapi trunk/refman-5.0 trunk/refman-5.1 | jon | 8 Feb |
