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

# alter_environment

### alter\_environment

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

    Alters an existing environment which can be referenced by a user-defined function (UDF).

    #### Parameters

    <ul>
      <li>
        environment\_name: string

        Name of the environment to be altered.
      </li>

      <li>
        action: string

        Modification operation to be applied.
      </li>

      <li>
        value: string

        The value of the modification, depending on `action`. For example, if `action` is install\_package, this would be the python package name.If `action` is install\_requirements, this would be the path of a requirements file from which to install packages.If an external data source is specified in datasource\_name, this can be the path to a wheel file or source archive. Alternatively, if installing from a file (wheel or source archive), the value may be a reference to a file in KiFS.
      </li>

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

        Optional parameters.
      </li>

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

        Optional callback function
      </li>
    </ul>

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

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

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

### alter\_environment\_request

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

    Alters an existing environment which can be referenced by a user-defined function (UDF).

    #### Parameters

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

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

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

        Optional callback function
      </li>
    </ul>

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

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

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


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