2.3.18 The NdbError Structure

2.3.18.1 NdbError Types

Abstract

This section discusses the NdbError data structure, which contains status and other information about errors, including error codes, classifications, and messages.

Description.  An NdbError consists of six parts, listed here, of which one is deprecated as of MySQL Cluster NDB 6.2.19, MySQL Cluster NDB 6.3.29, and MySQL Cluster NDB 7.0.10:

  1. Error status: This describes the impact of an error on the application, and reflects what the application should do when the error is encountered.

    The error status is described by a value of the Status type. See Section 2.3.18.1.2, “The NdbError::Status Type”, for possible Status values and how they should be interpreted.

  2. Error classification: This represents a logical error type or grouping.

    The error classification is described by a value of the Classification type. See Section 2.3.18.1.1, “The NdbError::Classification Type”, for possible classifications and their interpretation. Additional information is provided in Section 7.2.3, “NDB Error Classifications”.

  3. Error code: This is an NDB API internal error code which uniquely identifies the error.

    Important

    It is not 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.

    A listing of current error codes, broken down by classification, is provided in Section 7.2.2, “NDB Error Codes and Messages”. This listing is updated with new MySQL Cluster releases. You can also check the file storage/ndb/src/ndbapi/ndberror.c in the MySQL Cluster sources.

  4. MySQL Error code: This is the corresponding MySQL Server error code. MySQL error codes are not discussed in this document; please see Server Error Codes and Messages, in the MySQL Manual, for information about these.

  5. Error message: This is a generic, context-independent description of the error.

  6. Error details: 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.

    Where not specified, the error detail message is NULL.

    Note

    This property is deprecated as of MySQL Cluster NDB 6.2.19, MySQL Cluster NDB 6.3.29, and MySQL Cluster NDB 7.0.10. Beginning with these MySQL Cluster releases, for obtaining error details, you should use the Ndb::getNdbErrorDetail() method instead.

Important

Specific NDB API error codes, messages, and detail messages are subject to change without notice.

Definition.  The NdbError structure contains the following members, whose types are as shown here:

See the Description for more information about these members and their types.

Types.  NdbError defines the two data types listed here:

Structure Diagram.  This diagram shows all the available members and types of the NdbError structure:

Public members and types of the NdbError structure.