com.gpudb.protocol

Class GetRecordsFromCollectionRequest

java.lang.Object

com.gpudb.protocol.GetRecordsFromCollectionRequest

All Implemented Interfaces:

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

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

A set of parameters for GPUdb.getRecordsFromCollectionRaw(GetRecordsFromCollectionRequest).

Retrieves records from a collection. The operation can optionally return the record IDs which can be used in certain queries such as GPUdb.deleteRecords(DeleteRecordsRequest).

This operation supports paging through the data via the offset and limit parameters.

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GetRecordsFromCollectionRequest.Encoding Specifies the encoding for returned records; either 'binary' or 'json'.
static class	GetRecordsFromCollectionRequest.Options RETURN_RECORD_IDS: If 'true' then return the internal record ID along with each returned record.

Constructor Summary

Constructors

Constructor and Description
GetRecordsFromCollectionRequest() Constructs a GetRecordsFromCollectionRequest object with default parameters.
GetRecordsFromCollectionRequest(String tableName, long offset, long limit, Map<String,String> options) Constructs a GetRecordsFromCollectionRequest object with the specified parameters.
GetRecordsFromCollectionRequest(String tableName, long offset, long limit, String encoding, Map<String,String> options) Constructs a GetRecordsFromCollectionRequest 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()
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.
GetRecordsFromCollectionRequest	setEncoding(String encoding)
GetRecordsFromCollectionRequest	setLimit(long limit)
GetRecordsFromCollectionRequest	setOffset(long offset)
GetRecordsFromCollectionRequest	setOptions(Map<String,String> options)
GetRecordsFromCollectionRequest	setTableName(String tableName)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetRecordsFromCollectionRequest

public GetRecordsFromCollectionRequest()

Constructs a GetRecordsFromCollectionRequest object with default parameters.

GetRecordsFromCollectionRequest

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

Constructs a GetRecordsFromCollectionRequest object with the specified parameters.

Parameters:

tableName - Name of the collection or table from which records are to be retrieved. Must be an existing collection or table.

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 offset & limit to request subsequent pages of results. The default value is -9999.

options -

• RETURN_RECORD_IDS: If 'true' then return the internal record ID along with each returned record. Default is 'false'. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.

The default value is an empty Map.

GetRecordsFromCollectionRequest

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

Constructs a GetRecordsFromCollectionRequest object with the specified parameters.

Parameters:

tableName - Name of the collection or table from which records are to be retrieved. Must be an existing collection or table.

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 offset & 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 -

• RETURN_RECORD_IDS: If 'true' then return the internal record ID along with each returned record. Default is 'false'. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.

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

Returns:

Name of the collection or table from which records are to be retrieved. Must be an existing collection or table.

setTableName

public GetRecordsFromCollectionRequest setTableName(String tableName)

Parameters:

tableName - Name of the collection or table from which records are to be retrieved. Must be an existing collection or table.

Returns:

this to mimic the builder pattern.

getOffset

public long getOffset()

Returns:

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.

setOffset

public GetRecordsFromCollectionRequest setOffset(long offset)

Parameters:

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.

Returns:

this to mimic the builder pattern.

getLimit

public long getLimit()

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. 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 offset & limit to request subsequent pages of results. The default value is -9999.

setLimit

public GetRecordsFromCollectionRequest setLimit(long limit)

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. 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 offset & limit to request subsequent pages of results. The default value is -9999.

Returns:

this to mimic the builder pattern.

getEncoding

public String getEncoding()

Returns:

Specifies the encoding for returned records; either 'binary' or 'json'. Supported values:

• BINARY
• JSON

The default value is BINARY.

setEncoding

public GetRecordsFromCollectionRequest setEncoding(String encoding)

Parameters:

encoding - Specifies the encoding for returned records; either 'binary' or 'json'. Supported values:

• BINARY
• JSON

The default value is BINARY.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Returns:

• RETURN_RECORD_IDS: If 'true' then return the internal record ID along with each returned record. Default is 'false'. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.

The default value is an empty Map.

setOptions

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

Parameters:

options -

• RETURN_RECORD_IDS: If 'true' then return the internal record ID along with each returned record. Default is 'false'. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.

The default value is an empty Map.

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