public class GetRecordsRequest extends Object implements org.apache.avro.generic.IndexedRecord
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, 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.
| 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 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.
|
| 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() |
public GetRecordsRequest()
public GetRecordsRequest(String tableName, long offset, long limit, Map<String,String> options)
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 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 max number of results 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:
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:
The default value is ASCENDING.
Map.public GetRecordsRequest(String tableName, long offset, long limit, String encoding, Map<String,String> options)
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 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 max number of results 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.
Supported values:
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:
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:
The default value is ASCENDING.
Map.public static org.apache.avro.Schema getClassSchema()
public String getTableName()
public GetRecordsRequest setTableName(String tableName)
tableName - Name of the table from which the records will be
fetched. Must be a table, view or homogeneous
collection.this to mimic the builder pattern.public long getOffset()
public GetRecordsRequest setOffset(long offset)
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.this to mimic the builder pattern.public long getLimit()
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.public GetRecordsRequest setLimit(long limit)
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. 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.this to mimic the builder pattern.public String getEncoding()
public GetRecordsRequest setEncoding(String encoding)
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:
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:
The default value is ASCENDING.
Map.public GetRecordsRequest setOptions(Map<String,String> options)
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:
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:
The default value is ASCENDING.
Map.this to mimic the builder pattern.public org.apache.avro.Schema getSchema()
getSchema in interface org.apache.avro.generic.GenericContainerpublic Object get(int index)
get in interface org.apache.avro.generic.IndexedRecordindex - the position of the field to getIndexOutOfBoundsExceptionpublic void put(int index,
Object value)
put in interface org.apache.avro.generic.IndexedRecordindex - the position of the field to setvalue - the value to setIndexOutOfBoundsExceptionCopyright © 2020. All rights reserved.