Note

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

/alter/directory

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

Alters an existing directory in KiFS.

Input Parameter Description

Name

Type

Description

directory_name

string

Name of the directory in KiFS to be altered.

directory_updates_map

map of string to strings

Map containing the properties of the directory to be altered. Error if empty.

Supported Parameters (keys)	Parameter Description
data_limit	The maximum capacity, in bytes, to apply to the directory. Set to -1 to indicate no upper limit.

options

map of string to strings

Optional 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:

Name

Type

Description

status

String

'OK' or 'ERROR'

message

String

Empty if success or an error message

data_type

String

'alter_directory_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 /alter/directory endpoint:

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

Empty string in case of an error.