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

Optional parameters.

• OFFSET: A positive integer indicating the number of initial results to skip from source table (specified by sourceTableName). Default is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. The default value is '0'.
• LIMIT: A positive integer indicating the maximum number of results to be returned from source table (specified by sourceTableName). Or END_OF_SET (-9999) to indicate that the max number of results should be returned. The default value is '-9999'.
• EXPRESSION: Optional filter expression to apply to the source table (specified by sourceTableName). Empty by default. The default value is ''.
• ORDER_BY: Comma-separated list of the columns and expressions to be sorted by from the 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 ''.
• UPDATE_ON_EXISTING_PK: Specifies the record collision policy for inserting the source table records (specified by sourceTableName) into the target table (specified by tableName) table with a primary key. If set to true, any existing target table record with primary key values that match those of a source table record being inserted will be replaced by that new record. If set to false, any existing target table record with primary key values that match those of a source table record being inserted will remain unchanged and the new record discarded. If the specified table does not have a primary key, then this option is ignored. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• TRUNCATE_STRINGS: If set to true, it allows inserting unrestricted length strings into charN string columns by truncating the unrestricted length strings to fit. 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	EXPRESSION Optional filter expression to apply to the source table (specified by sourceTableName).
static String	FALSE
static String	LIMIT A positive integer indicating the maximum number of results to be returned from source table (specified by sourceTableName).
static String	OFFSET A positive integer indicating the number of initial results to skip from source table (specified by sourceTableName).
static String	ORDER_BY Comma-separated list of the columns and expressions to be sorted by from the source table (specified by sourceTableName); e.g.
static String	TRUE
static String	TRUNCATE_STRINGS If set to true, it allows inserting unrestricted length strings into charN string columns by truncating the unrestricted length strings to fit.
static String	UPDATE_ON_EXISTING_PK Specifies the record collision policy for inserting the source table records (specified by sourceTableName) into the target table (specified by tableName) table 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 source table (specified by 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 source table (specified by 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 source table (specified by sourceTableName). Empty by default. The default value is ''.

See Also:

Constant Field Values

ORDER_BY

public static final String ORDER_BY

Comma-separated list of the columns and expressions to be sorted by from the 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 the source table records (specified by sourceTableName) into the target table (specified by tableName) table with a primary key. If set to true, any existing target table record with primary key values that match those of a source table record being inserted will be replaced by that new record. If set to false, any existing target table record with primary key values that match those of a source table record being inserted will remain unchanged and the new record discarded. If the specified table does not have a primary key, then this option is ignored. Supported values:

• TRUE
• FALSE

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

TRUNCATE_STRINGS

public static final String TRUNCATE_STRINGS

If set to true, it allows inserting unrestricted length strings into charN string columns by truncating the unrestricted length strings to fit. Supported values:

• TRUE
• FALSE

The default value is FALSE.

See Also:

Constant Field Values