InsertRecordsRequest (Kinetica Java API 5.2.0 API)

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 GPUdb will not return a response until all the records are fully inserted and available. The response payload provides unique identifier for each added record along with counts of the number of records actually inserted and/or updated.

options can be used to customize this function's behavior. The only parameter available is update_on_existing_pk. The value can be either 'true' or 'false'. If the table has a primary key and if update_on_existing_pk is 'true' then if any of the records being added have the same primary key as existing records, the existing records are replaced (i.e. *updated*) with the given records. If update_on_existing_pk is false and if the records being added have the same primary key as existing records, the given records with existing primary keys are ignored (the existing records are left unchanged). It is quite possible that in this case some of the given records will be inserted and some (those having existing primary keys) will be ignored (or updated). If the specified table does not have a primary key column then the update_on_existing_pk option is ignored. The Raw version of this method can be used to specify the encoding scheme of the request.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class InsertRecordsRequest.Options
Optional parameters.

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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)` The Raw version of this method can be used to specify the encoding scheme of the request.
`List<T>`	`getData()` The Raw version of this method can be used to specify the encoding scheme of the request.
`Map<String,String>`	`getOptions()` The Raw version of this method can be used to specify the encoding scheme of the request.
`String`	`getTableName()` The Raw version of this method can be used to specify the encoding scheme of the request.
`int`	`hashCode()` The Raw version of this method can be used to specify the encoding scheme of the request.
`InsertRecordsRequest<T>`	`setData(List<T> data)` The Raw version of this method can be used to specify the encoding scheme of the request.
`InsertRecordsRequest<T>`	`setOptions(Map<String,String> options)` The Raw version of this method can be used to specify the encoding scheme of the request.
`InsertRecordsRequest<T>`	`setTableName(String tableName)` The Raw version of this method can be used to specify the encoding scheme of the request.
`String`	`toString()` The Raw version of this method can be used to specify the encoding scheme of the request.

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. The Raw version of this method can be used to specify the encoding scheme of the request.
  - InsertRecordsRequest
```
public InsertRecordsRequest(String tableName,
                            List<T> data,
                            Map<String,String> options)
```
    Constructs an InsertRecordsRequest object with the specified parameters. The Raw version of this method can be used to specify the encoding scheme of the request.
    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: If the table has a primary key, then if the value is 'true' then if any of the records being added have the same primary key as existing records, the existing records are replaced (i.e. *updated*) with the given records. If 'false' and if the records being added have the same primary key as existing records, the given records with existing primary keys are ignored (the existing records are left unchanged). It is quite possible that in this case some of the given records will be inserted and some (those having existing primary keys) will be ignored (or updated). If the specified table does not have a primary key column then this optional parameter is ignored. Values: true, false.
    return_record_ids: If 'true' then return GPUdb's internal record id along for each inserted record. Default is 'false'. Values: true, 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()
```
    The Raw version of this method can be used to specify the encoding scheme of the request.
    
    Returns:
    
    Table to which the records are to be added. Must be an existing table.
  - setTableName
```
public InsertRecordsRequest<T> setTableName(String tableName)
```
    The Raw version of this method can be used to specify the encoding scheme of the request.
    
    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()
```
    The Raw version of this method can be used to specify the encoding scheme of the request.
    
    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)
```
    The Raw version of this method can be used to specify the encoding scheme of the request.
    
    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()
```
    The Raw version of this method can be used to specify the encoding scheme of the request.
    Returns:
    Optional parameters.
    
    update_on_existing_pk: If the table has a primary key, then if the value is 'true' then if any of the records being added have the same primary key as existing records, the existing records are replaced (i.e. *updated*) with the given records. If 'false' and if the records being added have the same primary key as existing records, the given records with existing primary keys are ignored (the existing records are left unchanged). It is quite possible that in this case some of the given records will be inserted and some (those having existing primary keys) will be ignored (or updated). If the specified table does not have a primary key column then this optional parameter is ignored. Values: true, false.
    return_record_ids: If 'true' then return GPUdb's internal record id along for each inserted record. Default is 'false'. Values: true, 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)
```
    The Raw version of this method can be used to specify the encoding scheme of the request.
    Parameters:
    options - Optional parameters.
    
    update_on_existing_pk: If the table has a primary key, then if the value is 'true' then if any of the records being added have the same primary key as existing records, the existing records are replaced (i.e. *updated*) with the given records. If 'false' and if the records being added have the same primary key as existing records, the given records with existing primary keys are ignored (the existing records are left unchanged). It is quite possible that in this case some of the given records will be inserted and some (those having existing primary keys) will be ignored (or updated). If the specified table does not have a primary key column then this optional parameter is ignored. Values: true, false.
    return_record_ids: If 'true' then return GPUdb's internal record id along for each inserted record. Default is 'false'. Values: true, 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)
```
    The Raw version of this method can be used to specify the encoding scheme of the request.
    
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    The Raw version of this method can be used to specify the encoding scheme of the request.
    
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    The Raw version of this method can be used to specify the encoding scheme of the request.
    
    Overrides:
    
    hashCode in class Object

Class InsertRecordsRequest<T>

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

InsertRecordsRequest

InsertRecordsRequest

Method Detail

getTableName

setTableName

getData

setData

getOptions

setOptions

equals

toString

hashCode