com.gpudb.protocol

Class InsertRecordsRequest.Options

java.lang.Object

com.gpudb.protocol.InsertRecordsRequest.Options

Enclosing class:

InsertRecordsRequest<T>

public static final class InsertRecordsRequest.Options
extends Object

Optional parameters.

• UPDATE_ON_EXISTING_PK: 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, & 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.
• 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). 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 & 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.
• RETURN_RECORD_IDS: If true then return the internal record id along for each inserted record. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• TRUNCATE_STRINGS: If set to true, any strings which are too long for their target charN string columns will be truncated to fit. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• RETURN_INDIVIDUAL_ERRORS: 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). And 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:
  • TRUE
  • FALSE
  The default value is FALSE.
• ALLOW_PARTIAL_BATCH: 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:
  • TRUE
  • FALSE
  The default value is FALSE.
• DRY_RUN: If set to true, no data will be saved and any errors will be returned. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.

The default value is an empty Map. A set of string constants for the parameter options.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALLOW_PARTIAL_BATCH If set to true, all correct records will be inserted and incorrect records will be rejected and reported.
static String	DRY_RUN If set to true, no data will be saved and any errors will be returned.
static String	FALSE
static String	IGNORE_EXISTING_PK Specifies the record collision error-suppression policy for inserting into a table with a	static String	RETURN_INDIVIDUAL_ERRORS If set to true, success will always be returned, and any errors found will be included in the info map.
static String	RETURN_RECORD_IDS If true then return the internal record id along for each inserted record.
static String	TRUE
static String	TRUNCATE_STRINGS If set to true, any strings which are too long for their target charN string columns will be truncated to fit.
static String	UPDATE_ON_EXISTING_PK Specifies the record collision policy for inserting into a table with a Method Summary Methods inherited from class java.lang.Object clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait Field Detail UPDATE_ON_EXISTING_PK public static final String UPDATE_ON_EXISTING_PK 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, & 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. See Also: Constant Field Values TRUE public static final String TRUE See Also: Constant Field Values FALSE public static final String FALSE See Also: Constant Field Values IGNORE_EXISTING_PK public static final String 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). 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 & 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. See Also: Constant Field Values RETURN_RECORD_IDS public static final String RETURN_RECORD_IDS If true then return the internal record id along for each inserted record. Supported values: TRUE FALSE The default value is FALSE. See Also: Constant Field Values TRUNCATE_STRINGS public static final String TRUNCATE_STRINGS If set to true, any strings which are too long for their target charN string columns will be truncated to fit. Supported values: TRUE FALSE The default value is FALSE. See Also: Constant Field Values RETURN_INDIVIDUAL_ERRORS public static final String RETURN_INDIVIDUAL_ERRORS 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). And 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: TRUE FALSE The default value is FALSE. See Also: Constant Field Values ALLOW_PARTIAL_BATCH public static final String ALLOW_PARTIAL_BATCH 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: TRUE FALSE The default value is FALSE. See Also: Constant Field Values DRY_RUN public static final String DRY_RUN If set to true, no data will be saved and any errors will be returned. Supported values: TRUE FALSE The default value is FALSE. See Also: Constant Field Values Skip navigation links Overview Package Class Use Tree Deprecated Index Help Prev Class Next Class Frames No Frames All Classes Summary: Nested | Field | Constr | Method Detail: Field | Constr | Method Copyright © 2024. All rights reserved.