Class ExportRecordsToFilesRequest.Options
ExportRecordsToFilesRequest parameter options.
Optional parameters.
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringNumber of records to be exported as a batch.static final StringFor each source column specified, applies the column-property-bound format.static final StringSpecifies a comma-delimited list of columns from the source table to export, written to the output file in the order they are given.static final StringComma-separated list of column names or column numbers to not export.static final StringFile compression type.static final StringDatasink name, created usingGPUdb.createDatasink.static final StringSpecifies the default format to use to write data.static final StringDelimited text file format; e.g., CSV, TSV, PSV, etc.static final StringSave DDL to a separate file.static final Stringstatic final StringExtension to give the export file.static final StringSpecifies the file format to use when exporting data.static final Stringstatic final StringWhether to include a Kinetica proprietary header.static final StringIf a Kinetica proprietary header is included, then specify a property separator.static final Stringstatic final Stringstatic final StringSave records to a single file.static final StringMax file size (in MB) to allow saving to a single file.static final Stringstatic final StringSpecifies the character to write out to delimit field values and field names in the header (if present).static final StringIndicates whether to write out a header row.static final StringSpecifies the character string that should be written out for the null value in the data.static final Stringstatic final String
Field Details
COLUMN_FORMATS
For each source column specified, applies the column-property-bound format. Currently supported column properties include date, time, and 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_FORMATSfor valid format syntax.See Also: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.See Also: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 withCOLUMNS_TO_EXPORT.See Also:DEFAULT_COLUMN_FORMATS
Specifies the default format to use to write data. Currently supported column properties include date, time, and datetime. This default column-property-bound format can be overridden by specifying a column property and format for a given source column inCOLUMN_FORMATS. For each specified annotation, the format will apply to all columns with that annotation unless customCOLUMN_FORMATSfor 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”
See Also:FILE_TYPE
Specifies the file format to use when exporting data. Supported values:DELIMITED_TEXT: Delimited text file format; e.g., CSV, TSV, PSV, etc.PARQUET
DELIMITED_TEXT.See Also: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. Supported values:See Also:TEXT_DELIMITER
Specifies the character to write out to delimit field values and field names in the header (if present).For
DELIMITED_TEXTFILE_TYPEonly. The default value is ’,’.See Also:TEXT_NULL_STRING
Specifies the character string that should be written out for the null value in the data.For
DELIMITED_TEXTFILE_TYPEonly. The default value is ‘\N’.See Also: