A set of parameters for GPUdb::alterEnvironment. More...

#include <gpudb/protocol/alter_environment.h>

Public Member Functions
	AlterEnvironmentRequest ()
	Constructs an AlterEnvironmentRequest object with default parameters. More...

	AlterEnvironmentRequest (const std::string &environmentName_, const std::string &action_, const std::string &value_, const std::map< std::string, std::string > &options_)
	Constructs an AlterEnvironmentRequest object with the specified parameters. More...

Public Attributes
std::string	environmentName
	Name of the environment to be altered. More...

std::string	action
	Modification operation to be applied. More...

std::string	value
	The value of the modification, depending on action. More...

std::map< std::string, std::string >	options
	Optional parameters. More...

Detailed Description

A set of parameters for GPUdb::alterEnvironment.

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

Definition at line 20 of file alter_environment.h.

Constructor & Destructor Documentation

◆ AlterEnvironmentRequest() [1/2]

gpudb::AlterEnvironmentRequest::AlterEnvironmentRequest ( )

inline

Constructs an AlterEnvironmentRequest object with default parameters.

Definition at line 26 of file alter_environment.h.

◆ AlterEnvironmentRequest() [2/2]

gpudb::AlterEnvironmentRequest::AlterEnvironmentRequest	(	const std::string &	environmentName_,
		const std::string &	action_,
		const std::string &	value_,
		const std::map< std::string, std::string > &	options_
	)

inline

Constructs an AlterEnvironmentRequest object with the specified parameters.

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.

Definition at line 100 of file alter_environment.h.

Member Data Documentation

◆ action

std::string gpudb::AlterEnvironmentRequest::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

Definition at line 139 of file alter_environment.h.

◆ environmentName

std::string gpudb::AlterEnvironmentRequest::environmentName

Name of the environment to be altered.

Definition at line 111 of file alter_environment.h.

◆ options

std::map<std::string, std::string> gpudb::AlterEnvironmentRequest::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.

Definition at line 170 of file alter_environment.h.

◆ value

std::string gpudb::AlterEnvironmentRequest::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.

Definition at line 158 of file alter_environment.h.

The documentation for this struct was generated from the following file:

gpudb/protocol/alter_environment.h

Public Member Functions

Public Attributes