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

Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. This operation can be performed on tables and views. Records can be returned encoded as binary, json, or geojson.

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 A set of string constants for the GetRecordsRequest parameter encoding.
static class	GetRecordsRequest.Options A set of string constants for the GetRecordsRequest parameter options.

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)
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() Specifies the encoding for returned records; one of BINARY, JSON, or GEOJSON.
long	getLimit() A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned.
long	getOffset() A positive integer indicating the number of initial results to skip (this can be useful for paging through the results).
Map<String,String>	getOptions() EXPRESSION: Optional filter expression to apply to the table.
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 or view from which the records will be fetched, 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.
GetRecordsRequest	setEncoding(String encoding) Specifies the encoding for returned records; one of BINARY, JSON, or GEOJSON.
GetRecordsRequest	setLimit(long limit) A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned.
GetRecordsRequest	setOffset(long offset) A positive integer indicating the number of initial results to skip (this can be useful for paging through the results).
GetRecordsRequest	setOptions(Map<String,String> options) EXPRESSION: Optional filter expression to apply to the table.
GetRecordsRequest	setTableName(String tableName) Name of the table or view from which the records will be fetched, 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

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 or view from which the records will be fetched, in [schema_name.]table_name format, using standard name resolution rules.

offset - A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0. 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 maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use hasMoreRecords to see if more records exist in the result to be fetched, and offset & limit to request subsequent pages of results. The default value is -9999.

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]. Supported values:
  • TRUE
  • FALSE
  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.

The default value is an empty Map.

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 or view from which the records will be fetched, in [schema_name.]table_name format, using standard name resolution rules.

offset - A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0. 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 maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use hasMoreRecords to see if more records exist in the result to be fetched, and offset & limit to request subsequent pages of results. The default value is -9999.

encoding - Specifies the encoding for returned records; one of BINARY, JSON, or GEOJSON. Supported values:

• BINARY
• JSON
• GEOJSON

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]. Supported values:
  • TRUE
  • FALSE
  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.

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 or view from which the records will be fetched, in [schema_name.]table_name format, using standard name resolution rules.

Returns:

The current value of tableName.

setTableName

public GetRecordsRequest setTableName(String tableName)

Name of the table or view from which the records will be fetched, in [schema_name.]table_name format, using standard name resolution rules.

Parameters:

tableName - The new value for tableName.

Returns:

this to mimic the builder pattern.

getOffset

public long getOffset()

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

Returns:

The current value of offset.

setOffset

public GetRecordsRequest setOffset(long offset)

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

Parameters:

offset - The new value for offset.

Returns:

this to mimic the builder pattern.

getLimit

public long getLimit()

A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use hasMoreRecords to see if more records exist in the result to be fetched, and offset & limit to request subsequent pages of results. The default value is -9999.

Returns:

The current value of limit.

setLimit

public GetRecordsRequest setLimit(long limit)

A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use hasMoreRecords to see if more records exist in the result to be fetched, and offset & limit to request subsequent pages of results. The default value is -9999.

Parameters:

limit - The new value for limit.

Returns:

this to mimic the builder pattern.

getEncoding

public String getEncoding()

Specifies the encoding for returned records; one of BINARY, JSON, or GEOJSON. Supported values:

• BINARY
• JSON
• GEOJSON

The default value is BINARY.

Returns:

The current value of encoding.

setEncoding

public GetRecordsRequest setEncoding(String encoding)

Specifies the encoding for returned records; one of BINARY, JSON, or GEOJSON. Supported values:

• BINARY
• JSON
• GEOJSON

The default value is BINARY.

Parameters:

encoding - The new value for encoding.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

• 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]. Supported values:
  • TRUE
  • FALSE
  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.

The default value is an empty Map.

Returns:

The current value of options.

setOptions

public GetRecordsRequest setOptions(Map<String,String> 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]. Supported values:
  • TRUE
  • FALSE
  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.

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