alterEnvironment - Kinetica Docs

◆ alterEnvironment() [1/4]

AlterEnvironmentResponse gpudb::GPUdb::alterEnvironment ( const AlterEnvironmentRequest & request_ ) const

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

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns

Response object containing the result of the operation.

AlterEnvironmentResponse & gpudb::GPUdb::alterEnvironment	(	const AlterEnvironmentRequest &	request_,
		AlterEnvironmentResponse &	response_ ) const

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

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns

Response object containing the result of the operation (initially passed in by reference).

AlterEnvironmentResponse gpudb::GPUdb::alterEnvironment	(	const std::string &	environmentName,
		const std::string &	action,
		const std::string &	value,
		const std::map< std::string, std::string > &	options ) const

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

Parameters

[in]	environmentName	Name of the environment to be altered.
[in]	action	Modification operation to be applied. Supported values: alter_environment_install_package: Install a python package from PyPI, an external data source or KiFS. alter_environment_install_requirements: Install packages from a requirements file. alter_environment_uninstall_package: Uninstall a python package. alter_environment_uninstall_requirements: Uninstall packages from a requirements file. alter_environment_reset: Uninstalls all packages in the environment and resets it to the original state at time of creation. alter_environment_rebuild: Recreates the environment and re-installs all packages, upgrades the packages if necessary based on dependencies.
[in]	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.
[in]	options	Optional parameters. alter_environment_datasource_name: Name of an existing external data source from which packages specified in value can be loaded. The default value is an empty map.

Returns

Response object containing the result of the operation.

AlterEnvironmentResponse & gpudb::GPUdb::alterEnvironment	(	const std::string &	environmentName,
		const std::string &	action,
		const std::string &	value,
		const std::map< std::string, std::string > &	options,
		AlterEnvironmentResponse &	response_ ) const

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

Parameters

[in]	environmentName	Name of the environment to be altered.
[in]	action	Modification operation to be applied. Supported values: alter_environment_install_package: Install a python package from PyPI, an external data source or KiFS. alter_environment_install_requirements: Install packages from a requirements file. alter_environment_uninstall_package: Uninstall a python package. alter_environment_uninstall_requirements: Uninstall packages from a requirements file. alter_environment_reset: Uninstalls all packages in the environment and resets it to the original state at time of creation. alter_environment_rebuild: Recreates the environment and re-installs all packages, upgrades the packages if necessary based on dependencies.
[in]	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.
[in]	options	Optional parameters. alter_environment_datasource_name: Name of an existing external data source from which packages specified in value can be loaded. The default value is an empty map.
[out]	response_	Response object containing the results of the operation.

Returns

Response object containing the result of the operation (initially passed in by reference).