gpudb::UploadFilesResponse Struct Reference

A set of output parameters for const. More...

#include <gpudb/protocol/upload_files.h>

Public Member Functions
	UploadFilesResponse ()
	Constructs an UploadFilesResponse object with default parameter values. More...

Public Attributes
std::map< std::string, std::string >	info

Detailed Description

A set of output parameters for const.

Uploads one or more files to KiFS. There are two methods for uploading files: load files in their entirety, or load files in parts. The latter is recommeded for files of approximately 60 MB or larger.

To upload files in their entirety, populate fileNames with the file names to upload into on KiFS, and their respective byte content in fileData.

Multiple steps are involved when uploading in multiple parts. Only one file at a time can be uploaded in this manner. A user-provided UUID is utilized to tie all the upload steps together for a given file. To upload a file in multiple parts:

1. Provide the file name in fileNames, the UUID in the multipart_upload_uuid key in options, and a multipart_operation value of init.
2. Upload one or more parts by providing the file name, the part data in fileData, the UUID, a multipart_operation value of upload_part, and the part number in the multipart_upload_part_number. The part numbers must start at 1 and increase incrementally. Parts may not be uploaded out of order.
3. Complete the upload by providing the file name, the UUID, and a multipart_operation value of complete.

Multipart uploads in progress may be canceled by providing the file name, the UUID, and a multipart_operation value of cancel. If an new upload is initialized with a different UUID for an existing upload in progress, the pre-existing upload is automatically canceled in favor of the new upload.

The multipart upload must be completed for the file to be usable in KiFS. Information about multipart uploads in progress is available in const.

File data may be pre-encoded using base64 encoding. This should be indicated using the file_encoding option, and is recommended when using JSON serialization.

Each file path must reside in a top-level KiFS directory, i.e. one of the directories listed in const. The user must have write permission on the directory. Nested directories are permitted in file name paths. Directories are deliniated with the directory separator of '/'. For example, given the file path '/a/b/c/d.txt', 'a' must be a KiFS directory.

These characters are allowed in file name paths: letters, numbers, spaces, the path delimiter of '/', and the characters: '.' '-' ':' '[' ']' '(' ')' '#' '='.

Definition at line 309 of file upload_files.h.

Constructor & Destructor Documentation

gpudb::UploadFilesResponse::UploadFilesResponse ( )

inline

Constructs an UploadFilesResponse object with default parameter values.

Definition at line 316 of file upload_files.h.

Member Data Documentation

std::map<std::string, std::string> gpudb::UploadFilesResponse::info

Definition at line 321 of file upload_files.h.

---

The documentation for this struct was generated from the following file:

• gpudb/protocol/upload_files.h