7 using System.Collections.Generic;
18 public class InsertRecordsFromPayloadRequest : KineticaData
26 public struct CreateTableOptions
32 public const string TYPE_ID =
"type_id";
52 public const string TRUE =
"true";
53 public const string FALSE =
"false";
133 public const string RANGE =
"RANGE";
138 public const string INTERVAL =
"INTERVAL";
143 public const string LIST =
"LIST";
148 public const string HASH =
"HASH";
153 public const string SERIES =
"SERIES";
201 public const string TTL =
"ttl";
205 public const string CHUNK_SIZE =
"chunk_size";
248 public struct Options
272 public const string BATCH_SIZE =
"batch_size";
351 public const string NONE =
"none";
355 public const string AUTO =
"auto";
358 public const string GZIP =
"gzip";
361 public const string BZIP2 =
"bzip2";
427 public const string PERMISSIVE =
"permissive";
436 public const string ABORT =
"abort";
474 public const string FILE_TYPE =
"file_type";
477 public const string AVRO =
"avro";
484 public const string GDB =
"gdb";
487 public const string JSON =
"json";
490 public const string PARQUET =
"parquet";
493 public const string SHAPEFILE =
"shapefile";
515 public const string TRUE =
"true";
519 public const string FALSE =
"false";
584 public const string FULL =
"full";
590 public const string DRY_RUN =
"dry_run";
601 public const string LAYER =
"layer";
656 public const string HEAD =
"head";
740 public const string SHARD_KEYS =
"shard_keys";
744 public const string SKIP_LINES =
"skip_lines";
759 public const string SUBSCRIBE =
"subscribe";
777 public const string SINGLE =
"single";
935 public const string ACCURACY =
"accuracy";
940 public const string SPEED =
"speed";
985 public IDictionary<string, IDictionary<string, string>>
modify_columns {
get;
set; } =
new Dictionary<string, IDictionary<string, string>>();
1251 public IDictionary<string, string>
create_table_options {
get;
set; } =
new Dictionary<string, string>();
1998 public IDictionary<string, string>
options {
get;
set; } =
new Dictionary<string, string>();
3035 IDictionary<
string, IDictionary<string, string>>
modify_columns =
null,
3037 IDictionary<string, string>
options =
null)
3041 this.data_bytes =
data_bytes ??
new byte[] { };
3051 public class InsertRecordsFromPayloadResponse : KineticaData
3061 public string type_id {
get;
set; }
3073 public IDictionary<string, IList<string>>
type_properties {
get;
set; } =
new Dictionary<string, IList<string>>();
3089 public IDictionary<string, string>
info {
get;
set; } =
new Dictionary<string, string>();
const string AUTO
Default.
const string INTERVAL
Use interval partitioning.
long count_inserted
Number of records inserted into the target table.
const string CHUNK_SIZE
Indicates the number of records per chunk to be used for this table.
byte [] data_bytes
Records formatted as binary data
const string JSON
Json file format
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 IS_AUTOMATIC_PARTITION
If TRUE, a new partition will be created for values which don't fall into an existing partition.
const string BZIP2
bzip2 file compression.
const string GDB
Esri/GDB file format
IDictionary< string, string > options
Optional parameters.
const string UPDATE_ON_EXISTING_PK
Specifies the record collision policy for inserting into a table with a primary key.
const string TEXT_QUOTE_CHARACTER
Specifies the character that should be interpreted as a field value quoting character in the source d...
long count_skipped
Number of records skipped, when not running in ABORT error handling mode.
const string PARTITION_DEFINITIONS
Comma-separated list of partition definitions, whose format depends on the choice of PARTITION_TYPE.
const string TYPE_INFERENCE_MODE
optimize type inference for:
const string NONE
Uncompressed
const string BAD_RECORD_TABLE_NAME
Optional name of a table to which records that were rejected are written.
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 LOADING_MODE
Scheme for distributing the extraction and loading of data from the source data file(s).
const string SUBSCRIBE
Continuously poll the data source to check for new data and load it into the table.
const string TYPE_INFERENCE_MAX_RECORDS_READ
The default value is ''.
const string SERIES
Use series partitioning.
const string DISTRIBUTED_SHARED
The head node coordinates loading data by worker processes across all nodes from shared files availab...
const string PARTITION_KEYS
Comma-separated list of partition keys, which are the columns or column expressions by which records ...
const string SCHEMA_REGISTRY_CONNECTION_RETRIES
Confluent Schema registry connection timeout (in Secs)
const string COLUMN_FORMATS
For each target column specified, applies the column-property-bound format to the source data loaded ...
const string TRUNCATE_STRINGS
If set to TRUE, truncate string values that are longer than the column's type size.
const string PERMISSIVE
Records with missing columns are populated with nulls if possible; otherwise, the malformed records a...
string data_text
Records formatted as delimited text
const string TABLE_INSERT_MODE
Optional: table_insert_mode.
const string DEFAULT_COLUMN_FORMATS
Specifies the default format to be applied to source data loaded into columns with the corresponding ...
const string TEXT_COMMENT_STRING
Specifies the character string that should be interpreted as a comment line prefix in the source data...
const string GDAL_CONFIGURATION_OPTIONS
Comma separated list of gdal conf options, for the specific requests: key=value.
const string TABLE_PER_FILE
const string IS_REPLICATED
Affects the distribution scheme for the table's data.
const string SPEED
Scans data and picks the widest possible column types so that 'all' values will fit with minimum data...
const string TTL
Sets the TTL of the table specified in table_name.
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 FOREIGN_KEYS
Semicolon-separated list of foreign keys, of the format '(source_column_name [, .....
const string TEXT_NULL_STRING
Specifies the character string that should be interpreted as a null value in the source data.
const string FLATTEN_COLUMNS
Specifies how to handle nested columns.
const string AVRO
Avro file format
const string LIST
Use list partitioning.
IDictionary< string, string > info
Additional information.
const string GZIP
gzip file compression.
const string STRATEGY_DEFINITION
The tier strategy for the table and its columns.
const string SHARD_KEYS
Optional: comma separated list of column names, to set as primary keys, when not specified in the typ...
const string TRUE
Upsert new records when primary keys match existing records
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 TEXT_HEADER_PROPERTY_DELIMITER
Specifies the delimiter for column properties in the header row (if present).
const string RANGE
Use range partitioning.
const string IS_RESULT_TABLE
Indicates whether the table is a memory-only table.
const string PARQUET
Apache Parquet file format
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 ABORT
Stops current insertion and aborts entire operation when an error is encountered.
const string TRUNCATE_TABLE
If set to TRUE, truncates the table specified by table_name prior to loading the file(s).
const string BATCH_SIZE
Internal tuning parameter–number of records per batch when inserting data.
const string IGNORE_BAD_RECORDS
Malformed records are skipped.
string type_label
The user-defined description associated with the target table's structure
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 COMPRESSION_CODEC
The default compression codec for this table's columns.
string type_definition
A JSON string describing the columns of the target table
const string DRY_RUN
Does not load data, but walks through the source data and determines the number of valid records,...
const string TEXT_SEARCH_COLUMNS
Add 'text_search' property to internally inferenced string columns.
const string POLL_INTERVAL
If TRUE, the number of seconds between attempts to load external files into the table.
string table_name
Value of table_name.
IDictionary< string, string > create_table_options
Options used when creating the target table.
const string DISTRIBUTED_LOCAL
A single worker process on each node loads all files that are available to it.
const string PRIMARY_KEYS
Optional: comma separated list of column names, to set as primary keys, when not specified in the typ...
InsertRecordsFromPayloadRequest()
Constructs an InsertRecordsFromPayloadRequest object with default parameters.
const string INGESTION_MODE
Whether to do a full load, dry run, or perform a type inference on the source data.
const string HEAD
The head node loads all data.
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 DELIMITED_TEXT
Delimited text file format; e.g., CSV, TSV, PSV, etc.
const string TEXT_SEARCH_MIN_COLUMN_LENGTH
Set minimum column size.
const string FALSE
Reject new records when primary keys match existing records
const string HASH
Use hash partitioning.
const string COMPRESSION_TYPE
Optional: payload compression type.
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.
const string TYPE_INFERENCE_ONLY
Infer the type of the source data and return, without ingesting any data.
const string FULL
Run a type inference on the source data (if needed) and ingest
const string TEXT_HAS_HEADER
Indicates whether the source data contains a header row.
const string FILE_TYPE
Specifies the type of the file(s) whose records will be inserted.
const string ACCURACY
Scans data to get exactly-typed & sized columns for all data scanned.
const string COLUMNS_TO_SKIP
Specifies a comma-delimited list of columns from the source data to skip.
const string SCHEMA_REGISTRY_CONNECTION_TIMEOUT
Confluent Schema registry connection timeout (in Secs)
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_EXISTING_PK
Specifies the record collision error-suppression policy for inserting into a table with a primary key...
const string ERROR_HANDLING
Specifies how errors should be handled upon insertion.
const string TEXT_ESCAPE_CHARACTER
Specifies the character that is used to escape other characters in the source data.
string table_name
Name of the table into which the data will be inserted, in [schema_name.
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 TYPE_ID
ID of a currently registered type.
const string SCHEMA_REGISTRY_SCHEMA_NAME
Name of the Avro schema in the schema registry to use when reading Avro records.
const string LOCAL_TIME_OFFSET
For Avro local timestamp columns
const string PARTITION_TYPE
Partitioning scheme to use.
const string SHAPEFILE
ShapeFile file format
const string MAX_CONSECUTIVE_INVALID_SCHEMA_FAILURE
Max records to skip due to schema related errors, before failing
const string TEXT_DELIMITER
Specifies the character delimiting field values in the source data and field names in the header (if ...
const string SKIP_LINES
Skip a number of lines from the beginning of the file.
const string SCHEMA_REGISTRY_MAX_CONSECUTIVE_CONNECTION_FAILURES
Max records to skip due to SR connection failures, before failing
string type_id
ID of the currently registered table structure type for the target table
const string NUM_TASKS_PER_RANK
Optional: number of tasks for reading file per rank.
const string COLUMNS_TO_LOAD
Specifies a comma-delimited list of columns from the source data to load.
IDictionary< string, IDictionary< string, string > > modify_columns
Not implemented yet.