Note

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

/create/environment

URL: http://<db.host>:<db.port>/create/environment

Creates a new environment which can be used by user-defined functions (UDF).

Input Parameter Description

NameTypeDescription
environment_namestringName of the environment to be created.
optionsmap of string to stringsOptional parameters. The default value is an empty map ( {} ).

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:

NameTypeDescription
statusString'OK' or 'ERROR'
messageStringEmpty if success or an error message
data_typeString'create_environment_response' or 'none' in case of an error
dataStringEmpty string
data_strJSON or String

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

NameTypeDescription
environment_namestringValue of input parameter environment_name.
infomap of string to stringsAdditional information.

Empty string in case of an error.