com.gpudb.protocol

Class GetRecordsRequest

java.lang.Object

com.gpudb.protocol.GetRecordsRequest

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord

public class GetRecordsRequest
extends Object
implements org.apache.avro.generic.IndexedRecord

A set of parameters for GPUdb.getRecordsRaw(GetRecordsRequest).

Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. This operation can be performed on tables, views, or on homogeneous collections (collections containing tables of all the same type). Records can be returned encoded as binary or json.

This operation supports paging through the data via the offset and limit parameters. Note that when paging through a table, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records retrieved may differ between calls based on the updates applied.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GetRecordsRequest.Encoding Specifies the encoding for returned records.
static class	GetRecordsRequest.Options EXPRESSION: Optional filter expression to apply to the table.

Constructor Summary

Constructors

Constructor and Description
GetRecordsRequest() Constructs a GetRecordsRequest object with default parameters.
GetRecordsRequest(String tableName, long offset, long limit, Map<String,String> options) Constructs a GetRecordsRequest object with the specified parameters.
GetRecordsRequest(String tableName, long offset, long limit, String encoding, Map<String,String> options) Constructs a GetRecordsRequest object with the specified parameters.

Method Summary

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.
String	getEncoding()
long	getLimit()
long	getOffset()
Map<String,String>	getOptions()
org.apache.avro.Schema	getSchema() This method supports the Avro framework and is not intended to be called directly by the user.
String	getTableName()
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.
GetRecordsRequest	setEncoding(String encoding)
GetRecordsRequest	setLimit(long limit)
GetRecordsRequest	setOffset(long offset)
GetRecordsRequest	setOptions(Map<String,String> options)
GetRecordsRequest	setTableName(String tableName)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

GetRecordsRequest

public GetRecordsRequest()

Constructs a GetRecordsRequest object with default parameters.

GetRecordsRequest

public GetRecordsRequest(String tableName,
                 long offset,
                 long limit,
                 Map<String,String> options)

Constructs a GetRecordsRequest object with the specified parameters.

Parameters:

tableName - Name of the table from which the records will be fetched. Must be a table, view or homogeneous collection.

offset - A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.

limit - A positive integer indicating the maximum number of results to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned.

options -

• EXPRESSION: Optional filter expression to apply to the table.
• FAST_INDEX_LOOKUP: Indicates if indexes should be used to perform the lookup for a given expression if possible. Only applicable if there is no sorting, the expression contains only equivalence comparisons based on existing tables indexes and the range of requested values is from [0 to END_OF_SET]. The default value is true.
• SORT_BY: Optional column that the data should be sorted by. Empty by default (i.e. no sorting is applied).
• SORT_ORDER: String indicating how the returned values should be sorted - ascending or descending. If sort_order is provided, sort_by has to be provided. Supported values:
  • ASCENDING
  • DESCENDING
  The default value is ASCENDING.

GetRecordsRequest

public GetRecordsRequest(String tableName,
                 long offset,
                 long limit,
                 String encoding,
                 Map<String,String> options)

Constructs a GetRecordsRequest object with the specified parameters.

Parameters:

tableName - Name of the table from which the records will be fetched. Must be a table, view or homogeneous collection.

offset - A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.

limit - A positive integer indicating the maximum number of results to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned.

encoding - Specifies the encoding for returned records. Supported values:

• BINARY
• JSON

The default value is BINARY.

options -

• EXPRESSION: Optional filter expression to apply to the table.
• FAST_INDEX_LOOKUP: Indicates if indexes should be used to perform the lookup for a given expression if possible. Only applicable if there is no sorting, the expression contains only equivalence comparisons based on existing tables indexes and the range of requested values is from [0 to END_OF_SET]. The default value is true.
• SORT_BY: Optional column that the data should be sorted by. Empty by default (i.e. no sorting is applied).
• SORT_ORDER: String indicating how the returned values should be sorted - ascending or descending. If sort_order is provided, sort_by has to be provided. Supported values:
  • ASCENDING
  • DESCENDING
  The default value is ASCENDING.

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()

Returns:

Name of the table from which the records will be fetched. Must be a table, view or homogeneous collection.

setTableName

public GetRecordsRequest setTableName(String tableName)

Parameters:

tableName - Name of the table from which the records will be fetched. Must be a table, view or homogeneous collection.

Returns:

this to mimic the builder pattern.

getOffset

public long getOffset()

Returns:

A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.

setOffset

public GetRecordsRequest setOffset(long offset)

Parameters:

offset - A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.

Returns:

this to mimic the builder pattern.

getLimit

public long getLimit()

Returns:

A positive integer indicating the maximum number of results to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned.

setLimit

public GetRecordsRequest setLimit(long limit)

Parameters:

limit - A positive integer indicating the maximum number of results to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned.

Returns:

this to mimic the builder pattern.

getEncoding

public String getEncoding()

Returns:

Specifies the encoding for returned records. Supported values:

• BINARY
• JSON

The default value is BINARY.

setEncoding

public GetRecordsRequest setEncoding(String encoding)

Parameters:

encoding - Specifies the encoding for returned records. Supported values:

• BINARY
• JSON

The default value is BINARY.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Returns:

• EXPRESSION: Optional filter expression to apply to the table.
• FAST_INDEX_LOOKUP: Indicates if indexes should be used to perform the lookup for a given expression if possible. Only applicable if there is no sorting, the expression contains only equivalence comparisons based on existing tables indexes and the range of requested values is from [0 to END_OF_SET]. The default value is true.
• SORT_BY: Optional column that the data should be sorted by. Empty by default (i.e. no sorting is applied).
• SORT_ORDER: String indicating how the returned values should be sorted - ascending or descending. If sort_order is provided, sort_by has to be provided. Supported values:
  • ASCENDING
  • DESCENDING
  The default value is ASCENDING.

setOptions

public GetRecordsRequest setOptions(Map<String,String> options)

Parameters:

options -

• EXPRESSION: Optional filter expression to apply to the table.
• FAST_INDEX_LOOKUP: Indicates if indexes should be used to perform the lookup for a given expression if possible. Only applicable if there is no sorting, the expression contains only equivalence comparisons based on existing tables indexes and the range of requested values is from [0 to END_OF_SET]. The default value is true.
• SORT_BY: Optional column that the data should be sorted by. Empty by default (i.e. no sorting is applied).
• SORT_ORDER: String indicating how the returned values should be sorted - ascending or descending. If sort_order is provided, sort_by has to be provided. Supported values:
  • ASCENDING
  • DESCENDING
  The default value is ASCENDING.

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