Kinetica   C#   API  Version 7.2.3.1
InsertRecordsFromPayload.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 
19 {
26  public struct CreateTableOptions
27  {
31  public const string TYPE_ID = "type_id";
32 
48  public const string NO_ERROR_IF_EXISTS = "no_error_if_exists";
49 
50  public const string TRUE = "true";
51  public const string FALSE = "false";
52 
69  public const string IS_REPLICATED = "is_replicated";
70 
76  public const string FOREIGN_KEYS = "foreign_keys";
77 
80  public const string FOREIGN_SHARD_KEY = "foreign_shard_key";
81 
122  public const string PARTITION_TYPE = "partition_type";
123 
127  public const string RANGE = "RANGE";
128 
132  public const string INTERVAL = "INTERVAL";
133 
137  public const string LIST = "LIST";
138 
142  public const string HASH = "HASH";
143 
147  public const string SERIES = "SERIES";
148 
154  public const string PARTITION_KEYS = "partition_keys";
155 
172  public const string PARTITION_DEFINITIONS = "partition_definitions";
173 
189  public const string IS_AUTOMATIC_PARTITION = "is_automatic_partition";
190 
194  public const string TTL = "ttl";
195 
198  public const string CHUNK_SIZE = "chunk_size";
199 
202  public const string CHUNK_COLUMN_MAX_MEMORY = "chunk_column_max_memory";
203 
206  public const string CHUNK_MAX_MEMORY = "chunk_max_memory";
207 
223  public const string IS_RESULT_TABLE = "is_result_table";
224 
228  public const string STRATEGY_DEFINITION = "strategy_definition";
229 
234  public const string COMPRESSION_CODEC = "compression_codec";
235  } // end struct CreateTableOptions
236 
240  public struct Options
241  {
247  public const string BAD_RECORD_TABLE_NAME = "bad_record_table_name";
248 
252  public const string BAD_RECORD_TABLE_LIMIT = "bad_record_table_limit";
253 
260  public const string BAD_RECORD_TABLE_LIMIT_PER_INPUT = "bad_record_table_limit_per_input";
261 
264  public const string BATCH_SIZE = "batch_size";
265 
280  public const string COLUMN_FORMATS = "column_formats";
281 
307  public const string COLUMNS_TO_LOAD = "columns_to_load";
308 
314  public const string COLUMNS_TO_SKIP = "columns_to_skip";
315 
339  public const string COMPRESSION_TYPE = "compression_type";
340 
342  public const string NONE = "none";
343 
346  public const string AUTO = "auto";
347 
349  public const string GZIP = "gzip";
350 
352  public const string BZIP2 = "bzip2";
353 
382  public const string DEFAULT_COLUMN_FORMATS = "default_column_formats";
383 
411  public const string ERROR_HANDLING = "error_handling";
412 
415  public const string PERMISSIVE = "permissive";
416 
418  public const string IGNORE_BAD_RECORDS = "ignore_bad_records";
419 
424  public const string ABORT = "abort";
425 
460  public const string FILE_TYPE = "file_type";
461 
463  public const string AVRO = "avro";
464 
467  public const string DELIMITED_TEXT = "delimited_text";
468 
470  public const string GDB = "gdb";
471 
473  public const string JSON = "json";
474 
476  public const string PARQUET = "parquet";
477 
479  public const string SHAPEFILE = "shapefile";
480 
497  public const string FLATTEN_COLUMNS = "flatten_columns";
498 
501  public const string TRUE = "true";
502 
505  public const string FALSE = "false";
506 
510  public const string GDAL_CONFIGURATION_OPTIONS = "gdal_configuration_options";
511 
535  public const string IGNORE_EXISTING_PK = "ignore_existing_pk";
536 
565  public const string INGESTION_MODE = "ingestion_mode";
566 
569  public const string FULL = "full";
570 
575  public const string DRY_RUN = "dry_run";
576 
581  public const string TYPE_INFERENCE_ONLY = "type_inference_only";
582 
585  public const string LAYER = "layer";
586 
635  public const string LOADING_MODE = "loading_mode";
636 
640  public const string HEAD = "head";
641 
650  public const string DISTRIBUTED_SHARED = "distributed_shared";
651 
669  public const string DISTRIBUTED_LOCAL = "distributed_local";
670 
672  public const string LOCAL_TIME_OFFSET = "local_time_offset";
673 
679  public const string MAX_RECORDS_TO_LOAD = "max_records_to_load";
680 
684  public const string NUM_TASKS_PER_RANK = "num_tasks_per_rank";
685 
692  public const string POLL_INTERVAL = "poll_interval";
693 
697  public const string PRIMARY_KEYS = "primary_keys";
698 
701  public const string SCHEMA_REGISTRY_CONNECTION_RETRIES = "schema_registry_connection_retries";
702 
705  public const string SCHEMA_REGISTRY_CONNECTION_TIMEOUT = "schema_registry_connection_timeout";
706 
709  public const string SCHEMA_REGISTRY_MAX_CONSECUTIVE_CONNECTION_FAILURES = "schema_registry_max_consecutive_connection_failures";
710 
713  public const string MAX_CONSECUTIVE_INVALID_SCHEMA_FAILURE = "max_consecutive_invalid_schema_failure";
714 
717  public const string SCHEMA_REGISTRY_SCHEMA_NAME = "schema_registry_schema_name";
718 
722  public const string SHARD_KEYS = "shard_keys";
723 
726  public const string SKIP_LINES = "skip_lines";
727 
741  public const string SUBSCRIBE = "subscribe";
742 
758  public const string TABLE_INSERT_MODE = "table_insert_mode";
759 
760  public const string SINGLE = "single";
761  public const string TABLE_PER_FILE = "table_per_file";
762 
770  public const string TEXT_COMMENT_STRING = "text_comment_string";
771 
778  public const string TEXT_DELIMITER = "text_delimiter";
779 
794  public const string TEXT_ESCAPE_CHARACTER = "text_escape_character";
795 
809  public const string TEXT_HAS_HEADER = "text_has_header";
810 
820  public const string TEXT_HEADER_PROPERTY_DELIMITER = "text_header_property_delimiter";
821 
828  public const string TEXT_NULL_STRING = "text_null_string";
829 
841  public const string TEXT_QUOTE_CHARACTER = "text_quote_character";
842 
849  public const string TEXT_SEARCH_COLUMNS = "text_search_columns";
850 
854  public const string TEXT_SEARCH_MIN_COLUMN_LENGTH = "text_search_min_column_length";
855 
869  public const string TRIM_SPACE = "trim_space";
870 
885  public const string TRUNCATE_STRINGS = "truncate_strings";
886 
901  public const string TRUNCATE_TABLE = "truncate_table";
902 
904  public const string TYPE_INFERENCE_MAX_RECORDS_READ = "type_inference_max_records_read";
905 
923  public const string TYPE_INFERENCE_MODE = "type_inference_mode";
924 
927  public const string ACCURACY = "accuracy";
928 
931  public const string SPEED = "speed";
932 
951  public const string UPDATE_ON_EXISTING_PK = "update_on_existing_pk";
952  } // end struct Options
953 
964  public string table_name { get; set; }
965 
967  public string data_text { get; set; }
968 
970  public byte[] data_bytes { get; set; }
971 
975  public IDictionary<string, IDictionary<string, string>> modify_columns { get; set; } = new Dictionary<string, IDictionary<string, string>>();
976 
1231  public IDictionary<string, string> create_table_options { get; set; } = new Dictionary<string, string>();
1232 
1967  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
1968 
1972 
2981  string data_text,
2982  byte[] data_bytes,
2983  IDictionary<string, IDictionary<string, string>> modify_columns = null,
2984  IDictionary<string, string> create_table_options = null,
2985  IDictionary<string, string> options = null)
2986  {
2987  this.table_name = table_name ?? "";
2988  this.data_text = data_text ?? "";
2989  this.data_bytes = data_bytes ?? new byte[] { };
2990  this.modify_columns = modify_columns ?? new Dictionary<string, IDictionary<string, string>>();
2991  this.create_table_options = create_table_options ?? new Dictionary<string, string>();
2992  this.options = options ?? new Dictionary<string, string>();
2993  } // end constructor
2994 } // end class InsertRecordsFromPayloadRequest
2995 
3000 {
3004  public string table_name { get; set; }
3005 
3009  public string type_id { get; set; }
3010 
3013  public string type_definition { get; set; }
3014 
3017  public string type_label { get; set; }
3018 
3021  public IDictionary<string, IList<string>> type_properties { get; set; } = new Dictionary<string, IList<string>>();
3022 
3024  public long count_inserted { get; set; }
3025 
3029  public long count_skipped { get; set; }
3030 
3033  public long count_updated { get; set; }
3034 
3036  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
3037 } // end class InsertRecordsFromPayloadResponse
const string BAD_RECORD_TABLE_LIMIT_PER_INPUT
For subscriptions: A positive integer indicating the maximum number of records that can be written to...
const string COLUMN_FORMATS
For each target column specified, applies the column-property-bound format to the source data loaded ...
const string FOREIGN_KEYS
Semicolon-separated list of foreign keys, of the format '(source_column_name [, .....
string type_definition
A JSON string describing the columns of the target table.
const string PRIMARY_KEYS
Comma separated list of column names, to set as primary keys, when not specified in the type.
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 COLUMNS_TO_LOAD
Specifies a comma-delimited list of columns from the source data to load.
const string BZIP2
bzip2 file compression.
const string DRY_RUN
Does not load data, but walks through the source data and determines the number of valid records,...
const string TYPE_ID
ID of a currently registered type.
const string IS_REPLICATED
Affects the distribution scheme for the table's data.
const string GDAL_CONFIGURATION_OPTIONS
Comma separated list of gdal conf options, for the specific requests: key=value.
const string SHAPEFILE
ShapeFile file format.
IDictionary< string, IList< string > > type_properties
A mapping of each target table column name to an array of column properties associated with that colu...
const string UPDATE_ON_EXISTING_PK
Specifies the record collision policy for inserting into a table with a primary key.
const string TTL
Sets the TTL of the table specified in table_name.
const string TEXT_COMMENT_STRING
Specifies the character string that should be interpreted as a comment line prefix in the source data...
const string STRATEGY_DEFINITION
The tier strategy for the table and its columns.
const string TYPE_INFERENCE_MODE
Optimize type inference mode.
IDictionary< string, string > create_table_options
Options used when creating 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 TEXT_SEARCH_COLUMNS
Add 'text_search' property to internally inferenced string columns.
const string PARTITION_DEFINITIONS
Comma-separated list of partition definitions, whose format depends on the choice of PARTITION_TYPE.
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
const string SCHEMA_REGISTRY_MAX_CONSECUTIVE_CONNECTION_FAILURES
Max records to skip due to SR connection failures, before failing.
long count_updated
[Not yet implemented] Number of records updated within the target table.
const string ACCURACY
Scans data to get exactly-typed and sized columns for all data scanned.
const string IS_RESULT_TABLE
Indicates whether the table is a memory-only table.
long count_inserted
Number of records inserted into the target table.
IDictionary< string, IDictionary< string, string > > modify_columns
Not implemented yet.
const string FALSE
Reject new records when primary keys match existing records.
string data_text
Records formatted as delimited text.
const string SKIP_LINES
Skip a number of lines from the beginning of the file.
const string TYPE_INFERENCE_MAX_RECORDS_READ
The default value is ''.
const string DISTRIBUTED_LOCAL
A single worker process on each node loads all files that are available to it.
const string ERROR_HANDLING
Specifies how errors should be handled upon insertion.
const string FILE_TYPE
Specifies the type of the file(s) whose records will be inserted.
const string TRUNCATE_TABLE
If set to TRUE, truncates the table specified by table_name prior to loading the file(s).
const string SCHEMA_REGISTRY_SCHEMA_NAME
Name of the Avro schema in the schema registry to use when reading Avro records.
const string TRUNCATE_STRINGS
If set to TRUE, truncate string values that are longer than the column's type size.
const string BATCH_SIZE
Internal tuning parameter–number of records per batch when inserting data.
byte [] data_bytes
Records formatted as binary data.
const string PARTITION_KEYS
Comma-separated list of partition keys, which are the columns or column expressions by which records ...
const string IGNORE_EXISTING_PK
Specifies the record collision error-suppression policy for inserting into a table with a primary key...
const string SPEED
Scans data and picks the widest possible column types so that 'all' values will fit with minimum data...
A set of parameters for Kinetica.insertRecordsFromPayload.
const string ABORT
Stops current insertion and aborts entire operation when an error is encountered.
IDictionary< string, string > info
Additional information.
const string TRIM_SPACE
If set to TRUE, remove leading or trailing space from fields.
const string COMPRESSION_TYPE
Payload compression type.
const string FOREIGN_SHARD_KEY
Foreign shard key of the format 'source_column references shard_by_column from target_table(primary_k...
const string LOADING_MODE
Scheme for distributing the extraction and loading of data from the source data file(s).
const string TEXT_HAS_HEADER
Indicates whether the source data contains a header row.
const string SHARD_KEYS
Comma separated list of column names, to set as shard keys, when not specified in the type.
A set of results returned by Kinetica.insertRecordsFromPayload.
const string LOCAL_TIME_OFFSET
For Avro local timestamp columns.
InsertRecordsFromPayloadRequest(string table_name, string data_text, byte[] data_bytes, IDictionary< string, IDictionary< string, string >> modify_columns=null, IDictionary< string, string > create_table_options=null, IDictionary< string, string > options=null)
Constructs an InsertRecordsFromPayloadRequest object with the specified parameters.
string type_id
ID of the currently registered table structure type for the target table.
const string SCHEMA_REGISTRY_CONNECTION_RETRIES
Confluent Schema registry connection timeout (in secs).
IDictionary< string, string > options
Optional parameters.
const string GZIP
gzip file compression.
const string TEXT_DELIMITER
Specifies the character delimiting field values in the source data and field names in the header (if ...
const string PERMISSIVE
Records with missing columns are populated with nulls if possible; otherwise, the malformed records a...
const string CHUNK_MAX_MEMORY
Indicates the target maximum data size for all columns in a chunk to be used for this table.
InsertRecordsFromPayloadRequest()
Constructs an InsertRecordsFromPayloadRequest object with default parameters.
const string SCHEMA_REGISTRY_CONNECTION_TIMEOUT
Confluent Schema registry connection timeout (in secs).
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 FULL
Run a type inference on the source data (if needed) and ingest.
const string TEXT_NULL_STRING
Specifies the character string that should be interpreted as a null value in the source data.
const string TRUE
Upsert new records when primary keys match existing records.
long count_skipped
Number of records skipped, when not running in ABORT error handling mode.
const string TABLE_INSERT_MODE
When inserting records from multiple files: if TABLE_PER_FILE, then insert from each file into a new ...
string table_name
Name of the table into which the data will be inserted, in [schema_name.
const string PARTITION_TYPE
Partitioning scheme to use.
A set of string constants for the parameter options.
const string DEFAULT_COLUMN_FORMATS
Specifies the default format to be applied to source data loaded into columns with the corresponding ...
const string FLATTEN_COLUMNS
Specifies how to handle nested columns.
const string COMPRESSION_CODEC
The default compression codec for this table's columns.
const string DISTRIBUTED_SHARED
The head node coordinates loading data by worker processes across all nodes from shared files availab...
const string TYPE_INFERENCE_ONLY
Infer the type of the source data and return, without ingesting any data.
const string POLL_INTERVAL
If TRUE, the number of seconds between attempts to load external files into the table.
const string HEAD
The head node loads all data.
A set of string constants for the parameter create_table_options.
const string TEXT_SEARCH_MIN_COLUMN_LENGTH
Set minimum column size.
const string MAX_CONSECUTIVE_INVALID_SCHEMA_FAILURE
Max records to skip due to schema related errors, before failing.
const string PARQUET
Apache Parquet file format.
const string LAYER
Geo files layer(s) name(s): comma separated.
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_HEADER_PROPERTY_DELIMITER
Specifies the delimiter for column properties in the header row (if present).
const string DELIMITED_TEXT
Delimited text file format; e.g., CSV, TSV, PSV, etc.
const string MAX_RECORDS_TO_LOAD
Limit the number of records to load in this request: If this number is larger than a batch_size,...
const string IGNORE_BAD_RECORDS
Malformed records are skipped.
const string BAD_RECORD_TABLE_NAME
Name of a table to which records that were rejected are written.
const string COLUMNS_TO_SKIP
Specifies a comma-delimited list of columns from the source data to skip.
const string CHUNK_SIZE
Indicates the number of records per chunk to be used for this table.
string type_label
The user-defined description associated with the target table's structure.
const string SUBSCRIBE
Continuously poll the data source to check for new data and load it into the table.
const string TEXT_ESCAPE_CHARACTER
Specifies the character that is used to escape other characters in the source data.
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 NUM_TASKS_PER_RANK
Number of tasks for reading file per rank.
const string INGESTION_MODE
Whether to do a full load, dry run, or perform a type inference on the source data.