showEnvironment - Kinetica Docs

◆ showEnvironment() [1/4]

ShowEnvironmentResponse gpudb::GPUdb::showEnvironment ( const ShowEnvironmentRequest & request_ ) const

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

Returns detailed information about existing environments.

Parameters

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

Returns

Response object containing the result of the operation.

ShowEnvironmentResponse & gpudb::GPUdb::showEnvironment	(	const ShowEnvironmentRequest &	request_,
		ShowEnvironmentResponse &	response_ ) const

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

Returns detailed information about existing environments.

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

ShowEnvironmentResponse gpudb::GPUdb::showEnvironment	(	const std::string &	environmentName,
		const std::map< std::string, std::string > &	options ) const

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

Returns detailed information about existing environments.

Parameters

[in]	environmentName	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. The default value is ”.
[in]	options	Optional parameters. show_environment_no_error_if_not_exists: If true and if the environment specified in environmentName does not exist, no error is returned. If false and if the environment specified in environmentName does not exist, then an error is returned. Supported values: show_environment_true show_environment_false The default value is show_environment_false. show_environment_show_names_only: If true only return the names of the installed environments and omit package listing. Supported values: show_environment_true show_environment_false The default value is show_environment_false. The default value is an empty map.

Returns

Response object containing the result of the operation.

ShowEnvironmentResponse & gpudb::GPUdb::showEnvironment	(	const std::string &	environmentName,
		const std::map< std::string, std::string > &	options,
		ShowEnvironmentResponse &	response_ ) const

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

Returns detailed information about existing environments.

Parameters

[in]	environmentName	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. The default value is ”.
[in]	options	Optional parameters. show_environment_no_error_if_not_exists: If true and if the environment specified in environmentName does not exist, no error is returned. If false and if the environment specified in environmentName does not exist, then an error is returned. Supported values: show_environment_true show_environment_false The default value is show_environment_false. show_environment_show_names_only: If true only return the names of the installed environments and omit package listing. Supported values: show_environment_true show_environment_false The default value is show_environment_false. 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).