URL: http://<db.host>:<db.port>/insert/records/frompayload
Input Parameter Description
string
Name of the table into which the data will be inserted, in [schema_name.]table_name format, using standard name resolution rules. If the table does not exist, the table will be created using either an existing type_id or the type inferred from the payload, and the new table name will have to meet standard table naming criteria.
string
Records formatted as delimited text.
bytes
Records formatted as binary data.
map of string to maps of string to strings
Not implemented yet.The default value is an empty map ( {} ).
map of string to strings
Options used when creating the target table. Includes type to use. The other options match those in /create/table.The default value is an empty map ( {} ).
Show create_table_options
Show create_table_options
If true, prevents an error from occurring if the table already exists and is of the given type. If a table with the same ID but a different type exists, it is still an error.The default value is
false.The supported values are:- true
- false
Affects the distribution scheme for the table’s data. If true and the given type has no explicit shard key defined, the table will be replicated. If false, the table will be sharded according to the shard key specified in the given type_id, or randomly sharded, if no shard key is specified. Note that a type containing a shard key cannot be used to create a replicated table.The default value is
false.The supported values are:- true
- false
Semicolon-separated list of foreign keys, of the format ‘(source_column_name [, …]) references target_table_name(primary_key_column_name [, …]) [as foreign_key_name]’.
Foreign shard key of the format ‘source_column references shard_by_column from target_table(primary_key_column)’.
Partitioning scheme to use.
- RANGE: Use range partitioning.
- INTERVAL: Use interval partitioning.
- LIST: Use list partitioning.
- HASH: Use hash partitioning.
- SERIES: Use series partitioning.
Comma-separated list of partition keys, which are the columns or column expressions by which records will be assigned to partitions defined by partition_definitions.
Comma-separated list of partition definitions, whose format depends on the choice of partition_type. See range partitioning, interval partitioning, list partitioning, hash partitioning, or series partitioning for example formats.
If true, a new partition will be created for values which don’t fall into an existing partition. Currently only supported for list partitions.The default value is
false.The supported values are:- true
- false
Indicates the number of records per chunk to be used for this table.
Indicates the target maximum data size for each column in a chunk to be used for this table.
Indicates the target maximum data size for all columns in a chunk to be used for this table.
Indicates whether the table is a memory-only table. A result table cannot contain columns with text_search data-handling, and it will not be retained if the server is restarted.The default value is
false.The supported values are:- true
- false
The tier strategy for the table and its columns.
The default compression codec for this table’s columns.
map of string to strings
Optional parameters.The default value is an empty map ( {} ).
Show options
Show options
Name of a table to which records that were rejected are written. The bad-record-table has the following columns: line_number (long), line_rejected (string), error_message (string).
A positive integer indicating the maximum number of records that can be written to the bad-record-table. Default value is 10000.
For subscriptions: A positive integer indicating the maximum number of records that can be written to the bad-record-table per file/payload. Default value will be ‘bad_record_table_limit’ and total size of the table per rank is limited to ‘bad_record_table_limit’.
Internal tuning parameter—number of records per batch when inserting data.
For each target column specified, applies the column-property-bound format to the source data loaded into that column. Each column format will contain a mapping of one or more of its column properties to an appropriate format for each property. Currently supported column properties include date, time, and datetime. The parameter value must be formatted as a JSON string of maps of column names to maps of column properties to their corresponding column formats, e.g., ’{ “order_date” : { “date” : “%Y.%m.%d” }, “order_time” : { “time” : “%H:%M:%S” } }’.See default_column_formats for valid format syntax.
Specifies a comma-delimited list of columns from the source data to load. If more than one file is being loaded, this list applies to all files.Column numbers can be specified discretely or as a range. For example, a value of ‘5,7,1..3’ will insert values from the fifth column in the source data into the first column in the target table, from the seventh column in the source data into the second column in the target table, and from the first through third columns in the source data into the third through fifth columns in the target table.If the source data contains a header, column names matching the file header names may be provided instead of column numbers. If the target table doesn’t exist, the table will be created with the columns in this order. If the target table does exist with columns in a different order than the source data, this list can be used to match the order of the target table. For example, a value of ‘C, B, A’ will create a three column table with column C, followed by column B, followed by column A; or will insert those fields in that order into a table created with columns in that order. If the target table exists, the column names must match the source data field names for a name-mapping to be successful.Mutually exclusive with columns_to_skip.
Specifies a comma-delimited list of columns from the source data to skip. Mutually exclusive with columns_to_load.
Payload compression type.The default value is
auto.- none: Uncompressed.
- auto: Default. Auto detect compression type.
- gzip: gzip file compression.
- bzip2: bzip2 file compression.
Specifies the default format to be applied to source data loaded into columns with the corresponding column property. Currently supported column properties include date, time, and datetime. This default column-property-bound format can be overridden by specifying a column property and format for a given target column in column_formats. For each specified annotation, the format will apply to all columns with that annotation unless a custom column_formats for that annotation is specified.The parameter value must be formatted as a JSON string that is a map of column properties to their respective column formats, e.g., ’{ “date” : “%Y.%m.%d”, “time” : “%H:%M:%S” }’. Column formats are specified as a string of control characters and plain text. The supported control characters are ‘Y’, ‘m’, ‘d’, ‘H’, ‘M’, ‘S’, and ‘s’, which follow the Linux ‘strptime()’ specification, as well as ‘s’, which specifies seconds and fractional seconds (though the fractional component will be truncated past milliseconds).Formats for the ‘date’ annotation must include the ‘Y’, ‘m’, and ‘d’ control characters. Formats for the ‘time’ annotation must include the ‘H’, ‘M’, and either ‘S’ or ‘s’ (but not both) control characters. Formats for the ‘datetime’ annotation meet both the ‘date’ and ‘time’ control character requirements. For example, ’{“datetime” : “%m/%d/%Y %H:%M:%S” }’ would be used to interpret text as “05/04/2000 12:12:11”
Specifies how errors should be handled upon insertion.The default value is
abort.- permissive: Records with missing columns are populated with nulls if possible; otherwise, the malformed records are skipped.
- skip: Malformed records are skipped.
- ignore_bad_records: Deprecated. Alias for skip.
- abort: Stops current insertion and aborts entire operation when an error is encountered. Primary key collisions are considered abortable errors in this mode.
Specifies the type of the file(s) whose records will be inserted.The default value is
delimited_text.- avro: Avro file format.
- delimited_text: Delimited text file format; e.g., CSV, TSV, PSV, etc.
- gdb: Esri/GDB file format.
- json: JSON file format.
- parquet: Apache Parquet file format.
- shapefile: ShapeFile file format.
Specifies how to handle nested columns.The default value is
false.- true: Break up nested columns to multiple columns.
- false: Treat nested columns as JSON columns instead of flattening.
Comma separated list of gdal conf options, for the specific requests: key=value.The default value is ”.
The record with higher value for the column resolves the primary-key insert conflict.The default value is ”.
The record with lower value for the column resolves the primary-key insert conflict.The default value is ”.
Specifies the record collision error-suppression policy for inserting into a table with a primary key, only used when not in upsert mode (upsert mode is disabled when update_on_existing_pk is false). If set to true, any record being inserted that is rejected for having primary key values that match those of an existing table record will be ignored with no error generated. If false, the rejection of any record for having primary key values matching an existing record will result in an error being reported, as determined by error_handling. If the specified table does not have a primary key or if upsert mode is in effect (update_on_existing_pk is true), then this option has no effect.The default value is
false.- true: Ignore new records whose primary key values collide with those of existing records.
- false: Treat as errors any new records whose primary key values collide with those of existing records.
Whether to do a full load, dry run, or perform a type inference on the source data.The default value is
full.- full: Run a type inference on the source data (if needed) and ingest.
- dry_run: Does not load data, but walks through the source data and determines the number of valid records, taking into account the current mode of error_handling.
- type_inference_only: Infer the type of the source data and return, without ingesting any data. The inferred type is returned in the response.
Geo files layer(s) name(s): comma separated.The default value is ”.
Scheme for distributing the extraction and loading of data from the source data file(s). This option applies only when loading files that are local to the database.The default value is
head.- head: The head node loads all data. All files must be available to the head node.
- distributed_shared: The head node coordinates loading data by worker processes across all nodes from shared files available to all workers. NOTE: Instead of existing on a shared source, the files can be duplicated on a source local to each host to improve performance, though the files must appear as the same data set from the perspective of all hosts performing the load.
- distributed_local: A single worker process on each node loads all files that are available to it. This option works best when each worker loads files from its own file system, to maximize performance. In order to avoid data duplication, either each worker performing the load needs to have visibility to a set of files unique to it (no file is visible to more than one node) or the target table needs to have a primary key (which will allow the worker to automatically deduplicate data). NOTE: If the target table doesn’t exist, the table structure will be determined by the head node. If the head node has no files local to it, it will be unable to determine the structure and the request will fail. If the head node is configured to have no worker processes, no data strictly accessible to the head node will be loaded.
For Avro local timestamp columns.
Limit the number of records to load in this request: If this number is larger than a batch_size, then the number of records loaded will be limited to the next whole number of batch_size (per working thread).The default value is ”.
Specifies a comma-delimited list of column names to be used as the source-data column names. If the payload has a header row (i.e., text_has_header is true), these names override the payload’s header names. If the payload has no header row, these names are used as the source-data column names. Either way, the i-th name in this list applies to the i-th column in the payload, enabling name-based matching against the target table’s columns (and use with columns_to_load / columns_to_skip).
Number of tasks for reading file per rank. Default will be external_file_reader_num_tasks.
If true, the number of seconds between attempts to load external files into the table. If zero, polling will be continuous as long as data is found. If no data is found, the interval will steadily increase to a maximum of 60 seconds.
Comma separated list of column names, to set as primary keys, when not specified in the type.The default value is ”.
Confluent Schema registry connection timeout (in secs).
Confluent Schema registry connection timeout (in secs).
Max records to skip due to SR connection failures, before failing.
Max records to skip due to schema related errors, before failing.
Name of the Avro schema in the schema registry to use when reading Avro records.
Comma separated list of column names, to set as shard keys, when not specified in the type.The default value is ”.
Skip a number of lines from the beginning of the file.
Continuously poll the data source to check for new data and load it into the table.The default value is
false.The supported values are:- true
- false
When inserting records from multiple files: if table_per_file, then insert from each file into a new table. Currently supported only for shapefiles.The default value is
single.The supported values are:- single
- table_per_file
Specifies the character string that should be interpreted as a comment line prefix in the source data. All lines in the data starting with the provided string are ignored.For delimited_text file_type only.The default value is
#.Specifies the character delimiting field values in the source data and field names in the header (if present).For delimited_text file_type only.The default value is
,.Specifies the character that is used to escape other characters in the source data.An ‘a’, ‘b’, ‘f’, ‘n’, ‘r’, ‘t’, or ‘v’ preceded by an escape character will be interpreted as the ASCII bell, backspace, form feed, line feed, carriage return, horizontal tab, and vertical tab, respectively. For example, the escape character followed by an ‘n’ will be interpreted as a newline within a field value.The escape character can also be used to escape the quoting character, and will be treated as an escape character whether it is within a quoted field value or not.For delimited_text file_type only.
Indicates whether the source data contains a header row.For delimited_text file_type only.The default value is
true.The supported values are:- true
- false
Specifies the delimiter for column properties in the header row (if present). Cannot be set to same value as text_delimiter.For delimited_text file_type only.The default value is
|.Specifies the character string that should be interpreted as a null value in the source data.For delimited_text file_type only.The default value is
\N.Specifies the character that should be interpreted as a field value quoting character in the source data. The character must appear at beginning and end of field value to take effect. Delimiters within quoted fields are treated as literals and not delimiters. Within a quoted field, two consecutive quote characters will be interpreted as a single literal quote character, effectively escaping it. To not have a quote character, specify an empty string.For delimited_text file_type only.The default value is
".Add ‘text_search’ property to internally inferenced string columns. Comma separated list of column names or ’*’ for all columns. To add text_search property only to string columns of minimum size, set also the option ‘text_search_min_column_length’.
Set minimum column size. Used only when ‘text_search_columns’ has a value.
If set to true, remove leading or trailing space from fields.The default value is
false.The supported values are:- true
- false
If set to true, truncate string values that are longer than the column’s type size.The default value is
false.The supported values are:- true
- false
If set to true, truncates the table specified by input parameter table_name prior to loading the file(s).The default value is
false.The supported values are:- true
- false
The default value is ”.
Optimize type inference mode.The default value is
accuracy.- accuracy: Scans data to get exactly-typed and sized columns for all data scanned.
- speed: Scans data and picks the widest possible column types so that ‘all’ values will fit with minimum data scanned.
Applies only when upserting (when update_on_existing_pk is true). If set to true (the default), an existing record matched by primary key is modified in place. If set to false, the matched record is updated by deleting it and inserting a replacement (delete and insert), which prevents the change from being reflected in dependent materialized views until they are refreshed.The default value is
true.The supported values are:- true
- false
Specifies the record collision policy for inserting into a table with a primary key. If set to true, any existing table record with primary key values that match those of a record being inserted will be replaced by that new record (the new data will be “upserted”). If set to false, any existing table record with primary key values that match those of a record being inserted will remain unchanged, while the new record will be rejected and the error handled as determined by ignore_existing_pk and error_handling. If the specified table does not have a primary key, then this option has no effect.The default value is
false.- true: Upsert new records when primary keys match existing records.
- false: Reject new records when primary keys match existing records.
Comma-separated expressions, one per target table column. Each expression is evaluated per record. Empty entries (two consecutive commas) mean no transformation for that column — the value is resolved from the input record, table default, NULL, or an error. Expressions may reference input columns by name or by position (1forthefirstinputcolumn,2 for the second, etc.).The default value is ”.
Output Parameter Description
The Kinetica server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:String
‘OK’ or ‘ERROR’
String
Empty if success or an error message
String
‘insert_records_from_payload_response’ or ‘none’ in case of an error
String
Empty string
JSON or String
This embedded JSON represents the result of the /insert/records/frompayload endpoint:
Empty string in case of an error.
Show data_str
Show data_str
string
Value of input parameter table_name.
string
A JSON string describing the columns of the target table.
string
The user-defined description associated with the target table’s structure.
map of string to arrays of strings
A mapping of each target table column name to an array of column properties associated with that column.
long
Number of records inserted into the target table.
long
Number of records skipped, when not running in abort error handling mode.
long
[Not yet implemented] Number of records updated within the target table.
map of string to strings
Additional information.