Note

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

Download Files

Downloads one or more files from KiFS.

Input Parameter Description

NameTypeDescription
file_namesarray of stringsAn array of the file names to download from KiFS. 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.
read_offsetsarray of longsAn array of starting byte offsets from which to read each respective file in input parameter file_names. Must either be empty or the same length as input parameter file_names. If empty, files are downloaded in their entirety. If not empty, input parameter read_lengths must also not be empty.
read_lengthsarray of longsArray of number of bytes to read from each respective file in input parameter file_names. Must either be empty or the same length as input parameter file_names. If empty, files are downloaded in their entirety. If not empty, input parameter read_offsets must also not be empty.
optionsmap of string to strings

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

Supported Parameters (keys)Parameter Description
file_encoding

Encoding to be applied to the output file data. When using JSON serialization it is recommended to specify this as base64. The default value is none.

Supported ValuesDescription
base64Apply base64 encoding to the output file data.
noneDo not apply any encoding to the output file data.

Output Parameter Description

NameTypeDescription
file_namesarray of stringsNames of the files downloaded from KiFS
file_dataarray of bytesData for the respective downloaded files listed in output parameter file_names
infomap of string to stringsAdditional information.