Documentation Home
MySQL NDB Cluster 8.0
Related Documentation Download this Excerpt
PDF (US Ltr) - 4.7Mb
PDF (A4) - 4.8Mb


MySQL NDB Cluster 8.0  /  NDB Cluster Programs  /  ndb_perror — Obtain NDB Error Message Information

5.16 ndb_perror — Obtain NDB Error Message Information

ndb_perror shows information about an NDB error, given its error code. This includes the error message, the type of error, and whether the error is permanent or temporary. This is intended as a drop-in replacement for perror --ndb, which is no longer supported.

Usage

ndb_perror [options] error_code

ndb_perror does not need to access a running NDB Cluster, or any nodes (including SQL nodes). To view information about a given NDB error, invoke the program, using the error code as an argument, like this:

$> ndb_perror 323
NDB error code 323: Invalid nodegroup id, nodegroup already existing: Permanent error: Application error

To display only the error message, invoke ndb_perror with the --silent option (short form -s), as shown here:

$> ndb_perror -s 323
Invalid nodegroup id, nodegroup already existing: Permanent error: Application error

Like perror, ndb_perror accepts multiple error codes:

$> ndb_perror 321 1001
NDB error code 321: Invalid nodegroup id: Permanent error: Application error
NDB error code 1001: Illegal connect string

Additional program options for ndb_perror are described later in this section.

ndb_perror replaces perror --ndb, which is no longer supported by NDB Cluster. To make substitution easier in scripts and other applications that might depend on perror for obtaining NDB error information, ndb_perror supports its own dummy --ndb option, which does nothing.

The following table includes all options that are specific to the NDB Cluster program ndb_perror. Additional descriptions follow the table.

Table 5.15 Command-line options used with the program ndb_perror

Format Description Added, Deprecated, or Removed

--defaults-extra-file=path

Read given file after global files are read

(Supported in all NDB releases based on MySQL 8.0)

--defaults-file=path

Read default options from given file only

(Supported in all NDB releases based on MySQL 8.0)

--defaults-group-suffix=string

Also read groups with concat(group, suffix)

(Supported in all NDB releases based on MySQL 8.0)

--help,

-?

Display help text

(Supported in all NDB releases based on MySQL 8.0)

--login-path=path

Read given path from login file

(Supported in all NDB releases based on MySQL 8.0)

--ndb

For compatibility with applications depending on old versions of perror; does nothing

(Supported in all NDB releases based on MySQL 8.0)

--no-defaults

Do not read default options from any option file other than login file

(Supported in all NDB releases based on MySQL 8.0)

--print-defaults

Print program argument list and exit

(Supported in all NDB releases based on MySQL 8.0)

--silent,

-s

Show error message only

(Supported in all NDB releases based on MySQL 8.0)

--version,

-V

Print program version information and exit

(Supported in all NDB releases based on MySQL 8.0)

--verbose,

-v

Verbose output; disable with --silent

(Supported in all NDB releases based on MySQL 8.0)


Additional Options

  • --defaults-extra-file

    Command-Line Format --defaults-extra-file=path
    Type String
    Default Value [none]

    Read given file after global files are read.

  • --defaults-file

    Command-Line Format --defaults-file=path
    Type String
    Default Value [none]

    Read default options from given file only.

  • --defaults-group-suffix

    Command-Line Format --defaults-group-suffix=string
    Type String
    Default Value [none]

    Also read groups with concat(group, suffix).

  • --help, -?

    Command-Line Format --help

    Display program help text and exit.

  • --login-path

    Command-Line Format --login-path=path
    Type String
    Default Value [none]

    Read given path from login file.

  • --ndb

    Command-Line Format --ndb

    For compatibility with applications depending on old versions of perror that use that program's --ndb option. The option when used with ndb_perror does nothing, and is ignored by it.

  • --no-defaults

    Command-Line Format --no-defaults

    Do not read default options from any option file other than login file.

  • --print-defaults

    Command-Line Format --print-defaults

    Print program argument list and exit.

  • --silent, -s

    Command-Line Format --silent

    Show error message only.

  • --version, -V

    Command-Line Format --version

    Print program version information and exit.

  • --verbose, -v

    Command-Line Format --verbose

    Verbose output; disable with --silent.