com.gpudb.protocol

Class InsertRecordsRequest<T>

java.lang.Object

com.gpudb.protocol.InsertRecordsRequest<T>

Type Parameters:

T - The type of object being processed.

public class InsertRecordsRequest<T>
extends Object

A set of parameters for GPUdb.insertRecords(InsertRecordsRequest).

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.

The route_to_address option directs that inserted records should be targeted for a particular database node.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InsertRecordsRequest.Options Optional parameters.

Constructor Summary

Constructors

Constructor and Description
InsertRecordsRequest() Constructs an InsertRecordsRequest object with default parameters.
InsertRecordsRequest(String tableName, List<T> data, Map<String,String> options) Constructs an InsertRecordsRequest object with the specified parameters.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<T>	getData()
Map<String,String>	getOptions()
String	getTableName()
int	hashCode()
InsertRecordsRequest<T>	setData(List<T> data)
InsertRecordsRequest<T>	setOptions(Map<String,String> options)
InsertRecordsRequest<T>	setTableName(String tableName)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

InsertRecordsRequest

public InsertRecordsRequest()

Constructs an InsertRecordsRequest object with default parameters.

InsertRecordsRequest

public InsertRecordsRequest(String tableName,
                    List<T> data,
                    Map<String,String> options)

Constructs an InsertRecordsRequest object with the specified parameters.

Parameters:

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

data - 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.
• ROUTE_TO_ADDRESS: Route to a specific rank/tom. Option not suitable for tables using primary/shard keys

Method Detail

getTableName

public String getTableName()

Returns:

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

setTableName

public InsertRecordsRequest<T> 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.

getData

public List<T> getData()

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.

setData

public InsertRecordsRequest<T> setData(List<T> data)

Parameters:

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

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.
• ROUTE_TO_ADDRESS: Route to a specific rank/tom. Option not suitable for tables using primary/shard keys

setOptions

public InsertRecordsRequest<T> 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.
• ROUTE_TO_ADDRESS: Route to a specific rank/tom. Option not suitable for tables using primary/shard keys

Returns:

this to mimic the builder pattern.

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