RawInsertRecordsRequest (Kinetica Java API 5.2.0 API)

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 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`	`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

All Methods Static 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.
`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()` The Raw version of this method can be used to specify the encoding scheme of the request.
`String`	`getListEncoding()` The Raw version of this method can be used to specify the encoding scheme of the request.
`List<String>`	`getListStr()` 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.
`org.apache.avro.Schema`	`getSchema()` This method supports the Avro framework and is not intended to be called directly by the user.
`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.
`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)` The Raw version of this method can be used to specify the encoding scheme of the request.
`RawInsertRecordsRequest`	`setListEncoding(String listEncoding)` The Raw version of this method can be used to specify the encoding scheme of the request.
`RawInsertRecordsRequest`	`setListStr(List<String> listStr)` The Raw version of this method can be used to specify the encoding scheme of the request.
`RawInsertRecordsRequest`	`setOptions(Map<String,String> options)` The Raw version of this method can be used to specify the encoding scheme of the request.
`RawInsertRecordsRequest`	`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
  - RawInsertRecordsRequest
```
public RawInsertRecordsRequest()
```
    Constructs a RawInsertRecordsRequest object with default parameters. The Raw version of this method can be used to specify the encoding scheme of the request.
  - RawInsertRecordsRequest
```
public RawInsertRecordsRequest(String tableName,
                               List<ByteBuffer> list,
                               Map<String,String> options)
```
    Constructs a RawInsertRecordsRequest 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.
    
    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: 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
  - 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. 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.
    
    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. Values: binary, 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
  - 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. The Raw version of this method can be used to specify the encoding scheme of the request.
    
    Returns:
    
    the schema for the class.
  - 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 RawInsertRecordsRequest 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.
  - getList
```
public List<ByteBuffer> getList()
```
    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.
  - setList
```
public RawInsertRecordsRequest setList(List<ByteBuffer> list)
```
    The Raw version of this method can be used to specify the encoding scheme of the request.
    
    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()
```
    The Raw version of this method can be used to specify the encoding scheme of the request.
    
    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)
```
    The Raw version of this method can be used to specify the encoding scheme of the request.
    
    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()
```
    The Raw version of this method can be used to specify the encoding scheme of the request.
    
    Returns:
    
    The encoding of the records to be inserted. Values: binary, json.
  - setListEncoding
```
public RawInsertRecordsRequest setListEncoding(String listEncoding)
```
    The Raw version of this method can be used to specify the encoding scheme of the request.
    
    Parameters:
    
    listEncoding - The encoding of the records to be inserted. Values: binary, 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 RawInsertRecordsRequest 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.
  - getSchema
```
public org.apache.avro.Schema getSchema()
```
    This method supports the Avro framework and is not intended to be called directly by the user. The Raw version of this method can be used to specify the encoding scheme of the request.
    
    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. The Raw version of this method can be used to specify the encoding scheme of the request.
    
    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. The Raw version of this method can be used to specify the encoding scheme of the request.
    
    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)
```
    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 RawInsertRecordsRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RawInsertRecordsRequest

RawInsertRecordsRequest

RawInsertRecordsRequest

Method Detail

getClassSchema

getTableName

setTableName

getList

setList

getListStr

setListStr

getListEncoding

setListEncoding

getOptions

setOptions

getSchema

get

put

equals

toString

hashCode