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

# show_environment

### show\_environment

<ul>
  <li>
    show\_environment(\
    &#x20;environment\_name?: string,\
    &#x20;options?: Record\<string, string>,\
    &#x20;callback?: [GPUdbCallback](https://docs.kinetica.com/content/api/nodejs/types/GPUdbCallback.md),\
    ): Promise\<[ShowEnvironmentResponse](https://docs.kinetica.com/content/api/nodejs/interfaces/ShowEnvironmentResponse.md)>

    Shows information about a specified user-defined function (UDF) environment or all environments.Returns detailed information about existing environments.

    #### Parameters

    <ul>
      <li>
        `Optional`environment\_name: string

        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.
      </li>

      <li>
        `Optional`options: Record\<string, string>

        Optional parameters.
      </li>

      <li>
        `Optional`callback: [GPUdbCallback](https://docs.kinetica.com/content/api/nodejs/types/GPUdbCallback.md)

        Optional callback function
      </li>
    </ul>

    #### Returns Promise\<[ShowEnvironmentResponse](https://docs.kinetica.com/content/api/nodejs/interfaces/ShowEnvironmentResponse.md)>

    Promise\<Types.ShowEnvironmentResponse> - Promise resolving to the response

    <ul>
      <li>Defined in [src/GPUdb.ts:13359](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/GPUdb.ts#L13359)</li>
    </ul>
  </li>
</ul>

### show\_environment\_request

<ul>
  <li>
    show\_environment\_request(\
    &#x20;request: [ShowEnvironmentRequest](https://docs.kinetica.com/content/api/nodejs/interfaces/ShowEnvironmentRequest.md),\
    &#x20;callback?: [GPUdbCallback](https://docs.kinetica.com/content/api/nodejs/types/GPUdbCallback.md),\
    ): Promise\<[ShowEnvironmentResponse](https://docs.kinetica.com/content/api/nodejs/interfaces/ShowEnvironmentResponse.md)>

    Shows information about a specified user-defined function (UDF) environment or all environments.Returns detailed information about existing environments.

    #### Parameters

    <ul>
      <li>
        request: [ShowEnvironmentRequest](https://docs.kinetica.com/content/api/nodejs/interfaces/ShowEnvironmentRequest.md)

        Request object containing the parameters for the operation
      </li>

      <li>
        `Optional`callback: [GPUdbCallback](https://docs.kinetica.com/content/api/nodejs/types/GPUdbCallback.md)

        Optional callback function
      </li>
    </ul>

    #### Returns Promise\<[ShowEnvironmentResponse](https://docs.kinetica.com/content/api/nodejs/interfaces/ShowEnvironmentResponse.md)>

    Promise\<Types.ShowEnvironmentResponse> - Promise resolving to the response

    <ul>
      <li>Defined in [src/GPUdb.ts:13333](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/GPUdb.ts#L13333)</li>
    </ul>
  </li>
</ul>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.