> ## Documentation Index > Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt > Use this file to discover all available pages before exploring further. # kinetica.RawInsertRecordsRequest.Options > kinetica.RawInsertRecordsRequest.Options — Kinetica C# API

A set of string constants for the parameter RawInsertRecordsRequest.options. More...

Static Public Attributes

const string  UPDATE\_ON\_EXISTING\_PK = "update\_on\_existing\_pk"
  Specifies the record collision policy for inserting into a table with a primary key.
 
const string  TRUE = "true"
  A boolean constant for the RawInsertRecordsRequest.Options options.
 
const string  FALSE = "false"
  A boolean constant for the RawInsertRecordsRequest.Options options.
 
const string  ENABLE\_INPLACE\_UPDATES = "enable\_inplace\_updates"
  Applies only when upserting (when UPDATE\_ON\_EXISTING\_PK is TRUE).
 
const string  IGNORE\_EXISTING\_PK = "ignore\_existing\_pk"
  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).
 
const string  PK\_CONFLICT\_PREDICATE\_HIGHER = "pk\_conflict\_predicate\_higher"
  The record with higher value for the column resolves the primary-key insert conflict.
 
const string  PK\_CONFLICT\_PREDICATE\_LOWER = "pk\_conflict\_predicate\_lower"
  The record with lower value for the column resolves the primary-key insert conflict.
 
const string  RETURN\_RECORD\_IDS = "return\_record\_ids"
  If TRUE then return the internal record id along for each inserted record.
 
const string  TRUNCATE\_STRINGS = "truncate\_strings"
  If set to TRUE, any strings which are too long for their target charN string columns will be truncated to fit.
 
const string  RETURN\_INDIVIDUAL\_ERRORS = "return\_individual\_errors"
  If set to TRUE, success will always be returned, and any errors found will be included in the info map.
 
const string  ALLOW\_PARTIAL\_BATCH = "allow\_partial\_batch"
  If set to TRUE, all correct records will be inserted and incorrect records will be rejected and reported.
 
const string  ERROR\_HANDLING = "error\_handling"
  Specifies how errors should be handled upon insertion.
 
const string  PERMISSIVE = "permissive"
  Records with bad column values are kept when possible: the offending column is filled with its default value if one exists, otherwise with null if the column is nullable; if neither is possible the record is skipped and reported.
 
const string  SKIP = "skip"
  Records with bad values are skipped and reported; the rest of the batch is inserted.
 
const string  ABORT = "abort"
  Stops the insertion and rejects the remaining batch when any record is incorrect.
 
const string  DRY\_RUN = "dry\_run"
  If set to TRUE, no data will be saved and any errors will be returned.
 
const string  REQUEST\_SCHEMA\_STR = "request\_schema\_str"
  Type schema of RawInsertRecordsRequest.list (when RawInsertRecordsRequest.list\_encoding is BINARY), in \[\["{"{"}column\_name{"}"}","{"{"}column\_type{"}"}"]] format.
 
const string  TRANSFORMATIONS = "transformations"
  Comma-separated expressions, one per target table column.
 

Detailed Description

A set of string constants for the parameter RawInsertRecordsRequest.options.

Optional parameters.

Definition at line 66 of file InsertRecords.cs.

Member Data Documentation

◆ ABORT

const string kinetica.RawInsertRecordsRequest.Options.ABORT = "abort"
static

Stops the insertion and rejects the remaining batch when any record is incorrect.

Definition at line 347 of file InsertRecords.cs.

◆ ALLOW\_PARTIAL\_BATCH

const string kinetica.RawInsertRecordsRequest.Options.ALLOW\_PARTIAL\_BATCH = "allow\_partial\_batch"
static

If set to TRUE, all correct records will be inserted and incorrect records will be rejected and reported.

Otherwise, the entire batch will be rejected if any records are incorrect. Supported values:

The default value is FALSE.

Definition at line 295 of file InsertRecords.cs.

◆ DRY\_RUN

const string kinetica.RawInsertRecordsRequest.Options.DRY\_RUN = "dry\_run"
static

If set to TRUE, no data will be saved and any errors will be returned.

Supported values:

The default value is FALSE.

Definition at line 368 of file InsertRecords.cs.

◆ ENABLE\_INPLACE\_UPDATES

const string kinetica.RawInsertRecordsRequest.Options.ENABLE\_INPLACE\_UPDATES = "enable\_inplace\_updates"
static

Applies only when upserting (when UPDATE\_ON\_EXISTING\_PK is TRUE).

If set to TRUE, an existing record matched by primary key is modified in place. If set to FALSE, it is updated by deleting the existing record and inserting a replacement (delete and insert), which prevents the change from being reflected in dependent materialized views until they are refreshed. Supported values:

The default value is TRUE.

Definition at line 144 of file InsertRecords.cs.

◆ ERROR\_HANDLING

const string kinetica.RawInsertRecordsRequest.Options.ERROR\_HANDLING = "error\_handling"
static

Specifies how errors should be handled upon insertion.

When set, this option is authoritative; supplying a contradictory ALLOW\_PARTIAL\_BATCH is an error. Supported values:

  • PERMISSIVE: Records with bad column values are kept when possible: the offending column is filled with its default value if one exists, otherwise with null if the column is nullable; if neither is possible the record is skipped and reported.
  • SKIP: Records with bad values are skipped and reported; the rest of the batch is inserted.
  • ABORT: Stops the insertion and rejects the remaining batch when any record is incorrect.

The default value is ABORT.

Definition at line 333 of file InsertRecords.cs.

◆ FALSE

const string kinetica.RawInsertRecordsRequest.Options.FALSE = "false"
static

A boolean constant for the RawInsertRecordsRequest.Options options.

Definition at line 115 of file InsertRecords.cs.

◆ IGNORE\_EXISTING\_PK

const string kinetica.RawInsertRecordsRequest.Options.IGNORE\_EXISTING\_PK = "ignore\_existing\_pk"
static

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 ALLOW\_PARTIAL\_BATCH and RETURN\_INDIVIDUAL\_ERRORS. 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. Supported values:

  • 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.

The default value is FALSE.

Definition at line 192 of file InsertRecords.cs.

◆ PERMISSIVE

const string kinetica.RawInsertRecordsRequest.Options.PERMISSIVE = "permissive"
static

Records with bad column values are kept when possible: the offending column is filled with its default value if one exists, otherwise with null if the column is nullable; if neither is possible the record is skipped and reported.

Definition at line 339 of file InsertRecords.cs.

◆ PK\_CONFLICT\_PREDICATE\_HIGHER

const string kinetica.RawInsertRecordsRequest.Options.PK\_CONFLICT\_PREDICATE\_HIGHER = "pk\_conflict\_predicate\_higher"
static

The record with higher value for the column resolves the primary-key insert conflict.

The default value is ''.

Definition at line 197 of file InsertRecords.cs.

◆ PK\_CONFLICT\_PREDICATE\_LOWER

const string kinetica.RawInsertRecordsRequest.Options.PK\_CONFLICT\_PREDICATE\_LOWER = "pk\_conflict\_predicate\_lower"
static

The record with lower value for the column resolves the primary-key insert conflict.

The default value is ''.

Definition at line 202 of file InsertRecords.cs.

◆ REQUEST\_SCHEMA\_STR

const string kinetica.RawInsertRecordsRequest.Options.REQUEST\_SCHEMA\_STR = "request\_schema\_str"
static

Type schema of RawInsertRecordsRequest.list (when RawInsertRecordsRequest.list\_encoding is BINARY), in \[\["{"{"}column\_name{"}"}","{"{"}column\_type{"}"}"]] format.

When non-empty and different from the table's schema, the server remaps the incoming records to the table's full schema. Columns present in the table but absent from this schema are filled using their default values, NULL (if nullable), or an error is returned. If empty, records must match the table's full schema. The default value is ''.

Definition at line 381 of file InsertRecords.cs.

◆ RETURN\_INDIVIDUAL\_ERRORS

const string kinetica.RawInsertRecordsRequest.Options.RETURN\_INDIVIDUAL\_ERRORS = "return\_individual\_errors"
static

If set to TRUE, success will always be returned, and any errors found will be included in the info map.

The "bad\_record\_indices" entry is a comma-separated list of bad records (0-based). If so, there will also be an "error\_N" entry for each record with an error, where N is the index (0-based). Supported values:

The default value is FALSE.

Definition at line 271 of file InsertRecords.cs.

◆ RETURN\_RECORD\_IDS

const string kinetica.RawInsertRecordsRequest.Options.RETURN\_RECORD\_IDS = "return\_record\_ids"
static

If TRUE then return the internal record id along for each inserted record.

Supported values:

The default value is FALSE.

Definition at line 223 of file InsertRecords.cs.

◆ SKIP

const string kinetica.RawInsertRecordsRequest.Options.SKIP = "skip"
static

Records with bad values are skipped and reported; the rest of the batch is inserted.

Definition at line 343 of file InsertRecords.cs.

◆ TRANSFORMATIONS

const string kinetica.RawInsertRecordsRequest.Options.TRANSFORMATIONS = "transformations"
static

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 ($1 for the first input column, $2 for the second, etc.). The default value is ''.

Definition at line 391 of file InsertRecords.cs.

◆ TRUE

const string kinetica.RawInsertRecordsRequest.Options.TRUE = "true"
static

A boolean constant for the RawInsertRecordsRequest.Options options.

Definition at line 111 of file InsertRecords.cs.

◆ TRUNCATE\_STRINGS

const string kinetica.RawInsertRecordsRequest.Options.TRUNCATE\_STRINGS = "truncate\_strings"
static

If set to TRUE, any strings which are too long for their target charN string columns will be truncated to fit.

Supported values:

The default value is FALSE.

Definition at line 245 of file InsertRecords.cs.

◆ UPDATE\_ON\_EXISTING\_PK

const string kinetica.RawInsertRecordsRequest.Options.UPDATE\_ON\_EXISTING\_PK = "update\_on\_existing\_pk"
static

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, ALLOW\_PARTIAL\_BATCH, and RETURN\_INDIVIDUAL\_ERRORS. If the specified table does not have a primary key, then this option has no effect. Supported values:

  • TRUE: Upsert new records when primary keys match existing records.
  • FALSE: Reject new records when primary keys match existing records.

The default value is FALSE.

Definition at line 107 of file InsertRecords.cs.

The documentation for this struct was generated from the following file:
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.