GetRecordsByColumnRequest

java.lang.Object

com.gpudb.protocol.GetRecordsByColumnRequest

All Implemented Interfaces:

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

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

A set of parameters for GPUdb.getRecordsByColumn.

For a given table, retrieves the values from the requested column(s). Maps of column name to the array of values as well as the column data type are returned. This endpoint supports pagination with the offset and limit parameters.

Window functions, which can perform operations like moving averages, are available through this endpoint as well as GPUdb.createProjection.

When using pagination, if the table (or the underlying table in the case of a view) is modified (records are inserted, updated, or deleted) during a call to the endpoint, the records or values retrieved may differ between calls based on the type of the update, e.g., the contiguity across pages cannot be relied upon.

If tableName is empty, selection is performed against a single-row virtual table. This can be useful in executing temporal (NOW()), identity (USER()), or constant-based functions (GEODIST(-77.11, 38.88, -71.06, 42.36)).

The response is returned as a dynamic schema. For details see: dynamic schemas documentation.

Nested Class Summary
Nested Classes
Modifier and Type
Class
Description
static final class
GetRecordsByColumnRequest.Encoding
A set of string constants for the GetRecordsByColumnRequest parameter encoding.
static final class
GetRecordsByColumnRequest.Options
A set of string constants for the GetRecordsByColumnRequest parameter options.
Constructor Summary
Constructors
Constructor
Description
GetRecordsByColumnRequest()
Constructs a GetRecordsByColumnRequest object with default parameters.
GetRecordsByColumnRequest(String tableName, List<String> columnNames, long offset, long limit, String encoding, Map<String,String> options)
Constructs a GetRecordsByColumnRequest object with the specified parameters.
GetRecordsByColumnRequest(String tableName, List<String> columnNames, long offset, long limit, Map<String,String> options)
Constructs a GetRecordsByColumnRequest object with the specified parameters.
Method Summary
Modifier and Type
Method
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>
getColumnNames()
The list of column values to retrieve.
String
getEncoding()
Specifies the encoding for returned records; either BINARY or JSON.
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: 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 on which this operation will be performed, in [schema_name.]table_name format, using standard name resolution rules.
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.
GetRecordsByColumnRequest
setColumnNames(List<String> columnNames)
The list of column values to retrieve.
GetRecordsByColumnRequest
setEncoding(String encoding)
Specifies the encoding for returned records; either BINARY or JSON.
GetRecordsByColumnRequest
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.
GetRecordsByColumnRequest
setOffset(long offset)
A positive integer indicating the number of initial results to skip (this can be useful for paging through the results).
GetRecordsByColumnRequest
setOptions(Map<String,String> options)
EXPRESSION: Filter expression to apply to the table.
GetRecordsByColumnRequest
setTableName(String tableName)
Name of the table or view on which this operation will be performed, in [schema_name.]table_name format, using standard name resolution rules.
String
toString()

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

Constructor Details
- GetRecordsByColumnRequest
  public GetRecordsByColumnRequest()
  Constructs a GetRecordsByColumnRequest object with default parameters.
- GetRecordsByColumnRequest
  public GetRecordsByColumnRequest(String tableName, List<String> columnNames, long offset, long limit, Map<String,String> options)
  Constructs a GetRecordsByColumnRequest object with the specified parameters.
  Parameters:
  tableName - Name of the table or view on which this operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. An empty table name retrieves one record from a single-row virtual table, where columns specified should be constants or constant expressions.
  columnNames - The list of column values to retrieve.
  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 and limit to request subsequent pages of results. The default value is -9999.
  options -
  EXPRESSION: Filter expression to apply to the table.
  SORT_BY: Column that the data should be sorted by. Used in conjunction with SORT_ORDER. The ORDER_BY option can be used in lieu of SORT_BY / SORT_ORDER. The default value is ”.
  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.
  ORDER_BY: Comma-separated list of the columns to be sorted by as well as the sort direction, e.g., ‘timestamp asc, x desc’. The default value is ”.
  CONVERT_WKTS_TO_WKBS: If TRUE, then WKT string columns will be returned as WKB bytes. Supported values:
  TRUE
  FALSE
  The default value is FALSE.
  ROUTE_TO_TOM: For multihead record retrieval without shard key expression - specifies from which tom to retrieve data.
  The default value is an empty Map.
- GetRecordsByColumnRequest
  public GetRecordsByColumnRequest(String tableName, List<String> columnNames, long offset, long limit, String encoding, Map<String,String> options)
  Constructs a GetRecordsByColumnRequest object with the specified parameters.
  Parameters:
  tableName - Name of the table or view on which this operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. An empty table name retrieves one record from a single-row virtual table, where columns specified should be constants or constant expressions.
  columnNames - The list of column values to retrieve.
  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 and limit to request subsequent pages of results. The default value is -9999.
  encoding - Specifies the encoding for returned records; either BINARY or JSON. Supported values:
  BINARY
  JSON
  The default value is BINARY.
  options -
  EXPRESSION: Filter expression to apply to the table.
  SORT_BY: Column that the data should be sorted by. Used in conjunction with SORT_ORDER. The ORDER_BY option can be used in lieu of SORT_BY / SORT_ORDER. The default value is ”.
  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.
  ORDER_BY: Comma-separated list of the columns to be sorted by as well as the sort direction, e.g., ‘timestamp asc, x desc’. The default value is ”.
  CONVERT_WKTS_TO_WKBS: If TRUE, then WKT string columns will be returned as WKB bytes. Supported values:
  TRUE
  FALSE
  The default value is FALSE.
  ROUTE_TO_TOM: For multihead record retrieval without shard key expression - specifies from which tom to retrieve data.
  The default value is an empty Map.
Method Details
- 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 on which this operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. An empty table name retrieves one record from a single-row virtual table, where columns specified should be constants or constant expressions.
  Returns:
  The current value of tableName.
- setTableName
  public GetRecordsByColumnRequest setTableName(String tableName)
  Name of the table or view on which this operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. An empty table name retrieves one record from a single-row virtual table, where columns specified should be constants or constant expressions.
  Parameters:
  tableName - The new value for tableName.
  Returns:
  this to mimic the builder pattern.
- getColumnNames
  public List<String> getColumnNames()
  The list of column values to retrieve.
  Returns:
  The current value of columnNames.
- setColumnNames
  public GetRecordsByColumnRequest setColumnNames(List<String> columnNames)
  The list of column values to retrieve.
  Parameters:
  columnNames - The new value for columnNames.
  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 GetRecordsByColumnRequest 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 and limit to request subsequent pages of results. The default value is -9999.
  Returns:
  The current value of limit.
- setLimit
  public GetRecordsByColumnRequest 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 and 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; either BINARY or JSON. Supported values:
  BINARY
  JSON
  The default value is BINARY.
  Returns:
  The current value of encoding.
- setEncoding
  public GetRecordsByColumnRequest setEncoding(String encoding)
  Specifies the encoding for returned records; either BINARY or JSON. Supported values:
  BINARY
  JSON
  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: Filter expression to apply to the table.
  SORT_BY: Column that the data should be sorted by. Used in conjunction with SORT_ORDER. The ORDER_BY option can be used in lieu of SORT_BY / SORT_ORDER. The default value is ”.
  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.
  ORDER_BY: Comma-separated list of the columns to be sorted by as well as the sort direction, e.g., ‘timestamp asc, x desc’. The default value is ”.
  CONVERT_WKTS_TO_WKBS: If TRUE, then WKT string columns will be returned as WKB bytes. Supported values:
  TRUE
  FALSE
  The default value is FALSE.
  ROUTE_TO_TOM: For multihead record retrieval without shard key expression - specifies from which tom to retrieve data.
  The default value is an empty Map.
  Returns:
  The current value of options.
- setOptions
  public GetRecordsByColumnRequest setOptions(Map<String,String> options)
  EXPRESSION: Filter expression to apply to the table.
  SORT_BY: Column that the data should be sorted by. Used in conjunction with SORT_ORDER. The ORDER_BY option can be used in lieu of SORT_BY / SORT_ORDER. The default value is ”.
  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.
  ORDER_BY: Comma-separated list of the columns to be sorted by as well as the sort direction, e.g., ‘timestamp asc, x desc’. The default value is ”.
  CONVERT_WKTS_TO_WKBS: If TRUE, then WKT string columns will be returned as WKB bytes. Supported values:
  TRUE
  FALSE
  The default value is FALSE.
  ROUTE_TO_TOM: For multihead record retrieval without shard key expression - specifies from which tom to retrieve data.
  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 GetRecordsByColumnRequest

​Nested Class Summary

​Constructor Summary

​Method Summary

​Methods inherited from class java.lang.Object

​Constructor Details