Optional parameters. 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(string,string,IDictionary{string, string}). 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

Optional parameters.

BATCH_SIZE: Number of records to be exported as a batch. The default value is '1000000'.
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.
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.
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.
DATASINK_NAME: Datasink name, created using /create/datasink.
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"
EXPORT_DDL: Save DDL to a separate file. The default value is 'false'.
FILE_EXTENSION: Extension to give the export file. The default value is '.csv'.
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.
KINETICA_HEADER: Whether to include a Kinetica proprietary header. Will not be written if text_has_header is false. Supported values:
- TRUE
- FALSE
The default value is FALSE.
KINETICA_HEADER_DELIMITER: If a Kinetica proprietary header is included, then specify a property separator. Different from column delimiter. The default value is '|'.
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:
- UNCOMPRESSED
- SNAPPY
- GZIP
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). Supported values:
- TRUE
- FALSE
- OVERWRITE
The default value is TRUE.
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 ''.
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 ','.
TEXT_HAS_HEADER: Indicates whether to write out a header row.
For delimited_text file_type only. Supported values:
- TRUE
- FALSE
The default value is TRUE.
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'.

The default value is an empty Dictionary. A set of string constants for the parameter options.

Definition at line 301 of file ExportRecordsToFiles.cs.

Member Data Documentation

const string kinetica.ExportRecordsToFilesRequest.Options.BATCH_SIZE = "batch_size"

Number of records to be exported as a batch.

The default value is '1000000'.

Definition at line 306 of file ExportRecordsToFiles.cs.

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

Definition at line 320 of file ExportRecordsToFiles.cs.

const string kinetica.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 341 of file ExportRecordsToFiles.cs.

const string kinetica.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 350 of file ExportRecordsToFiles.cs.

const string kinetica.ExportRecordsToFilesRequest.Options.COMPRESSION_TYPE = "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:

Definition at line 468 of file ExportRecordsToFiles.cs.

const string kinetica.ExportRecordsToFilesRequest.Options.DATASINK_NAME = "datasink_name"

Datasink name, created using Kinetica.createDatasink(string,string,IDictionary{string, string}).

Definition at line 355 of file ExportRecordsToFiles.cs.

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

Definition at line 390 of file ExportRecordsToFiles.cs.

const string kinetica.ExportRecordsToFilesRequest.Options.DELIMITED_TEXT = "delimited_text"

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

Definition at line 420 of file ExportRecordsToFiles.cs.

const string kinetica.ExportRecordsToFilesRequest.Options.EXPORT_DDL = "export_ddl"

Save DDL to a separate file.

The default value is 'false'.

Definition at line 394 of file ExportRecordsToFiles.cs.

const string kinetica.ExportRecordsToFilesRequest.Options.FALSE = "false"

Definition at line 442 of file ExportRecordsToFiles.cs.

const string kinetica.ExportRecordsToFilesRequest.Options.FILE_EXTENSION = "file_extension"

Extension to give the export file.

The default value is '.csv'.

Definition at line 398 of file ExportRecordsToFiles.cs.

const string kinetica.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 416 of file ExportRecordsToFiles.cs.

const string kinetica.ExportRecordsToFilesRequest.Options.GZIP = "gzip"

Definition at line 471 of file ExportRecordsToFiles.cs.

const string kinetica.ExportRecordsToFilesRequest.Options.KINETICA_HEADER = "kinetica_header"

Whether to include a Kinetica proprietary header.

Will not be written if text_has_header is false. Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 440 of file ExportRecordsToFiles.cs.

const string kinetica.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 448 of file ExportRecordsToFiles.cs.

const string kinetica.ExportRecordsToFilesRequest.Options.OVERWRITE = "overwrite"

Definition at line 495 of file ExportRecordsToFiles.cs.

const string kinetica.ExportRecordsToFilesRequest.Options.PARQUET = "parquet"

Definition at line 421 of file ExportRecordsToFiles.cs.

const string kinetica.ExportRecordsToFilesRequest.Options.SINGLE_FILE = "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). Supported values:

The default value is TRUE.

Definition at line 494 of file ExportRecordsToFiles.cs.

const string kinetica.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 500 of file ExportRecordsToFiles.cs.

const string kinetica.ExportRecordsToFilesRequest.Options.SNAPPY = "snappy"

Definition at line 470 of file ExportRecordsToFiles.cs.

const string kinetica.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 508 of file ExportRecordsToFiles.cs.

const string kinetica.ExportRecordsToFilesRequest.Options.TEXT_HAS_HEADER = "text_has_header"

Indicates whether to write out a header row.

For delimited_text file_type only. Supported values:

TRUE
FALSE

The default value is TRUE.

Definition at line 526 of file ExportRecordsToFiles.cs.

const string kinetica.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 534 of file ExportRecordsToFiles.cs.

const string kinetica.ExportRecordsToFilesRequest.Options.TRUE = "true"

Definition at line 441 of file ExportRecordsToFiles.cs.

const string kinetica.ExportRecordsToFilesRequest.Options.UNCOMPRESSED = "uncompressed"

Definition at line 469 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