Note

This documentation is for a prior release of Kinetica. For the latest documentation, click here.

/drop/environment

URL: https://<aws.fqdn>/<aws.cluster.name>/gpudb-0/drop/environment

Drop an existing user-defined function (UDF) environment.

Input Parameter Description

Name

Type

Description

environment_name

string

Name of the environment to be dropped. Must be an existing environment.

options

map of string to strings

Optional parameters. The default value is an empty map ( {} ).

Supported Parameters (keys)

Parameter Description

no_error_if_not_exists

If true and if the environment specified in input parameter environment_name does not exist, no error is returned. If false and if the environment specified in input parameter environment_name does not exist, then an error is returned. The default value is false. The supported values are:

true
false

Output Parameter Description

The GPUdb server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:

Name

Type

Description

status

String

'OK' or 'ERROR'

message

String

Empty if success or an error message

data_type

String

'drop_environment_response' or 'none' in case of an error

data

String

Empty string

data_str

JSON or String

This embedded JSON represents the result of the /drop/environment endpoint:

Name	Type	Description
environment_name	string	Value of input parameter environment_name.
info	map of string to strings	Additional information.

Empty string in case of an error.