com.gpudb.protocol

Class AggregateGroupByRequest

java.lang.Object

com.gpudb.protocol.AggregateGroupByRequest

All Implemented Interfaces:

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

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

A set of parameters for GPUdb.aggregateGroupByRaw(AggregateGroupByRequest).

Calculates unique combinations (groups) of values for the given columns in a given table/view/collection and computes aggregates on each unique combination. This is somewhat analogous to an SQL-style SELECT...GROUP BY. Any column(s) can be grouped on, but only non-string (i.e. numeric) columns may be used for computing aggregates. The results can be paged via the offset and limit parameters. For example, to get 10 groups with the largest counts the inputs would be: limit=10, options={"sort_order":"descending", "sort_by":"value"}. options can be used to customize behavior of this call e.g. filtering or sorting the results. To group by 'x' and 'y' and compute the number of objects within each group, use column_names=['x','y','count(*)']. To also compute the sum of 'z' over each group, use column_names=['x','y','count(*)','sum(z)']. Available aggregation functions are: 'count(*)', 'sum', 'min', 'max', 'avg', 'mean', 'stddev', 'stddev_pop', 'stddev_samp', 'var', 'var_pop', 'var_samp', 'arg_min', 'arg_max' and 'count_distinct'. The response is returned as a dynamic schema. For details see: dynamic schemas documentation. If the 'result_table' option is provided then the results are stored in a table with the name given in the option and the results are not returned in the response. 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	AggregateGroupByRequest.Encoding Specifies the encoding for returned records.
static class	AggregateGroupByRequest.Options Optional parameters.

Constructor Summary

Constructors

Constructor and Description
AggregateGroupByRequest() Constructs an AggregateGroupByRequest object with default parameters.
AggregateGroupByRequest(String tableName, List<String> columnNames, long offset, long limit, Map<String,String> options) Constructs an AggregateGroupByRequest object with the specified parameters.
AggregateGroupByRequest(String tableName, List<String> columnNames, long offset, long limit, String encoding, Map<String,String> options) Constructs an AggregateGroupByRequest 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.
AggregateGroupByRequest	setColumnNames(List<String> columnNames) The Raw version of this method can be used to specify the encoding scheme of the response.
AggregateGroupByRequest	setEncoding(String encoding) The Raw version of this method can be used to specify the encoding scheme of the response.
AggregateGroupByRequest	setLimit(long limit) The Raw version of this method can be used to specify the encoding scheme of the response.
AggregateGroupByRequest	setOffset(long offset) The Raw version of this method can be used to specify the encoding scheme of the response.
AggregateGroupByRequest	setOptions(Map<String,String> options) The Raw version of this method can be used to specify the encoding scheme of the response.
AggregateGroupByRequest	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

AggregateGroupByRequest

public AggregateGroupByRequest()

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

AggregateGroupByRequest

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

Constructs an AggregateGroupByRequest 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 the operation will be performed. Must be a valid table/view/collection in GPUdb.

columnNames - List of one or more column names, expressions, and aggregate expressions. Must include at least one 'grouping' column or expression. If no aggregate is included, count(*) will be computed as a default.

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 Or END_OF_SET (-9999) to indicate that the max number of results should be returned.

options - Optional parameters.

• expression: Filter expression to apply to the table prior to computing the aggregate group by.
• having: Filter expression to apply to the aggregated results.
• sort_order: String indicating how the returned values should be sorted - ascending or descending. Values: ascending, descending.
• sort_by: String determining how the results are sorted. Values: key, value.
• result_table: The name of the table used to store the results. If present no results are returned in the response.

AggregateGroupByRequest

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

Constructs an AggregateGroupByRequest 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 the operation will be performed. Must be a valid table/view/collection in GPUdb.

columnNames - List of one or more column names, expressions, and aggregate expressions. Must include at least one 'grouping' column or expression. If no aggregate is included, count(*) will be computed as a default.

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 Or END_OF_SET (-9999) to indicate that the max number of results should be returned.

encoding - Specifies the encoding for returned records. Values: binary, json.

options - Optional parameters.

• expression: Filter expression to apply to the table prior to computing the aggregate group by.
• having: Filter expression to apply to the aggregated results.
• sort_order: String indicating how the returned values should be sorted - ascending or descending. Values: ascending, descending.
• sort_by: String determining how the results are sorted. Values: key, value.
• result_table: The name of the table used to store the results. If present no results are returned in the response.

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 the operation will be performed. Must be a valid table/view/collection in GPUdb.

setTableName

public AggregateGroupByRequest 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 the operation will be performed. Must be a valid table/view/collection in GPUdb.

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:

List of one or more column names, expressions, and aggregate expressions. Must include at least one 'grouping' column or expression. If no aggregate is included, count(*) will be computed as a default.

setColumnNames

public AggregateGroupByRequest setColumnNames(List<String> columnNames)

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

Parameters:

columnNames - List of one or more column names, expressions, and aggregate expressions. Must include at least one 'grouping' column or expression. If no aggregate is included, count(*) will be computed as a default.

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 AggregateGroupByRequest 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 Or END_OF_SET (-9999) to indicate that the max number of results should be returned.

setLimit

public AggregateGroupByRequest 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 Or END_OF_SET (-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. Values: binary, json.

setEncoding

public AggregateGroupByRequest 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. 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:

Optional parameters.

• expression: Filter expression to apply to the table prior to computing the aggregate group by.
• having: Filter expression to apply to the aggregated results.
• sort_order: String indicating how the returned values should be sorted - ascending or descending. Values: ascending, descending.
• sort_by: String determining how the results are sorted. Values: key, value.
• result_table: The name of the table used to store the results. If present no results are returned in the response.

setOptions

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

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

Parameters:

options - Optional parameters.

• expression: Filter expression to apply to the table prior to computing the aggregate group by.
• having: Filter expression to apply to the aggregated results.
• sort_order: String indicating how the returned values should be sorted - ascending or descending. Values: ascending, descending.
• sort_by: String determining how the results are sorted. Values: key, value.
• result_table: The name of the table used to store the results. If present no results are returned in the response.

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