Kinetica   C#   API  Version 7.2.3.1
InsertRecordsFromQuery.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 
17 {
22  public struct CreateTableOptions
23  {
27  public const string TYPE_ID = "type_id";
28 
44  public const string NO_ERROR_IF_EXISTS = "no_error_if_exists";
45 
46  public const string TRUE = "true";
47  public const string FALSE = "false";
48 
65  public const string IS_REPLICATED = "is_replicated";
66 
72  public const string FOREIGN_KEYS = "foreign_keys";
73 
76  public const string FOREIGN_SHARD_KEY = "foreign_shard_key";
77 
118  public const string PARTITION_TYPE = "partition_type";
119 
123  public const string RANGE = "RANGE";
124 
128  public const string INTERVAL = "INTERVAL";
129 
133  public const string LIST = "LIST";
134 
138  public const string HASH = "HASH";
139 
143  public const string SERIES = "SERIES";
144 
150  public const string PARTITION_KEYS = "partition_keys";
151 
168  public const string PARTITION_DEFINITIONS = "partition_definitions";
169 
185  public const string IS_AUTOMATIC_PARTITION = "is_automatic_partition";
186 
190  public const string TTL = "ttl";
191 
194  public const string CHUNK_SIZE = "chunk_size";
195 
211  public const string IS_RESULT_TABLE = "is_result_table";
212 
216  public const string STRATEGY_DEFINITION = "strategy_definition";
217 
222  public const string COMPRESSION_CODEC = "compression_codec";
223  } // end struct CreateTableOptions
224 
228  public struct Options
229  {
236  public const string BAD_RECORD_TABLE_NAME = "bad_record_table_name";
237 
241  public const string BAD_RECORD_TABLE_LIMIT = "bad_record_table_limit";
242 
244  public const string BATCH_SIZE = "batch_size";
245 
248  public const string DATASOURCE_NAME = "datasource_name";
249 
277  public const string ERROR_HANDLING = "error_handling";
278 
281  public const string PERMISSIVE = "permissive";
282 
284  public const string IGNORE_BAD_RECORDS = "ignore_bad_records";
285 
290  public const string ABORT = "abort";
291 
315  public const string IGNORE_EXISTING_PK = "ignore_existing_pk";
316 
319  public const string TRUE = "true";
320 
323  public const string FALSE = "false";
324 
353  public const string INGESTION_MODE = "ingestion_mode";
354 
357  public const string FULL = "full";
358 
363  public const string DRY_RUN = "dry_run";
364 
369  public const string TYPE_INFERENCE_ONLY = "type_inference_only";
370 
373  public const string JDBC_FETCH_SIZE = "jdbc_fetch_size";
374 
378  public const string JDBC_SESSION_INIT_STATEMENT = "jdbc_session_init_statement";
379 
383  public const string NUM_SPLITS_PER_RANK = "num_splits_per_rank";
384 
388  public const string NUM_TASKS_PER_RANK = "num_tasks_per_rank";
389 
393  public const string PRIMARY_KEYS = "primary_keys";
394 
398  public const string SHARD_KEYS = "shard_keys";
399 
413  public const string SUBSCRIBE = "subscribe";
414 
429  public const string TRUNCATE_TABLE = "truncate_table";
430 
433  public const string REMOTE_QUERY = "remote_query";
434 
438  public const string REMOTE_QUERY_ORDER_BY = "remote_query_order_by";
439 
444  public const string REMOTE_QUERY_FILTER_COLUMN = "remote_query_filter_column";
445 
449  public const string REMOTE_QUERY_INCREASING_COLUMN = "remote_query_increasing_column";
450 
455  public const string REMOTE_QUERY_PARTITION_COLUMN = "remote_query_partition_column";
456 
471  public const string TRUNCATE_STRINGS = "truncate_strings";
472 
491  public const string UPDATE_ON_EXISTING_PK = "update_on_existing_pk";
492  } // end struct Options
493 
504  public string table_name { get; set; }
505 
507  public string remote_query { get; set; }
508 
512  public IDictionary<string, IDictionary<string, string>> modify_columns { get; set; } = new Dictionary<string, IDictionary<string, string>>();
513 
754  public IDictionary<string, string> create_table_options { get; set; } = new Dictionary<string, string>();
755 
1063  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
1064 
1068 
1634  string remote_query,
1635  IDictionary<string, IDictionary<string, string>> modify_columns = null,
1636  IDictionary<string, string> create_table_options = null,
1637  IDictionary<string, string> options = null)
1638  {
1639  this.table_name = table_name ?? "";
1640  this.remote_query = remote_query ?? "";
1641  this.modify_columns = modify_columns ?? new Dictionary<string, IDictionary<string, string>>();
1642  this.create_table_options = create_table_options ?? new Dictionary<string, string>();
1643  this.options = options ?? new Dictionary<string, string>();
1644  } // end constructor
1645 } // end class InsertRecordsFromQueryRequest
1646 
1651 {
1655  public string table_name { get; set; }
1656 
1660  public string type_id { get; set; }
1661 
1664  public string type_definition { get; set; }
1665 
1668  public string type_label { get; set; }
1669 
1672  public IDictionary<string, IList<string>> type_properties { get; set; } = new Dictionary<string, IList<string>>();
1673 
1675  public long count_inserted { get; set; }
1676 
1680  public long count_skipped { get; set; }
1681 
1684  public long count_updated { get; set; }
1685 
1687  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1688 } // end class InsertRecordsFromQueryResponse
const string PARTITION_KEYS
Comma-separated list of partition keys, which are the columns or column expressions by which records ...
const string REMOTE_QUERY_INCREASING_COLUMN
Column on subscribed remote query result that will increase for new records (e.g.,...
IDictionary< string, IDictionary< string, string > > modify_columns
Not implemented yet.
IDictionary< string, string > create_table_options
Options used when creating the target table.
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 PRIMARY_KEYS
Comma separated list of column names, to set as primary keys, when not specified in the type.
const string TTL
Sets the TTL of the table specified in table_name.
const string TYPE_INFERENCE_ONLY
Infer the type of the source data and return, without ingesting any data.
const string IS_RESULT_TABLE
Indicates whether the table is a memory-only table.
const string COMPRESSION_CODEC
The default compression codec for this table's columns.
const string PARTITION_DEFINITIONS
Comma-separated list of partition definitions, whose format depends on the choice of PARTITION_TYPE.
const string JDBC_SESSION_INIT_STATEMENT
Executes the statement per each JDBC session before doing actual load.
string table_name
Name of the table into which the data will be inserted, in [schema_name.
const string FOREIGN_KEYS
Semicolon-separated list of foreign keys, of the format '(source_column_name [, .....
const string PARTITION_TYPE
Partitioning scheme to use.
A set of string constants for the parameter options.
IDictionary< string, string > options
Optional parameters.
A set of results returned by Kinetica.insertRecordsFromQuery.
const string NUM_TASKS_PER_RANK
Number of tasks for reading data per rank.
string type_label
The user-defined description associated with the target table's structure.
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
const string JDBC_FETCH_SIZE
The JDBC fetch size, which determines how many rows to fetch per round trip.
const string TRUNCATE_STRINGS
If set to TRUE, truncate string values that are longer than the column's type size.
const string SHARD_KEYS
Comma separated list of column names, to set as shard 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 INTERVAL
Use interval partitioning.
const string PERMISSIVE
Records with missing columns are populated with nulls if possible; otherwise, the malformed records a...
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 FALSE
Reject new records when primary keys match existing records.
const string TYPE_ID
ID of a currently registered type.
const string BAD_RECORD_TABLE_NAME
Name of a table to which records that were rejected are written.
const string FULL
Run a type inference on the source data (if needed) and ingest.
const string TRUNCATE_TABLE
If set to TRUE, truncates the table specified by table_name prior to loading the data.
const string DATASOURCE_NAME
Name of an existing external data source from which table will be loaded.
const string CHUNK_SIZE
Indicates the number of records per chunk to be used for this table.
const string REMOTE_QUERY
Remote SQL query from which data will be sourced.
IDictionary< string, string > info
Additional information.
const string REMOTE_QUERY_FILTER_COLUMN
Name of column to be used for splitting the query into multiple sub-queries using the data distributi...
const string BATCH_SIZE
Number of records per batch when inserting data.
const string DRY_RUN
Does not load data, but walks through the source data and determines the number of valid records,...
const string FOREIGN_SHARD_KEY
Foreign shard key of the format 'source_column references shard_by_column from target_table(primary_k...
const string IGNORE_BAD_RECORDS
Malformed records are skipped.
const string INGESTION_MODE
Whether to do a full load, dry run, or perform a type inference on the source data.
long count_updated
[Not yet implemented] Number of records updated within the target table.
A set of parameters for Kinetica.insertRecordsFromQuery.
const string REMOTE_QUERY_ORDER_BY
Name of column to be used for splitting the query into multiple sub-queries using ordering of given c...
const string UPDATE_ON_EXISTING_PK
Specifies the record collision policy for inserting into a table with a primary key.
const string NUM_SPLITS_PER_RANK
Number of splits for reading data per rank.
const string STRATEGY_DEFINITION
The tier strategy for the table and its columns.
string type_id
ID of the currently registered table structure type for the target table.
const string ABORT
Stops current insertion and aborts entire operation when an error is encountered.
const string IGNORE_EXISTING_PK
Specifies the record collision error-suppression policy for inserting into a table with a primary key...
const string TRUE
Upsert new records when primary keys match existing records.
InsertRecordsFromQueryRequest()
Constructs an InsertRecordsFromQueryRequest object with default parameters.
string table_name
Value of table_name.
const string SUBSCRIBE
Continuously poll the data source to check for new data and load it into the table.
long count_skipped
Number of records skipped, when not running in ABORT error handling mode.
const string ERROR_HANDLING
Specifies how errors should be handled upon insertion.
const string REMOTE_QUERY_PARTITION_COLUMN
Alias name for REMOTE_QUERY_FILTER_COLUMN.
const string IS_REPLICATED
Affects the distribution scheme for the table's data.
string type_definition
A JSON string describing the columns of the target table.
long count_inserted
Number of records inserted into the target table.
string remote_query
Query for which result data needs to be imported.
InsertRecordsFromQueryRequest(string table_name, string remote_query, IDictionary< string, IDictionary< string, string >> modify_columns=null, IDictionary< string, string > create_table_options=null, IDictionary< string, string > options=null)
Constructs an InsertRecordsFromQueryRequest object with the specified parameters.
A set of string constants for the parameter create_table_options.
const string IS_AUTOMATIC_PARTITION
If TRUE, a new partition will be created for values which don't fall into an existing partition.