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

> gpudb::DropEnvironmentRequest — 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#a14b76ff4dd5ab041e2ccbda35bf3b023">GPUdb::dropEnvironment</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/drop__environment_8h_source">gpudb/protocol/drop\_environment.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:ab041e4fe8fe31dba6607893259792b9f" id="r_ab041e4fe8fe31dba6607893259792b9f">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#ab041e4fe8fe31dba6607893259792b9f">DropEnvironmentRequest</a> ()</td>
      </tr>

      <tr className="memdesc:ab041e4fe8fe31dba6607893259792b9f">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1DropEnvironmentRequest" title="A set of parameters for GPUdb::dropEnvironment.">DropEnvironmentRequest</a> object with default parameters. <br /></td>
      </tr>

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

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

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

      <tr className="separator:af03ea782983566ef022359ea42d3ebf2">
        <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:a4cb261d0d8ef7e5b6151b5063b0e3b38" id="r_a4cb261d0d8ef7e5b6151b5063b0e3b38">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a4cb261d0d8ef7e5b6151b5063b0e3b38">environmentName</a></td>
      </tr>

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

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

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

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

      <tr className="separator:a25b8a146f447ff7156e5bd813325c016">
        <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#a14b76ff4dd5ab041e2ccbda35bf3b023">GPUdb::dropEnvironment</a>. </p>
      <p>Drop an existing <a href="/content/concepts/udf/" target="_top">user-defined function</a> (UDF) environment. </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/drop__environment_8h_source#l00019">19</a> of file <a className="el" href="/content/api/cpp/drop__environment_8h_source">drop\_environment.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#ab041e4fe8fe31dba6607893259792b9f">◆ </a></span>DropEnvironmentRequest() <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::DropEnvironmentRequest::DropEnvironmentRequest </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_1DropEnvironmentRequest" title="A set of parameters for GPUdb::dropEnvironment.">DropEnvironmentRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/drop__environment_8h_source#l00024">24</a> of file <a className="el" href="/content/api/cpp/drop__environment_8h_source">drop\_environment.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#af03ea782983566ef022359ea42d3ebf2">◆ </a></span>DropEnvironmentRequest() <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::DropEnvironmentRequest::DropEnvironmentRequest </td>
                  <td>(</td>
                  <td className="paramtype">const std::string &</td>
                  <td className="paramname"><span className="paramname"><span className="em">environmentName\_</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_1DropEnvironmentRequest" title="A set of parameters for GPUdb::dropEnvironment.">DropEnvironmentRequest</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">environmentName\_</td>
                <td>Name of the environment to be dropped. Must be an existing environment. </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#a2521b71b6a75d3eaeb15cfce2000e5ce">drop\_environment\_no\_error\_if\_not\_exists</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#affd49e2b4c60317582d7e59170529bc7">true</a> and if the environment specified in <span className="em arg">environmentName\_</span> does not exist, no error is returned. If <a className="el" href="/content/api/cpp/namespacegpudb#a9fd7868a0d53f7b0bab5bd0ee09f1cfe">false</a> and if the environment specified in <span className="em arg">environmentName\_</span> does not exist, then an error is returned. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#affd49e2b4c60317582d7e59170529bc7">drop\_environment\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a9fd7868a0d53f7b0bab5bd0ee09f1cfe">drop\_environment\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a9fd7868a0d53f7b0bab5bd0ee09f1cfe">drop\_environment\_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__environment_8h_source#l00064">64</a> of file <a className="el" href="/content/api/cpp/drop__environment_8h_source">drop\_environment.h</a>.</p>
      </div>
    </div>

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

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

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

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

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

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

        <ul>
          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a2521b71b6a75d3eaeb15cfce2000e5ce">drop\_environment\_no\_error\_if\_not\_exists</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#affd49e2b4c60317582d7e59170529bc7">true</a> and if the environment specified in <a className="el" href="#a4cb261d0d8ef7e5b6151b5063b0e3b38">environmentName</a> does not exist, no error is returned. If <a className="el" href="/content/api/cpp/namespacegpudb#a9fd7868a0d53f7b0bab5bd0ee09f1cfe">false</a> and if the environment specified in <a className="el" href="#a4cb261d0d8ef7e5b6151b5063b0e3b38">environmentName</a> does not exist, then an error is returned. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#affd49e2b4c60317582d7e59170529bc7">drop\_environment\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a9fd7868a0d53f7b0bab5bd0ee09f1cfe">drop\_environment\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a9fd7868a0d53f7b0bab5bd0ee09f1cfe">drop\_environment\_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__environment_8h_source#l00098">98</a> of file <a className="el" href="/content/api/cpp/drop__environment_8h_source">drop\_environment.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__environment_8h_source">drop\_environment.h</a></li>
    </ul>
  </div>
</div>