RawUpdateRecordsRequest (Kinetica Java API 5.2.0 API)

java.lang.Object
- com.gpudb.protocol.RawUpdateRecordsRequest

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord
```
public class RawUpdateRecordsRequest
extends Object
implements org.apache.avro.generic.IndexedRecord
```
A set of parameters for GPUdb.updateRecordsRaw(RawUpdateRecordsRequest).

Runs multiple predicate-based updates in a single call. With the list of given expressions, any matching record's column values will be updated as provided in newValuesMaps. There is also an optional 'upsert' capability where if a particular predicate doesn't match any existing record, then a new record can be inserted.

Note that this operation can only be run on an original table and not on a collection or a result view.

This operation can update primary key values. By default only 'pure primary key' predicates are allowed when updating primary key values. If the primary key for a table is the column 'attr1', then the operation will only accept predicates of the form: "attr1 == 'foo'" if the attr1 column is being updated. For a composite primary key (e.g. columns 'attr1' and 'attr2') then this operation will only accept predicates of the form: "(attr1 == 'foo') and (attr2 == 'bar')". Meaning, all primary key columns must appear in an equality predicate in the expressions. Furthermore each 'pure primary key' predicate must be unique within a given request. These restrictions can be removed by utilizing some available options through options. 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`	`RawUpdateRecordsRequest.Options` Optional parameters.
`static class`	`RawUpdateRecordsRequest.RecordEncoding` Identifies which of `recordsToInsert` and `recordsToInsertStr` should be used.

Constructor Summary

Constructors
Constructor and Description
`RawUpdateRecordsRequest()` Constructs a RawUpdateRecordsRequest object with default parameters.
`RawUpdateRecordsRequest(String tableName, List<String> expressions, List<Map<String,String>> newValuesMaps, List<ByteBuffer> recordsToInsert, List<String> recordsToInsertStr, String recordEncoding, Map<String,String> options)` Constructs a RawUpdateRecordsRequest object with the specified parameters.
`RawUpdateRecordsRequest(String tableName, List<String> expressions, List<Map<String,String>> newValuesMaps, List<ByteBuffer> recordsToInsert, Map<String,String> options)` Constructs a RawUpdateRecordsRequest 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<String>`	`getExpressions()` The Raw version of this method can be used to specify the encoding scheme of the request.
`List<Map<String,String>>`	`getNewValuesMaps()` 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`	`getRecordEncoding()` The Raw version of this method can be used to specify the encoding scheme of the request.
`List<ByteBuffer>`	`getRecordsToInsert()` The Raw version of this method can be used to specify the encoding scheme of the request.
`List<String>`	`getRecordsToInsertStr()` 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.
`RawUpdateRecordsRequest`	`setExpressions(List<String> expressions)` The Raw version of this method can be used to specify the encoding scheme of the request.
`RawUpdateRecordsRequest`	`setNewValuesMaps(List<Map<String,String>> newValuesMaps)` The Raw version of this method can be used to specify the encoding scheme of the request.
`RawUpdateRecordsRequest`	`setOptions(Map<String,String> options)` The Raw version of this method can be used to specify the encoding scheme of the request.
`RawUpdateRecordsRequest`	`setRecordEncoding(String recordEncoding)` The Raw version of this method can be used to specify the encoding scheme of the request.
`RawUpdateRecordsRequest`	`setRecordsToInsert(List<ByteBuffer> recordsToInsert)` The Raw version of this method can be used to specify the encoding scheme of the request.
`RawUpdateRecordsRequest`	`setRecordsToInsertStr(List<String> recordsToInsertStr)` The Raw version of this method can be used to specify the encoding scheme of the request.
`RawUpdateRecordsRequest`	`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
  - RawUpdateRecordsRequest
```
public RawUpdateRecordsRequest()
```
    Constructs a RawUpdateRecordsRequest object with default parameters. The Raw version of this method can be used to specify the encoding scheme of the request.
  - RawUpdateRecordsRequest
```
public RawUpdateRecordsRequest(String tableName,
                               List<String> expressions,
                               List<Map<String,String>> newValuesMaps,
                               List<ByteBuffer> recordsToInsert,
                               Map<String,String> options)
```
    Constructs a RawUpdateRecordsRequest 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 be updated. Must be a currently existing table and not a collection or view.
    
    expressions - A list of the actual predicates, one for each update; format should follow the guidelines here.
    
    newValuesMaps - List of new values for the matching records. Each element is a map with (key, value) pairs where the keys are the names of the columns whose values are to be updated; the values are the new values. The number of elements in the list should match the length of expressions.
    
    recordsToInsert - An *optional* list of new binary-avro encoded records to insert, one for each update. If one of expressions does not yield a matching record to be updated, then the corresponding element from this list will be added to the table.
    options - Optional parameters.
    
    global_expression: An optional global expression to reduce the search space of the predicates listed in expressions.
    bypass_safety_checks: When set to 'true', all predicates are available for primary key updates. Keep in mind that it is possible to destroy data in this case, since a single predicate may match multiple objects (potentially all of records of a table), and then updating all of those records to have the same primary key will, due to the primary key uniqueness constraints, effectively delete all but one of those updated records. Values: true, false.
    update_on_existing_pk: Can be used to customize behavior when the updated primary key value already exists, as described in GPUdb.insertRecordsRaw(RawInsertRecordsRequest). Values: true, false.
    record_id: ID of a single record to be updated (returned in the call to GPUdb.insertRecordsRaw(RawInsertRecordsRequest) or GPUdb.getRecordsFromCollectionRaw(GetRecordsFromCollectionRequest)).
  - RawUpdateRecordsRequest
```
public RawUpdateRecordsRequest(String tableName,
                               List<String> expressions,
                               List<Map<String,String>> newValuesMaps,
                               List<ByteBuffer> recordsToInsert,
                               List<String> recordsToInsertStr,
                               String recordEncoding,
                               Map<String,String> options)
```
    Constructs a RawUpdateRecordsRequest 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 be updated. Must be a currently existing table and not a collection or view.
    
    expressions - A list of the actual predicates, one for each update; format should follow the guidelines here.
    
    newValuesMaps - List of new values for the matching records. Each element is a map with (key, value) pairs where the keys are the names of the columns whose values are to be updated; the values are the new values. The number of elements in the list should match the length of expressions.
    
    recordsToInsert - An *optional* list of new binary-avro encoded records to insert, one for each update. If one of expressions does not yield a matching record to be updated, then the corresponding element from this list will be added to the table.
    
    recordsToInsertStr - An optional list of new json-avro encoded objects to insert, one for each update, to be added to the set if the particular update did not affect any objects.
    
    recordEncoding - Identifies which of recordsToInsert and recordsToInsertStr should be used. Values: binary, json.
    options - Optional parameters.
    
    global_expression: An optional global expression to reduce the search space of the predicates listed in expressions.
    bypass_safety_checks: When set to 'true', all predicates are available for primary key updates. Keep in mind that it is possible to destroy data in this case, since a single predicate may match multiple objects (potentially all of records of a table), and then updating all of those records to have the same primary key will, due to the primary key uniqueness constraints, effectively delete all but one of those updated records. Values: true, false.
    update_on_existing_pk: Can be used to customize behavior when the updated primary key value already exists, as described in GPUdb.insertRecordsRaw(RawInsertRecordsRequest). Values: true, false.
    record_id: ID of a single record to be updated (returned in the call to GPUdb.insertRecordsRaw(RawInsertRecordsRequest) or GPUdb.getRecordsFromCollectionRaw(GetRecordsFromCollectionRequest)).
- 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 be updated. Must be a currently existing table and not a collection or view.
  - setTableName
```
public RawUpdateRecordsRequest setTableName(String tableName)
```
    The Raw version of this method can be used to specify the encoding scheme of the request.
    
    Parameters:
    
    tableName - Table to be updated. Must be a currently existing table and not a collection or view.
    
    Returns:
    
    this to mimic the builder pattern.
  - getExpressions
```
public List<String> getExpressions()
```
    The Raw version of this method can be used to specify the encoding scheme of the request.
    
    Returns:
    
    A list of the actual predicates, one for each update; format should follow the guidelines here.
  - setExpressions
```
public RawUpdateRecordsRequest setExpressions(List<String> expressions)
```
    The Raw version of this method can be used to specify the encoding scheme of the request.
    
    Parameters:
    
    expressions - A list of the actual predicates, one for each update; format should follow the guidelines here.
    
    Returns:
    
    this to mimic the builder pattern.
  - getNewValuesMaps
```
public List<Map<String,String>> getNewValuesMaps()
```
    The Raw version of this method can be used to specify the encoding scheme of the request.
    
    Returns:
    
    List of new values for the matching records. Each element is a map with (key, value) pairs where the keys are the names of the columns whose values are to be updated; the values are the new values. The number of elements in the list should match the length of expressions.
  - setNewValuesMaps
```
public RawUpdateRecordsRequest setNewValuesMaps(List<Map<String,String>> newValuesMaps)
```
    The Raw version of this method can be used to specify the encoding scheme of the request.
    
    Parameters:
    
    newValuesMaps - List of new values for the matching records. Each element is a map with (key, value) pairs where the keys are the names of the columns whose values are to be updated; the values are the new values. The number of elements in the list should match the length of expressions.
    
    Returns:
    
    this to mimic the builder pattern.
  - getRecordsToInsert
```
public List<ByteBuffer> getRecordsToInsert()
```
    The Raw version of this method can be used to specify the encoding scheme of the request.
    
    Returns:
    
    An *optional* list of new binary-avro encoded records to insert, one for each update. If one of expressions does not yield a matching record to be updated, then the corresponding element from this list will be added to the table.
  - setRecordsToInsert
```
public RawUpdateRecordsRequest setRecordsToInsert(List<ByteBuffer> recordsToInsert)
```
    The Raw version of this method can be used to specify the encoding scheme of the request.
    
    Parameters:
    
    recordsToInsert - An *optional* list of new binary-avro encoded records to insert, one for each update. If one of expressions does not yield a matching record to be updated, then the corresponding element from this list will be added to the table.
    
    Returns:
    
    this to mimic the builder pattern.
  - getRecordsToInsertStr
```
public List<String> getRecordsToInsertStr()
```
    The Raw version of this method can be used to specify the encoding scheme of the request.
    
    Returns:
    
    An optional list of new json-avro encoded objects to insert, one for each update, to be added to the set if the particular update did not affect any objects.
  - setRecordsToInsertStr
```
public RawUpdateRecordsRequest setRecordsToInsertStr(List<String> recordsToInsertStr)
```
    The Raw version of this method can be used to specify the encoding scheme of the request.
    
    Parameters:
    
    recordsToInsertStr - An optional list of new json-avro encoded objects to insert, one for each update, to be added to the set if the particular update did not affect any objects.
    
    Returns:
    
    this to mimic the builder pattern.
  - getRecordEncoding
```
public String getRecordEncoding()
```
    The Raw version of this method can be used to specify the encoding scheme of the request.
    
    Returns:
    
    Identifies which of recordsToInsert and recordsToInsertStr should be used. Values: binary, json.
  - setRecordEncoding
```
public RawUpdateRecordsRequest setRecordEncoding(String recordEncoding)
```
    The Raw version of this method can be used to specify the encoding scheme of the request.
    
    Parameters:
    
    recordEncoding - Identifies which of recordsToInsert and recordsToInsertStr should be used. 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.
    
    global_expression: An optional global expression to reduce the search space of the predicates listed in expressions.
    bypass_safety_checks: When set to 'true', all predicates are available for primary key updates. Keep in mind that it is possible to destroy data in this case, since a single predicate may match multiple objects (potentially all of records of a table), and then updating all of those records to have the same primary key will, due to the primary key uniqueness constraints, effectively delete all but one of those updated records. Values: true, false.
    update_on_existing_pk: Can be used to customize behavior when the updated primary key value already exists, as described in GPUdb.insertRecordsRaw(RawInsertRecordsRequest). Values: true, false.
    record_id: ID of a single record to be updated (returned in the call to GPUdb.insertRecordsRaw(RawInsertRecordsRequest) or GPUdb.getRecordsFromCollectionRaw(GetRecordsFromCollectionRequest)).
  - setOptions
```
public RawUpdateRecordsRequest 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.
    
    global_expression: An optional global expression to reduce the search space of the predicates listed in expressions.
    bypass_safety_checks: When set to 'true', all predicates are available for primary key updates. Keep in mind that it is possible to destroy data in this case, since a single predicate may match multiple objects (potentially all of records of a table), and then updating all of those records to have the same primary key will, due to the primary key uniqueness constraints, effectively delete all but one of those updated records. Values: true, false.
    update_on_existing_pk: Can be used to customize behavior when the updated primary key value already exists, as described in GPUdb.insertRecordsRaw(RawInsertRecordsRequest). Values: true, false.
    record_id: ID of a single record to be updated (returned in the call to GPUdb.insertRecordsRaw(RawInsertRecordsRequest) or GPUdb.getRecordsFromCollectionRaw(GetRecordsFromCollectionRequest)).
    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 RawUpdateRecordsRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RawUpdateRecordsRequest

RawUpdateRecordsRequest

RawUpdateRecordsRequest

Method Detail

getClassSchema

getTableName

setTableName

getExpressions

setExpressions

getNewValuesMaps

setNewValuesMaps

getRecordsToInsert

setRecordsToInsert

getRecordsToInsertStr

setRecordsToInsertStr

getRecordEncoding

setRecordEncoding

getOptions

setOptions

getSchema

get

put

equals

toString

hashCode