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 only be performed on tables or on homogeneous collection (collections whose children all have 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.

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation. The Raw version of this method can be used to specify the encoding scheme of the response.

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

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 response.
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() The Raw version of this method can be used to specify the encoding scheme of the response.
long	getLimit() The Raw version of this method can be used to specify the encoding scheme of the response.
long	getOffset() The Raw version of this method can be used to specify the encoding scheme of the response.
Map<String,String>	getOptions() The Raw version of this method can be used to specify the encoding scheme of the response.
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 response.
int	hashCode() The Raw version of this method can be used to specify the encoding scheme of the response.
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) The Raw version of this method can be used to specify the encoding scheme of the response.
GetRecordsRequest	setLimit(long limit) The Raw version of this method can be used to specify the encoding scheme of the response.
GetRecordsRequest	setOffset(long offset) The Raw version of this method can be used to specify the encoding scheme of the response.
GetRecordsRequest	setOptions(Map<String,String> options) The Raw version of this method can be used to specify the encoding scheme of the response.
GetRecordsRequest	setTableName(String tableName) The Raw version of this method can be used to specify the encoding scheme of the response.
String	toString() The Raw version of this method can be used to specify the encoding scheme of the response.

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. The Raw version of this method can be used to specify the encoding scheme of the response.

GetRecordsRequest

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

Constructs a GetRecordsRequest object with the specified parameters. The Raw version of this method can be used to specify the encoding scheme of the response.

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.
• 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. Ignored if 'sort_by' option is not specified. Values: ascending, descending.

GetRecordsRequest

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

Constructs a GetRecordsRequest object with the specified parameters. The Raw version of this method can be used to specify the encoding scheme of the response.

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. Values: binary, json.

options -

• expression: Optional filter expression to apply to the table.
• 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. Ignored if 'sort_by' option is not specified. Values: ascending, descending.

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 response.

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 response.

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)

The Raw version of this method can be used to specify the encoding scheme of the response.

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

The Raw version of this method can be used to specify the encoding scheme of the response.

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)

The Raw version of this method can be used to specify the encoding scheme of the response.

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

The Raw version of this method can be used to specify the encoding scheme of the response.

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)

The Raw version of this method can be used to specify the encoding scheme of the response.

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

The Raw version of this method can be used to specify the encoding scheme of the response.

Returns:

Specifies the encoding for returned records. Values: binary, json.

setEncoding

public GetRecordsRequest setEncoding(String encoding)

The Raw version of this method can be used to specify the encoding scheme of the response.

Parameters:

encoding - Specifies the encoding for returned records. 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 response.

Returns:

• expression: Optional filter expression to apply to the table.
• 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. Ignored if 'sort_by' option is not specified. Values: ascending, descending.

setOptions

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

The Raw version of this method can be used to specify the encoding scheme of the response.

Parameters:

options -

• expression: Optional filter expression to apply to the table.
• 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. Ignored if 'sort_by' option is not specified. Values: ascending, descending.

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 response.

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 response.

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 response.

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 response.

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 response.

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 response.

Overrides:

hashCode in class Object