Package com.gpudb.protocol

Class AppendRecordsRequest.Options

java.lang.Object

com.gpudb.protocol.AppendRecordsRequest.Options

Enclosing class:

AppendRecordsRequest

public static final class AppendRecordsRequest.Options
extends Object

A set of string constants for the AppendRecordsRequest parameter options.

Optional parameters.

Field Summary

Fields

Modifier and Type	Field	Description
static String	EXPRESSION	Optional filter expression to apply to the sourceTableName.
static String	FALSE
static String	IGNORE_EXISTING_PK	Specifies the record collision error-suppression policy for inserting source table records (specified by sourceTableName) into a target table (specified by tableName) with a primary key, only used when not in upsert mode (upsert mode is disabled when UPDATE_ON_EXISTING_PK is FALSE).
static String	LIMIT	A positive integer indicating the maximum number of results to be returned from sourceTableName.
static String	OFFSET	A positive integer indicating the number of initial results to skip from sourceTableName.
static String	ORDER_BY	Comma-separated list of the columns to be sorted by from source table (specified by sourceTableName), e.g., 'timestamp asc, x desc'.
static String	PK_CONFLICT_PREDICATE_HIGHER	The record with higher value for the column resolves the primary-key insert conflict.
static String	PK_CONFLICT_PREDICATE_LOWER	The record with lower value for the column resolves the primary-key insert conflict.
static String	TRUE
static String	TRUNCATE_STRINGS	If set to TRUE, it allows inserting longer strings into smaller charN string columns by truncating the longer strings to fit.
static String	UPDATE_ON_EXISTING_PK	Specifies the record collision policy for inserting source table records (specified by sourceTableName) into a target table (specified by tableName) with a primary key.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OFFSET

public static final String OFFSET

A positive integer indicating the number of initial results to skip from sourceTableName. Default is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. The default value is '0'.

See Also:

Constant Field Values

LIMIT

public static final String LIMIT

A positive integer indicating the maximum number of results to be returned from sourceTableName. Or END_OF_SET (-9999) to indicate that the max number of results should be returned. The default value is '-9999'.

See Also:

Constant Field Values

EXPRESSION

public static final String EXPRESSION

Optional filter expression to apply to the sourceTableName. The default value is ''.

See Also:

Constant Field Values

ORDER_BY

public static final String ORDER_BY

Comma-separated list of the columns to be sorted by from source table (specified by sourceTableName), e.g., 'timestamp asc, x desc'. The ORDER_BY columns do not have to be present in fieldMap. The default value is ''.

See Also:

Constant Field Values

UPDATE_ON_EXISTING_PK

public static final String UPDATE_ON_EXISTING_PK

Specifies the record collision policy for inserting source table records (specified by sourceTableName) into a target table (specified by tableName) with a primary key. If set to TRUE, any existing table record with primary key values that match those of a source table 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 source table record being inserted will remain unchanged, while the source record will be rejected and an error handled as determined by IGNORE_EXISTING_PK. 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 source table records (specified by sourceTableName) into a target table (specified by tableName) 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 source table record being inserted that is rejected for having primary key values that match those of an existing target table record will be ignored with no error generated. If FALSE, the rejection of any source table record for having primary key values matching an existing target table record will result in an error being raised. 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 source table records whose primary key values collide with those of target table records
• FALSE: Raise an error for any source table record whose primary key values collide with those of a target table record

The default value is FALSE.

See Also:

Constant Field Values

PK_CONFLICT_PREDICATE_HIGHER

public static final String PK_CONFLICT_PREDICATE_HIGHER

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

See Also:

Constant Field Values

PK_CONFLICT_PREDICATE_LOWER

public static final String PK_CONFLICT_PREDICATE_LOWER

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

See Also:

Constant Field Values

TRUNCATE_STRINGS

public static final String TRUNCATE_STRINGS

If set to TRUE, it allows inserting longer strings into smaller charN string columns by truncating the longer strings to fit. Supported values:

• TRUE
• FALSE

The default value is FALSE.

See Also:

Constant Field Values