DeleteRecordsRequest (Kinetica Java API 7.2.3.1 API)

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

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord
```
public class DeleteRecordsRequest
extends Object
implements org.apache.avro.generic.IndexedRecord
```
A set of parameters for GPUdb.deleteRecords.
Deletes record(s) matching the provided criteria from the given table. The record selection criteria can either be one or more expressions (matching multiple records), a single record identified by RECORD_ID options, or all records when using DELETE_ALL_RECORDS. Note that the three selection criteria are mutually exclusive. This operation cannot be run on a view. The operation is synchronous meaning that a response will not be available until the request is completely processed and all the matching records are deleted.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DeleteRecordsRequest.Options
A set of string constants for the DeleteRecordsRequest parameter options.

Nested Classes
Modifier and Type	Class and Description
`static class`	`DeleteRecordsRequest.Options` A set of string constants for the `DeleteRecordsRequest` parameter `options`.

Constructor Summary

Constructors
Constructor and Description
`DeleteRecordsRequest()` Constructs a DeleteRecordsRequest object with default parameters.
`DeleteRecordsRequest(String tableName, List<String> expressions, Map<String,String> options)` Constructs a DeleteRecordsRequest 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)`
`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()` A list of the actual predicates, one for each select; format should follow the guidelines provided	`Map<String,String>`	`getOptions()` Optional parameters.
`org.apache.avro.Schema`	`getSchema()` This method supports the Avro framework and is not intended to be called directly by the user.
`String`	`getTableName()` Name of the table from which to delete records, in [schema_name.]table_name format, using standard	`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.
`DeleteRecordsRequest`	`setExpressions(List<String> expressions)` A list of the actual predicates, one for each select; format should follow the guidelines provided	`DeleteRecordsRequest`	`setOptions(Map<String,String> options)` Optional parameters.
`DeleteRecordsRequest`	`setTableName(String tableName)` Name of the table from which to delete records, in [schema_name.]table_name format, using standard	`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DeleteRecordsRequest
```
public DeleteRecordsRequest()
```
    Constructs a DeleteRecordsRequest object with default parameters.
  - DeleteRecordsRequest
```
public DeleteRecordsRequest(String tableName,
                            List<String> expressions,
                            Map<String,String> options)
```
    Constructs a DeleteRecordsRequest object with the specified parameters.
    Parameters:
    
    tableName - Name of the table from which to delete records, in [schema_name.]table_name format, using standard name resolution rules. Must contain the name of an existing table; not applicable to views.
    
    expressions - A list of the actual predicates, one for each select; format should follow the guidelines provided here. Specifying one or more expressions is mutually exclusive to specifying RECORD_ID in the options.
    options - Optional parameters.
    
    GLOBAL_EXPRESSION: An optional global expression to reduce the search space of the expressions. The default value is ''.
    RECORD_ID: A record ID identifying a single record, obtained at the time of insertion of the record or by calling GPUdb.getRecordsFromCollection with the *return_record_ids* option. This option cannot be used to delete records from replicated tables.
    DELETE_ALL_RECORDS: If set to TRUE, all records in the table will be deleted. If set to FALSE, then the option is effectively ignored. 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()
```
    Name of the table from which to delete records, in [schema_name.]table_name format, using standard name resolution rules. Must contain the name of an existing table; not applicable to views.
    
    Returns:
    
    The current value of tableName.
  - setTableName
```
public DeleteRecordsRequest setTableName(String tableName)
```
    Name of the table from which to delete records, in [schema_name.]table_name format, using standard name resolution rules. Must contain the name of an existing table; not applicable to views.
    
    Parameters:
    
    tableName - The new value for tableName.
    
    Returns:
    
    this to mimic the builder pattern.
  - getExpressions
```
public List<String> getExpressions()
```
    A list of the actual predicates, one for each select; format should follow the guidelines provided here. Specifying one or more expressions is mutually exclusive to specifying RECORD_ID in the options.
    
    Returns:
    
    The current value of expressions.
  - setExpressions
```
public DeleteRecordsRequest setExpressions(List<String> expressions)
```
    A list of the actual predicates, one for each select; format should follow the guidelines provided here. Specifying one or more expressions is mutually exclusive to specifying RECORD_ID in the options.
    
    Parameters:
    
    expressions - The new value for expressions.
    
    Returns:
    
    this to mimic the builder pattern.
  - getOptions
```
public Map<String,String> getOptions()
```
    Optional parameters.
    - GLOBAL_EXPRESSION: An optional global expression to reduce the search space of the expressions. The default value is ''.
    - RECORD_ID: A record ID identifying a single record, obtained at the time of insertion of the record or by calling GPUdb.getRecordsFromCollection with the *return_record_ids* option. This option cannot be used to delete records from replicated tables.
    - DELETE_ALL_RECORDS: If set to TRUE, all records in the table will be deleted. If set to FALSE, then the option is effectively ignored. Supported values:
      
      TRUE
      FALSE
      The default value is FALSE.
    The default value is an empty Map.
    Returns:
    
    The current value of options.
  - setOptions
```
public DeleteRecordsRequest setOptions(Map<String,String> options)
```
    Optional parameters.
    - GLOBAL_EXPRESSION: An optional global expression to reduce the search space of the expressions. The default value is ''.
    - RECORD_ID: A record ID identifying a single record, obtained at the time of insertion of the record or by calling GPUdb.getRecordsFromCollection with the *return_record_ids* option. This option cannot be used to delete records from replicated tables.
    - DELETE_ALL_RECORDS: If set to TRUE, all records in the table will be deleted. If set to FALSE, then the option is effectively ignored. Supported values:
      
      TRUE
      FALSE
      The default value is FALSE.
    The default value is an empty Map.
    Parameters:
    
    options - The new value for options.
    
    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

Class DeleteRecordsRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DeleteRecordsRequest

DeleteRecordsRequest

Method Detail

getClassSchema

getTableName

setTableName

getExpressions

setExpressions

getOptions

setOptions

getSchema

get

put

equals

toString

hashCode