A set of parameters for Kinetica.insertRecordsFromFiles(string,IList{string},IDictionary{string, string},IDictionary{string, string}). More...

Inheritance diagram for kinetica.InsertRecordsFromFilesRequest:

Collaboration diagram for kinetica.InsertRecordsFromFilesRequest:

Classes
struct	CreateTableOptions
	Options used when creating a new table. More...

struct	Options
	Optional parameters. More...

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

	InsertRecordsFromFilesRequest (string table_name, IList< string > filepaths, IDictionary< string, string > create_table_options=null, IDictionary< string, string > options=null)
	Constructs an InsertRecordsFromFilesRequest object with the specified parameters. More...

Public Member Functions inherited from kinetica.KineticaData
	KineticaData (KineticaType type)
	Constructor from Kinetica Type More...

	KineticaData (System.Type type=null)
	Default constructor, with optional System.Type More...

object	Get (int fieldPos)
	Retrieve a specific property from this object More...

void	Put (int fieldPos, object fieldValue)
	Write a specific property to this object More...

Properties
string	table_name `[get, set]`
	Name of the table into which the data will be inserted. More...

IList< string >	filepaths `[get, set]`
	Absolute or relative filepath(s) from where files will be loaded. More...

IDictionary< string, string >	create_table_options = new List<string>() `[get, set]`
	Options used when creating a new table. More...

IDictionary< string, string >	options = new Dictionary<string, string>() `[get, set]`
	Optional parameters. More...

Properties inherited from kinetica.KineticaData
Schema	Schema `[get]`
	Avro Schema for this class More...

Additional Inherited Members
Static Public Member Functions inherited from kinetica.KineticaData
static RecordSchema	SchemaFromType (System.Type t, KineticaType ktype=null)
	Create an Avro Schema from a System.Type and a KineticaType. More...

Detailed Description

A set of parameters for Kinetica.insertRecordsFromFiles(string,IList{string},IDictionary{string, string},IDictionary{string, string}).

Reads from one or more files located on the server and inserts the data into a new or existing table.
For CSV files, there are two loading schemes: positional and name-based. The name-based loading scheme is enabled when the file has a header present and text_has_header is set to true. In this scheme, the source file(s) field names must match the target table's column names exactly; however, the source file can have more fields than the target table has columns. If error_handling is set to permissive, the source file can have fewer fields than the target table has columns. If the name-based loading scheme is being used, names matching the file header's names may be provided to columns_to_load instead of numbers, but ranges are not supported.
Returns once all files are processed.

Definition at line 34 of file InsertRecordsFromFiles.cs.

Constructor & Destructor Documentation

kinetica.InsertRecordsFromFilesRequest.InsertRecordsFromFilesRequest ( )

inline

Constructs an InsertRecordsFromFilesRequest object with default parameters.

Definition at line 1494 of file InsertRecordsFromFiles.cs.

kinetica.InsertRecordsFromFilesRequest.InsertRecordsFromFilesRequest	(	string	table_name,
		IList< string >	filepaths,
		IDictionary< string, string >	create_table_options = `null`,
		IDictionary< string, string >	options = `null`
	)

inline

Constructs an InsertRecordsFromFilesRequest object with the specified parameters.

Parameters

table_name	Name of the table into which the data will be inserted. If the table does not exist, the table will be created using either an existing type_id or the type inferred from the file.
filepaths	Absolute or relative filepath(s) from where files will be loaded. Relative filepaths are relative to the defined external_files_directory parameter in the server configuration. The filepaths may include wildcards (*). If the first path ends in .tsv, the text delimiter will be defaulted to a tab character. If the first path ends in .psv, the text delimiter will be defaulted to a pipe character (\|).
create_table_options	Options used when creating a new table. TYPE_ID: ID of a currently registered type. The default value is ''. NO_ERROR_IF_EXISTS: If true, prevents an error from occurring if the table already exists and is of the given type. If a table with the same ID but a different type exists, it is still an error. Supported values: TRUE FALSE The default value is FALSE. COLLECTION_NAME: Name of a collection which is to contain the newly created table. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created table will be a top-level table. IS_REPLICATED: For a table, affects the distribution scheme for the table's data. If true and the given type has no explicit shard key defined, the table will be replicated. If false, the table will be sharded according to the shard key specified in the given type_id, or randomly sharded, if no shard key is specified. Note that a type containing a shard key cannot be used to create a replicated table. Supported values: TRUE FALSE The default value is FALSE. FOREIGN_KEYS: Semicolon-separated list of foreign keys, of the format '(source_column_name [, ...]) references target_table_name(primary_key_column_name [, ...]) [as foreign_key_name]'. FOREIGN_SHARD_KEY: Foreign shard key of the format 'source_column references shard_by_column from target_table(primary_key_column)'. PARTITION_TYPE: Partitioning scheme to use. Supported values: RANGE: Use range partitioning. INTERVAL: Use interval partitioning. LIST: Use list partitioning. HASH: Use hash partitioning. PARTITION_KEYS: Comma-separated list of partition keys, which are the columns or column expressions by which records will be assigned to partitions defined by partition_definitions. PARTITION_DEFINITIONS: Comma-separated list of partition definitions, whose format depends on the choice of partition_type. See range partitioning, interval partitioning, list partitioning, or hash partitioning for example formats. IS_AUTOMATIC_PARTITION: If true, a new partition will be created for values which don't fall into an existing partition. Currently only supported for list partitions. Supported values: TRUE FALSE The default value is FALSE. TTL: For a table, sets the TTL of the table specified in . CHUNK_SIZE: Indicates the number of records per chunk to be used for this table. IS_RESULT_TABLE: For a table, indicates whether the table is an in-memory table. A result table cannot contain store_only, text_search, or string columns (charN columns are acceptable), and it will not be retained if the server is restarted. Supported values: TRUE FALSE The default value is FALSE. STRATEGY_DEFINITION: The tier strategy for the table and its columns. See tier strategy usage for format and tier strategy examples for examples. The default value is an empty Dictionary.
options	Optional parameters. BATCH_SIZE: Specifies number of records to process before inserting. COLUMN_FORMATS: For each target column specified, applies the column-property-bound format to the source data loaded into that column. Each column format will contain a mapping of one or more of its column properties to an appropriate format for each property. 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_LOAD: For delimited_text file_type only. Specifies a comma-delimited list of column positions or names to load instead of loading all columns in the file(s); if more than one file is being loaded, the list of columns will apply to all files. Column numbers can be specified discretely or as a range, e.g., a value of '5,7,1..3' will create a table with the first column in the table being the fifth column in the file, followed by seventh column in the file, then the first column through the fourth column in the file. DEFAULT_COLUMN_FORMATS: Specifies the default format to be applied to source data loaded into columns with the corresponding column property. This default column-property-bound format can be overridden by specifying a column property & format for a given target column in column_formats. For each specified annotation, the format will apply to all columns with that annotation unless a custom column_formats for that annotation is 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 interpret text as "05/04/2000 12:12:11" DRY_RUN: If set to true, no data will be inserted but the file will be read with the applied error_handling mode and the number of valid records that would be normally inserted are returned. Supported values: FALSE TRUE The default value is FALSE. ERROR_HANDLING: Specifies how errors should be handled upon insertion. Supported values: PERMISSIVE: Records with missing columns are populated with nulls if possible; otherwise, the malformed records are skipped. IGNORE_BAD_RECORDS: Malformed records are skipped. ABORT: Stops current insertion and aborts entire operation when an error is encountered. The default value is PERMISSIVE. FILE_TYPE: File type for the file(s). Supported values: DELIMITED_TEXT: Indicates the file(s) are in delimited text format, e.g., CSV, TSV, PSV, etc. The default value is DELIMITED_TEXT. LOADING_MODE: Specifies how to divide data loading among nodes. Supported values: HEAD: The head node loads all data. All files must be available on the head node. DISTRIBUTED_SHARED: The worker nodes coordinate loading a set of files that are available to all of them. All files must be available on all nodes. This option is best when there is a shared file system. DISTRIBUTED_LOCAL: Each worker node loads all files that are available to it. This option is best when each worker node has its own file system. The default value is HEAD. TEXT_COMMENT_STRING: For delimited_text file_type only. All lines in the file(s) starting with the provided string are ignored. The comment string has no effect unless it appears at the beginning of a line. The default value is '#'. TEXT_DELIMITER: For delimited_text file_type only. Specifies the delimiter for values and columns in the header row (if present). Must be a single character. The default value is ','. TEXT_ESCAPE_CHARACTER: For delimited_text file_type only. The character used in the file(s) to escape certain character sequences in text. For example, the escape character followed by a literal 'n' escapes to a newline character within the field. Can be used within quoted string to escape a quote character. An empty value for this option does not specify an escape character. TEXT_HAS_HEADER: For delimited_text file_type only. Indicates whether the delimited text files have a header row. Supported values: TRUE FALSE The default value is TRUE. TEXT_HEADER_PROPERTY_DELIMITER: For delimited_text file_type only. Specifies the delimiter for column properties in the header row (if present). Cannot be set to same value as text_delimiter. The default value is '\|'. TEXT_NULL_STRING: For delimited_text file_type only. The value in the file(s) to treat as a null value in the database. The default value is ''. TEXT_QUOTE_CHARACTER: For delimited_text file_type only. The quote character used in the file(s), typically encompassing a field value. The character must appear at beginning and end of field to take effect. Delimiters within quoted fields are not treated as delimiters. Within a quoted field, double quotes (") can be used to escape a single literal quote character. To not have a quote character, specify an empty string (""). The default value is '"'. TRUNCATE_TABLE: If set to true, truncates the table specified by prior to loading the file(s). Supported values: TRUE FALSE The default value is FALSE. NUM_TASKS_PER_RANK: Optional: number of tasks for reading file per rank. Default will be external_file_reader_num_tasks The default value is an empty Dictionary.

Definition at line 1993 of file InsertRecordsFromFiles.cs.

Property Documentation

IDictionary<string, string> kinetica.InsertRecordsFromFilesRequest.create_table_options = new List<string>()

getset

Options used when creating a new table.

TYPE_ID: ID of a currently registered type. The default value is ''.
NO_ERROR_IF_EXISTS: If true, prevents an error from occurring if the table already exists and is of the given type. If a table with the same ID but a different type exists, it is still an error. Supported values:
- TRUE
- FALSE
The default value is FALSE.
COLLECTION_NAME: Name of a collection which is to contain the newly created table. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created table will be a top-level table.
IS_REPLICATED: For a table, affects the distribution scheme for the table's data. If true and the given type has no explicit shard key defined, the table will be replicated. If false, the table will be sharded according to the shard key specified in the given type_id, or randomly sharded, if no shard key is specified. Note that a type containing a shard key cannot be used to create a replicated table. Supported values:
- TRUE
- FALSE
The default value is FALSE.
FOREIGN_KEYS: Semicolon-separated list of foreign keys, of the format '(source_column_name [, ...]) references target_table_name(primary_key_column_name [, ...]) [as foreign_key_name]'.
FOREIGN_SHARD_KEY: Foreign shard key of the format 'source_column references shard_by_column from target_table(primary_key_column)'.
PARTITION_TYPE: Partitioning scheme to use. Supported values:
- RANGE: Use range partitioning.
- INTERVAL: Use interval partitioning.
- LIST: Use list partitioning.
- HASH: Use hash partitioning.
PARTITION_KEYS: Comma-separated list of partition keys, which are the columns or column expressions by which records will be assigned to partitions defined by partition_definitions.
PARTITION_DEFINITIONS: Comma-separated list of partition definitions, whose format depends on the choice of partition_type. See range partitioning, interval partitioning, list partitioning, or hash partitioning for example formats.
IS_AUTOMATIC_PARTITION: If true, a new partition will be created for values which don't fall into an existing partition. Currently only supported for list partitions. Supported values:
- TRUE
- FALSE
The default value is FALSE.
TTL: For a table, sets the TTL of the table specified in .
CHUNK_SIZE: Indicates the number of records per chunk to be used for this table.
IS_RESULT_TABLE: For a table, indicates whether the table is an in-memory table. A result table cannot contain store_only, text_search, or string columns (charN columns are acceptable), and it will not be retained if the server is restarted. Supported values:
- TRUE
- FALSE
The default value is FALSE.
STRATEGY_DEFINITION: The tier strategy for the table and its columns. See tier strategy usage for format and tier strategy examples for examples.

The default value is an empty Dictionary.

Definition at line 1224 of file InsertRecordsFromFiles.cs.

IList<string> kinetica.InsertRecordsFromFilesRequest.filepaths

getset

Absolute or relative filepath(s) from where files will be loaded.

Relative filepaths are relative to the defined external_files_directory parameter in the server configuration. The filepaths may include wildcards (*). If the first path ends in .tsv, the text delimiter will be defaulted to a tab character. If the first path ends in .psv, the text delimiter will be defaulted to a pipe character (|).

Definition at line 1005 of file InsertRecordsFromFiles.cs.

IDictionary<string, string> kinetica.InsertRecordsFromFilesRequest.options = new Dictionary<string, string>()

getset

Optional parameters.

BATCH_SIZE: Specifies number of records to process before inserting.
COLUMN_FORMATS: For each target column specified, applies the column-property-bound format to the source data loaded into that column. Each column format will contain a mapping of one or more of its column properties to an appropriate format for each property. 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_LOAD: For delimited_text file_type only. Specifies a comma-delimited list of column positions or names to load instead of loading all columns in the file(s); if more than one file is being loaded, the list of columns will apply to all files. Column numbers can be specified discretely or as a range, e.g., a value of '5,7,1..3' will create a table with the first column in the table being the fifth column in the file, followed by seventh column in the file, then the first column through the fourth column in the file.
DEFAULT_COLUMN_FORMATS: Specifies the default format to be applied to source data loaded into columns with the corresponding column property. This default column-property-bound format can be overridden by specifying a column property & format for a given target column in column_formats. For each specified annotation, the format will apply to all columns with that annotation unless a custom column_formats for that annotation is 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 interpret text as "05/04/2000 12:12:11"
DRY_RUN: If set to true, no data will be inserted but the file will be read with the applied error_handling mode and the number of valid records that would be normally inserted are returned. Supported values:
- FALSE
- TRUE
The default value is FALSE.
ERROR_HANDLING: Specifies how errors should be handled upon insertion. Supported values:
- PERMISSIVE: Records with missing columns are populated with nulls if possible; otherwise, the malformed records are skipped.
- IGNORE_BAD_RECORDS: Malformed records are skipped.
- ABORT: Stops current insertion and aborts entire operation when an error is encountered.
The default value is PERMISSIVE.
FILE_TYPE: File type for the file(s). Supported values:
- DELIMITED_TEXT: Indicates the file(s) are in delimited text format, e.g., CSV, TSV, PSV, etc.
The default value is DELIMITED_TEXT.
LOADING_MODE: Specifies how to divide data loading among nodes. Supported values:
- HEAD: The head node loads all data. All files must be available on the head node.
- DISTRIBUTED_SHARED: The worker nodes coordinate loading a set of files that are available to all of them. All files must be available on all nodes. This option is best when there is a shared file system.
- DISTRIBUTED_LOCAL: Each worker node loads all files that are available to it. This option is best when each worker node has its own file system.
The default value is HEAD.
TEXT_COMMENT_STRING: For delimited_text file_type only. All lines in the file(s) starting with the provided string are ignored. The comment string has no effect unless it appears at the beginning of a line. The default value is '#'.
TEXT_DELIMITER: For delimited_text file_type only. Specifies the delimiter for values and columns in the header row (if present). Must be a single character. The default value is ','.
TEXT_ESCAPE_CHARACTER: For delimited_text file_type only. The character used in the file(s) to escape certain character sequences in text. For example, the escape character followed by a literal 'n' escapes to a newline character within the field. Can be used within quoted string to escape a quote character. An empty value for this option does not specify an escape character.
TEXT_HAS_HEADER: For delimited_text file_type only. Indicates whether the delimited text files have a header row. Supported values:
- TRUE
- FALSE
The default value is TRUE.
TEXT_HEADER_PROPERTY_DELIMITER: For delimited_text file_type only. Specifies the delimiter for column properties in the header row (if present). Cannot be set to same value as text_delimiter. The default value is '|'.
TEXT_NULL_STRING: For delimited_text file_type only. The value in the file(s) to treat as a null value in the database. The default value is ''.
TEXT_QUOTE_CHARACTER: For delimited_text file_type only. The quote character used in the file(s), typically encompassing a field value. The character must appear at beginning and end of field to take effect. Delimiters within quoted fields are not treated as delimiters. Within a quoted field, double quotes (") can be used to escape a single literal quote character. To not have a quote character, specify an empty string (""). The default value is '"'.
TRUNCATE_TABLE: If set to true, truncates the table specified by prior to loading the file(s). Supported values:
- TRUE
- FALSE
The default value is FALSE.
NUM_TASKS_PER_RANK: Optional: number of tasks for reading file per rank. Default will be external_file_reader_num_tasks

The default value is an empty Dictionary.

Definition at line 1489 of file InsertRecordsFromFiles.cs.

string kinetica.InsertRecordsFromFilesRequest.table_name

getset

Name of the table into which the data will be inserted.

If the table does not exist, the table will be created using either an existing type_id or the type inferred from the file.

Definition at line 995 of file InsertRecordsFromFiles.cs.

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

Kinetica/Protocol/InsertRecordsFromFiles.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Property Documentation