Note

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

/show/directories

URL: https://<aws.fqdn>/<aws.cluster.name>/gpudb-0/show/directories

Shows information about directories in KiFS. Can be used to show a single directory, or all directories.

Input Parameter Description

NameTypeDescription
directory_namestringThe KiFS directory name to show. If empty, shows all directories. The default value is ''.
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'show_directories_response' or 'none' in case of an error
dataStringEmpty string
data_strJSON or String

This embedded JSON represents the result of the /show/directories endpoint:

NameTypeDescription
directoriesarray of stringsKiFS directory names
usersarray of stringsUser that created each directory for the respective directories in output parameter directories
creation_timesarray of longsThe creation time for each directory in milliseconds since epoch, for the respective directories in output parameter directories
data_usagesarray of longsThe data usage each directory in bytes, for the respective directories in output parameter directories
data_limitsarray of longsThe data limit for each directory in bytes, for the respective directories in output parameter directories
permissionsarray of stringsHighest level of permission the calling user has for the respective directories in output parameter directories. Will be empty if no permissions. If a user has been granted both read and write permissions, 'directory_write' will be listed.
infomap of string to stringsAdditional information.

Empty string in case of an error.