Kinetica C# API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
InsertRecordsFromFiles.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 
35  {
36 
256  public struct CreateTableOptions
257  {
258 
262  public const string TYPE_ID = "type_id";
263 
281  public const string NO_ERROR_IF_EXISTS = "no_error_if_exists";
282  public const string TRUE = "true";
283  public const string FALSE = "false";
284 
289  public const string COLLECTION_NAME = "collection_name";
290 
319  public const string IS_REPLICATED = "is_replicated";
320 
327  public const string FOREIGN_KEYS = "foreign_keys";
328 
332  public const string FOREIGN_SHARD_KEY = "foreign_shard_key";
333 
367  public const string PARTITION_TYPE = "partition_type";
368 
372  public const string RANGE = "RANGE";
373 
377  public const string INTERVAL = "INTERVAL";
378 
382  public const string LIST = "LIST";
383 
387  public const string HASH = "HASH";
388 
393  public const string PARTITION_KEYS = "partition_keys";
394 
406  public const string PARTITION_DEFINITIONS = "partition_definitions";
407 
426  public const string IS_AUTOMATIC_PARTITION = "is_automatic_partition";
427 
431  public const string TTL = "ttl";
432 
435  public const string CHUNK_SIZE = "chunk_size";
436 
454  public const string IS_RESULT_TABLE = "is_result_table";
455 
462  public const string STRATEGY_DEFINITION = "strategy_definition";
463  } // end struct CreateTableOptions
464 
465 
731  public struct Options
732  {
733 
736  public const string BATCH_SIZE = "batch_size";
737 
749  public const string COLUMN_FORMATS = "column_formats";
750 
760  public const string COLUMNS_TO_LOAD = "columns_to_load";
761 
785  public const string DEFAULT_COLUMN_FORMATS = "default_column_formats";
786 
804  public const string DRY_RUN = "dry_run";
805  public const string FALSE = "false";
806  public const string TRUE = "true";
807 
833  public const string ERROR_HANDLING = "error_handling";
834 
838  public const string PERMISSIVE = "permissive";
839 
841  public const string IGNORE_BAD_RECORDS = "ignore_bad_records";
842 
845  public const string ABORT = "abort";
846 
859  public const string FILE_TYPE = "file_type";
860 
863  public const string DELIMITED_TEXT = "delimited_text";
864 
892  public const string LOADING_MODE = "loading_mode";
893 
896  public const string HEAD = "head";
897 
902  public const string DISTRIBUTED_SHARED = "distributed_shared";
903 
907  public const string DISTRIBUTED_LOCAL = "distributed_local";
908 
913  public const string TEXT_COMMENT_STRING = "text_comment_string";
914 
919  public const string TEXT_DELIMITER = "text_delimiter";
920 
928  public const string TEXT_ESCAPE_CHARACTER = "text_escape_character";
929 
945  public const string TEXT_HAS_HEADER = "text_has_header";
946 
951  public const string TEXT_HEADER_PROPERTY_DELIMITER = "text_header_property_delimiter";
952 
956  public const string TEXT_NULL_STRING = "text_null_string";
957 
966  public const string TEXT_QUOTE_CHARACTER = "text_quote_character";
967 
983  public const string TRUNCATE_TABLE = "truncate_table";
984 
987  public const string NUM_TASKS_PER_RANK = "num_tasks_per_rank";
988  } // end struct Options
989 
990 
995  public string table_name { get; set; }
996 
1005  public IList<string> filepaths { get; set; } = new List<string>();
1006 
1224  public IDictionary<string, string> create_table_options { get; set; } = new Dictionary<string, string>();
1225 
1489  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
1490 
1491 
1495 
1994  IList<string> filepaths,
1995  IDictionary<string, string> create_table_options = null,
1996  IDictionary<string, string> options = null)
1997  {
1998  this.table_name = table_name ?? "";
1999  this.filepaths = filepaths ?? new List<string>();
2000  this.create_table_options = create_table_options ?? new Dictionary<string, string>();
2001  this.options = options ?? new Dictionary<string, string>();
2002  } // end constructor
2003 
2004  } // end class InsertRecordsFromFilesRequest
2005 
2006 
2007 
2012  {
2013 
2016  public string table_name { get; set; }
2017 
2019  public string type_id { get; set; }
2020 
2022  public long count_inserted { get; set; }
2023 
2026  public long count_skipped { get; set; }
2027 
2030  public long count_updated { get; set; } = -1;
2031 
2033  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
2034 
2035  } // end class InsertRecordsFromFilesResponse
2036 
2037 
2038 
2039 
2040 } // end namespace kinetica
const string TRUNCATE_TABLE
If set to true, truncates the table specified by table_name prior to loading the file(s).
const string IGNORE_BAD_RECORDS
Malformed records are skipped.
const string PARTITION_KEYS
Comma-separated list of partition keys, which are the columns or column expressions by which records ...
const string TEXT_HEADER_PROPERTY_DELIMITER
For delimited_text file_type only.
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;.
const string TEXT_ESCAPE_CHARACTER
For delimited_text file_type only.
const string BATCH_SIZE
Specifies number of records to process before inserting.
const string DISTRIBUTED_SHARED
The worker nodes coordinate loading a set of files that are available to all of them.
long count_updated
Number of records updated.
const string IS_RESULT_TABLE
For a table, indicates whether the table is an in-memory table.
InsertRecordsFromFilesRequest()
Constructs an InsertRecordsFromFilesRequest object with default parameters.
const string DRY_RUN
If set to true, no data will be inserted but the file will be read with the applied error_handling mo...
const string FOREIGN_SHARD_KEY
Foreign shard key of the format &#39;source_column references shard_by_column from target_table(primary_k...
const string TTL
For a table, sets the TTL of the table specified in table_name.
const string COLLECTION_NAME
Name of a collection which is to contain the newly created table.
const string COLUMN_FORMATS
For each target column specified, applies the column-property-bound format to the source data loaded ...
long count_skipped
Number of records skipped when not running in abort error handling mode.
long count_inserted
Number of records inserted.
const string TEXT_DELIMITER
For delimited_text file_type only.
const string COLUMNS_TO_LOAD
For delimited_text file_type only.
const string IS_REPLICATED
For a table, affects the distribution scheme for the table&#39;s data.
const string FILE_TYPE
File type for the file(s).
const string HEAD
The head node loads all data.
const string TEXT_QUOTE_CHARACTER
For delimited_text file_type only.
const string TEXT_NULL_STRING
For delimited_text file_type only.
const string TEXT_COMMENT_STRING
For delimited_text file_type only.
const string NUM_TASKS_PER_RANK
Optional: number of tasks for reading file per rank.
IList< string > filepaths
Absolute or relative filepath(s) from where files will be loaded.
A set of results returned by Kinetica.insertRecordsFromFiles(string,IList{string},IDictionary{string, string},IDictionary{string, string}).
IDictionary< string, string > info
Additional information.
const string TYPE_ID
ID of a currently registered type.
const string DELIMITED_TEXT
Indicates the file(s) are in delimited text format, e.g., CSV, TSV, PSV, etc.
IDictionary< string, string > create_table_options
Options used when creating a new table.
const string CHUNK_SIZE
Indicates the number of records per chunk to be used for this table.
IDictionary< string, string > options
Optional parameters.
const string PARTITION_DEFINITIONS
Comma-separated list of partition definitions, whose format depends on the choice of partition_type...
const string PERMISSIVE
Records with missing columns are populated with nulls if possible; otherwise, the malformed records a...
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
const string ERROR_HANDLING
Specifies how errors should be handled upon insertion.
const string LOADING_MODE
Specifies how to divide data loading among nodes.
string table_name
Name of the table into which the data will be inserted.
A set of parameters for Kinetica.insertRecordsFromFiles(string,IList{string},IDictionary{string, string},IDictionary{string, string}).
const string IS_AUTOMATIC_PARTITION
If true, a new partition will be created for values which don&#39;t fall into an existing partition...
const string STRATEGY_DEFINITION
The tier strategy for the table and its columns.
const string ABORT
Stops current insertion and aborts entire operation when an error is encountered. ...
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 DEFAULT_COLUMN_FORMATS
Specifies the default format to be applied to source data loaded into columns with the corresponding ...
InsertRecordsFromFilesRequest(string table_name, IList< string > filepaths, IDictionary< string, string > create_table_options=null, IDictionary< string, string > options=null)
Constructs an InsertRecordsFromFilesRequest object with the specified parameters. ...
const string DISTRIBUTED_LOCAL
Each worker node loads all files that are available to it.
const string TEXT_HAS_HEADER
For delimited_text file_type only.