Kinetica   C#   API  Version 7.2.3.0
InsertRecordsFromFiles.cs
Go to the documentation of this file.
1 /*
2  * This file was autogenerated by the Kinetica schema processor.
3  *
4  * DO NOT EDIT DIRECTLY.
5  */
6 
7 using System.Collections.Generic;
8 
9 namespace kinetica
10 {
41  {
48  public struct CreateTableOptions
49  {
53  public const string TYPE_ID = "type_id";
54 
71  public const string NO_ERROR_IF_EXISTS = "no_error_if_exists";
72 
73  public const string TRUE = "true";
74  public const string FALSE = "false";
75 
93  public const string IS_REPLICATED = "is_replicated";
94 
101  public const string FOREIGN_KEYS = "foreign_keys";
102 
106  public const string FOREIGN_SHARD_KEY = "foreign_shard_key";
107 
149  public const string PARTITION_TYPE = "partition_type";
150 
154  public const string RANGE = "RANGE";
155 
159  public const string INTERVAL = "INTERVAL";
160 
164  public const string LIST = "LIST";
165 
169  public const string HASH = "HASH";
170 
174  public const string SERIES = "SERIES";
175 
181  public const string PARTITION_KEYS = "partition_keys";
182 
199  public const string PARTITION_DEFINITIONS = "partition_definitions";
200 
217  public const string IS_AUTOMATIC_PARTITION = "is_automatic_partition";
218 
222  public const string TTL = "ttl";
223 
226  public const string CHUNK_SIZE = "chunk_size";
227 
230  public const string CHUNK_COLUMN_MAX_MEMORY = "chunk_column_max_memory";
231 
234  public const string CHUNK_MAX_MEMORY = "chunk_max_memory";
235 
252  public const string IS_RESULT_TABLE = "is_result_table";
253 
257  public const string STRATEGY_DEFINITION = "strategy_definition";
258  } // end struct CreateTableOptions
259 
263  public struct Options
264  {
273  public const string BAD_RECORD_TABLE_NAME = "bad_record_table_name";
274 
278  public const string BAD_RECORD_TABLE_LIMIT = "bad_record_table_limit";
279 
288  public const string BAD_RECORD_TABLE_LIMIT_PER_INPUT = "bad_record_table_limit_per_input";
289 
293  public const string BATCH_SIZE = "batch_size";
294 
309  public const string COLUMN_FORMATS = "column_formats";
310 
337  public const string COLUMNS_TO_LOAD = "columns_to_load";
338 
344  public const string COLUMNS_TO_SKIP = "columns_to_skip";
345 
368  public const string COMPRESSION_TYPE = "compression_type";
369 
371  public const string NONE = "none";
372 
374  public const string AUTO = "auto";
375 
377  public const string GZIP = "gzip";
378 
380  public const string BZIP2 = "bzip2";
381 
385  public const string DATASOURCE_NAME = "datasource_name";
386 
416  public const string DEFAULT_COLUMN_FORMATS = "default_column_formats";
417 
446  public const string ERROR_HANDLING = "error_handling";
447 
451  public const string PERMISSIVE = "permissive";
452 
454  public const string IGNORE_BAD_RECORDS = "ignore_bad_records";
455 
460  public const string ABORT = "abort";
461 
498  public const string FILE_TYPE = "file_type";
499 
501  public const string AVRO = "avro";
502 
505  public const string DELIMITED_TEXT = "delimited_text";
506 
508  public const string GDB = "gdb";
509 
511  public const string JSON = "json";
512 
514  public const string PARQUET = "parquet";
515 
517  public const string SHAPEFILE = "shapefile";
518 
535  public const string FLATTEN_COLUMNS = "flatten_columns";
536 
539  public const string TRUE = "true";
540 
543  public const string FALSE = "false";
544 
547  public const string GDAL_CONFIGURATION_OPTIONS = "gdal_configuration_options";
548 
573  public const string IGNORE_EXISTING_PK = "ignore_existing_pk";
574 
603  public const string INGESTION_MODE = "ingestion_mode";
604 
607  public const string FULL = "full";
608 
613  public const string DRY_RUN = "dry_run";
614 
619  public const string TYPE_INFERENCE_ONLY = "type_inference_only";
620 
624  public const string KAFKA_CONSUMERS_PER_RANK = "kafka_consumers_per_rank";
625 
629  public const string KAFKA_GROUP_ID = "kafka_group_id";
630 
645  public const string KAFKA_OFFSET_RESET_POLICY = "kafka_offset_reset_policy";
646 
647  public const string EARLIEST = "earliest";
648  public const string LATEST = "latest";
649 
664  public const string KAFKA_OPTIMISTIC_INGEST = "kafka_optimistic_ingest";
665 
670  public const string KAFKA_SUBSCRIPTION_CANCEL_AFTER = "kafka_subscription_cancel_after";
671 
674  public const string KAFKA_TYPE_INFERENCE_FETCH_TIMEOUT = "kafka_type_inference_fetch_timeout";
675 
677  public const string LAYER = "layer";
678 
727  public const string LOADING_MODE = "loading_mode";
728 
732  public const string HEAD = "head";
733 
743  public const string DISTRIBUTED_SHARED = "distributed_shared";
744 
762  public const string DISTRIBUTED_LOCAL = "distributed_local";
763 
766  public const string LOCAL_TIME_OFFSET = "local_time_offset";
767 
774  public const string MAX_RECORDS_TO_LOAD = "max_records_to_load";
775 
779  public const string NUM_TASKS_PER_RANK = "num_tasks_per_rank";
780 
788  public const string POLL_INTERVAL = "poll_interval";
789 
792  public const string PRIMARY_KEYS = "primary_keys";
793 
796  public const string SCHEMA_REGISTRY_SCHEMA_NAME = "schema_registry_schema_name";
797 
800  public const string SHARD_KEYS = "shard_keys";
801 
803  public const string SKIP_LINES = "skip_lines";
804 
809  public const string START_OFFSETS = "start_offsets";
810 
824  public const string SUBSCRIBE = "subscribe";
825 
845  public const string TABLE_INSERT_MODE = "table_insert_mode";
846 
848  public const string SINGLE = "single";
849 
852  public const string TABLE_PER_FILE = "table_per_file";
853 
863  public const string TEXT_COMMENT_STRING = "text_comment_string";
864 
872  public const string TEXT_DELIMITER = "text_delimiter";
873 
888  public const string TEXT_ESCAPE_CHARACTER = "text_escape_character";
889 
903  public const string TEXT_HAS_HEADER = "text_has_header";
904 
915  public const string TEXT_HEADER_PROPERTY_DELIMITER = "text_header_property_delimiter";
916 
923  public const string TEXT_NULL_STRING = "text_null_string";
924 
937  public const string TEXT_QUOTE_CHARACTER = "text_quote_character";
938 
947  public const string TEXT_SEARCH_COLUMNS = "text_search_columns";
948 
954  public const string TEXT_SEARCH_MIN_COLUMN_LENGTH = "text_search_min_column_length";
955 
970  public const string TRUNCATE_STRINGS = "truncate_strings";
971 
986  public const string TRUNCATE_TABLE = "truncate_table";
987 
1007  public const string TYPE_INFERENCE_MODE = "type_inference_mode";
1008 
1011  public const string ACCURACY = "accuracy";
1012 
1016  public const string SPEED = "speed";
1017 
1037  public const string UPDATE_ON_EXISTING_PK = "update_on_existing_pk";
1038  } // end struct Options
1039 
1050  public string table_name { get; set; }
1051 
1078  public IList<string> filepaths { get; set; } = new List<string>();
1079 
1083  public IDictionary<string, IDictionary<string, string>> modify_columns { get; set; } = new Dictionary<string, IDictionary<string, string>>();
1084 
1343  public IDictionary<string, string> create_table_options { get; set; } = new Dictionary<string, string>();
1344 
2152  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
2153 
2157 
3263  IList<string> filepaths,
3264  IDictionary<string, IDictionary<string, string>> modify_columns = null,
3265  IDictionary<string, string> create_table_options = null,
3266  IDictionary<string, string> options = null)
3267  {
3268  this.table_name = table_name ?? "";
3269  this.filepaths = filepaths ?? new List<string>();
3270  this.modify_columns = modify_columns ?? new Dictionary<string, IDictionary<string, string>>();
3271  this.create_table_options = create_table_options ?? new Dictionary<string, string>();
3272  this.options = options ?? new Dictionary<string, string>();
3273  } // end constructor
3274  } // end class InsertRecordsFromFilesRequest
3275 
3280  {
3284  public string table_name { get; set; }
3285 
3289  public string type_id { get; set; }
3290 
3293  public string type_definition { get; set; }
3294 
3297  public string type_label { get; set; }
3298 
3301  public IDictionary<string, IList<string>> type_properties { get; set; } = new Dictionary<string, IList<string>>();
3302 
3305  public long count_inserted { get; set; }
3306 
3310  public long count_skipped { get; set; }
3311 
3314  public long count_updated { get; set; }
3315 
3317  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
3318 
3319  public IList<string> files { get; set; } = new List<string>();
3320  } // end class InsertRecordsFromFilesResponse
3321 } // end namespace kinetica
const string TRUNCATE_TABLE
If set to TRUE, truncates the table specified by table_name prior to loading the file(s).
const string AUTO
Auto detect compression type
const string BAD_RECORD_TABLE_LIMIT_PER_INPUT
For subscriptions, a positive integer indicating the maximum number of records that can be written to...
A set of string constants for the parameter create_table_options.
const string IGNORE_BAD_RECORDS
Malformed records are skipped.
const string PARTITION_KEYS
Comma-separated list of partition keys, which are the columns or column expressions by which records ...
const string TABLE_PER_FILE
Insert records from each file into a new table corresponding to that file.
const string CHUNK_MAX_MEMORY
Indicates the target maximum data size for all columns in a chunk to be used for this table.
const string TEXT_HEADER_PROPERTY_DELIMITER
Specifies the delimiter for column properties in the header row (if present).
const string FOREIGN_KEYS
Semicolon-separated list of foreign keys, of the format '(source_column_name [, .....
const string FLATTEN_COLUMNS
Specifies how to handle nested columns.
const string TEXT_ESCAPE_CHARACTER
Specifies the character that is used to escape other characters in the source data.
const string BATCH_SIZE
Number of records to insert per batch when inserting data.
const string BAD_RECORD_TABLE_NAME
Name of a table to which records that were rejected are written.
const string GDAL_CONFIGURATION_OPTIONS
Comma separated list of gdal conf options, for the specific requets: key=value
const string DISTRIBUTED_SHARED
The head node coordinates loading data by worker processes across all nodes from shared files availab...
long count_updated
[Not yet implemented] Number of records updated within the target table.
const string IS_RESULT_TABLE
Indicates whether the table is a memory-only table.
InsertRecordsFromFilesRequest()
Constructs an InsertRecordsFromFilesRequest object with default parameters.
const string DRY_RUN
Does not load data, but walks through the source data and determines the number of valid records,...
const string KAFKA_CONSUMERS_PER_RANK
Number of Kafka consumer threads per rank (valid range 1-6).
const string FOREIGN_SHARD_KEY
Foreign shard key of the format 'source_column references shard_by_column from target_table(primary_k...
const string TTL
Sets the TTL of the table specified in table_name.
const string KAFKA_SUBSCRIPTION_CANCEL_AFTER
Sets the Kafka subscription lifespan (in minutes).
const string TEXT_SEARCH_MIN_COLUMN_LENGTH
Set the minimum column size for strings to apply the 'text_search' property to.
const string COLUMNS_TO_SKIP
Specifies a comma-delimited list of columns from the source data to skip.
const string COLUMN_FORMATS
For each target column specified, applies the column-property-bound format to the source data loaded ...
const string MAX_RECORDS_TO_LOAD
Limit the number of records to load in this request: if this number is larger than BATCH_SIZE,...
const string KAFKA_GROUP_ID
The group id to be used when consuming data from a Kafka topic (valid only for Kafka datasource subsc...
long count_skipped
Number of records skipped, when not running in ABORT error handling mode.
const string LAYER
Geo files layer(s) name(s): comma separated.
const string SPEED
Scans data and picks the widest possible column types so that 'all' values will fit with minimum data...
IDictionary< string, IList< string > > type_properties
A mapping of each target table column name to an array of column properties associated with that colu...
long count_inserted
Number of records inserted into the target table.
const string TRUNCATE_STRINGS
If set to TRUE, truncate string values that are longer than the column's type size.
const string FALSE
Reject new records when primary keys match existing records
const string TEXT_DELIMITER
Specifies the character delimiting field values in the source data and field names in the header (if ...
const string BAD_RECORD_TABLE_LIMIT
A positive integer indicating the maximum number of records that can be written to the bad-record-tab...
const string TYPE_INFERENCE_MODE
Optimize type inferencing for either speed or accuracy.
const string SINGLE
Insert all records into a single table.
const string SKIP_LINES
Skip number of lines from begining of file.
const string SCHEMA_REGISTRY_SCHEMA_NAME
Name of the Avro schema in the schema registry to use when reading Avro records.
const string POLL_INTERVAL
If TRUE, the number of seconds between attempts to load external files into the table.
string type_definition
A JSON string describing the columns of the target table
const string TEXT_SEARCH_COLUMNS
Add 'text_search' property to internally inferenced string columns.
const string COLUMNS_TO_LOAD
Specifies a comma-delimited list of columns from the source data to load.
const string IS_REPLICATED
Affects the distribution scheme for the table's data.
const string ACCURACY
Scans data to get exactly-typed & sized columns for all data scanned.
const string FILE_TYPE
Specifies the type of the file(s) whose records will be inserted.
const string KAFKA_TYPE_INFERENCE_FETCH_TIMEOUT
Maximum time to collect Kafka messages before type inferencing on the set of them.
IDictionary< string, IDictionary< string, string > > modify_columns
Not implemented yet.
const string HEAD
The head node loads all data.
const string TEXT_QUOTE_CHARACTER
Specifies the character that should be interpreted as a field value quoting character in the source d...
const string TEXT_NULL_STRING
Specifies the character string that should be interpreted as a null value in the source data.
A set of string constants for the parameter options.
const string TEXT_COMMENT_STRING
Specifies the character string that should be interpreted as a comment line prefix in the source data...
const string NUM_TASKS_PER_RANK
Number of tasks for reading file per rank.
const string FULL
Run a type inference on the source data (if needed) and ingest
const string SUBSCRIBE
Continuously poll the data source to check for new data and load it into the table.
const string TYPE_INFERENCE_ONLY
Infer the type of the source data and return, without ingesting any data.
const string PARQUET
Apache Parquet file format
IList< string > filepaths
A list of file paths from which data will be sourced; For paths in KiFS, use the uri prefix of kifs:/...
const string KAFKA_OFFSET_RESET_POLICY
Policy to determine whether the Kafka data consumption starts either at earliest offset or latest off...
const string TRUE
Upsert new records when primary keys match existing records
A set of results returned by Kinetica.insertRecordsFromFiles.
IDictionary< string, string > info
Additional information.
const string INGESTION_MODE
Whether to do a full load, dry run, or perform a type inference on the source data.
const string IGNORE_EXISTING_PK
Specifies the record collision error-suppression policy for inserting into a table with a primary key...
const string TYPE_ID
ID of a currently registered type.
const string UPDATE_ON_EXISTING_PK
Specifies the record collision policy for inserting into a table with a primary key.
const string DELIMITED_TEXT
Delimited text file format; e.g., CSV, TSV, PSV, etc.
const string START_OFFSETS
Starting offsets by partition to fetch from kafka.
const string PRIMARY_KEYS
Comma separated list of column names to set as primary keys, when not specified in the type.
string type_label
The user-defined description associated with the target table's structure
IDictionary< string, string > create_table_options
Options from Kinetica.createTable, allowing the structure of the table to be defined independently of...
const string KAFKA_OPTIMISTIC_INGEST
Enable optimistic ingestion where Kafka topic offsets and table data are committed independently to a...
const string CHUNK_SIZE
Indicates the number of records per chunk to be used for this table.
IDictionary< string, string > options
Optional parameters.
string type_id
ID of the currently registered table structure type for the target table
const string CHUNK_COLUMN_MAX_MEMORY
Indicates the target maximum data size for each column in a chunk to be used for this table.
const string PARTITION_DEFINITIONS
Comma-separated list of partition definitions, whose format depends on the choice of PARTITION_TYPE.
const string PERMISSIVE
Records with missing columns are populated with nulls if possible; otherwise, the malformed records a...
const string LOCAL_TIME_OFFSET
Apply an offset to Avro local timestamp columns.
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
const string ERROR_HANDLING
Specifies how errors should be handled upon insertion.
const string LOADING_MODE
Scheme for distributing the extraction and loading of data from the source data file(s).
string table_name
Name of the table into which the data will be inserted, in [schema_name.
const string DATASOURCE_NAME
Name of an existing external data source from which data file(s) specified in filepaths will be loade...
A set of parameters for Kinetica.insertRecordsFromFiles.
const string IS_AUTOMATIC_PARTITION
If TRUE, a new partition will be created for values which don't fall into an existing partition.
const string STRATEGY_DEFINITION
The tier strategy for the table and its columns.
const string ABORT
Stops current insertion and aborts entire operation when an error is encountered.
const string NO_ERROR_IF_EXISTS
If TRUE, prevents an error from occurring if the table already exists and is of the given type.
const string TABLE_INSERT_MODE
Insertion scheme to use when inserting records from multiple shapefiles.
const string DEFAULT_COLUMN_FORMATS
Specifies the default format to be applied to source data loaded into columns with the corresponding ...
const string SHARD_KEYS
Comma separated list of column names to set as shard keys, when not specified in the type.
const string DISTRIBUTED_LOCAL
A single worker process on each node loads all files that are available to it.
InsertRecordsFromFilesRequest(string table_name, IList< string > filepaths, IDictionary< string, IDictionary< string, string >> modify_columns=null, IDictionary< string, string > create_table_options=null, IDictionary< string, string > options=null)
Constructs an InsertRecordsFromFilesRequest object with the specified parameters.
const string TEXT_HAS_HEADER
Indicates whether the source data contains a header row.
const string COMPRESSION_TYPE
Source data compression type.