<div id="docs-body">
 <div class="section">
  <div class="titlepage">
   <div>
    <div>
     <h3 class="title">
      <a name="mysql-cluster-programs-ndb-perror">
      </a>
      25.5.16 ndb_perror — Obtain NDB Error Message Information
     </h3>
    </div>
   </div>
  </div>
  <a class="indexterm" name="idm46045100742256">
  </a>
  <p>
   <a class="link" href="mysql-cluster-programs-ndb-perror.html" title="25.5.16 ndb_perror — Obtain NDB Error Message Information">
    <span class="command">
     <strong>
      ndb_perror
     </strong>
    </span>
   </a>
   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
   <a class="link" href="perror.html" title="6.8.1 perror — Display MySQL Error Message Information">
    <span class="command">
     <strong>
      perror
     </strong>
    </span>
   </a>
   <a class="ulink" href="/doc/refman/8.0/en/perror.html#option_perror_ndb" target="_top">
    <code class="option">
     --ndb
    </code>
   </a>
   ,
        which is no longer supported.
  </p>
  <h4>
   <a name="idm46045100737232">
   </a>
   Usage
  </h4>
  <div class="copytoclipboard-wrapper">
   <pre class="programlisting one-line language-terminal"><div class="docs-select-all right" id="sa10372790"><div class="copy-help left">Press ⌘+C to copy</div> <div class="right"><button class="clipboard-btn" title="Copy to Clipboard"><span class="icon-clipboard"></span></button></div></div><code class="language-terminal">ndb_perror <span class="token punctuation">[</span><em class="replaceable">options</em><span class="token punctuation">]</span> <em class="replaceable">error_code</em></code></pre>
  </div>
  <p>
   <a class="link" href="mysql-cluster-programs-ndb-perror.html" title="25.5.16 ndb_perror — Obtain NDB Error Message Information">
    <span class="command">
     <strong>
      ndb_perror
     </strong>
    </span>
   </a>
   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:
  </p>
  <div class="copytoclipboard-wrapper">
   <pre class="programlisting language-terminal"><div class="docs-select-all right" id="sa1420516"><div class="copy-help left">Press ⌘+C to copy</div> <div class="right"><button class="clipboard-btn" title="Copy to Clipboard"><span class="icon-clipboard"></span></button></div></div><code class="language-terminal"><span class="token prompt">$&gt; </span><span class="token command">ndb_perror</span> 323
NDB error code 323<span class="token punctuation">:</span> Invalid nodegroup id<span class="token punctuation">,</span> nodegroup already existing<span class="token punctuation">:</span> Permanent error<span class="token punctuation">:</span> Application error</code></pre>
  </div>
  <p>
   To display only the error message, invoke
   <a class="link" href="mysql-cluster-programs-ndb-perror.html" title="25.5.16 ndb_perror — Obtain NDB Error Message Information">
    <span class="command">
     <strong>
      ndb_perror
     </strong>
    </span>
   </a>
   with the
   <a class="link" href="mysql-cluster-programs-ndb-perror.html#option_ndb_perror_silent">
    <code class="option">
     --silent
    </code>
   </a>
   option (short form
   <code class="option">
    -s
   </code>
   ), as shown here:
  </p>
  <div class="copytoclipboard-wrapper">
   <pre class="programlisting language-terminal"><div class="docs-select-all right" id="sa92944932"><div class="copy-help left">Press ⌘+C to copy</div> <div class="right"><button class="clipboard-btn" title="Copy to Clipboard"><span class="icon-clipboard"></span></button></div></div><code class="language-terminal"><span class="token prompt">$&gt; </span><span class="token command">ndb_perror</span> <span class="token property">-s</span> 323
Invalid nodegroup id<span class="token punctuation">,</span> nodegroup already existing<span class="token punctuation">:</span> Permanent error<span class="token punctuation">:</span> Application error</code></pre>
  </div>
  <p>
   Like
   <a class="link" href="perror.html" title="6.8.1 perror — Display MySQL Error Message Information">
    <span class="command">
     <strong>
      perror
     </strong>
    </span>
   </a>
   ,
   <a class="link" href="mysql-cluster-programs-ndb-perror.html" title="25.5.16 ndb_perror — Obtain NDB Error Message Information">
    <span class="command">
     <strong>
      ndb_perror
     </strong>
    </span>
   </a>
   accepts multiple error codes:
  </p>
  <div class="copytoclipboard-wrapper">
   <pre class="programlisting language-terminal"><div class="docs-select-all right" id="sa3102433"><div class="copy-help left">Press ⌘+C to copy</div> <div class="right"><button class="clipboard-btn" title="Copy to Clipboard"><span class="icon-clipboard"></span></button></div></div><code class="language-terminal"><span class="token prompt">$&gt; </span><span class="token command">ndb_perror</span> 321 1001
NDB error code 321<span class="token punctuation">:</span> Invalid nodegroup id<span class="token punctuation">:</span> Permanent error<span class="token punctuation">:</span> Application error
NDB error code 1001<span class="token punctuation">:</span> Illegal connect string</code></pre>
  </div>
  <p>
   Additional program options for
   <a class="link" href="mysql-cluster-programs-ndb-perror.html" title="25.5.16 ndb_perror — Obtain NDB Error Message Information">
    <span class="command">
     <strong>
      ndb_perror
     </strong>
    </span>
   </a>
   are
        described later in this section.
  </p>
  <p>
   <a class="link" href="mysql-cluster-programs-ndb-perror.html" title="25.5.16 ndb_perror — Obtain NDB Error Message Information">
    <span class="command">
     <strong>
      ndb_perror
     </strong>
    </span>
   </a>
   replaces
   <a class="link" href="perror.html" title="6.8.1 perror — Display MySQL Error Message Information">
    <span class="command">
     <strong>
      perror
     </strong>
    </span>
   </a>
   <code class="option">
    --ndb
   </code>
   , which is no longer supported by NDB
        Cluster. To make substitution easier in scripts and other
        applications that might depend on
   <a class="link" href="perror.html" title="6.8.1 perror — Display MySQL Error Message Information">
    <span class="command">
     <strong>
      perror
     </strong>
    </span>
   </a>
   for
        obtaining NDB error information,
   <a class="link" href="mysql-cluster-programs-ndb-perror.html" title="25.5.16 ndb_perror — Obtain NDB Error Message Information">
    <span class="command">
     <strong>
      ndb_perror
     </strong>
    </span>
   </a>
   supports its own
   <span class="quote">
    “
    <span class="quote">
     dummy
    </span>
    ”
   </span>
   <a class="link" href="mysql-cluster-programs-ndb-perror.html#option_ndb_perror_ndb">
    <code class="option">
     --ndb
    </code>
   </a>
   option, which does
        nothing.
  </p>
  <p>
   The following table includes all options that are specific to
        the NDB Cluster program
   <a class="link" href="mysql-cluster-programs-ndb-perror.html" title="25.5.16 ndb_perror — Obtain NDB Error Message Information">
    <span class="command">
     <strong>
      ndb_perror
     </strong>
    </span>
   </a>
   .
        Additional descriptions follow the table.
  </p>
  <p>
  </p>
  <h4>
   <a name="mysql-cluster-programs-ndb-perror-additional-options">
   </a>
   Additional Options
  </h4>
  <div class="itemizedlist">
   <ul class="itemizedlist" style="list-style-type: disc; ">
    <li class="listitem">
     <p>
      <a name="option_ndb_perror_defaults-extra-file">
      </a>
      <a class="link" href="mysql-cluster-programs-ndb-perror.html#option_ndb_perror_defaults-extra-file">
       <code class="option">
        --defaults-extra-file
       </code>
      </a>
     </p>
     <a class="indexterm" name="idm46045100706032">
     </a>
     <a class="indexterm" name="idm46045100704576">
     </a>
     <div class="informaltable">
      <table frame="box" rules="all" summary="Properties for defaults-extra-file">
       <colgroup>
        <col style="width: 30%"/>
        <col style="width: 70%"/>
       </colgroup>
       <tbody>
        <tr>
         <th>
          Command-Line Format
         </th>
         <td>
          <code class="literal">
           --defaults-extra-file=path
          </code>
         </td>
        </tr>
        <tr>
         <th>
          Type
         </th>
         <td>
          String
         </td>
        </tr>
        <tr>
         <th>
          Default Value
         </th>
         <td>
          <code class="literal">
           [none]
          </code>
         </td>
        </tr>
       </tbody>
      </table>
     </div>
     <p>
      Read given file after global files are read.
     </p>
    </li>
    <li class="listitem">
     <p>
      <a name="option_ndb_perror_defaults-file">
      </a>
      <a class="link" href="mysql-cluster-programs-ndb-perror.html#option_ndb_perror_defaults-file">
       <code class="option">
        --defaults-file
       </code>
      </a>
     </p>
     <a class="indexterm" name="idm46045100690224">
     </a>
     <a class="indexterm" name="idm46045100688736">
     </a>
     <div class="informaltable">
      <table frame="box" rules="all" summary="Properties for defaults-file">
       <colgroup>
        <col style="width: 30%"/>
        <col style="width: 70%"/>
       </colgroup>
       <tbody>
        <tr>
         <th>
          Command-Line Format
         </th>
         <td>
          <code class="literal">
           --defaults-file=path
          </code>
         </td>
        </tr>
        <tr>
         <th>
          Type
         </th>
         <td>
          String
         </td>
        </tr>
        <tr>
         <th>
          Default Value
         </th>
         <td>
          <code class="literal">
           [none]
          </code>
         </td>
        </tr>
       </tbody>
      </table>
     </div>
     <p>
      Read default options from given file only.
     </p>
    </li>
    <li class="listitem">
     <p>
      <a name="option_ndb_perror_defaults-group-suffix">
      </a>
      <a class="link" href="mysql-cluster-programs-ndb-perror.html#option_ndb_perror_defaults-group-suffix">
       <code class="option">
        --defaults-group-suffix
       </code>
      </a>
     </p>
     <a class="indexterm" name="idm46045100674528">
     </a>
     <a class="indexterm" name="idm46045100673072">
     </a>
     <div class="informaltable">
      <table frame="box" rules="all" summary="Properties for defaults-group-suffix">
       <colgroup>
        <col style="width: 30%"/>
        <col style="width: 70%"/>
       </colgroup>
       <tbody>
        <tr>
         <th>
          Command-Line Format
         </th>
         <td>
          <code class="literal">
           --defaults-group-suffix=string
          </code>
         </td>
        </tr>
        <tr>
         <th>
          Type
         </th>
         <td>
          String
         </td>
        </tr>
        <tr>
         <th>
          Default Value
         </th>
         <td>
          <code class="literal">
           [none]
          </code>
         </td>
        </tr>
       </tbody>
      </table>
     </div>
     <p>
      Also read groups with concat(group, suffix).
     </p>
    </li>
    <li class="listitem">
     <p>
      <a name="option_ndb_perror_help">
      </a>
      <a class="link" href="mysql-cluster-programs-ndb-perror.html#option_ndb_perror_help">
       <code class="option">
        --help
       </code>
      </a>
      ,
      <code class="option">
       -?
      </code>
     </p>
     <a class="indexterm" name="idm46045100658416">
     </a>
     <a class="indexterm" name="idm46045100656928">
     </a>
     <div class="informaltable">
      <table frame="box" rules="all" summary="Properties for help">
       <colgroup>
        <col style="width: 30%"/>
        <col style="width: 70%"/>
       </colgroup>
       <tbody>
        <tr>
         <th>
          Command-Line Format
         </th>
         <td>
          <code class="literal">
           --help
          </code>
         </td>
        </tr>
       </tbody>
      </table>
     </div>
     <p>
      Display program help text and exit.
     </p>
    </li>
    <li class="listitem">
     <p>
      <a name="option_ndb_perror_login-path">
      </a>
      <a class="link" href="mysql-cluster-programs-ndb-perror.html#option_ndb_perror_login-path">
       <code class="option">
        --login-path
       </code>
      </a>
     </p>
     <a class="indexterm" name="idm46045100647184">
     </a>
     <a class="indexterm" name="idm46045100645696">
     </a>
     <div class="informaltable">
      <table frame="box" rules="all" summary="Properties for login-path">
       <colgroup>
        <col style="width: 30%"/>
        <col style="width: 70%"/>
       </colgroup>
       <tbody>
        <tr>
         <th>
          Command-Line Format
         </th>
         <td>
          <code class="literal">
           --login-path=path
          </code>
         </td>
        </tr>
        <tr>
         <th>
          Type
         </th>
         <td>
          String
         </td>
        </tr>
        <tr>
         <th>
          Default Value
         </th>
         <td>
          <code class="literal">
           [none]
          </code>
         </td>
        </tr>
       </tbody>
      </table>
     </div>
     <p>
      Read given path from login file.
     </p>
    </li>
    <li class="listitem">
     <p>
      <a name="option_ndb_perror_no-login-paths">
      </a>
      <a class="link" href="mysql-cluster-programs-ndb-perror.html#option_ndb_perror_no-login-paths">
       <code class="option">
        --no-login-paths
       </code>
      </a>
     </p>
     <a class="indexterm" name="idm46045100631424">
     </a>
     <a class="indexterm" name="idm46045100629936">
     </a>
     <div class="informaltable">
      <table frame="box" rules="all" summary="Properties for no-login-paths">
       <colgroup>
        <col style="width: 30%"/>
        <col style="width: 70%"/>
       </colgroup>
       <tbody>
        <tr>
         <th>
          Command-Line Format
         </th>
         <td>
          <code class="literal">
           --no-login-paths
          </code>
         </td>
        </tr>
       </tbody>
      </table>
     </div>
     <p>
      Skips reading options from the login path file.
     </p>
    </li>
    <li class="listitem">
     <p>
      <a name="option_ndb_perror_ndb">
      </a>
      <a class="link" href="mysql-cluster-programs-ndb-perror.html#option_ndb_perror_ndb">
       <code class="option">
        --ndb
       </code>
      </a>
     </p>
     <a class="indexterm" name="idm46045100620448">
     </a>
     <a class="indexterm" name="idm46045100618960">
     </a>
     <div class="informaltable">
      <table frame="box" rules="all" summary="Properties for ndb">
       <colgroup>
        <col style="width: 30%"/>
        <col style="width: 70%"/>
       </colgroup>
       <tbody>
        <tr>
         <th>
          Command-Line Format
         </th>
         <td>
          <code class="literal">
           --ndb
          </code>
         </td>
        </tr>
       </tbody>
      </table>
     </div>
     <p>
      For compatibility with applications depending on old
            versions of
      <a class="link" href="perror.html" title="6.8.1 perror — Display MySQL Error Message Information">
       <span class="command">
        <strong>
         perror
        </strong>
       </span>
      </a>
      that use that
            program's
      <a class="ulink" href="/doc/refman/8.0/en/perror.html#option_perror_ndb" target="_top">
       <code class="option">
        --ndb
       </code>
      </a>
      option.
            The option when used with
      <a class="link" href="mysql-cluster-programs-ndb-perror.html" title="25.5.16 ndb_perror — Obtain NDB Error Message Information">
       <span class="command">
        <strong>
         ndb_perror
        </strong>
       </span>
      </a>
      does
            nothing, and is ignored by it.
     </p>
    </li>
    <li class="listitem">
     <p>
      <a name="option_ndb_perror_no-defaults">
      </a>
      <a class="link" href="mysql-cluster-programs-ndb-perror.html#option_ndb_perror_no-defaults">
       <code class="option">
        --no-defaults
       </code>
      </a>
     </p>
     <a class="indexterm" name="idm46045100605696">
     </a>
     <a class="indexterm" name="idm46045100604208">
     </a>
     <div class="informaltable">
      <table frame="box" rules="all" summary="Properties for no-defaults">
       <colgroup>
        <col style="width: 30%"/>
        <col style="width: 70%"/>
       </colgroup>
       <tbody>
        <tr>
         <th>
          Command-Line Format
         </th>
         <td>
          <code class="literal">
           --no-defaults
          </code>
         </td>
        </tr>
       </tbody>
      </table>
     </div>
     <p>
      Do not read default options from any option file other than
            login file.
     </p>
    </li>
    <li class="listitem">
     <p>
      <a name="option_ndb_perror_print-defaults">
      </a>
      <a class="link" href="mysql-cluster-programs-ndb-perror.html#option_ndb_perror_print-defaults">
       <code class="option">
        --print-defaults
       </code>
      </a>
     </p>
     <a class="indexterm" name="idm46045100594496">
     </a>
     <a class="indexterm" name="idm46045100593008">
     </a>
     <div class="informaltable">
      <table frame="box" rules="all" summary="Properties for print-defaults">
       <colgroup>
        <col style="width: 30%"/>
        <col style="width: 70%"/>
       </colgroup>
       <tbody>
        <tr>
         <th>
          Command-Line Format
         </th>
         <td>
          <code class="literal">
           --print-defaults
          </code>
         </td>
        </tr>
       </tbody>
      </table>
     </div>
     <p>
      Print program argument list and exit.
     </p>
    </li>
    <li class="listitem">
     <p>
      <a name="option_ndb_perror_silent">
      </a>
      <a class="link" href="mysql-cluster-programs-ndb-perror.html#option_ndb_perror_silent">
       <code class="option">
        --silent
       </code>
      </a>
      ,
      <code class="option">
       -s
      </code>
     </p>
     <a class="indexterm" name="idm46045100582928">
     </a>
     <a class="indexterm" name="idm46045100581440">
     </a>
     <div class="informaltable">
      <table frame="box" rules="all" summary="Properties for silent">
       <colgroup>
        <col style="width: 30%"/>
        <col style="width: 70%"/>
       </colgroup>
       <tbody>
        <tr>
         <th>
          Command-Line Format
         </th>
         <td>
          <code class="literal">
           --silent
          </code>
         </td>
        </tr>
       </tbody>
      </table>
     </div>
     <p>
      Show error message only.
     </p>
    </li>
    <li class="listitem">
     <p>
      <a name="option_ndb_perror_version">
      </a>
      <a class="link" href="mysql-cluster-programs-ndb-perror.html#option_ndb_perror_version">
       <code class="option">
        --version
       </code>
      </a>
      ,
      <code class="option">
       -V
      </code>
     </p>
     <a class="indexterm" name="idm46045100571344">
     </a>
     <a class="indexterm" name="idm46045100569856">
     </a>
     <div class="informaltable">
      <table frame="box" rules="all" summary="Properties for version">
       <colgroup>
        <col style="width: 30%"/>
        <col style="width: 70%"/>
       </colgroup>
       <tbody>
        <tr>
         <th>
          Command-Line Format
         </th>
         <td>
          <code class="literal">
           --version
          </code>
         </td>
        </tr>
       </tbody>
      </table>
     </div>
     <p>
      Print program version information and exit.
     </p>
    </li>
    <li class="listitem">
     <p>
      <a name="option_ndb_perror_verbose">
      </a>
      <a class="link" href="mysql-cluster-programs-ndb-perror.html#option_ndb_perror_verbose">
       <code class="option">
        --verbose
       </code>
      </a>
      ,
      <code class="option">
       -v
      </code>
     </p>
     <a class="indexterm" name="idm46045100559744">
     </a>
     <a class="indexterm" name="idm46045100558256">
     </a>
     <div class="informaltable">
      <table frame="box" rules="all" summary="Properties for verbose">
       <colgroup>
        <col style="width: 30%"/>
        <col style="width: 70%"/>
       </colgroup>
       <tbody>
        <tr>
         <th>
          Command-Line Format
         </th>
         <td>
          <code class="literal">
           --verbose
          </code>
         </td>
        </tr>
       </tbody>
      </table>
     </div>
     <p>
      Verbose output; disable with
      <a class="link" href="mysql-cluster-programs-ndb-perror.html#option_ndb_perror_silent">
       <code class="option">
        --silent
       </code>
      </a>
      .
     </p>
    </li>
   </ul>
  </div>
 </div>
 <br/>
</div>
