/delete/files

URL: http://<db.host>:<db.port>/delete/files

Deletes one or more files from KiFS.

Input Parameter Description

Name Type Description
file_names array of strings An array of names of files to be deleted. File paths may contain wildcard characters after the KiFS directory delimeter. Accepted wildcard characters are asterisk (*) to represent any string of zero or more characters, and question mark (?) to indicate a single character.
options map of string to strings

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

Supported Parameters (keys) Parameter Description
no_error_if_not_exists

If true, no error is returned if a specified file 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:

Name Type Description
status String 'OK' or 'ERROR'
message String Empty if success or an error message
data_type String 'delete_files_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 /delete/files endpoint:

Name Type Description
file_names array of strings Names of the files deleted from KiFS
info map of string to strings Additional information.

Empty string in case of an error.