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

> gpudb::ShowEnvironmentRequest — 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#ad2c3289e4d36b6d0278357e362354c35">GPUdb::showEnvironment</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/show__environment_8h_source">gpudb/protocol/show\_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:a555db120137dfb927d41fbef1ef2122f" id="r_a555db120137dfb927d41fbef1ef2122f">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a555db120137dfb927d41fbef1ef2122f">ShowEnvironmentRequest</a> ()</td>
      </tr>

      <tr className="memdesc:a555db120137dfb927d41fbef1ef2122f">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1ShowEnvironmentRequest" title="A set of parameters for GPUdb::showEnvironment.">ShowEnvironmentRequest</a> object with default parameters. <br /></td>
      </tr>

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

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

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

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

      <tr className="memdesc:a3d3a5e73229c0dbb554b532b6fb25629">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Name of the environment on which to retrieve information. <br /></td>
      </tr>

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

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

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

      <tr className="separator:a0705d72af1a9d6bdebaf117b48373b46">
        <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#ad2c3289e4d36b6d0278357e362354c35">GPUdb::showEnvironment</a>. </p>
      <p>Shows information about a specified <a href="/content/concepts/udf/" target="_top">user-defined function</a> (UDF) environment or all environments. Returns detailed information about existing environments. </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/show__environment_8h_source#l00021">21</a> of file <a className="el" href="/content/api/cpp/show__environment_8h_source">show\_environment.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a555db120137dfb927d41fbef1ef2122f">◆ </a></span>ShowEnvironmentRequest() <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::ShowEnvironmentRequest::ShowEnvironmentRequest </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_1ShowEnvironmentRequest" title="A set of parameters for GPUdb::showEnvironment.">ShowEnvironmentRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/show__environment_8h_source#l00026">26</a> of file <a className="el" href="/content/api/cpp/show__environment_8h_source">show\_environment.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#af58353b2034bc2a2cf4cd6f006318769">◆ </a></span>ShowEnvironmentRequest() <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::ShowEnvironmentRequest::ShowEnvironmentRequest </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_1ShowEnvironmentRequest" title="A set of parameters for GPUdb::showEnvironment.">ShowEnvironmentRequest</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 on which to retrieve information. The name must refer to a currently existing environment. If '\*' or an empty value is specified, information about all environments will be returned. 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#af575f109d992b4aef0f341f00e7b5d94">show\_environment\_no\_error\_if\_not\_exists</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a4d1a16db5d9451ac3fcfaeddb78814b9">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#aa866ab06d053878b37890174c72e0c8b">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#a4d1a16db5d9451ac3fcfaeddb78814b9">show\_environment\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#aa866ab06d053878b37890174c72e0c8b">show\_environment\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#aa866ab06d053878b37890174c72e0c8b">show\_environment\_false</a>.
                    </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a8155c4dd32a05da2c9b16699f39779d0">show\_environment\_show\_names\_only</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a4d1a16db5d9451ac3fcfaeddb78814b9">true</a> only return the names of the installed environments and omit package listing. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a4d1a16db5d9451ac3fcfaeddb78814b9">show\_environment\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#aa866ab06d053878b37890174c72e0c8b">show\_environment\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#aa866ab06d053878b37890174c72e0c8b">show\_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/show__environment_8h_source#l00090">90</a> of file <a className="el" href="/content/api/cpp/show__environment_8h_source">show\_environment.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>Name of the environment on which to retrieve information. </p>
        <p>The name must refer to a currently existing environment. If '\*' or an empty value is specified, information about all environments will be returned. The default value is ''. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/show__environment_8h_source#l00102">102</a> of file <a className="el" href="/content/api/cpp/show__environment_8h_source">show\_environment.h</a>.</p>
      </div>
    </div>

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

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

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

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

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a4d1a16db5d9451ac3fcfaeddb78814b9">show\_environment\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#aa866ab06d053878b37890174c72e0c8b">show\_environment\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#aa866ab06d053878b37890174c72e0c8b">show\_environment\_false</a>.
          </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a8155c4dd32a05da2c9b16699f39779d0">show\_environment\_show\_names\_only</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a4d1a16db5d9451ac3fcfaeddb78814b9">true</a> only return the names of the installed environments and omit package listing. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a4d1a16db5d9451ac3fcfaeddb78814b9">show\_environment\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#aa866ab06d053878b37890174c72e0c8b">show\_environment\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#aa866ab06d053878b37890174c72e0c8b">show\_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/show__environment_8h_source#l00139">139</a> of file <a className="el" href="/content/api/cpp/show__environment_8h_source">show\_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/show__environment_8h_source">show\_environment.h</a></li>
    </ul>
  </div>
</div>