A set of parameters for GPUdb::uploadFiles. More...

#include <gpudb/protocol/upload_files.h>

Public Member Functions
	UploadFilesRequest ()
	Constructs an UploadFilesRequest object with default parameters. More...

	UploadFilesRequest (const std::vector< std::string > &fileNames_, const std::vector< std::vector< uint8_t > > &fileData_, const std::map< std::string, std::string > &options_)
	Constructs an UploadFilesRequest object with the specified parameters. More...

Public Attributes
std::vector< std::string >	fileNames
	An array of full file name paths to be used for the files uploaded to KiFS. More...

std::vector< std::vector< uint8_t > >	fileData
	File data for the files being uploaded, for the respective files in fileNames. More...

std::map< std::string, std::string >	options
	Optional parameters. More...

Detailed Description

A set of parameters for GPUdb::uploadFiles.

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:

Provide the file name in fileNames, the UUID in the multipart_upload_uuid key in options, and a multipart_operation value of init.
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.
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 GPUdb::showFiles.

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 GPUdb::showDirectories. 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 74 of file upload_files.h.

Constructor & Destructor Documentation

◆ UploadFilesRequest() [1/2]

gpudb::UploadFilesRequest::UploadFilesRequest ( )

inline

Constructs an UploadFilesRequest object with default parameters.

Definition at line 79 of file upload_files.h.

◆ UploadFilesRequest() [2/2]

gpudb::UploadFilesRequest::UploadFilesRequest	(	const std::vector< std::string > &	fileNames_,
		const std::vector< std::vector< uint8_t > > &	fileData_,
		const std::map< std::string, std::string > &	options_
	)

inline

Constructs an UploadFilesRequest object with the specified parameters.

Parameters

[in]	fileNames_	An array of full file name paths to be used for the files uploaded to KiFS. File names may have any number of nested directories in their paths, but the top-level directory must be an existing KiFS directory. Each file must reside in or under a top-level directory. A full file name path cannot be larger than 1024 characters.
[in]	fileData_	File data for the files being uploaded, for the respective files in fileNames_.
[in]	options_	Optional parameters. upload_files_file_encoding: Encoding that has been applied to the uploaded file data. When using JSON serialization it is recommended to utilize base64. The caller is responsible for encoding the data provided in this payload. Supported values: upload_files_base64: Specifies that the file data being uploaded has been base64 encoded. upload_files_none: The uploaded file data has not been encoded. The default value is upload_files_none. upload_files_multipart_operation: Multipart upload operation to perform. Supported values: upload_files_none: Default, indicates this is not a multipart upload upload_files_init: Initialize a multipart file upload upload_files_upload_part: Uploads a part of the specified multipart file upload upload_files_complete: Complete the specified multipart file upload upload_files_cancel: Cancel the specified multipart file upload The default value is upload_files_none. upload_files_multipart_upload_uuid: UUID to uniquely identify a multipart upload upload_files_multipart_upload_part_number: Incremental part number for each part in a multipart upload. Part numbers start at 1, increment by 1, and must be uploaded sequentially upload_files_delete_if_exists: If true, any existing files specified in fileNames_ will be deleted prior to start of upload. Otherwise the file is replaced once the upload completes. Rollback of the original file is no longer possible if the upload is cancelled, aborted or fails if the file was deleted beforehand. Supported values: upload_files_true upload_files_false The default value is upload_files_false. The default value is an empty map.

Definition at line 194 of file upload_files.h.

Member Data Documentation

◆ fileData

std::vector<std::vector<uint8_t> > gpudb::UploadFilesRequest::fileData

File data for the files being uploaded, for the respective files in fileNames.

Definition at line 214 of file upload_files.h.

◆ fileNames

std::vector<std::string> gpudb::UploadFilesRequest::fileNames

An array of full file name paths to be used for the files uploaded to KiFS.

File names may have any number of nested directories in their paths, but the top-level directory must be an existing KiFS directory. Each file must reside in or under a top-level directory. A full file name path cannot be larger than 1024 characters.

Definition at line 208 of file upload_files.h.

◆ options

std::map<std::string, std::string> gpudb::UploadFilesRequest::options

Optional parameters.

upload_files_file_encoding: Encoding that has been applied to the uploaded file data. When using JSON serialization it is recommended to utilize base64. The caller is responsible for encoding the data provided in this payload. Supported values:
- upload_files_base64: Specifies that the file data being uploaded has been base64 encoded.
- upload_files_none: The uploaded file data has not been encoded.
The default value is upload_files_none.
upload_files_multipart_operation: Multipart upload operation to perform. Supported values:
- upload_files_none: Default, indicates this is not a multipart upload
- upload_files_init: Initialize a multipart file upload
- upload_files_upload_part: Uploads a part of the specified multipart file upload
- upload_files_complete: Complete the specified multipart file upload
- upload_files_cancel: Cancel the specified multipart file upload
The default value is upload_files_none.
upload_files_multipart_upload_uuid: UUID to uniquely identify a multipart upload
upload_files_multipart_upload_part_number: Incremental part number for each part in a multipart upload. Part numbers start at 1, increment by 1, and must be uploaded sequentially
upload_files_delete_if_exists: If true, any existing files specified in fileNames will be deleted prior to start of upload. Otherwise the file is replaced once the upload completes. Rollback of the original file is no longer possible if the upload is cancelled, aborted or fails if the file was deleted beforehand. Supported values:
- upload_files_true
- upload_files_false
The default value is upload_files_false.

The default value is an empty map.

Definition at line 282 of file upload_files.h.

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

gpudb/protocol/upload_files.h

Public Member Functions

Public Attributes