alterEnvironment - Kinetica Docs

◆ alterEnvironment() [1/2]

AlterEnvironmentResponse kinetica.Kinetica.alterEnvironment ( AlterEnvironmentRequest request_ )

inline

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

Parameters

request_ Request object containing the parameters for the operation.

Returns

Response object containing the result of the operation.

Definition at line 10497 of file KineticaFunctions.cs.

AlterEnvironmentResponse kinetica.Kinetica.alterEnvironment	(	string	environment_name,
		string	action,
		string	_value,
		IDictionary< string, string >	options = null )

inline

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

Parameters

environment_name	Name of the environment to be altered.
action	Modification operation to be applied. Supported values: INSTALL_PACKAGE: Install a python package from PyPI, an external data source or KiFS. INSTALL_REQUIREMENTS: Install packages from a requirements file. UNINSTALL_PACKAGE: Uninstall a python package. UNINSTALL_REQUIREMENTS: Uninstall packages from a requirements file. RESET: Uninstalls all packages in the environment and resets it to the original state at time of creation. REBUILD: Recreates the environment and re-installs all packages, upgrades the packages if necessary based on dependencies.
_value	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.
options	Optional parameters. DATASOURCE_NAME: Name of an existing external data source from which packages specified in _value can be loaded. The default value is an empty Dictionary.

Returns

Response object containing the result of the operation.

Definition at line 10603 of file KineticaFunctions.cs.

async System.Threading.Tasks.Task< AlterEnvironmentResponse > kinetica.Kinetica.AlterEnvironmentAsync	(	AlterEnvironmentRequest	request_,
		System.Threading.CancellationToken	cancellationToken = default )

inline

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

(async)

Parameters

request_	Request object containing the parameters for the operation.
cancellationToken	Cancellation token to cancel the operation.

Returns

Task that returns the response object containing the result of the operation.

Definition at line 10514 of file KineticaFunctions.cs.

async System.Threading.Tasks.Task< AlterEnvironmentResponse > kinetica.Kinetica.AlterEnvironmentAsync	(	string	environment_name,
		string	action,
		string	_value,
		IDictionary< string, string >	options = null,
		System.Threading.CancellationToken	cancellationToken = default )

inline

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

(async)

Parameters

environment_name	Name of the environment to be altered.
action	Modification operation to be applied. Supported values: INSTALL_PACKAGE: Install a python package from PyPI, an external data source or KiFS. INSTALL_REQUIREMENTS: Install packages from a requirements file. UNINSTALL_PACKAGE: Uninstall a python package. UNINSTALL_REQUIREMENTS: Uninstall packages from a requirements file. RESET: Uninstalls all packages in the environment and resets it to the original state at time of creation. REBUILD: Recreates the environment and re-installs all packages, upgrades the packages if necessary based on dependencies.
_value	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.
options	Optional parameters. DATASOURCE_NAME: Name of an existing external data source from which packages specified in _value can be loaded. The default value is an empty Dictionary.
cancellationToken	Cancellation token to cancel the operation.

Returns

Task that returns the response object containing the result of the operation.

Definition at line 10695 of file KineticaFunctions.cs.