Note

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

/create/directory

URL: https://<aws.fqdn>/<aws.cluster.name>/gpudb-0/create/directory

Creates a new directory in KiFS. The new directory serves as a location in which the user can upload files using /upload/files.

Input Parameter Description

NameTypeDescription
directory_namestringName of the directory in KiFS to be created.
optionsmap of string to strings

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

Supported Parameters (keys)Parameter Description
create_home_directoryWhen set, a home directory is created for the user name provided in the value. The input parameter directory_name must be an empty string in this case. The user must exist.
data_limitThe maximum capacity, in bytes, to apply to the created directory. Set to -1 to indicate no upper limit. If empty, the system default limit is applied.
no_error_if_exists

If true, does not return an error if the directory already exists 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:

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

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

NameTypeDescription
directory_namestringValue of input parameter directory_name.
infomap of string to stringsAdditional information.

Empty string in case of an error.