com.gpudb.protocol

Class RawInsertRecordsRequest

java.lang.Object

com.gpudb.protocol.RawInsertRecordsRequest

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord

public class RawInsertRecordsRequest
extends Object
implements org.apache.avro.generic.IndexedRecord

A set of parameters for GPUdb.insertRecordsRaw(RawInsertRecordsRequest).

Adds multiple records to the specified table. The operation is synchronous, meaning that a response will not be returned until all the records are fully inserted and available. The response payload provides the counts of the number of records actually inserted and/or updated, and can provide the unique identifier of each added record.

The options parameter can be used to customize this function's behavior.

The update_on_existing_pk option specifies the record collision policy for inserting into a table with a primary key, but is ignored if no primary key exists.

The return_record_ids option indicates that the database should return the unique identifiers of inserted records.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RawInsertRecordsRequest.ListEncoding The encoding of the records to be inserted.
static class	RawInsertRecordsRequest.Options Optional parameters.

Constructor Summary

Constructors

Constructor and Description
RawInsertRecordsRequest() Constructs a RawInsertRecordsRequest object with default parameters.
RawInsertRecordsRequest(String tableName, List<ByteBuffer> list, List<String> listStr, String listEncoding, Map<String,String> options) Constructs a RawInsertRecordsRequest object with the specified parameters.
RawInsertRecordsRequest(String tableName, List<ByteBuffer> list, Map<String,String> options) Constructs a RawInsertRecordsRequest object with the specified parameters.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Object	get(int index) This method supports the Avro framework and is not intended to be called directly by the user.
static org.apache.avro.Schema	getClassSchema() This method supports the Avro framework and is not intended to be called directly by the user.
List<ByteBuffer>	getList()
String	getListEncoding()
List<String>	getListStr()
Map<String,String>	getOptions()
org.apache.avro.Schema	getSchema() This method supports the Avro framework and is not intended to be called directly by the user.
String	getTableName()
int	hashCode()
void	put(int index, Object value) This method supports the Avro framework and is not intended to be called directly by the user.
RawInsertRecordsRequest	setList(List<ByteBuffer> list)
RawInsertRecordsRequest	setListEncoding(String listEncoding)
RawInsertRecordsRequest	setListStr(List<String> listStr)
RawInsertRecordsRequest	setOptions(Map<String,String> options)
RawInsertRecordsRequest	setTableName(String tableName)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RawInsertRecordsRequest

public RawInsertRecordsRequest()

Constructs a RawInsertRecordsRequest object with default parameters.

RawInsertRecordsRequest

public RawInsertRecordsRequest(String tableName,
                               List<ByteBuffer> list,
                               Map<String,String> options)

Constructs a RawInsertRecordsRequest object with the specified parameters.

Parameters:

tableName - Table to which the records are to be added. Must be an existing table.

list - An array of binary-encoded data for the records to be added. All records must be of the same type as that of the table. Empty array if listEncoding is json.

options - 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. If set to false, any existing table record with primary key values that match those of a 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.
• 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.

RawInsertRecordsRequest

public RawInsertRecordsRequest(String tableName,
                               List<ByteBuffer> list,
                               List<String> listStr,
                               String listEncoding,
                               Map<String,String> options)

Constructs a RawInsertRecordsRequest object with the specified parameters.

Parameters:

tableName - Table to which the records are to be added. Must be an existing table.

list - An array of binary-encoded data for the records to be added. All records must be of the same type as that of the table. Empty array if listEncoding is json.

listStr - An array of JSON encoded data for the records to be added. All records must be of the same type as that of the table. Empty array if listEncoding is binary.

listEncoding - The encoding of the records to be inserted. Supported values:

• BINARY
• JSON

The default value is BINARY.

options - 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. If set to false, any existing table record with primary key values that match those of a 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.
• 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.

Method Detail

getClassSchema

public static org.apache.avro.Schema getClassSchema()

This method supports the Avro framework and is not intended to be called directly by the user.

Returns:

the schema for the class.

getTableName

public String getTableName()

Returns:

Table to which the records are to be added. Must be an existing table.

setTableName

public RawInsertRecordsRequest setTableName(String tableName)

Parameters:

tableName - Table to which the records are to be added. Must be an existing table.

Returns:

this to mimic the builder pattern.

getList

public List<ByteBuffer> getList()

Returns:

An array of binary-encoded data for the records to be added. All records must be of the same type as that of the table. Empty array if listEncoding is json.

setList

public RawInsertRecordsRequest setList(List<ByteBuffer> list)

Parameters:

list - An array of binary-encoded data for the records to be added. All records must be of the same type as that of the table. Empty array if listEncoding is json.

Returns:

this to mimic the builder pattern.

getListStr

public List<String> getListStr()

Returns:

An array of JSON encoded data for the records to be added. All records must be of the same type as that of the table. Empty array if listEncoding is binary.

setListStr

public RawInsertRecordsRequest setListStr(List<String> listStr)

Parameters:

listStr - An array of JSON encoded data for the records to be added. All records must be of the same type as that of the table. Empty array if listEncoding is binary.

Returns:

this to mimic the builder pattern.

getListEncoding

public String getListEncoding()

Returns:

The encoding of the records to be inserted. Supported values:

• BINARY
• JSON

The default value is BINARY.

setListEncoding

public RawInsertRecordsRequest setListEncoding(String listEncoding)

Parameters:

listEncoding - The encoding of the records to be inserted. Supported values:

• BINARY
• JSON

The default value is BINARY.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Returns:

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. If set to false, any existing table record with primary key values that match those of a 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.
• 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.

setOptions

public RawInsertRecordsRequest setOptions(Map<String,String> options)

Parameters:

options - 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. If set to false, any existing table record with primary key values that match those of a 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.
• 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.

Returns:

this to mimic the builder pattern.

getSchema

public org.apache.avro.Schema getSchema()

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

getSchema in interface org.apache.avro.generic.GenericContainer

Returns:

the schema object describing this class.

get

public Object get(int index)

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

get in interface org.apache.avro.generic.IndexedRecord

Parameters:

index - the position of the field to get

Returns:

value of the field with the given index.

Throws:

IndexOutOfBoundsException

put

public void put(int index,
                Object value)

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

put in interface org.apache.avro.generic.IndexedRecord

Parameters:

index - the position of the field to set

value - the value to set

Throws:

IndexOutOfBoundsException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object