> ## 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::ClearTablesRequest

> gpudb::ClearTablesRequest — 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/cleartables#a6ea34c34f63eb6781811eea53b2a7e33">GPUdb::clearTables</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="https://github.com/kineticadb/kinetica-api-cpp/blob/master/gpudb/protocol/clear_tables.h">gpudb/protocol/clear\_tables.h</a>></code></p>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader">
            <div id="pub-methods" />

            Public Member Functions
          </h2>
        </td>
      </tr>

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

      <tr className="memdesc:a3355a86b48a1f5ab19710f9f6cd242f7">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1ClearTablesRequest" title="A set of parameters for GPUdb::clearTables.">ClearTablesRequest</a> object with default parameters. <br /></td>
      </tr>

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

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

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

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

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader">
            <div id="pub-attribs" />

            Public Attributes
          </h2>
        </td>
      </tr>

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

      <tr className="memdesc:a0babc8dca214897e4c604987e4efb3d2">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Names of the tables to be cleared, in \[ schema\_name. ]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>. <br /></td>
      </tr>

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

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

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

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

    <div id="details" />

    <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/cleartables#a6ea34c34f63eb6781811eea53b2a7e33">GPUdb::clearTables</a>. </p>
      <p>Clears (drops) tables in the database cluster. The operation is synchronous meaning that the tables will be cleared before the function returns. The response payload returns the status of the operation for each table requested. </p>
      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cpp/blob/master/gpudb/protocol/clear_tables.h#L21">21</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cpp/blob/master/gpudb/protocol/clear_tables.h">clear\_tables.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>

    <div id="a3355a86b48a1f5ab19710f9f6cd242f7" />

    <h2 className="memtitle"><span className="permalink"><a href="#a3355a86b48a1f5ab19710f9f6cd242f7">◆ </a></span>ClearTablesRequest() <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::ClearTablesRequest::ClearTablesRequest </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_1ClearTablesRequest" title="A set of parameters for GPUdb::clearTables.">ClearTablesRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cpp/blob/master/gpudb/protocol/clear_tables.h#L26">26</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cpp/blob/master/gpudb/protocol/clear_tables.h">clear\_tables.h</a>.</p>
      </div>
    </div>

    <div id="a2c2e465b4975b2c59baf9098f22d550b" />

    <h2 className="memtitle"><span className="permalink"><a href="#a2c2e465b4975b2c59baf9098f22d550b">◆ </a></span>ClearTablesRequest() <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::ClearTablesRequest::ClearTablesRequest </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_1ClearTablesRequest" title="A set of parameters for GPUdb::clearTables.">ClearTablesRequest</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>Names of the tables to be cleared, in \[schema\_name.]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>. Must be existing tables. Empty list clears all available tables, though this behavior is prevented by default via system configuration parameter <a href="/content/config/#config-main-general" target="_top">disable\_clear\_all</a>. The default value is an empty vector. </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#aad8bebea802c4d60f13cb20c11cdee46">clear\_tables\_no\_error\_if\_not\_exists</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#aeb4d938d6844d47c476c1e7f793b7603">true</a> and if a table specified in <span className="em arg">tableNames\_</span> does not exist no error is returned. If <a className="el" href="/content/api/cpp/namespacegpudb#a0820747ad294b1af92e267be2a7beae0">false</a> and if a table specified in <span className="em arg">tableNames\_</span> does not exist then an error is returned. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#aeb4d938d6844d47c476c1e7f793b7603">clear\_tables\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a0820747ad294b1af92e267be2a7beae0">clear\_tables\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a0820747ad294b1af92e267be2a7beae0">clear\_tables\_false</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="https://github.com/kineticadb/kinetica-api-cpp/blob/master/gpudb/protocol/clear_tables.h#L74">74</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cpp/blob/master/gpudb/protocol/clear_tables.h">clear\_tables.h</a>.</p>
      </div>
    </div>

    <h2 className="groupheader">Member Data Documentation</h2>

    <div id="aa687fc75f3d7c55dac3f7de53188dadd" />

    <h2 className="memtitle"><span className="permalink"><a href="#aa687fc75f3d7c55dac3f7de53188dadd">◆ </a></span>options</h2>

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

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

        <ul>
          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#aad8bebea802c4d60f13cb20c11cdee46">clear\_tables\_no\_error\_if\_not\_exists</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#aeb4d938d6844d47c476c1e7f793b7603">true</a> and if a table specified in <a className="el" href="#a0babc8dca214897e4c604987e4efb3d2">tableNames</a> does not exist no error is returned. If <a className="el" href="/content/api/cpp/namespacegpudb#a0820747ad294b1af92e267be2a7beae0">false</a> and if a table specified in <a className="el" href="#a0babc8dca214897e4c604987e4efb3d2">tableNames</a> does not exist then an error is returned. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#aeb4d938d6844d47c476c1e7f793b7603">clear\_tables\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a0820747ad294b1af92e267be2a7beae0">clear\_tables\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a0820747ad294b1af92e267be2a7beae0">clear\_tables\_false</a>.
          </li>
        </ul>

        <p>The default value is an empty map. </p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cpp/blob/master/gpudb/protocol/clear_tables.h#L112">112</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cpp/blob/master/gpudb/protocol/clear_tables.h">clear\_tables.h</a>.</p>
      </div>
    </div>

    <div id="a0babc8dca214897e4c604987e4efb3d2" />

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

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

      <div className="memdoc">
        <p>Names of the tables to be cleared, in \[ schema\_name. ]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>. </p>
        <p>Must be existing tables. Empty list clears all available tables, though this behavior is prevented by default via system configuration parameter <a href="/content/config/#config-main-general" target="_top">disable\_clear\_all</a>. The default value is an empty vector. </p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cpp/blob/master/gpudb/protocol/clear_tables.h#L91">91</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cpp/blob/master/gpudb/protocol/clear_tables.h">clear\_tables.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="https://github.com/kineticadb/kinetica-api-cpp/blob/master/gpudb/protocol/clear_tables.h">clear\_tables.h</a></li>
    </ul>
  </div>
</div>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.