A set of string constants for the parameter options. More...

Public Attributes
const string	BATCH_SIZE = "batch_size"
	Number of records to be exported as a batch. More...

const string	COLUMN_FORMATS = "column_formats"
	For each source column specified, applies the column-property-bound format. More...

const string	COLUMNS_TO_EXPORT = "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. More...

const string	COLUMNS_TO_SKIP = "columns_to_skip"
	Comma-separated list of column names or column numbers to not export. More...

const string	DATASINK_NAME = "datasink_name"
	Datasink name, created using Kinetica.createDatasink. More...

const string	DEFAULT_COLUMN_FORMATS = "default_column_formats"
	Specifies the default format to use to write data. More...

const string	EXPORT_DDL = "export_ddl"
	Save DDL to a separate file. More...

const string	FILE_EXTENSION = "file_extension"
	Extension to give the export file. More...

const string	FILE_TYPE = "file_type"
	Specifies the file format to use when exporting data. More...

const string	DELIMITED_TEXT = "delimited_text"
	Delimited text file format; e.g., CSV, TSV, PSV, etc. More...

const string	PARQUET = "parquet"

const string	KINETICA_HEADER = "kinetica_header"
	Whether to include a Kinetica proprietary header. More...

const string	TRUE = "true"

const string	FALSE = "false"

const string	KINETICA_HEADER_DELIMITER = "kinetica_header_delimiter"
	If a Kinetica proprietary header is included, then specify a property separator. More...

const string	COMPRESSION_TYPE = "compression_type"
	File compression type. More...

const string	UNCOMPRESSED = "uncompressed"

const string	SNAPPY = "snappy"

const string	GZIP = "gzip"

const string	SINGLE_FILE = "single_file"
	Save records to a single file. More...

const string	OVERWRITE = "overwrite"

const string	SINGLE_FILE_MAX_SIZE = "single_file_max_size"
	Max file size (in MB) to allow saving to a single file. More...

const string	TEXT_DELIMITER = "text_delimiter"
	Specifies the character to write out to delimit field values and field names in the header (if present). More...

const string	TEXT_HAS_HEADER = "text_has_header"
	Indicates whether to write out a header row. More...

const string	TEXT_NULL_STRING = "text_null_string"
	Specifies the character string that should be written out for the null value in the data. More...

Detailed Description

A set of string constants for the parameter options.

Optional parameters.

Definition at line 35 of file ExportRecordsToFiles.cs.

Member Data Documentation

◆ BATCH_SIZE

const string ExportRecordsToFilesRequest.Options.BATCH_SIZE = "batch_size"

Number of records to be exported as a batch.

The default value is '1000000'.

Definition at line 39 of file ExportRecordsToFiles.cs.

◆ COLUMN_FORMATS

const string ExportRecordsToFilesRequest.Options.COLUMN_FORMATS = "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_FORMATS for valid format syntax.

Definition at line 52 of file ExportRecordsToFiles.cs.

◆ COLUMNS_TO_EXPORT

const string ExportRecordsToFilesRequest.Options.COLUMNS_TO_EXPORT = "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.

Definition at line 70 of file ExportRecordsToFiles.cs.

◆ COLUMNS_TO_SKIP

const string ExportRecordsToFilesRequest.Options.COLUMNS_TO_SKIP = "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.

Definition at line 79 of file ExportRecordsToFiles.cs.

◆ COMPRESSION_TYPE

const string ExportRecordsToFilesRequest.Options.COMPRESSION_TYPE = "compression_type"

File compression type.

Supported values:

Definition at line 186 of file ExportRecordsToFiles.cs.

◆ DATASINK_NAME

const string ExportRecordsToFilesRequest.Options.DATASINK_NAME = "datasink_name"

Datasink name, created using Kinetica.createDatasink.

Definition at line 84 of file ExportRecordsToFiles.cs.

◆ DEFAULT_COLUMN_FORMATS

const string ExportRecordsToFilesRequest.Options.DEFAULT_COLUMN_FORMATS = "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 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"

Definition at line 113 of file ExportRecordsToFiles.cs.

◆ DELIMITED_TEXT

const string ExportRecordsToFilesRequest.Options.DELIMITED_TEXT = "delimited_text"

Delimited text file format; e.g., CSV, TSV, PSV, etc.

Definition at line 144 of file ExportRecordsToFiles.cs.

◆ EXPORT_DDL

const string ExportRecordsToFilesRequest.Options.EXPORT_DDL = "export_ddl"

Save DDL to a separate file.

The default value is 'false'.

Definition at line 117 of file ExportRecordsToFiles.cs.

◆ FALSE

const string ExportRecordsToFilesRequest.Options.FALSE = "false"

Definition at line 164 of file ExportRecordsToFiles.cs.

◆ FILE_EXTENSION

const string ExportRecordsToFilesRequest.Options.FILE_EXTENSION = "file_extension"

Extension to give the export file.

The default value is '.csv'.

Definition at line 121 of file ExportRecordsToFiles.cs.

◆ FILE_TYPE

const string ExportRecordsToFilesRequest.Options.FILE_TYPE = "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

The default value is DELIMITED_TEXT.

Definition at line 140 of file ExportRecordsToFiles.cs.

◆ GZIP

const string ExportRecordsToFilesRequest.Options.GZIP = "gzip"

Definition at line 190 of file ExportRecordsToFiles.cs.

◆ KINETICA_HEADER

const string ExportRecordsToFilesRequest.Options.KINETICA_HEADER = "kinetica_header"

Whether to include a Kinetica proprietary header.

Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 161 of file ExportRecordsToFiles.cs.

◆ KINETICA_HEADER_DELIMITER

const string ExportRecordsToFilesRequest.Options.KINETICA_HEADER_DELIMITER = "kinetica_header_delimiter"

If a Kinetica proprietary header is included, then specify a property separator.

Different from column delimiter. The default value is '|'.

Definition at line 170 of file ExportRecordsToFiles.cs.

◆ OVERWRITE

const string ExportRecordsToFilesRequest.Options.OVERWRITE = "overwrite"

Definition at line 209 of file ExportRecordsToFiles.cs.

◆ PARQUET

const string ExportRecordsToFilesRequest.Options.PARQUET = "parquet"

Definition at line 146 of file ExportRecordsToFiles.cs.

◆ SINGLE_FILE

const string ExportRecordsToFilesRequest.Options.SINGLE_FILE = "single_file"

Save records to a single file.

Supported values:

The default value is TRUE.

Definition at line 207 of file ExportRecordsToFiles.cs.

◆ SINGLE_FILE_MAX_SIZE

const string ExportRecordsToFilesRequest.Options.SINGLE_FILE_MAX_SIZE = "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 ''.

Definition at line 215 of file ExportRecordsToFiles.cs.

◆ SNAPPY

const string ExportRecordsToFilesRequest.Options.SNAPPY = "snappy"

Definition at line 189 of file ExportRecordsToFiles.cs.

◆ TEXT_DELIMITER

const string ExportRecordsToFilesRequest.Options.TEXT_DELIMITER = "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 ','.

Definition at line 223 of file ExportRecordsToFiles.cs.

◆ TEXT_HAS_HEADER

const string ExportRecordsToFilesRequest.Options.TEXT_HAS_HEADER = "text_has_header"

Indicates whether to write out a header row.

Supported values:

TRUE
FALSE

The default value is TRUE.

Definition at line 237 of file ExportRecordsToFiles.cs.

◆ TEXT_NULL_STRING

const string ExportRecordsToFilesRequest.Options.TEXT_NULL_STRING = "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 245 of file ExportRecordsToFiles.cs.

◆ TRUE

const string ExportRecordsToFilesRequest.Options.TRUE = "true"

Definition at line 163 of file ExportRecordsToFiles.cs.

◆ UNCOMPRESSED

const string ExportRecordsToFilesRequest.Options.UNCOMPRESSED = "uncompressed"

Definition at line 188 of file ExportRecordsToFiles.cs.

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

Kinetica/Protocol/ExportRecordsToFiles.cs

Public Attributes

Detailed Description

Member Data Documentation

◆ BATCH_SIZE

◆ COLUMN_FORMATS

◆ COLUMNS_TO_EXPORT

◆ COLUMNS_TO_SKIP

◆ COMPRESSION_TYPE

◆ DATASINK_NAME

◆ DEFAULT_COLUMN_FORMATS

◆ DELIMITED_TEXT

◆ EXPORT_DDL

◆ FALSE

◆ FILE_EXTENSION

◆ FILE_TYPE

◆ GZIP

◆ KINETICA_HEADER

◆ KINETICA_HEADER_DELIMITER

◆ OVERWRITE

◆ PARQUET

◆ SINGLE_FILE

◆ SINGLE_FILE_MAX_SIZE

◆ SNAPPY

◆ TEXT_DELIMITER

◆ TEXT_HAS_HEADER

◆ TEXT_NULL_STRING

◆ TRUE

◆ UNCOMPRESSED