Kinetica   C#   API  Version 7.2.3.0
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  {
32  public const string TYPE_ID = "type_id";
33 
50  public const string NO_ERROR_IF_EXISTS = "no_error_if_exists";
51 
52  public const string TRUE = "true";
53  public const string FALSE = "false";
54 
72  public const string IS_REPLICATED = "is_replicated";
73 
80  public const string FOREIGN_KEYS = "foreign_keys";
81 
85  public const string FOREIGN_SHARD_KEY = "foreign_shard_key";
86 
128  public const string PARTITION_TYPE = "partition_type";
129 
133  public const string RANGE = "RANGE";
134 
138  public const string INTERVAL = "INTERVAL";
139 
143  public const string LIST = "LIST";
144 
148  public const string HASH = "HASH";
149 
153  public const string SERIES = "SERIES";
154 
160  public const string PARTITION_KEYS = "partition_keys";
161 
178  public const string PARTITION_DEFINITIONS = "partition_definitions";
179 
196  public const string IS_AUTOMATIC_PARTITION = "is_automatic_partition";
197 
201  public const string TTL = "ttl";
202 
205  public const string CHUNK_SIZE = "chunk_size";
206 
209  public const string CHUNK_COLUMN_MAX_MEMORY = "chunk_column_max_memory";
210 
213  public const string CHUNK_MAX_MEMORY = "chunk_max_memory";
214 
231  public const string IS_RESULT_TABLE = "is_result_table";
232 
236  public const string STRATEGY_DEFINITION = "strategy_definition";
237  } // end struct CreateTableOptions
238 
242  public struct Options
243  {
246  public const string AVRO_HEADER_BYTES = "avro_header_bytes";
247 
250  public const string AVRO_NUM_RECORDS = "avro_num_records";
251 
255  public const string AVRO_SCHEMA = "avro_schema";
256 
268  public const string AVRO_SCHEMALESS = "avro_schemaless";
269 
272  public const string TRUE = "true";
273 
276  public const string FALSE = "false";
277 
283  public const string BAD_RECORD_TABLE_NAME = "bad_record_table_name";
284 
288  public const string BAD_RECORD_TABLE_LIMIT = "bad_record_table_limit";
289 
296  public const string BAD_RECORD_TABLE_LIMIT_PER_INPUT = "bad_record_table_limit_per_input";
297 
300  public const string BATCH_SIZE = "batch_size";
301 
316  public const string COLUMN_FORMATS = "column_formats";
317 
344  public const string COLUMNS_TO_LOAD = "columns_to_load";
345 
351  public const string COLUMNS_TO_SKIP = "columns_to_skip";
352 
376  public const string COMPRESSION_TYPE = "compression_type";
377 
379  public const string NONE = "none";
380 
383  public const string AUTO = "auto";
384 
386  public const string GZIP = "gzip";
387 
389  public const string BZIP2 = "bzip2";
390 
420  public const string DEFAULT_COLUMN_FORMATS = "default_column_formats";
421 
450  public const string ERROR_HANDLING = "error_handling";
451 
455  public const string PERMISSIVE = "permissive";
456 
458  public const string IGNORE_BAD_RECORDS = "ignore_bad_records";
459 
464  public const string ABORT = "abort";
465 
502  public const string FILE_TYPE = "file_type";
503 
505  public const string AVRO = "avro";
506 
509  public const string DELIMITED_TEXT = "delimited_text";
510 
512  public const string GDB = "gdb";
513 
515  public const string JSON = "json";
516 
518  public const string PARQUET = "parquet";
519 
521  public const string SHAPEFILE = "shapefile";
522 
539  public const string FLATTEN_COLUMNS = "flatten_columns";
540 
544  public const string GDAL_CONFIGURATION_OPTIONS = "gdal_configuration_options";
545 
570  public const string IGNORE_EXISTING_PK = "ignore_existing_pk";
571 
600  public const string INGESTION_MODE = "ingestion_mode";
601 
604  public const string FULL = "full";
605 
610  public const string DRY_RUN = "dry_run";
611 
616  public const string TYPE_INFERENCE_ONLY = "type_inference_only";
617 
621  public const string LAYER = "layer";
622 
671  public const string LOADING_MODE = "loading_mode";
672 
676  public const string HEAD = "head";
677 
687  public const string DISTRIBUTED_SHARED = "distributed_shared";
688 
706  public const string DISTRIBUTED_LOCAL = "distributed_local";
707 
709  public const string LOCAL_TIME_OFFSET = "local_time_offset";
710 
716  public const string MAX_RECORDS_TO_LOAD = "max_records_to_load";
717 
722  public const string NUM_TASKS_PER_RANK = "num_tasks_per_rank";
723 
730  public const string POLL_INTERVAL = "poll_interval";
731 
735  public const string PRIMARY_KEYS = "primary_keys";
736 
737  public const string SCHEMA_REGISTRY_SCHEMA_ID = "schema_registry_schema_id";
738  public const string SCHEMA_REGISTRY_SCHEMA_NAME = "schema_registry_schema_name";
739  public const string SCHEMA_REGISTRY_SCHEMA_VERSION = "schema_registry_schema_version";
740 
744  public const string SHARD_KEYS = "shard_keys";
745 
747  public const string SKIP_LINES = "skip_lines";
748 
762  public const string SUBSCRIBE = "subscribe";
763 
778  public const string TABLE_INSERT_MODE = "table_insert_mode";
779 
780  public const string SINGLE = "single";
781  public const string TABLE_PER_FILE = "table_per_file";
782 
792  public const string TEXT_COMMENT_STRING = "text_comment_string";
793 
801  public const string TEXT_DELIMITER = "text_delimiter";
802 
817  public const string TEXT_ESCAPE_CHARACTER = "text_escape_character";
818 
832  public const string TEXT_HAS_HEADER = "text_has_header";
833 
844  public const string TEXT_HEADER_PROPERTY_DELIMITER = "text_header_property_delimiter";
845 
852  public const string TEXT_NULL_STRING = "text_null_string";
853 
866  public const string TEXT_QUOTE_CHARACTER = "text_quote_character";
867 
874  public const string TEXT_SEARCH_COLUMNS = "text_search_columns";
875 
879  public const string TEXT_SEARCH_MIN_COLUMN_LENGTH = "text_search_min_column_length";
880 
895  public const string TRUNCATE_STRINGS = "truncate_strings";
896 
911  public const string TRUNCATE_TABLE = "truncate_table";
912 
931  public const string TYPE_INFERENCE_MODE = "type_inference_mode";
932 
935  public const string ACCURACY = "accuracy";
936 
940  public const string SPEED = "speed";
941 
961  public const string UPDATE_ON_EXISTING_PK = "update_on_existing_pk";
962  } // end struct Options
963 
974  public string table_name { get; set; }
975 
977  public string data_text { get; set; }
978 
980  public byte[] data_bytes { get; set; }
981 
985  public IDictionary<string, IDictionary<string, string>> modify_columns { get; set; } = new Dictionary<string, IDictionary<string, string>>();
986 
1242  public IDictionary<string, string> create_table_options { get; set; } = new Dictionary<string, string>();
1243 
2002  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
2003 
2007 
3041  string data_text,
3042  byte[] data_bytes,
3043  IDictionary<string, IDictionary<string, string>> modify_columns = null,
3044  IDictionary<string, string> create_table_options = null,
3045  IDictionary<string, string> options = null)
3046  {
3047  this.table_name = table_name ?? "";
3048  this.data_text = data_text ?? "";
3049  this.data_bytes = data_bytes ?? new byte[] { };
3050  this.modify_columns = modify_columns ?? new Dictionary<string, IDictionary<string, string>>();
3051  this.create_table_options = create_table_options ?? new Dictionary<string, string>();
3052  this.options = options ?? new Dictionary<string, string>();
3053  } // end constructor
3054  } // end class InsertRecordsFromPayloadRequest
3055 
3060  {
3064  public string table_name { get; set; }
3065 
3069  public string type_id { get; set; }
3070 
3073  public string type_definition { get; set; }
3074 
3077  public string type_label { get; set; }
3078 
3081  public IDictionary<string, IList<string>> type_properties { get; set; } = new Dictionary<string, IList<string>>();
3082 
3085  public long count_inserted { get; set; }
3086 
3090  public long count_skipped { get; set; }
3091 
3094  public long count_updated { get; set; }
3095 
3097  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
3098  } // end class InsertRecordsFromPayloadResponse
3099 } // end namespace kinetica
const string TEXT_ESCAPE_CHARACTER
Specifies the character that is used to escape other characters in the source data.
const string PARTITION_KEYS
Comma-separated list of partition keys, which are the columns or column expressions by which records ...
const string FLATTEN_COLUMNS
Specifies how to handle nested columns.
const string IS_REPLICATED
Affects the distribution scheme for the table's data.
const string DRY_RUN
Does not load data, but walks through the source data and determines the number of valid records,...
const string IS_RESULT_TABLE
Indicates whether the table is a memory-only table.
const string TEXT_SEARCH_COLUMNS
Add 'text_search' property to internally inferenced string columns.
string type_definition
A JSON string describing the columns of the target table
const string SPEED
Scans data and picks the widest possible column types so that 'all' values will fit with minimum data...
const string AVRO_SCHEMA
Optional string representing avro schema, for insert records in avro format, that does not include is...
byte [] data_bytes
Records formatted as binary data
const string FOREIGN_KEYS
Semicolon-separated list of foreign keys, of the format '(source_column_name [, .....
const string FILE_TYPE
Specifies the type of the file(s) whose records will be inserted.
const string TRUNCATE_STRINGS
If set to TRUE, truncate string values that are longer than the column's type size.
const string DEFAULT_COLUMN_FORMATS
Specifies the default format to be applied to source data loaded into columns with the corresponding ...
const string TABLE_INSERT_MODE
Optional: table_insert_mode.
A set of string constants for the parameter create_table_options.
const string TYPE_ID
ID of a currently registered type.
const string IGNORE_BAD_RECORDS
Malformed records are skipped.
const string PARTITION_DEFINITIONS
Comma-separated list of partition definitions, whose format depends on the choice of PARTITION_TYPE.
const string BAD_RECORD_TABLE_NAME
Optional name of a table to which records that were rejected are written.
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 PARQUET
Apache Parquet file format
string type_id
ID of the currently registered table structure type for the target table
const string TEXT_QUOTE_CHARACTER
Specifies the character that should be interpreted as a field value quoting character in the source d...
const string SUBSCRIBE
Continuously poll the data source to check for new data and load it into the table.
const string COMPRESSION_TYPE
Optional: payload compression type.
const string TEXT_HAS_HEADER
Indicates whether the source data contains a header row.
const string ERROR_HANDLING
Specifies how errors should be handled upon insertion.
const string LAYER
Optional: geo files layer(s) name(s): comma separated.
long count_updated
[Not yet implemented] Number of records updated within the target table.
const string CHUNK_SIZE
Indicates the number of records per chunk to be used for this table.
long count_skipped
Number of records skipped, when not running in ABORT error handling mode.
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 TEXT_COMMENT_STRING
Specifies the character string that should be interpreted as a comment line prefix in the source data...
const string PRIMARY_KEYS
Optional: comma separated list of column names, to set as primary keys, when not specified in the typ...
const string POLL_INTERVAL
If TRUE, the number of seconds between attempts to load external files into the table.
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 PERMISSIVE
Records with missing columns are populated with nulls if possible; otherwise, the malformed records a...
const string TEXT_SEARCH_MIN_COLUMN_LENGTH
Set minimum column size.
const string DISTRIBUTED_LOCAL
A single worker process on each node loads all files that are available to it.
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 AVRO_HEADER_BYTES
Optional number of bytes to skip when reading an avro record.
const string HEAD
The head node loads all data.
A set of string constants for the parameter options.
const string AVRO_SCHEMALESS
When user provides 'avro_schema', avro data is assumed to be schemaless, unless specified.
const string COLUMNS_TO_SKIP
Specifies a comma-delimited list of columns from the source data to skip.
string type_label
The user-defined description associated with the target table's structure
string data_text
Records formatted as delimited text
string table_name
Name of the table into which the data will be inserted, in [schema_name.
const string TYPE_INFERENCE_ONLY
Infer the type of the source data and return, without ingesting any data.
const string TYPE_INFERENCE_MODE
optimize type inference for:
const string NUM_TASKS_PER_RANK
Optional: number of tasks for reading file per rank.
const string TRUNCATE_TABLE
If set to TRUE, truncates the table specified by table_name prior to loading the file(s).
const string TRUE
Upsert new records when primary keys match existing records
IDictionary< string, string > info
Additional information.
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 UPDATE_ON_EXISTING_PK
Specifies the record collision policy for inserting into a table with a primary key.
const string TEXT_DELIMITER
Specifies the character delimiting field values in the source data and field names in the header (if ...
const string AVRO_NUM_RECORDS
Optional number of avro records, if data includes only records.
const string ABORT
Stops current insertion and aborts entire operation when an error is encountered.
const string LOADING_MODE
Scheme for distributing the extraction and loading of data from the source data file(s).
const string DELIMITED_TEXT
Delimited text file format; e.g., CSV, TSV, PSV, etc.
const string FOREIGN_SHARD_KEY
Foreign shard key of the format 'source_column references shard_by_column from target_table(primary_k...
long count_inserted
Number of records inserted into the target table.
const string SHARD_KEYS
Optional: comma separated list of column names, to set as primary keys, when not specified in the typ...
const string TEXT_NULL_STRING
Specifies the character string that should be interpreted as a null value in the source data.
const string TEXT_HEADER_PROPERTY_DELIMITER
Specifies the delimiter for column properties in the header row (if present).
InsertRecordsFromPayloadRequest()
Constructs an InsertRecordsFromPayloadRequest object with default parameters.
A set of results returned by Kinetica.insertRecordsFromPayload.
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 ACCURACY
Scans data to get exactly-typed & sized columns for all data scanned.
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 COLUMN_FORMATS
For each target column specified, applies the column-property-bound format to the source data loaded ...
const string STRATEGY_DEFINITION
The tier strategy for the table and its 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.
IDictionary< string, string > create_table_options
Options used when creating the target table.
IDictionary< string, string > options
Optional parameters.
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
const string BATCH_SIZE
Internal tuning parameter–number of records per batch when inserting data.
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 IGNORE_EXISTING_PK
Specifies the record collision error-suppression policy for inserting into a table with a primary key...
const string INGESTION_MODE
Whether to do a full load, dry run, or perform a type inference on the source data.
const string TTL
Sets the TTL of the table specified in table_name.
const string FULL
Run a type inference on the source data (if needed) and ingest
const string GDAL_CONFIGURATION_OPTIONS
Comma separated list of gdal conf options, for the specific requets: key=value.
const string SKIP_LINES
Skip number of lines from begining of file.
A set of parameters for Kinetica.insertRecordsFromPayload.
const string DISTRIBUTED_SHARED
The head node coordinates loading data by worker processes across all nodes from shared files availab...
const string FALSE
Reject new records when primary keys match existing records
const string LOCAL_TIME_OFFSET
For Avro local timestamp columns
IDictionary< string, IDictionary< string, string > > modify_columns
Not implemented yet.