com.gpudb.protocol

Class 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.getRecordsByColumnRaw(GetRecordsByColumnRequest).

For a given table, retrieves the values of the given columns within a given range. It returns maps of column name to the vector of values for each supported data type (double, float, long, int and string). This operation supports pagination feature, i.e. values that are retrieved are those associated with the indices between the start (offset) and end value (offset + limit) parameters (inclusive). If there are num_points values in the table then each of the indices between 0 and num_points-1 retrieves a unique value.

Note that when using the pagination feature, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records or values retrieved may differ between calls (discontiguous or overlap) based on the type of the update.

The response is returned as a dynamic schema. For details see: dynamic schemas documentation. 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	GetRecordsByColumnRequest.Encoding Specifies the encoding for returned records; either 'binary' or 'json'.
static class	GetRecordsByColumnRequest.Options expression: Optional filter expression to apply to the table.

Constructor Summary

Constructors

Constructor and Description
GetRecordsByColumnRequest() Constructs a GetRecordsByColumnRequest object with default parameters.
GetRecordsByColumnRequest(String tableName, List<String> columnNames, long offset, long limit, Map<String,String> options) Constructs a GetRecordsByColumnRequest object with the specified 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.

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.
List<String>	getColumnNames() The Raw version of this method can be used to specify the encoding scheme of the response.
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.
GetRecordsByColumnRequest	setColumnNames(List<String> columnNames) The Raw version of this method can be used to specify the encoding scheme of the response.
GetRecordsByColumnRequest	setEncoding(String encoding) The Raw version of this method can be used to specify the encoding scheme of the response.
GetRecordsByColumnRequest	setLimit(long limit) The Raw version of this method can be used to specify the encoding scheme of the response.
GetRecordsByColumnRequest	setOffset(long offset) The Raw version of this method can be used to specify the encoding scheme of the response.
GetRecordsByColumnRequest	setOptions(Map<String,String> options) The Raw version of this method can be used to specify the encoding scheme of the response.
GetRecordsByColumnRequest	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

GetRecordsByColumnRequest

public GetRecordsByColumnRequest()

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

GetRecordsByColumnRequest

public GetRecordsByColumnRequest(String tableName,
                                 List<String> columnNames,
                                 long offset,
                                 long limit,
                                 Map<String,String> options)

Constructs a GetRecordsByColumnRequest 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 on which this operation will be performed. The table cannot be a parent set.

columnNames - The list of column values to retrieve. Columns annotated as store only cannot be retrieved.

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 (if not provided the default is 10000). Or END_OF_column (-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. Default is 'ascending'. Ignored if 'sort_by' option is not specified. Values: ascending, descending.

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

Parameters:

tableName - Name of the table on which this operation will be performed. The table cannot be a parent set.

columnNames - The list of column values to retrieve. Columns annotated as store only cannot be retrieved.

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 (if not provided the default is 10000). Or END_OF_column (-9999) to indicate that the max number of results should be returned.

encoding - Specifies the encoding for returned records; either 'binary' or 'json'. 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. Default is 'ascending'. 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 on which this operation will be performed. The table cannot be a parent set.

setTableName

public GetRecordsByColumnRequest 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 on which this operation will be performed. The table cannot be a parent set.

Returns:

this to mimic the builder pattern.

getColumnNames

public List<String> getColumnNames()

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

Returns:

The list of column values to retrieve. Columns annotated as store only cannot be retrieved.

setColumnNames

public GetRecordsByColumnRequest setColumnNames(List<String> columnNames)

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

Parameters:

columnNames - The list of column values to retrieve. Columns annotated as store only cannot be retrieved.

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 GetRecordsByColumnRequest 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 (if not provided the default is 10000). Or END_OF_column (-9999) to indicate that the max number of results should be returned.

setLimit

public GetRecordsByColumnRequest 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 (if not provided the default is 10000). Or END_OF_column (-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; either 'binary' or 'json'. Values: binary, json.

setEncoding

public GetRecordsByColumnRequest 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; either 'binary' or 'json'. 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. Default is 'ascending'. Ignored if 'sort_by' option is not specified. Values: ascending, descending.

setOptions

public GetRecordsByColumnRequest 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. Default is 'ascending'. 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