> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt
> Use this file to discover all available pages before exploring further.

# gpudb::CheckTableRequest

> gpudb::CheckTableRequest — Kinetica C++ API

<div className="kinetica-doxygen">
  <div className="contents">
    <p>A set of parameters for <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#a90b3a1ea70450b92e93bcc38ca4e5658">GPUdb::checkTable</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/check__table_8h_source">gpudb/protocol/check\_table.h</a>></code></p>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader"> Public Member Functions</h2>
        </td>
      </tr>

      <tr className="memitem:a5111ba6523141a3bae46a3db494ce214" id="r_a5111ba6523141a3bae46a3db494ce214">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a5111ba6523141a3bae46a3db494ce214">CheckTableRequest</a> ()</td>
      </tr>

      <tr className="memdesc:a5111ba6523141a3bae46a3db494ce214">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1CheckTableRequest" title="A set of parameters for GPUdb::checkTable.">CheckTableRequest</a> object with default parameters. <br /></td>
      </tr>

      <tr className="separator:a5111ba6523141a3bae46a3db494ce214">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a89585d4f623533611546860c16a4207b" id="r_a89585d4f623533611546860c16a4207b">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a89585d4f623533611546860c16a4207b">CheckTableRequest</a> (const std::vector\< std::string > \&tableNames\_, const std::map\< std::string, std::string > \&options\_)</td>
      </tr>

      <tr className="memdesc:a89585d4f623533611546860c16a4207b">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1CheckTableRequest" title="A set of parameters for GPUdb::checkTable.">CheckTableRequest</a> object with the specified parameters. <br /></td>
      </tr>

      <tr className="separator:a89585d4f623533611546860c16a4207b">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>
    </table>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader"> Public Attributes</h2>
        </td>
      </tr>

      <tr className="memitem:a86963be684731f0b74fd1c68633cd15c" id="r_a86963be684731f0b74fd1c68633cd15c">
        <td className="memItemLeft" align="right" valign="top">std::vector\< std::string > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a86963be684731f0b74fd1c68633cd15c">tableNames</a></td>
      </tr>

      <tr className="memdesc:a86963be684731f0b74fd1c68633cd15c">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">List of tables to query. <br /></td>
      </tr>

      <tr className="separator:a86963be684731f0b74fd1c68633cd15c">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:af27ceca57d8d1ad20b1039f3113ebb89" id="r_af27ceca57d8d1ad20b1039f3113ebb89">
        <td className="memItemLeft" align="right" valign="top">std::map\< std::string, std::string > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#af27ceca57d8d1ad20b1039f3113ebb89">options</a></td>
      </tr>

      <tr className="memdesc:af27ceca57d8d1ad20b1039f3113ebb89">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Optional parameters. <br /></td>
      </tr>

      <tr className="separator:af27ceca57d8d1ad20b1039f3113ebb89">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>
    </table>

    <h2 className="groupheader">Detailed Description</h2>

    <div className="textblock">
      <p>A set of parameters for <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#a90b3a1ea70450b92e93bcc38ca4e5658">GPUdb::checkTable</a>. </p>
      <p>Scans the requested tables as specified in <a className="el" href="#a86963be684731f0b74fd1c68633cd15c">tableNames</a> for integrity. Any table chunks which fail the check will be marked as corrupt. By default the database will automatically repair corrupt tables (via truncating). Note that since this reads every table column from disk it may be a potentially long-running operation. The option <a className="el" href="/content/api/cpp/namespacegpudb#a8401ed637326bcdcc0d079e04c8d3415">local\_only</a> can be used to skip any table files already written to a remote storage. Returns table corruption results. </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/check__table_8h_source#l00024">24</a> of file <a className="el" href="/content/api/cpp/check__table_8h_source">check\_table.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a5111ba6523141a3bae46a3db494ce214">◆ </a></span>CheckTableRequest() <span className="overload">\[1/2]</span></h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">gpudb::CheckTableRequest::CheckTableRequest </td>
                  <td>(</td>

                  <td className="paramname">
                    <span className="paramname">
                      <span className="em" />
                    </span>
                  </td>

                  <td>)</td>

                  <td />
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel inline">inline</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1CheckTableRequest" title="A set of parameters for GPUdb::checkTable.">CheckTableRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/check__table_8h_source#l00029">29</a> of file <a className="el" href="/content/api/cpp/check__table_8h_source">check\_table.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a89585d4f623533611546860c16a4207b">◆ </a></span>CheckTableRequest() <span className="overload">\[2/2]</span></h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">gpudb::CheckTableRequest::CheckTableRequest </td>
                  <td>(</td>
                  <td className="paramtype">const std::vector\< std::string > &</td>
                  <td className="paramname"><span className="paramname"><span className="em">tableNames\_</span></span>, </td>
                </tr>

                <tr>
                  <td className="paramkey" />

                  <td />

                  <td className="paramtype">const std::map\< std::string, std::string > &</td>
                  <td className="paramname"><span className="paramname"><span className="em">options\_</span></span> )</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel inline">inline</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1CheckTableRequest" title="A set of parameters for GPUdb::checkTable.">CheckTableRequest</a> object with the specified parameters. </p>

        <div className="dl params">
          <div className="dt">Parameters</div>

          <div className="dd">
            <table className="params">
              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">tableNames\_</td>
                <td>List of tables to query. An asterisk returns all tables. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">options\_</td>

                <td>
                  Optional parameters.

                  <ul>
                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a8401ed637326bcdcc0d079e04c8d3415">check\_table\_local\_only</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#acedf36978a7c4bcd539742011f089d5d">true</a> only locally persisted files will be checked. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#acedf36978a7c4bcd539742011f089d5d">check\_table\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#af4c598105fb0d8ba28b7b7f6fbf3d47f">check\_table\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#af4c598105fb0d8ba28b7b7f6fbf3d47f">check\_table\_false</a>.
                    </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a03e8a889b6b455654cae1415bdb0ae11">check\_table\_show\_detail</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#acedf36978a7c4bcd539742011f089d5d">true</a> reports individual chunk errors. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#acedf36978a7c4bcd539742011f089d5d">check\_table\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#af4c598105fb0d8ba28b7b7f6fbf3d47f">check\_table\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#acedf36978a7c4bcd539742011f089d5d">check\_table\_true</a>.
                    </li>
                  </ul>

                  The default value is an empty map.
                </td>
              </tr>
            </table>
          </div>
        </div>

        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/check__table_8h_source#l00074">74</a> of file <a className="el" href="/content/api/cpp/check__table_8h_source">check\_table.h</a>.</p>
      </div>
    </div>

    <h2 className="groupheader">Member Data Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#af27ceca57d8d1ad20b1039f3113ebb89">◆ </a></span>options</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::map\<std::string, std::string> gpudb::CheckTableRequest::options</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Optional parameters. </p>

        <ul>
          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a8401ed637326bcdcc0d079e04c8d3415">check\_table\_local\_only</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#acedf36978a7c4bcd539742011f089d5d">true</a> only locally persisted files will be checked. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#acedf36978a7c4bcd539742011f089d5d">check\_table\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#af4c598105fb0d8ba28b7b7f6fbf3d47f">check\_table\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#af4c598105fb0d8ba28b7b7f6fbf3d47f">check\_table\_false</a>.
          </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a03e8a889b6b455654cae1415bdb0ae11">check\_table\_show\_detail</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#acedf36978a7c4bcd539742011f089d5d">true</a> reports individual chunk errors. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#acedf36978a7c4bcd539742011f089d5d">check\_table\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#af4c598105fb0d8ba28b7b7f6fbf3d47f">check\_table\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#acedf36978a7c4bcd539742011f089d5d">check\_table\_true</a>.
          </li>
        </ul>

        <p>The default value is an empty map. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/check__table_8h_source#l00111">111</a> of file <a className="el" href="/content/api/cpp/check__table_8h_source">check\_table.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a86963be684731f0b74fd1c68633cd15c">◆ </a></span>tableNames</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::vector\<std::string> gpudb::CheckTableRequest::tableNames</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>List of tables to query. </p>
        <p>An asterisk returns all tables. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/check__table_8h_source#l00083">83</a> of file <a className="el" href="/content/api/cpp/check__table_8h_source">check\_table.h</a>.</p>
      </div>
    </div>

    <hr />

    The documentation for this struct was generated from the following file:

    <ul>
      <li>gpudb/protocol/<a className="el" href="/content/api/cpp/check__table_8h_source">check\_table.h</a></li>
    </ul>
  </div>
</div>