Author: jstephens
Date: 2007-06-08 20:59:39 +0200 (Fri, 08 Jun 2007)
New Revision: 6733
Log:
Reorganise error code listings (as suggested by Stefan).
Modified:
trunk/ndbapi/errors.xml
trunk/ndbapi/mgm-api.xml
Modified: trunk/ndbapi/errors.xml
===================================================================
--- trunk/ndbapi/errors.xml 2007-06-08 18:19:48 UTC (rev 6732)
+++ trunk/ndbapi/errors.xml 2007-06-08 18:59:39 UTC (rev 6733)
Changed blocks: 2, Lines Added: 716, Lines Deleted: 414; 42637 bytes
@@ -7,7 +7,7 @@
]>
<chapter id="errors">
- <title>NDB API ERRORS</title>
+ <title><literal>NDB</literal> ERRORS</title>
<abstract>
@@ -28,543 +28,845 @@
</abstract>
- <section id="struct-ndberror">
+ <section id="mgm-errors">
- <title>The <literal>NdbError</literal> Structure</title>
+ <title>MGM<literal></literal> API Errors</title>
- <indexterm>
- <primary><literal>NdbError</literal> structure</primary>
- </indexterm>
+ <para>
+ The following sections list the values of <literal>MGM</literal>
+ errors by type. There are six types of <literal>MGM</literal>
+ errors:
- <abstract>
+ <orderedlist>
+ <listitem>
+ <para>
+ request errors
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ node ID allocation errors
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ service errors
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ backup errors
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ single user mode errors
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ general usage errors
+ </para>
+ </listitem>
+
+ </orderedlist>
+
+ There is only one general usage error.
+ </para>
+
+ <section id="mgm-errors-request">
+
+ <title>Request Errors</title>
+
<para>
- This section discusses the <literal>NdbError</literal> data
- structure, which contains status and other information about
- errors, including error codes, classifications, and messages.
+ These are errors generated by failures to connect to a
+ management server.
</para>
- </abstract>
+ <informaltable>
+ <tgroup cols="2">
+ <colspec colwidth="50*"/>
+ <colspec colwidth="50*"/>
+ <thead>
+ <row>
+ <entry>Value</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry/>
+ <entry><literal>NDB_MGM_ILLEGAL_CONNECT_STRING</literal></entry>
+ <entry>Invalid connectstring</entry>
+ </row>
+ <row>
+ <entry/>
+ <entry><literal>NDB_MGM_ILLEGAL_SERVER_HANDLE</literal></entry>
+ <entry>Invalid management server handle</entry>
+ </row>
+ <row>
+ <entry/>
+ <entry><literal>NDB_MGM_ILLEGAL_SERVER_REPLY</literal></entry>
+ <entry>Invalid response from management server</entry>
+ </row>
+ <row>
+ <entry/>
+ <entry><literal>NDB_MGM_ILLEGAL_NUMBER_OF_NODES</literal></entry>
+ <entry>Invalid number of nodes</entry>
+ </row>
+ <row>
+ <entry/>
+ <entry><literal>NDB_MGM_ILLEGAL_NODE_STATUS</literal></entry>
+ <entry>Invalid node status</entry>
+ </row>
+ <row>
+ <entry/>
+ <entry><literal>NDB_MGM_OUT_OF_MEMORY</literal></entry>
+ <entry>Memory allocation error</entry>
+ </row>
+ <row>
+ <entry/>
+ <entry><literal>NDB_MGM_SERVER_NOT_CONNECTED</literal></entry>
+ <entry>Management server not connected</entry>
+ </row>
+ <row>
+ <entry/>
+ <entry><literal>NDB_MGM_COULD_NOT_CONNECT_TO_SOCKET</literal></entry>
+ <entry>Not able to connect to socket</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
- <formalpara>
+ </section>
- <title>Description</title>
+ <section id="mgm-errors-node-id-allocation">
+ <title>Node ID Allocation Errors</title>
+
<para>
- An <literal>NdbError</literal> consists of six parts:
+ These errors result from a failure to assign a node ID to a
+ cluster node.
+ </para>
- <orderedlist>
+ <informaltable>
+ <tgroup cols="2">
+ <colspec colwidth="50*"/>
+ <colspec colwidth="50*"/>
+ <thead>
+ <row>
+ <entry>Value</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry/>
+ <entry><literal>NDB_MGM_ALLOCID_ERROR</literal></entry>
+ <entry>Generic error; may be possible to retry and recover</entry>
+ </row>
+ <row>
+ <entry/>
+ <entry><literal>NDB_MGM_ALLOCID_CONFIG_MISMATCH</literal></entry>
+ <entry>Non-recoverable generic error</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
- <listitem>
- <indexterm>
- <primary>Error status</primary>
- </indexterm>
+ </section>
- <para>
- <emphasis>Error status</emphasis>: This describes the
- impact of an error on the application, and reflects what
- the application should do when the error is encountered.
- </para>
+ <section id="mgm-errors-service">
- <para>
- The error status is described by a value of the
- <literal>Status</literal> type. See
- <xref linkend="struct-ndberror-status"/>, for possible
- <literal>Status</literal> values and how they should be
- interpreted.
- </para>
- </listitem>
+ <title>Service Errors</title>
- <listitem>
- <indexterm>
- <primary>error classification (defined)</primary>
- </indexterm>
+ <para>
+ These errors result from the failure of a node or cluster to
+ start, shut down, or restart.
+ </para>
- <para>
- <emphasis>Error classification</emphasis>: This represents
- a logical error type or grouping.
- </para>
+ <informaltable>
+ <tgroup cols="2">
+ <colspec colwidth="50*"/>
+ <colspec colwidth="50*"/>
+ <thead>
+ <row>
+ <entry>Value</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry/>
+ <entry><literal>NDB_MGM_START_FAILED</literal></entry>
+ <entry>Startup failure</entry>
+ </row>
+ <row>
+ <entry/>
+ <entry><literal>NDB_MGM_STOP_FAILED</literal></entry>
+ <entry>Shutdown failure</entry>
+ </row>
+ <row>
+ <entry/>
+ <entry><literal>NDB_MGM_RESTART_FAILED</literal></entry>
+ <entry>Restart failure</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
- <para>
- The error classification is described by a value of the
- <literal>Classification</literal> type. See
- <xref linkend="struct-ndberror-classification"/>, for
- possible classifications and their interpretation.
- Additional information is provided in
- <xref linkend="ndb-error-classifications"/>.
- </para>
- </listitem>
+ </section>
- <listitem>
- <indexterm>
- <primary>error code (defined)</primary>
- </indexterm>
+ <section id="mgm-errors-backup">
- <para>
- <emphasis>Error code</emphasis>: This is an NDB API
- internal error code which uniquely identifies the error.
- </para>
+ <title>Backup Errors</title>
- <important>
- <para>
- It is <emphasis>not</emphasis> recommended to write
- application programs which are dependent on specific
- error codes. Instead, applications should check error
- status and classification. More information about errors
- can also be obtained by checking error messages and
- (when available) error detail messages. However —
- like error codes — these error messages and error
- detail messages are subject to change.
- </para>
- </important>
+ <para>
+ These are errors which result from problems with initiating or
+ aborting backups.
+ </para>
- <para>
- A listing of current error codes, broken down by
- classification, is provided in
- <xref linkend="ndb-error-codes"/>. This listing will be
- updated periodically, or you can check the file
- <filename>storage/ndb/src/ndbapi/ndberror.c</filename> in
- the MySQL 5.1 sources.
- </para>
- </listitem>
+ <informaltable>
+ <tgroup cols="2">
+ <colspec colwidth="50*"/>
+ <colspec colwidth="50*"/>
+ <thead>
+ <row>
+ <entry>Value</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry/>
+ <entry><literal>NDB_MGM_COULD_NOT_START_BACKUP</literal></entry>
+ <entry>Unable to initiate backup</entry>
+ </row>
+ <row>
+ <entry/>
+ <entry><literal>NDB_MGM_COULD_NOT_ABORT_BACKUP</literal></entry>
+ <entry>Unable to abort backup</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
- <listitem>
- <para>
- <emphasis>MySQL Error code</emphasis>: This is the
- corresponding MySQL Server error code. MySQL error codes
- are not discussed in this document; please see
- <xref linkend="error-messages-server"/>, in the MySQL
- Manual, for information about these.
- </para>
- </listitem>
+ </section>
- <listitem>
- <indexterm>
- <primary>error message (defined)</primary>
- </indexterm>
+ <section id="mgm-errors-single-user-mode">
- <para>
- <emphasis>Error message</emphasis>: This is a generic,
- context-independent description of the error.
- </para>
- </listitem>
+ <title>Single User Mode Errors</title>
- <listitem>
- <indexterm>
- <primary>error detail message (defined)</primary>
- </indexterm>
+ <para>
+ These errors result from failures to enter or exit single user
+ mode.
+ </para>
- <para>
- <emphasis>Error details</emphasis>: This can often provide
- additional information (not found in the error message)
- about an error, specific to the circumstances under which
- the error is encountered. However, it is not available in
- all cases.
- </para>
+ <informaltable>
+ <tgroup cols="2">
+ <colspec colwidth="50*"/>
+ <colspec colwidth="50*"/>
+ <thead>
+ <row>
+ <entry>Value</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry/>
+ <entry><literal>NDB_MGM_COULD_NOT_ENTER_SINGLE_USER_MODE</literal></entry>
+ <entry>Unable to enter single-user mode</entry>
+ </row>
+ <row>
+ <entry/>
+ <entry><literal>NDB_MGM_COULD_NOT_EXIT_SINGLE_USER_MODE</literal></entry>
+ <entry>Unable to exit single-user mode</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
- <para>
- Where not specified, the error detail message is
- <literal>NULL</literal>.
- </para>
- </listitem>
+ </section>
- </orderedlist>
+ <section id="mgm-errors-general-usage">
+
+ <title>General Usage Errors</title>
+
+ <para>
+ This is a general error type for errors which are otherwise not
+ classifiable.
</para>
- </formalpara>
+ <informaltable>
+ <tgroup cols="2">
+ <colspec colwidth="50*"/>
+ <colspec colwidth="50*"/>
+ <thead>
+ <row>
+ <entry>Value</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry/>
+ <entry><literal>NDB_MGM_USAGE_ERROR</literal></entry>
+ <entry>General usage error</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </section>
+
+ </section>
+
+ <section id="ndb-error-messages">
+
+ <title><literal>NDB</literal> API Error Structure and Messages</title>
+
+ <abstract>
+
+ <para>
+ This section disucsses the <literal>NdbError</literal> structure
+ and contains listings of the most common <literal>NDB</literal>
+ error codes and messages, along with their classifications and
+ likely causes for which they might be raised.
+ </para>
+
+ </abstract>
+
<important>
<para>
- Specific NDB API error codes, messages, and detail messages are
- subject to change without notice.
+ It is strongly recommended that you <emphasis>not</emphasis>
+ depend on specific error codes in your <literal>NDB</literal>
+ API applications, as they are subject to change over time.
+ Instead, you should use the <literal>NdbError::Status</literal>
+ and error classification in your source code, or consult the
+ output of <literal>perror <option>--ndb</option>
+ <replaceable>error_code</replaceable></literal> to obtain
+ information about a specific error code.
</para>
+
+ <para>
+ If you find a situation in which you need to use a specific
+ error code in your application, please file a bug report at
+ <ulink url="http://bugs.mysql.com/"/> so that we can update the
+ corresponding status and classification.
+ </para>
</important>
- <formalpara>
+ <section id="struct-ndberror">
- <title>Definition</title>
+ <title>The <literal>NdbError</literal> Structure</title>
- <para>
- The NdbError structure contains the following members, whose
- types are as shown:
+ <indexterm>
+ <primary><literal>NdbError</literal> structure</primary>
+ </indexterm>
- <itemizedlist>
+ <abstract>
- <listitem>
- <para>
+ <para>
+ This section discusses the <literal>NdbError</literal> data
+ structure, which contains status and other information about
+ errors, including error codes, classifications, and messages.
+ </para>
+
+ </abstract>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ An <literal>NdbError</literal> consists of six parts:
+
+ <orderedlist>
+
+ <listitem>
+ <indexterm>
+ <primary>Error status</primary>
+ </indexterm>
+
+ <para>
+ <emphasis>Error status</emphasis>: This describes the
+ impact of an error on the application, and reflects what
+ the application should do when the error is encountered.
+ </para>
+
+ <para>
+ The error status is described by a value of the
+ <literal>Status</literal> type. See
+ <xref linkend="struct-ndberror-status"/>, for possible
+ <literal>Status</literal> values and how they should be
+ interpreted.
+ </para>
+ </listitem>
+
+ <listitem>
+ <indexterm>
+ <primary>error classification (defined)</primary>
+ </indexterm>
+
+ <para>
+ <emphasis>Error classification</emphasis>: This
+ represents a logical error type or grouping.
+ </para>
+
+ <para>
+ The error classification is described by a value of the
+ <literal>Classification</literal> type. See
+ <xref linkend="struct-ndberror-classification"/>, for
+ possible classifications and their interpretation.
+ Additional information is provided in
+ <xref linkend="ndb-error-classifications"/>.
+ </para>
+ </listitem>
+
+ <listitem>
+ <indexterm>
+ <primary>error code (defined)</primary>
+ </indexterm>
+
+ <para>
+ <emphasis>Error code</emphasis>: This is an NDB API
+ internal error code which uniquely identifies the error.
+ </para>
+
+ <important>
+ <para>
+ It is <emphasis>not</emphasis> recommended to write
+ application programs which are dependent on specific
+ error codes. Instead, applications should check error
+ status and classification. More information about
+ errors can also be obtained by checking error messages
+ and (when available) error detail messages. However
+ — like error codes — these error messages
+ and error detail messages are subject to change.
+ </para>
+ </important>
+
+ <para>
+ A listing of current error codes, broken down by
+ classification, is provided in
+ <xref linkend="ndb-error-codes"/>. This listing will be
+ updated periodically, or you can check the file
+ <filename>storage/ndb/src/ndbapi/ndberror.c</filename>
+ in the MySQL 5.1 sources.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>MySQL Error code</emphasis>: This is the
+ corresponding MySQL Server error code. MySQL error codes
+ are not discussed in this document; please see
+ <xref linkend="error-messages-server"/>, in the MySQL
+ Manual, for information about these.
+ </para>
+ </listitem>
+
+ <listitem>
+ <indexterm>
+ <primary>error message (defined)</primary>
+ </indexterm>
+
+ <para>
+ <emphasis>Error message</emphasis>: This is a generic,
+ context-independent description of the error.
+ </para>
+ </listitem>
+
+ <listitem>
+ <indexterm>
+ <primary>error detail message (defined)</primary>
+ </indexterm>
+
+ <para>
+ <emphasis>Error details</emphasis>: This can often
+ provide additional information (not found in the error
+ message) about an error, specific to the circumstances
+ under which the error is encountered. However, it is not
+ available in all cases.
+ </para>
+
+ <para>
+ Where not specified, the error detail message is
+ <literal>NULL</literal>.
+ </para>
+ </listitem>
+
+ </orderedlist>
+ </para>
+
+ </formalpara>
+
+ <important>
+ <para>
+ Specific NDB API error codes, messages, and detail messages
+ are subject to change without notice.
+ </para>
+ </important>
+
+ <formalpara>
+
+ <title>Definition</title>
+
+ <para>
+ The NdbError structure contains the following members, whose
+ types are as shown:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
<programlisting>
Status status
</programlisting>
- The error status.
- </para>
- </listitem>
+ The error status.
+ </para>
+ </listitem>
- <listitem>
- <para>
+ <listitem>
+ <para>
<programlisting>
Classification classification
</programlisting>
- The error type (classification).
- </para>
- </listitem>
+ The error type (classification).
+ </para>
+ </listitem>
- <listitem>
- <para>
+ <listitem>
+ <para>
<programlisting>
int code
</programlisting>
- The NDB API error code.
- </para>
- </listitem>
+ The NDB API error code.
+ </para>
+ </listitem>
- <listitem>
- <para>
+ <listitem>
+ <para>
<programlisting>
int mysql_code
</programlisting>
- The MySQL error code.
- </para>
- </listitem>
+ The MySQL error code.
+ </para>
+ </listitem>
- <listitem>
- <para>
+ <listitem>
+ <para>
<programlisting>
const char* message
</programlisting>
- The error message.
- </para>
- </listitem>
+ The error message.
+ </para>
+ </listitem>
- <listitem>
- <para>
+ <listitem>
+ <para>
<programlisting>
char* details
</programlisting>
- The error detail message.
- </para>
- </listitem>
+ The error detail message.
+ </para>
+ </listitem>
- </itemizedlist>
+ </itemizedlist>
- See the Description for more information about these members and
- their types.
- </para>
+ See the Description for more information about these members
+ and their types.
+ </para>
- </formalpara>
+ </formalpara>
- <formalpara>
+ <formalpara>
- <title>Public Types</title>
+ <title>Public Types</title>
- <para>
- <literal>NdbError</literal> defines two datatypes:
+ <para>
+ <literal>NdbError</literal> defines two datatypes:
- <itemizedlist>
+ <itemizedlist>
- <listitem>
- <para>
- <literal>Status</literal>: The error status. See
- <xref linkend="struct-ndberror-status"/>.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>Status</literal>: The error status. See
+ <xref linkend="struct-ndberror-status"/>.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>Classification</literal>: The type of error or
- the logical grouping to which it belongs. See
- <xref linkend="struct-ndberror-classification"/>.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>Classification</literal>: The type of error or
+ the logical grouping to which it belongs. See
+ <xref linkend="struct-ndberror-classification"/>.
+ </para>
+ </listitem>
- </itemizedlist>
- </para>
+ </itemizedlist>
+ </para>
- </formalpara>
+ </formalpara>
- <formalpara>
+ <formalpara>
- <title>Structure Diagram</title>
+ <title>Structure Diagram</title>
- <para>
- This diagram shows all the available members and types of the
- <literal>NdbError</literal> structure:
+ <para>
+ This diagram shows all the available members and types of the
+ <literal>NdbError</literal> structure:
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/NdbError-struct.png" format="PNG"/>
- </imageobject>
- <textobject>
- <phrase lang="en">Public members and types of the
- <literal>NdbError</literal> structure.</phrase>
- </textobject>
- </mediaobject>
- </para>
-
- </formalpara>
-
- <section id="struct-ndberror-types">
-
- <title><literal>NdbError</literal> Types</title>
-
- <abstract>
-
- <para>
- This section discusses the <literal>Status</literal> and
- <literal>Classification</literal> datatypes defined by
- <literal>NdbError</literal>.
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/NdbError-struct.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">Public members and types of the
+ <literal>NdbError</literal> structure.</phrase>
+ </textobject>
+ </mediaobject>
</para>
- </abstract>
+ </formalpara>
- <section id="struct-ndberror-status">
+ <section id="struct-ndberror-types">
- <title>The <literal>NdbError::Status</literal> Type</title>
+ <title><literal>NdbError</literal> Types</title>
- <indexterm>
- <primary><literal>NdbError::Status</literal> type</primary>
- </indexterm>
+ <abstract>
- <indexterm>
- <primary><literal>Status</literal> (<literal>NdbError</literal> datatype)</primary>
- </indexterm>
-
- <formalpara>
-
- <title>Description</title>
-
<para>
- This type is used to describe an error's status.
+ This section discusses the <literal>Status</literal> and
+ <literal>Classification</literal> datatypes defined by
+ <literal>NdbError</literal>.
</para>
- </formalpara>
+ </abstract>
- <formalpara>
+ <section id="struct-ndberror-status">
- <title>Enumeration Values</title>
+ <title>The <literal>NdbError::Status</literal> Type</title>
- <para>
- <informaltable>
- <tgroup cols="2">
- <colspec colwidth="35*"/>
- <colspec colwidth="65*"/>
- <thead>
- <row>
- <entry>Value</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><literal>Success</literal></entry>
- <entry>No error has occurred</entry>
- </row>
- <row>
- <entry><literal>TemporaryError</literal></entry>
- <entry>A temporary and usually recoverable error; the application should retry
- the operation giving rise to the error</entry>
- </row>
- <row>
- <entry><literal>PermanentError</literal></entry>
- <entry>Permanent error; not recoverable</entry>
- </row>
- <row>
- <entry><literal>UnknownResult</literal></entry>
- <entry>The operation's result or status is unknown</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
+ <indexterm>
+ <primary><literal>NdbError::Status</literal> type</primary>
+ </indexterm>
- </formalpara>
+ <indexterm>
+ <primary><literal>Status</literal> (<literal>NdbError</literal> datatype)</primary>
+ </indexterm>
- <note>
- <para>
- Related information specific to certain error conditions may
- be found in <xref linkend="ndb-error-classifications"/>.
- </para>
- </note>
+ <formalpara>
- </section>
+ <title>Description</title>
- <section id="struct-ndberror-classification">
+ <para>
+ This type is used to describe an error's status.
+ </para>
- <title>The <literal>NdbError::Classification</literal> Type</title>
+ </formalpara>
- <indexterm>
- <primary><literal>NdbError::Classification</literal> type</primary>
- </indexterm>
+ <formalpara>
- <indexterm>
- <primary><literal>Classification</literal> (<literal>NdbError</literal> datatype)</primary>
- </indexterm>
+ <title>Enumeration Values</title>
- <formalpara>
+ <para>
+ <informaltable>
+ <tgroup cols="2">
+ <colspec colwidth="35*"/>
+ <colspec colwidth="65*"/>
+ <thead>
+ <row>
+ <entry>Value</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><literal>Success</literal></entry>
+ <entry>No error has occurred</entry>
+ </row>
+ <row>
+ <entry><literal>TemporaryError</literal></entry>
+ <entry>A temporary and usually recoverable error; the application should retry
+ the operation giving rise to the error</entry>
+ </row>
+ <row>
+ <entry><literal>PermanentError</literal></entry>
+ <entry>Permanent error; not recoverable</entry>
+ </row>
+ <row>
+ <entry><literal>UnknownResult</literal></entry>
+ <entry>The operation's result or status is unknown</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
- <title>Description</title>
+ </formalpara>
- <para>
- This type describes the type of error, or the logical group
- to which it belongs.
- </para>
+ <note>
+ <para>
+ Related information specific to certain error conditions
+ may be found in
+ <xref linkend="ndb-error-classifications"/>.
+ </para>
+ </note>
- </formalpara>
+ </section>
- <formalpara>
+ <section id="struct-ndberror-classification">
- <title>Enumeration Values</title>
+ <title>The <literal>NdbError::Classification</literal> Type</title>
- <para>
- <informaltable>
- <tgroup cols="2">
- <colspec colwidth="35*"/>
- <colspec colwidth="65*"/>
- <thead>
- <row>
- <entry>Value</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><literal>NoError</literal></entry>
- <entry>Indicates success (no error occurred)</entry>
- </row>
- <row>
- <entry><literal>ApplicationError</literal></entry>
- <entry>An error occurred in an application program</entry>
- </row>
- <row>
- <entry><literal>NoDataFound</literal></entry>
- <entry>A read operation failed due to one or more missing records.</entry>
- </row>
- <row>
- <entry><literal>ConstraintViolation</literal></entry>
- <entry>A constraint violation occurred, such as attempting to insert a tuple
- having a primary key value already in use in the
- target table.</entry>
- </row>
- <row>
- <entry><literal>SchemaError</literal></entry>
- <entry>An error took place when trying to create or use a table.</entry>
- </row>
- <row>
- <entry><literal>InsufficientSpace</literal></entry>
- <entry>There was insufficient memory for data or indexes.</entry>
- </row>
- <row>
- <entry><literal>TemporaryResourceError</literal></entry>
- <entry>This type of error is typically encountered when there are too many
- active transactions.</entry>
- </row>
- <row>
- <entry><literal>NodeRecoveryError</literal></entry>
- <entry>This is a temporary failure which was likely caused by a node recovery
- in progress, some examples being when information
- sent between an application and
- <literal>NDB</literal> is lost, or when there is a
- distribution change.</entry>
- </row>
- <row>
- <entry><literal>OverloadError</literal></entry>
- <entry>This type of error is often caused when there is insufficient logfile
- space.</entry>
- </row>
- <row>
- <entry><literal>TimeoutExpired</literal></entry>
- <entry>A timeout, often caused by a deadlock.</entry>
- </row>
- <row>
- <entry><literal>UnknownResultError</literal></entry>
- <entry>It is not known whether a transaction was committed.</entry>
- </row>
- <row>
- <entry><literal>InternalError</literal></entry>
- <entry>A serious error has occurred in <literal>NDB</literal> itself.</entry>
- </row>
- <row>
- <entry><literal>FunctionNotImplemented</literal></entry>
- <entry>The application attempted to use a function which is not yet
- implemented.</entry>
- </row>
- <row>
- <entry><literal>UnknownErrorCode</literal></entry>
- <entry>This is seen where the <literal>NDB</literal> error handler cannot
- determine the correct error code to report.</entry>
- </row>
- <row>
- <entry><literal>NodeShutdown</literal></entry>
- <entry>This is caused by a node shutdown.</entry>
- </row>
- <row>
- <entry><literal>SchemaObjectExists</literal></entry>
- <entry>The application attempted to create a schema object that already exists.</entry>
- </row>
- <row>
- <entry><literal>InternalTemporary</literal></entry>
- <entry>A request was sent to a non-master node.</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
+ <indexterm>
+ <primary><literal>NdbError::Classification</literal> type</primary>
+ </indexterm>
- </formalpara>
+ <indexterm>
+ <primary><literal>Classification</literal> (<literal>NdbError</literal> datatype)</primary>
+ </indexterm>
- <note>
- <para>
- Related information specific to certain error conditions may
- be found in <xref linkend="ndb-error-codes"/>, and in
- <xref linkend="ndb-error-classifications"/>.
- </para>
- </note>
+ <formalpara>
- </section>
+ <title>Description</title>
- </section>
+ <para>
+ This type describes the type of error, or the logical
+ group to which it belongs.
+ </para>
- </section>
+ </formalpara>
- <section id="ndb-error-messages">
+ <formalpara>
- <title><literal>NDB</literal> Error Codes, Classifications, and Messages</title>
+ <title>Enumeration Values</title>
- <abstract>
+ <para>
+ <informaltable>
+ <tgroup cols="2">
+ <colspec colwidth="35*"/>
+ <colspec colwidth="65*"/>
+ <thead>
+ <row>
+ <entry>Value</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><literal>NoError</literal></entry>
+ <entry>Indicates success (no error occurred)</entry>
+ </row>
+ <row>
+ <entry><literal>ApplicationError</literal></entry>
+ <entry>An error occurred in an application program</entry>
+ </row>
+ <row>
+ <entry><literal>NoDataFound</literal></entry>
+ <entry>A read operation failed due to one or more missing records.</entry>
+ </row>
+ <row>
+ <entry><literal>ConstraintViolation</literal></entry>
+ <entry>A constraint violation occurred, such as attempting to insert a tuple
+ having a primary key value already in use in the
+ target table.</entry>
+ </row>
+ <row>
+ <entry><literal>SchemaError</literal></entry>
+ <entry>An error took place when trying to create or use a table.</entry>
+ </row>
+ <row>
+ <entry><literal>InsufficientSpace</literal></entry>
+ <entry>There was insufficient memory for data or indexes.</entry>
+ </row>
+ <row>
+ <entry><literal>TemporaryResourceError</literal></entry>
+ <entry>This type of error is typically encountered when there are too many
+ active transactions.</entry>
+ </row>
+ <row>
+ <entry><literal>NodeRecoveryError</literal></entry>
+ <entry>This is a temporary failure which was likely caused by a node recovery
+ in progress, some examples being when
+ information sent between an application and
+ <literal>NDB</literal> is lost, or when there is
+ a distribution change.</entry>
+ </row>
+ <row>
+ <entry><literal>OverloadError</literal></entry>
+ <entry>This type of error is often caused when there is insufficient logfile
+ space.</entry>
+ </row>
+ <row>
+ <entry><literal>TimeoutExpired</literal></entry>
+ <entry>A timeout, often caused by a deadlock.</entry>
+ </row>
+ <row>
+ <entry><literal>UnknownResultError</literal></entry>
+ <entry>It is not known whether a transaction was committed.</entry>
+ </row>
+ <row>
+ <entry><literal>InternalError</literal></entry>
+ <entry>A serious error has occurred in <literal>NDB</literal> itself.</entry>
+ </row>
+ <row>
+ <entry><literal>FunctionNotImplemented</literal></entry>
+ <entry>The application attempted to use a function which is not yet
+ implemented.</entry>
+ </row>
+ <row>
+ <entry><literal>UnknownErrorCode</literal></entry>
+ <entry>This is seen where the <literal>NDB</literal> error handler cannot
+ determine the correct error code to report.</entry>
+ </row>
+ <row>
+ <entry><literal>NodeShutdown</literal></entry>
+ <entry>This is caused by a node shutdown.</entry>
+ </row>
+ <row>
+ <entry><literal>SchemaObjectExists</literal></entry>
+ <entry>The application attempted to create a schema object that already exists.</entry>
+ </row>
+ <row>
+ <entry><literal>InternalTemporary</literal></entry>
+ <entry>A request was sent to a non-master node.</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
- <para>
- This section contains listings of common <literal>NDB</literal>
- error codes and messages, along with their classifications and
- likely causes for which they might be raised.
- </para>
+ </formalpara>
- </abstract>
+ <note>
+ <para>
+ Related information specific to certain error conditions
+ may be found in <xref linkend="ndb-error-codes"/>, and in
+ <xref linkend="ndb-error-classifications"/>.
+ </para>
+ </note>
- <important>
- <para>
- It is strongly recommended that you <emphasis>not</emphasis>
- depend on specific error codes in your <literal>NDB</literal>
- API applications, as they are subject to change over time.
- Instead, you should use the <literal>NdbError::Status</literal>
- and error classification in your source code, or consult the
- output of <literal>perror <option>--ndb</option>
- <replaceable>error_code</replaceable></literal> to obtain
- information about a specific error code.
- </para>
+ </section>
- <para>
- If you find a situation in which you need to use a specific
- error code in your application, please file a bug report at
- <ulink url="http://bugs.mysql.com/"/> so that we can update the
- corresponding status and classification.
- </para>
- </important>
+ </section>
+ </section>
+
<section id="ndb-error-codes">
<title><literal>NDB</literal> Error Codes and Messages</title>
Modified: trunk/ndbapi/mgm-api.xml
===================================================================
--- trunk/ndbapi/mgm-api.xml 2007-06-08 18:19:48 UTC (rev 6732)
+++ trunk/ndbapi/mgm-api.xml 2007-06-08 18:59:39 UTC (rev 6733)
Changed blocks: 2, Lines Added: 7, Lines Deleted: 149; 6732 bytes
@@ -1984,9 +1984,10 @@
<section id="ndb-mgm-number-of-mgmd-in-connect-string">
<title><literal>ndb_mgm_number_of_mgmd_in_connect_string()</literal></title>
-
+
<indexterm>
- <primary><literal>ndb_mgm_number_of_mgmd_in_connect_string()</literal> function (MGM API)</primary>
+ <primary><literal>ndb_mgm_number_of_mgmd_in_connect_string()</literal> function
+ (MGM API)</primary>
</indexterm>
<formalpara>
@@ -4864,158 +4865,15 @@
<para>
The values for this type are the error codes that may be
- generated by MGM API functions.
+ generated by MGM API functions. These may be found in
+ <xref linkend="mgm-errors"/>.
</para>
</formalpara>
- <formalpara>
-
- <title>Enumeration Values</title>
-
- <para>
- <informaltable>
- <tgroup cols="3">
- <colspec colwidth="15*"/>
- <colspec colwidth="55*"/>
- <colspec colwidth="30*"/>
- <thead>
- <row>
- <entry>Type</entry>
- <entry>Value</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><emphasis>Service Request Errors</emphasis></entry>
- <entry/>
- <entry/>
- </row>
- <row>
- <entry/>
- <entry><literal>NDB_MGM_ILLEGAL_CONNECT_STRING</literal></entry>
- <entry>Invalid connectstring</entry>
- </row>
- <row>
- <entry/>
- <entry><literal>NDB_MGM_ILLEGAL_SERVER_HANDLE</literal></entry>
- <entry>Invalid management server handle</entry>
- </row>
- <row>
- <entry/>
- <entry><literal>NDB_MGM_ILLEGAL_SERVER_REPLY</literal></entry>
- <entry>Invalid response from management server</entry>
- </row>
- <row>
- <entry/>
- <entry><literal>NDB_MGM_ILLEGAL_NUMBER_OF_NODES</literal></entry>
- <entry>Invalid number of nodes</entry>
- </row>
- <row>
- <entry/>
- <entry><literal>NDB_MGM_ILLEGAL_NODE_STATUS</literal></entry>
- <entry>Invalid node status</entry>
- </row>
- <row>
- <entry/>
- <entry><literal>NDB_MGM_OUT_OF_MEMORY</literal></entry>
- <entry>Memory allocation error</entry>
- </row>
- <row>
- <entry/>
- <entry><literal>NDB_MGM_SERVER_NOT_CONNECTED</literal></entry>
- <entry>Management server not connected</entry>
- </row>
- <row>
- <entry/>
- <entry><literal>NDB_MGM_COULD_NOT_CONNECT_TO_SOCKET</literal></entry>
- <entry>Not able to connect to socket</entry>
- </row>
- <row>
- <entry><emphasis>Node ID Allocation Errors</emphasis></entry>
- <entry/>
- <entry/>
- </row>
- <row>
- <entry/>
- <entry><literal>NDB_MGM_ALLOCID_ERROR</literal></entry>
- <entry>Generic error; may be possible to retry and recover</entry>
- </row>
- <row>
- <entry/>
- <entry><literal>NDB_MGM_ALLOCID_CONFIG_MISMATCH</literal></entry>
- <entry>Non-recoverable generic error</entry>
- </row>
- <row>
- <entry><emphasis>Service Errors</emphasis></entry>
- <entry>(Failure of a node or cluster to start, shut down, or restart</entry>
- <entry/>
- </row>
- <row>
- <entry/>
- <entry><literal>NDB_MGM_START_FAILED</literal></entry>
- <entry>Startup failure</entry>
- </row>
- <row>
- <entry/>
- <entry><literal>NDB_MGM_STOP_FAILED</literal></entry>
- <entry>Shutdown failure</entry>
- </row>
- <row>
- <entry/>
- <entry><literal>NDB_MGM_RESTART_FAILED</literal></entry>
- <entry>Restart failure</entry>
- </row>
- <row>
- <entry><emphasis>Backup Service Errors</emphasis></entry>
- <entry/>
- <entry/>
- </row>
- <row>
- <entry/>
- <entry><literal>NDB_MGM_COULD_NOT_START_BACKUP</literal></entry>
- <entry>Unable to initiate backup</entry>
- </row>
- <row>
- <entry/>
- <entry><literal>NDB_MGM_COULD_NOT_ABORT_BACKUP</literal></entry>
- <entry>Unable to abort backup</entry>
- </row>
- <row>
- <entry><emphasis>Single-User Mode Service Errors</emphasis></entry>
- <entry/>
- <entry/>
- </row>
- <row>
- <entry/>
- <entry><literal>NDB_MGM_COULD_NOT_ENTER_SINGLE_USER_MODE</literal></entry>
- <entry>Unable to enter single-user mode</entry>
- </row>
- <row>
- <entry/>
- <entry><literal>NDB_MGM_COULD_NOT_EXIT_SINGLE_USER_MODE</literal></entry>
- <entry>Unable to exit single-user mode</entry>
- </row>
- <row>
- <entry><emphasis>Usage Errors</emphasis></entry>
- <entry/>
- <entry/>
- </row>
- <row>
- <entry/>
- <entry><literal>NDB_MGM_USAGE_ERROR</literal></entry>
- <entry>General usage error</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
-
- </formalpara>
-
<para>
- See <xref linkend="ndb-mgm-get-latest-error"/>.
+ See also <xref linkend="ndb-mgm-get-latest-error"/>, for more
+ information.
</para>
</section>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r6733 - trunk/ndbapi | jon | 8 Jun |
