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

> gpudb::DropDatasinkRequest — 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#ad3e43fa7e239c990fa449b0ad0e93d0e">GPUdb::dropDatasink</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/drop__datasink_8h_source">gpudb/protocol/drop\_datasink.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:ae0e375c45eb554ba8653f3193f40213a" id="r_ae0e375c45eb554ba8653f3193f40213a">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#ae0e375c45eb554ba8653f3193f40213a">DropDatasinkRequest</a> ()</td>
      </tr>

      <tr className="memdesc:ae0e375c45eb554ba8653f3193f40213a">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1DropDatasinkRequest" title="A set of parameters for GPUdb::dropDatasink.">DropDatasinkRequest</a> object with default parameters. <br /></td>
      </tr>

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

      <tr className="memitem:aeb1d4d3d72d658d4b00ea7dc2a4c47a6" id="r_aeb1d4d3d72d658d4b00ea7dc2a4c47a6">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#aeb1d4d3d72d658d4b00ea7dc2a4c47a6">DropDatasinkRequest</a> (const std::string \&name\_, const std::map\< std::string, std::string > \&options\_)</td>
      </tr>

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

      <tr className="separator:aeb1d4d3d72d658d4b00ea7dc2a4c47a6">
        <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:a118f6a8b6d6d388f653356c49d363898" id="r_a118f6a8b6d6d388f653356c49d363898">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a118f6a8b6d6d388f653356c49d363898">name</a></td>
      </tr>

      <tr className="memdesc:a118f6a8b6d6d388f653356c49d363898">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Name of the data sink to be dropped. <br /></td>
      </tr>

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

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

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

      <tr className="separator:ac3847947c5836c191791e4e70cfa87ea">
        <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#ad3e43fa7e239c990fa449b0ad0e93d0e">GPUdb::dropDatasink</a>. </p>
      <p>Drops an existing <a href="/content/concepts/data_sinks/" target="_top">data sink</a>.</p>
      <p>By default, if any <a href="/content/concepts/table_monitors" target="_top">table monitors</a> use this sink as a destination, the request will be blocked unless option <a className="el" href="/content/api/cpp/namespacegpudb#a006aaa5a6920d6d800c0b359acbc8186">clear\_table\_monitors</a> is <a className="el" href="/content/api/cpp/namespacegpudb#ab3796448d7c9c059f60333507efdb713">true</a>. </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/drop__datasink_8h_source#l00025">25</a> of file <a className="el" href="/content/api/cpp/drop__datasink_8h_source">drop\_datasink.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#ae0e375c45eb554ba8653f3193f40213a">◆ </a></span>DropDatasinkRequest() <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::DropDatasinkRequest::DropDatasinkRequest </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_1DropDatasinkRequest" title="A set of parameters for GPUdb::dropDatasink.">DropDatasinkRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/drop__datasink_8h_source#l00030">30</a> of file <a className="el" href="/content/api/cpp/drop__datasink_8h_source">drop\_datasink.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#aeb1d4d3d72d658d4b00ea7dc2a4c47a6">◆ </a></span>DropDatasinkRequest() <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::DropDatasinkRequest::DropDatasinkRequest </td>
                  <td>(</td>
                  <td className="paramtype">const std::string &</td>
                  <td className="paramname"><span className="paramname"><span className="em">name\_</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_1DropDatasinkRequest" title="A set of parameters for GPUdb::dropDatasink.">DropDatasinkRequest</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">name\_</td>
                <td>Name of the data sink to be dropped. Must be an existing data sink. </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#a006aaa5a6920d6d800c0b359acbc8186">drop\_datasink\_clear\_table\_monitors</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#ab3796448d7c9c059f60333507efdb713">true</a>, any <a href="/content/concepts/table_monitors/" target="_top">table monitors</a> that use this data sink will be cleared. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#ab3796448d7c9c059f60333507efdb713">drop\_datasink\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a56149c6b2cbeee7126252eea80d1eec1">drop\_datasink\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a56149c6b2cbeee7126252eea80d1eec1">drop\_datasink\_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/drop__datasink_8h_source#l00065">65</a> of file <a className="el" href="/content/api/cpp/drop__datasink_8h_source">drop\_datasink.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>Name of the data sink to be dropped. </p>
        <p>Must be an existing data sink. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/drop__datasink_8h_source#l00074">74</a> of file <a className="el" href="/content/api/cpp/drop__datasink_8h_source">drop\_datasink.h</a>.</p>
      </div>
    </div>

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

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

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

        <ul>
          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a006aaa5a6920d6d800c0b359acbc8186">drop\_datasink\_clear\_table\_monitors</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#ab3796448d7c9c059f60333507efdb713">true</a>, any <a href="/content/concepts/table_monitors/" target="_top">table monitors</a> that use this data sink will be cleared. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#ab3796448d7c9c059f60333507efdb713">drop\_datasink\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a56149c6b2cbeee7126252eea80d1eec1">drop\_datasink\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a56149c6b2cbeee7126252eea80d1eec1">drop\_datasink\_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/drop__datasink_8h_source#l00095">95</a> of file <a className="el" href="/content/api/cpp/drop__datasink_8h_source">drop\_datasink.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/drop__datasink_8h_source">drop\_datasink.h</a></li>
    </ul>
  </div>
</div>