Kinetica   C#   API  Version 7.2.3.0
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  {
28  public const string TYPE_ID = "type_id";
29 
46  public const string NO_ERROR_IF_EXISTS = "no_error_if_exists";
47 
48  public const string TRUE = "true";
49  public const string FALSE = "false";
50 
68  public const string IS_REPLICATED = "is_replicated";
69 
76  public const string FOREIGN_KEYS = "foreign_keys";
77 
81  public const string FOREIGN_SHARD_KEY = "foreign_shard_key";
82 
124  public const string PARTITION_TYPE = "partition_type";
125 
129  public const string RANGE = "RANGE";
130 
134  public const string INTERVAL = "INTERVAL";
135 
139  public const string LIST = "LIST";
140 
144  public const string HASH = "HASH";
145 
149  public const string SERIES = "SERIES";
150 
156  public const string PARTITION_KEYS = "partition_keys";
157 
174  public const string PARTITION_DEFINITIONS = "partition_definitions";
175 
192  public const string IS_AUTOMATIC_PARTITION = "is_automatic_partition";
193 
197  public const string TTL = "ttl";
198 
201  public const string CHUNK_SIZE = "chunk_size";
202 
219  public const string IS_RESULT_TABLE = "is_result_table";
220 
224  public const string STRATEGY_DEFINITION = "strategy_definition";
225  } // end struct CreateTableOptions
226 
230  public struct Options
231  {
238  public const string BAD_RECORD_TABLE_NAME = "bad_record_table_name";
239 
243  public const string BAD_RECORD_TABLE_LIMIT = "bad_record_table_limit";
244 
247  public const string BATCH_SIZE = "batch_size";
248 
251  public const string DATASOURCE_NAME = "datasource_name";
252 
281  public const string ERROR_HANDLING = "error_handling";
282 
286  public const string PERMISSIVE = "permissive";
287 
289  public const string IGNORE_BAD_RECORDS = "ignore_bad_records";
290 
295  public const string ABORT = "abort";
296 
321  public const string IGNORE_EXISTING_PK = "ignore_existing_pk";
322 
325  public const string TRUE = "true";
326 
329  public const string FALSE = "false";
330 
359  public const string INGESTION_MODE = "ingestion_mode";
360 
363  public const string FULL = "full";
364 
369  public const string DRY_RUN = "dry_run";
370 
375  public const string TYPE_INFERENCE_ONLY = "type_inference_only";
376 
379  public const string JDBC_FETCH_SIZE = "jdbc_fetch_size";
380 
384  public const string JDBC_SESSION_INIT_STATEMENT = "jdbc_session_init_statement";
385 
390  public const string NUM_SPLITS_PER_RANK = "num_splits_per_rank";
391 
396  public const string NUM_TASKS_PER_RANK = "num_tasks_per_rank";
397 
401  public const string PRIMARY_KEYS = "primary_keys";
402 
406  public const string SHARD_KEYS = "shard_keys";
407 
421  public const string SUBSCRIBE = "subscribe";
422 
437  public const string TRUNCATE_TABLE = "truncate_table";
438 
441  public const string REMOTE_QUERY = "remote_query";
442 
446  public const string REMOTE_QUERY_ORDER_BY = "remote_query_order_by";
447 
452  public const string REMOTE_QUERY_FILTER_COLUMN = "remote_query_filter_column";
453 
457  public const string REMOTE_QUERY_INCREASING_COLUMN = "remote_query_increasing_column";
458 
461  public const string REMOTE_QUERY_PARTITION_COLUMN = "remote_query_partition_column";
462 
477  public const string TRUNCATE_STRINGS = "truncate_strings";
478 
498  public const string UPDATE_ON_EXISTING_PK = "update_on_existing_pk";
499  } // end struct Options
500 
512  public string table_name { get; set; }
513 
515  public string remote_query { get; set; }
516 
520  public IDictionary<string, IDictionary<string, string>> modify_columns { get; set; } = new Dictionary<string, IDictionary<string, string>>();
521 
762  public IDictionary<string, string> create_table_options { get; set; } = new Dictionary<string, string>();
763 
1078  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
1079 
1083 
1657  string remote_query,
1658  IDictionary<string, IDictionary<string, string>> modify_columns = null,
1659  IDictionary<string, string> create_table_options = null,
1660  IDictionary<string, string> options = null)
1661  {
1662  this.table_name = table_name ?? "";
1663  this.remote_query = remote_query ?? "";
1664  this.modify_columns = modify_columns ?? new Dictionary<string, IDictionary<string, string>>();
1665  this.create_table_options = create_table_options ?? new Dictionary<string, string>();
1666  this.options = options ?? new Dictionary<string, string>();
1667  } // end constructor
1668  } // end class InsertRecordsFromQueryRequest
1669 
1674  {
1678  public string table_name { get; set; }
1679 
1683  public string type_id { get; set; }
1684 
1687  public string type_definition { get; set; }
1688 
1691  public string type_label { get; set; }
1692 
1695  public IDictionary<string, IList<string>> type_properties { get; set; } = new Dictionary<string, IList<string>>();
1696 
1699  public long count_inserted { get; set; }
1700 
1704  public long count_skipped { get; set; }
1705 
1708  public long count_updated { get; set; }
1709 
1711  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1712  } // end class InsertRecordsFromQueryResponse
1713 } // end namespace kinetica
const string SHARD_KEYS
Optional: comma separated list of column names, to set as primary keys, when not specified in the typ...
const string TRUNCATE_TABLE
If set to TRUE, truncates the table specified by table_name prior to loading the data.
const string PARTITION_DEFINITIONS
Comma-separated list of partition definitions, whose format depends on the choice of PARTITION_TYPE.
const string JDBC_FETCH_SIZE
The JDBC fetch size, which determines how many rows to fetch per round trip.
const string TTL
Sets the TTL of the table specified in table_name.
const string TRUNCATE_STRINGS
If set to TRUE, truncate string values that are longer than the column's type size.
const string IGNORE_BAD_RECORDS
Malformed records are skipped.
const string NUM_TASKS_PER_RANK
Optional: number of tasks for reading data per rank.
const string CHUNK_SIZE
Indicates the number of records per chunk to be used for this table.
const string DATASOURCE_NAME
Name of an existing external data source from which table will be loaded
InsertRecordsFromQueryRequest()
Constructs an InsertRecordsFromQueryRequest object with default parameters.
IDictionary< string, IDictionary< string, string > > modify_columns
Not implemented yet.
A set of parameters for Kinetica.insertRecordsFromQuery.
const string BATCH_SIZE
Number of records per batch when inserting data.
const string REMOTE_QUERY_INCREASING_COLUMN
Column on subscribed remote query result that will increase for new records (e.g.,...
A set of string constants for the parameter create_table_options.
const string JDBC_SESSION_INIT_STATEMENT
Executes the statement per each jdbc session before doing actual load.
const string PRIMARY_KEYS
Optional: comma separated list of column names, to set as primary keys, when not specified in the typ...
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 ABORT
Stops current insertion and aborts entire operation when an error is encountered.
const string REMOTE_QUERY_FILTER_COLUMN
Name of column to be used for splitting the query into multiple sub-queries using the data distributi...
long count_updated
[Not yet implemented] Number of records updated within the target table.
const string PERMISSIVE
Records with missing columns are populated with nulls if possible; otherwise, the malformed records a...
string type_definition
A JSON string describing the columns of the target table
IDictionary< string, string > options
Optional parameters.
const string TYPE_ID
ID of a currently registered type.
const string STRATEGY_DEFINITION
The tier strategy for the table and its columns.
const string REMOTE_QUERY_PARTITION_COLUMN
Alias name for remote_query_filter_column.
const string FULL
Run a type inference on the source data (if needed) and ingest
const string DRY_RUN
Does not load data, but walks through the source data and determines the number of valid records,...
const string TYPE_INFERENCE_ONLY
Infer the type of the source data and return, without ingesting any data.
const string UPDATE_ON_EXISTING_PK
Specifies the record collision policy for inserting into a table with a primary key.
const string IS_REPLICATED
Affects the distribution scheme for the table's data.
const string IS_AUTOMATIC_PARTITION
If TRUE, a new partition will be created for values which don't fall into an existing partition.
string table_name
Name of the table into which the data will be inserted, in [schema_name.
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.
string type_label
The user-defined description associated with the target table's structure
const string IGNORE_EXISTING_PK
Specifies the record collision error-suppression policy for inserting into a table with a primary key...
string type_id
ID of the currently registered table structure type for the target table
IDictionary< string, string > info
Additional information.
const string FOREIGN_SHARD_KEY
Foreign shard key of the format 'source_column references shard_by_column from target_table(primary_k...
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.
IDictionary< string, string > create_table_options
Options used when creating the target table.
const string TRUE
Upsert new records when primary keys match existing records
const string BAD_RECORD_TABLE_NAME
Optional name of a table to which records that were rejected are written.
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 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 IS_RESULT_TABLE
Indicates whether the table is a memory-only table.
const string REMOTE_QUERY
Remote SQL query from which data will be sourced
A set of results returned by Kinetica.insertRecordsFromQuery.
long count_inserted
Number of records inserted into the target table.
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
const string PARTITION_KEYS
Comma-separated list of partition keys, which are the columns or column expressions by which records ...
const string NUM_SPLITS_PER_RANK
Optional: number of splits for reading data per rank.
A set of string constants for the parameter options.
const string FALSE
Reject new records when primary keys match existing records
const string INGESTION_MODE
Whether to do a full load, dry run, or perform a type inference on the source data.
string remote_query
Query for which result data needs to be imported
const string SUBSCRIBE
Continuously poll the data source to check for new data and load it into the table.
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 FOREIGN_KEYS
Semicolon-separated list of foreign keys, of the format '(source_column_name [, .....