> ## 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.

# showEnvironment

<div className="kinetica-doxygen">
  <div id="ad2c3289e4d36b6d0278357e362354c35" />

  <h2 className="memtitle"><span className="permalink"><a href="#ad2c3289e4d36b6d0278357e362354c35">◆ </a></span>showEnvironment() <span className="overload">\[1/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1ShowEnvironmentResponse">ShowEnvironmentResponse</a> gpudb::GPUdb::showEnvironment </td>
          <td>(</td>
          <td className="paramtype">const <a className="el" href="/content/api/cpp/structgpudb_1_1ShowEnvironmentRequest">ShowEnvironmentRequest</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">request\_</span></span></td>
          <td>)</td>
          <td> const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Shows information about a specified <a href="/content/concepts/udf/" target="_top">user-defined function</a> (UDF) environment or all environments. </p>
      <p>Returns detailed information about existing environments.</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">request\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1ShowEnvironmentRequest">Request</a> object containing the parameters for the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1ShowEnvironmentResponse">Response</a> object containing the result of the operation. </div>
      </div>
    </div>
  </div>

  <div id="a642110b2dfca287ef3f899ae69471648" />

  <h2 className="memtitle"><span className="permalink"><a href="#a642110b2dfca287ef3f899ae69471648">◆ </a></span>showEnvironment() <span className="overload">\[2/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1ShowEnvironmentResponse">ShowEnvironmentResponse</a> & gpudb::GPUdb::showEnvironment </td>
          <td>(</td>
          <td className="paramtype">const <a className="el" href="/content/api/cpp/structgpudb_1_1ShowEnvironmentRequest">ShowEnvironmentRequest</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">request\_</span></span>, </td>
        </tr>

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

          <td />

          <td className="paramtype"><a className="el" href="/content/api/cpp/structgpudb_1_1ShowEnvironmentResponse">ShowEnvironmentResponse</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">response\_</span></span> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Shows information about a specified <a href="/content/concepts/udf/" target="_top">user-defined function</a> (UDF) environment or all environments. </p>
      <p>Returns detailed information about existing environments.</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">request\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1ShowEnvironmentRequest">Request</a> object containing the parameters for the operation. </td>
            </tr>

            <tr>
              <td className="paramdir">\[out]</td>
              <td className="paramname">response\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1ShowEnvironmentResponse">Response</a> object containing the results of the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1ShowEnvironmentResponse">Response</a> object containing the result of the operation (initially passed in by reference). </div>
      </div>
    </div>
  </div>

  <div id="a02c334c7050c5c8541543bffbb2c3dab" />

  <h2 className="memtitle"><span className="permalink"><a href="#a02c334c7050c5c8541543bffbb2c3dab">◆ </a></span>showEnvironment() <span className="overload">\[3/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1ShowEnvironmentResponse">ShowEnvironmentResponse</a> gpudb::GPUdb::showEnvironment </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> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Shows information about a specified <a href="/content/concepts/udf/" target="_top">user-defined function</a> (UDF) environment or all environments. </p>
      <p>Returns detailed information about existing environments.</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>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1ShowEnvironmentResponse">Response</a> object containing the result of the operation. </div>
      </div>
    </div>
  </div>

  <div id="aa373b15e4a0e973a55356bc2b6a2c0b8" />

  <h2 className="memtitle"><span className="permalink"><a href="#aa373b15e4a0e973a55356bc2b6a2c0b8">◆ </a></span>showEnvironment() <span className="overload">\[4/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1ShowEnvironmentResponse">ShowEnvironmentResponse</a> & gpudb::GPUdb::showEnvironment </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>

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

          <td />

          <td className="paramtype"><a className="el" href="/content/api/cpp/structgpudb_1_1ShowEnvironmentResponse">ShowEnvironmentResponse</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">response\_</span></span> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Shows information about a specified <a href="/content/concepts/udf/" target="_top">user-defined function</a> (UDF) environment or all environments. </p>
      <p>Returns detailed information about existing environments.</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>

            <tr>
              <td className="paramdir">\[out]</td>
              <td className="paramname">response\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1ShowEnvironmentResponse">Response</a> object containing the results of the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1ShowEnvironmentResponse">Response</a> object containing the result of the operation (initially passed in by reference). </div>
      </div>
    </div>
  </div>
</div>