Note

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

/delete/directory

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

Deletes a directory from KiFS.

Input Parameter Description

NameTypeDescription
directory_namestringName of the directory in KiFS to be deleted. The directory must contain no files, unless recursive is true
optionsmap of string to strings

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

Supported Parameters (keys)Parameter Description
recursive

If true, will delete directory and all files residing in it. If false, directory must be empty for deletion. The default value is false. The supported values are:

  • true
  • false
no_error_if_not_exists

If true, no error is returned if specified directory does not exist 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'delete_directory_response' or 'none' in case of an error
dataStringEmpty string
data_strJSON or String

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

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

Empty string in case of an error.