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

> gpudb::ClearTableRequest — 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#a438f915ee5d2c8e5c624610842f47b34">GPUdb::clearTable</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/clear__table_8h_source">gpudb/protocol/clear\_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:a28a3482945b1f3d70e73fdf7c810fc52" id="r_a28a3482945b1f3d70e73fdf7c810fc52">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a28a3482945b1f3d70e73fdf7c810fc52">ClearTableRequest</a> ()</td>
      </tr>

      <tr className="memdesc:a28a3482945b1f3d70e73fdf7c810fc52">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1ClearTableRequest" title="A set of parameters for GPUdb::clearTable.">ClearTableRequest</a> object with default parameters. <br /></td>
      </tr>

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

      <tr className="memitem:aa0d961dcec1bb7cd056ca40ee303ed3b" id="r_aa0d961dcec1bb7cd056ca40ee303ed3b">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#aa0d961dcec1bb7cd056ca40ee303ed3b">ClearTableRequest</a> (const std::string \&tableName\_, const std::string \&authorization\_, const std::map\< std::string, std::string > \&options\_)</td>
      </tr>

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

      <tr className="separator:aa0d961dcec1bb7cd056ca40ee303ed3b">
        <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:acd4677a797ca3b0a2932755ce671a4e2" id="r_acd4677a797ca3b0a2932755ce671a4e2">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#acd4677a797ca3b0a2932755ce671a4e2">tableName</a></td>
      </tr>

      <tr className="memdesc:acd4677a797ca3b0a2932755ce671a4e2">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Name of the table 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:acd4677a797ca3b0a2932755ce671a4e2">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a41533e83f1c92b78051547483318c76c" id="r_a41533e83f1c92b78051547483318c76c">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a41533e83f1c92b78051547483318c76c">authorization</a></td>
      </tr>

      <tr className="memdesc:a41533e83f1c92b78051547483318c76c">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">No longer used. <br /></td>
      </tr>

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

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

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

      <tr className="separator:ac7f9b03d78a3b519bf34cae98ae94602">
        <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#a438f915ee5d2c8e5c624610842f47b34">GPUdb::clearTable</a>. </p>
      <p>Clears (drops) one or all tables in the database cluster. The operation is synchronous meaning that the table will be cleared before the function returns. The response payload returns the status of the operation along with the name of the table that was cleared. </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/clear__table_8h_source#l00020">20</a> of file <a className="el" href="/content/api/cpp/clear__table_8h_source">clear\_table.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a28a3482945b1f3d70e73fdf7c810fc52">◆ </a></span>ClearTableRequest() <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::ClearTableRequest::ClearTableRequest </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_1ClearTableRequest" title="A set of parameters for GPUdb::clearTable.">ClearTableRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/clear__table_8h_source#l00025">25</a> of file <a className="el" href="/content/api/cpp/clear__table_8h_source">clear\_table.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#aa0d961dcec1bb7cd056ca40ee303ed3b">◆ </a></span>ClearTableRequest() <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::ClearTableRequest::ClearTableRequest </td>
                  <td>(</td>
                  <td className="paramtype">const std::string &</td>
                  <td className="paramname"><span className="paramname"><span className="em">tableName\_</span></span>, </td>
                </tr>

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

                  <td />

                  <td className="paramtype">const std::string &</td>
                  <td className="paramname"><span className="paramname"><span className="em">authorization\_</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_1ClearTableRequest" title="A set of parameters for GPUdb::clearTable.">ClearTableRequest</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">tableName\_</td>
                <td>Name of the table 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 an existing table. Empty string clears all available tables, though this behavior is be prevented by default via gpudb.conf parameter 'disable\_clear\_all'. The default value is ''. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">authorization\_</td>
                <td>No longer used. User can pass an empty string. The default value is ''. </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#adea8b5fd768ea481c4324cedafc8ccc0">clear\_table\_no\_error\_if\_not\_exists</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a19066cad9fd313d9af1c6e6b7abfaaf5">true</a> and if the table specified in <span className="em arg">tableName\_</span> does not exist no error is returned. If <a className="el" href="/content/api/cpp/namespacegpudb#a8ce33841713205619a147b0e16df489b">false</a> and if the table specified in <span className="em arg">tableName\_</span> does not exist then an error is returned. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a19066cad9fd313d9af1c6e6b7abfaaf5">clear\_table\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a8ce33841713205619a147b0e16df489b">clear\_table\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a8ce33841713205619a147b0e16df489b">clear\_table\_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="/content/api/cpp/clear__table_8h_source#l00072">72</a> of file <a className="el" href="/content/api/cpp/clear__table_8h_source">clear\_table.h</a>.</p>
      </div>
    </div>

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

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::string gpudb::ClearTableRequest::authorization</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>No longer used. </p>
        <p>User can pass an empty string. The default value is ''. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/clear__table_8h_source#l00094">94</a> of file <a className="el" href="/content/api/cpp/clear__table_8h_source">clear\_table.h</a>.</p>
      </div>
    </div>

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

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

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

        <ul>
          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#adea8b5fd768ea481c4324cedafc8ccc0">clear\_table\_no\_error\_if\_not\_exists</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a19066cad9fd313d9af1c6e6b7abfaaf5">true</a> and if the table specified in <a className="el" href="#acd4677a797ca3b0a2932755ce671a4e2">tableName</a> does not exist no error is returned. If <a className="el" href="/content/api/cpp/namespacegpudb#a8ce33841713205619a147b0e16df489b">false</a> and if the table specified in <a className="el" href="#acd4677a797ca3b0a2932755ce671a4e2">tableName</a> does not exist then an error is returned. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a19066cad9fd313d9af1c6e6b7abfaaf5">clear\_table\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a8ce33841713205619a147b0e16df489b">clear\_table\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a8ce33841713205619a147b0e16df489b">clear\_table\_false</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/clear__table_8h_source#l00115">115</a> of file <a className="el" href="/content/api/cpp/clear__table_8h_source">clear\_table.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#acd4677a797ca3b0a2932755ce671a4e2">◆ </a></span>tableName</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::string gpudb::ClearTableRequest::tableName</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Name of the table 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 an existing table. Empty string clears all available tables, though this behavior is be prevented by default via gpudb.conf parameter 'disable\_clear\_all'. The default value is ''. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/clear__table_8h_source#l00088">88</a> of file <a className="el" href="/content/api/cpp/clear__table_8h_source">clear\_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/clear__table_8h_source">clear\_table.h</a></li>
    </ul>
  </div>
</div>