Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
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 
10 
11 namespace kinetica
12 {
13 
21  {
22 
243  public struct CreateTableOptions
244  {
245 
249  public const string TYPE_ID = "type_id";
250 
268  public const string NO_ERROR_IF_EXISTS = "no_error_if_exists";
269  public const string TRUE = "true";
270  public const string FALSE = "false";
271 
300  public const string IS_REPLICATED = "is_replicated";
301 
308  public const string FOREIGN_KEYS = "foreign_keys";
309 
313  public const string FOREIGN_SHARD_KEY = "foreign_shard_key";
314 
355  public const string PARTITION_TYPE = "partition_type";
356 
360  public const string RANGE = "RANGE";
361 
365  public const string INTERVAL = "INTERVAL";
366 
370  public const string LIST = "LIST";
371 
375  public const string HASH = "HASH";
376 
380  public const string SERIES = "SERIES";
381 
386  public const string PARTITION_KEYS = "partition_keys";
387 
401  public const string PARTITION_DEFINITIONS = "partition_definitions";
402 
421  public const string IS_AUTOMATIC_PARTITION = "is_automatic_partition";
422 
426  public const string TTL = "ttl";
427 
430  public const string CHUNK_SIZE = "chunk_size";
431 
454  public const string IS_RESULT_TABLE = "is_result_table";
455 
459  public const string STRATEGY_DEFINITION = "strategy_definition";
460  } // end struct CreateTableOptions
461 
462 
765  public struct Options
766  {
767 
773  public const string BAD_RECORD_TABLE_NAME = "bad_record_table_name";
774 
778  public const string BAD_RECORD_TABLE_LIMIT = "bad_record_table_limit";
779 
782  public const string BATCH_SIZE = "batch_size";
783 
786  public const string DATASOURCE_NAME = "datasource_name";
787 
814  public const string ERROR_HANDLING = "error_handling";
815 
819  public const string PERMISSIVE = "permissive";
820 
822  public const string IGNORE_BAD_RECORDS = "ignore_bad_records";
823 
827  public const string ABORT = "abort";
828 
866  public const string IGNORE_EXISTING_PK = "ignore_existing_pk";
867 
870  public const string TRUE = "true";
871 
874  public const string FALSE = "false";
875 
904  public const string INGESTION_MODE = "ingestion_mode";
905 
908  public const string FULL = "full";
909 
913  public const string DRY_RUN = "dry_run";
914 
918  public const string TYPE_INFERENCE_ONLY = "type_inference_only";
919 
922  public const string JDBC_FETCH_SIZE = "jdbc_fetch_size";
923 
926  public const string JDBC_SESSION_INIT_STATEMENT = "jdbc_session_init_statement";
927 
931  public const string NUM_SPLITS_PER_RANK = "num_splits_per_rank";
932 
935  public const string NUM_TASKS_PER_RANK = "num_tasks_per_rank";
936 
940  public const string PRIMARY_KEYS = "primary_keys";
941 
945  public const string SHARD_KEYS = "shard_keys";
946 
962  public const string SUBSCRIBE = "subscribe";
963 
979  public const string TRUNCATE_TABLE = "truncate_table";
980 
983  public const string REMOTE_QUERY = "remote_query";
984 
988  public const string REMOTE_QUERY_ORDER_BY = "remote_query_order_by";
989 
993  public const string REMOTE_QUERY_FILTER_COLUMN = "remote_query_filter_column";
994 
998  public const string REMOTE_QUERY_INCREASING_COLUMN = "remote_query_increasing_column";
999 
1002  public const string REMOTE_QUERY_PARTITION_COLUMN = "remote_query_partition_column";
1003 
1019  public const string TRUNCATE_STRINGS = "truncate_strings";
1020 
1053  public const string UPDATE_ON_EXISTING_PK = "update_on_existing_pk";
1054  } // end struct Options
1055 
1056 
1067  public string table_name { get; set; }
1068 
1071  public string remote_query { get; set; }
1072 
1075  public IDictionary<string, IDictionary<string, string>> modify_columns { get; set; } = new Dictionary<string, IDictionary<string, string>>();
1076 
1295  public IDictionary<string, string> create_table_options { get; set; } = new Dictionary<string, string>();
1296 
1597  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
1598 
1599 
1603 
2143  string remote_query,
2144  IDictionary<string, IDictionary<string, string>> modify_columns = null,
2145  IDictionary<string, string> create_table_options = null,
2146  IDictionary<string, string> options = null)
2147  {
2148  this.table_name = table_name ?? "";
2149  this.remote_query = remote_query ?? "";
2150  this.modify_columns = modify_columns ?? new Dictionary<string, IDictionary<string, string>>();
2151  this.create_table_options = create_table_options ?? new Dictionary<string, string>();
2152  this.options = options ?? new Dictionary<string, string>();
2153  } // end constructor
2154 
2155  } // end class InsertRecordsFromQueryRequest
2156 
2157 
2158 
2163  {
2164 
2167  public string table_name { get; set; }
2168 
2172  public string type_id { get; set; }
2173 
2176  public string type_definition { get; set; }
2177 
2180  public string type_label { get; set; }
2181 
2184  public IDictionary<string, IList<string>> type_properties { get; set; } = new Dictionary<string, IList<string>>();
2185 
2188  public long count_inserted { get; set; }
2189 
2192  public long count_skipped { get; set; }
2193 
2196  public long count_updated { get; set; }
2197 
2199  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
2200 
2201  } // end class InsertRecordsFromQueryResponse
2202 
2203 
2204 
2205 
2206 } // 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&#39;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(string,string,IDictionary{string, IDictionary{string, string}},IDictionary{string, string},IDictionary{string, string}).
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., TIMESTAMP).
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&#39;s data.
const string IS_AUTOMATIC_PARTITION
If true, a new partition will be created for values which don&#39;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&#39;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 &#39;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(string,string,IDictionary{string, IDictionary{string, string}},IDictionary{string, string},IDictionary{string, string}).
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.
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 &#39;(source_column_name [, ...]) references target_table_name(primary_key_column_name [, ...]) [as foreign_key_name]&#39;.