gpudb::ExportRecordsToFilesRequest Struct Reference

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

#include <gpudb/protocol/export_records_to_files.h>

Public Member Functions
	ExportRecordsToFilesRequest ()
	Constructs an ExportRecordsToFilesRequest object with default parameter values. More...
	ExportRecordsToFilesRequest (const std::string &tableName_, const std::string &filepath_, const std::map< std::string, std::string > &options_)
	Constructs an ExportRecordsToFilesRequest object with the specified parameters. More...

Public Attributes
std::string	tableName
std::string	filepath
std::map< std::string, std::string >	options

Detailed Description

A set of input parameters for const.

Export records from a table to files. All tables can be exported, in full or partial (see columns_to_export and columns_to_skip). Additional filtering can be applied when using export table with expression through SQL. Default destination is KIFS, though other storage types (Azure, S3, GCS, and HDFS) are supported through datasink_name; see const.

Server's local file system is not supported. Default file format is delimited text. See options for different file types and different options for each file type. Table is saved to a single file if within max file size limits (may vary depending on datasink type). If not, then table is split into multiple files; these may be smaller than the max size limit.

All filenames created are returned in the response.

Definition at line 36 of file export_records_to_files.h.

Constructor & Destructor Documentation

gpudb::ExportRecordsToFilesRequest::ExportRecordsToFilesRequest ( )

inline

Constructs an ExportRecordsToFilesRequest object with default parameter values.

Definition at line 43 of file export_records_to_files.h.

gpudb::ExportRecordsToFilesRequest::ExportRecordsToFilesRequest ( const std::string &  tableName_, const std::string &  filepath_, const std::map< std::string, std::string > &  options_  )

inline

Constructs an ExportRecordsToFilesRequest object with the specified parameters.

Parameters

[in]	tableName_
[in]	filepath_	Path to data export target. If filepath has a file extension, it is read as the name of a file. If filepath is a directory, then the source table name with a random UUID appended will be used as the name of each exported file, all written to that directory. If filepath is a filename, then all exported files will have a random UUID appended to the given name. In either case, the target directory specified or implied must exist. The names of all exported files are returned in the response.
[in]	options_	Optional parameters. gpudb::export_records_to_files_batch_size: Number of records to be exported as a batch. The default value is '1000000'. gpudb::export_records_to_files_column_formats: For each source column specified, applies the column-property-bound format. Currently supported column properties include date, time, & datetime. The parameter value must be formatted as a JSON string of maps of column names to maps of column properties to their corresponding column formats, e.g., '{ "order_date" : { "date" : "%Y.%m.%d" }, "order_time" : { "time" : "%H:%M:%S" } }'. See default_column_formats for valid format syntax. gpudb::export_records_to_files_columns_to_export: Specifies a comma-delimited list of columns from the source table to export, written to the output file in the order they are given. Column names can be provided, in which case the target file will use those names as the column headers as well. Alternatively, column numbers can be specified–discretely or as a range. For example, a value of '5,7,1..3' will write values from the fifth column in the source table into the first column in the target file, from the seventh column in the source table into the second column in the target file, and from the first through third columns in the source table into the third through fifth columns in the target file. Mutually exclusive with columns_to_skip. gpudb::export_records_to_files_columns_to_skip: Comma-separated list of column names or column numbers to not export. All columns in the source table not specified will be written to the target file in the order they appear in the table definition. Mutually exclusive with columns_to_export. gpudb::export_records_to_files_datasink_name: Datasink name, created using /create/datasink. gpudb::export_records_to_files_default_column_formats: Specifies the default format to use to write data. Currently supported column properties include date, time, & datetime. This default column-property-bound format can be overridden by specifying a column property & format for a given source column in column_formats. For each specified annotation, the format will apply to all columns with that annotation unless custom column_formats for that annotation are specified. The parameter value must be formatted as a JSON string that is a map of column properties to their respective column formats, e.g., '{ "date" : "%Y.%m.%d", "time" : "%H:%M:%S" }'. Column formats are specified as a string of control characters and plain text. The supported control characters are 'Y', 'm', 'd', 'H', 'M', 'S', and 's', which follow the Linux 'strptime()' specification, as well as 's', which specifies seconds and fractional seconds (though the fractional component will be truncated past milliseconds). Formats for the 'date' annotation must include the 'Y', 'm', and 'd' control characters. Formats for the 'time' annotation must include the 'H', 'M', and either 'S' or 's' (but not both) control characters. Formats for the 'datetime' annotation meet both the 'date' and 'time' control character requirements. For example, '{"datetime" : "%m/%d/%Y %H:%M:%S" }' would be used to write text as "05/04/2000 12:12:11" gpudb::export_records_to_files_export_ddl: Save DDL to a separate file. The default value is 'false'. gpudb::export_records_to_files_file_extension: Extension to give the export file. The default value is '.csv'. gpudb::export_records_to_files_file_type: Specifies the file format to use when exporting data. gpudb::export_records_to_files_delimited_text: Delimited text file format; e.g., CSV, TSV, PSV, etc. gpudb::export_records_to_files_parquet The default value is gpudb::export_records_to_files_delimited_text. gpudb::export_records_to_files_kinetica_header: Whether to include a Kinetica proprietary header. Will not be written if text_has_header is false. gpudb::export_records_to_files_true gpudb::export_records_to_files_false The default value is gpudb::export_records_to_files_false. gpudb::export_records_to_files_kinetica_header_delimiter: If a Kinetica proprietary header is included, then specify a property separator. Different from column delimiter. The default value is '|'. gpudb::export_records_to_files_compression_type: File compression type. GZip can be applied to text and Parquet files. Snappy can only be applied to Parquet files, and is the default compression for them. gpudb::export_records_to_files_uncompressed gpudb::export_records_to_files_snappy gpudb::export_records_to_files_gzip gpudb::export_records_to_files_single_file: Save records to a single file. This option may be ignored if file size exceeds internal file size limits (this limit will differ on different targets). gpudb::export_records_to_files_true gpudb::export_records_to_files_false gpudb::export_records_to_files_overwrite The default value is gpudb::export_records_to_files_true. gpudb::export_records_to_files_single_file_max_size: Max file size (in MB) to allow saving to a single file. May be overridden by target limitations. The default value is ''. gpudb::export_records_to_files_text_delimiter: Specifies the character to write out to delimit field values and field names in the header (if present). For delimited_text file_type only. The default value is ','. gpudb::export_records_to_files_text_has_header: Indicates whether to write out a header row. For delimited_text file_type only. gpudb::export_records_to_files_true gpudb::export_records_to_files_false The default value is gpudb::export_records_to_files_true. gpudb::export_records_to_files_text_null_string: Specifies the character string that should be written out for the null value in the data. For delimited_text file_type only. The default value is '\N'.

Definition at line 272 of file export_records_to_files.h.

Member Data Documentation

std::string gpudb::ExportRecordsToFilesRequest::filepath

Definition at line 280 of file export_records_to_files.h.

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

Definition at line 281 of file export_records_to_files.h.

std::string gpudb::ExportRecordsToFilesRequest::tableName

Definition at line 279 of file export_records_to_files.h.

---

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

• gpudb/protocol/export_records_to_files.h