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.aggregateGroupBy.

Calculates unique combinations (groups) of values for the given columns in a given table or view and computes aggregates on each unique combination. This is somewhat analogous to an SQL-style SELECT...GROUP BY.

For aggregation details and examples, see Aggregation. For limitations, see Aggregation Limitations.

Any column(s) can be grouped on, and all column types except unrestricted-length strings may be used for computing applicable 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 columns '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.

Available grouping functions are Rollup, Cube, and Grouping Sets

This service also provides support for Pivot operations.

Filtering on aggregates is supported via expressions using aggregation functions supplied to HAVING.

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

If a RESULT\_TABLE name is specified in the options, the results are stored in a new table with that name--no results are returned in the response. Both the table name and resulting column names must adhere to standard naming conventions; column/aggregation expressions will need to be aliased. If the source table's shard key is used as the grouping column(s) and all result records are selected (offset is 0 and limit is -9999), the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available when any of the values of columnNames is an unrestricted-length string.

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static final class

AggregateGroupByRequest.Encoding

A set of string constants for the AggregateGroupByRequest parameter encoding.

static final class

AggregateGroupByRequest.Options

A set of string constants for the AggregateGroupByRequest parameter options.
Constructor Summary

Constructors

Constructor

Description

AggregateGroupByRequest()

Constructs an AggregateGroupByRequest object with default 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.

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

Constructs an AggregateGroupByRequest 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()

List of one or more column names, expressions, and aggregate expressions.

String

getEncoding()

Specifies the encoding for returned records.

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

Optional parameters.

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 an existing table or view on which the 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.

AggregateGroupByRequest

setColumnNames(List\<String> columnNames)

List of one or more column names, expressions, and aggregate expressions.

AggregateGroupByRequest

setEncoding(String encoding)

Specifies the encoding for returned records.

AggregateGroupByRequest

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.

AggregateGroupByRequest

setOffset(long offset)

A positive integer indicating the number of initial results to skip (this can be useful for paging through the results).

AggregateGroupByRequest

setOptions(Map\<String,String> options)

Optional parameters.

AggregateGroupByRequest

setTableName(String tableName)

Name of an existing table or view on which the 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
- AggregateGroupByRequest
  
  public AggregateGroupByRequest()
  
  Constructs an AggregateGroupByRequest object with default parameters.
- AggregateGroupByRequest
  
  public AggregateGroupByRequest(String tableName, List\<String> columnNames, long offset, long limit, Map\<String,String> options)
  
  Constructs an AggregateGroupByRequest object with the specified parameters.
  Parameters:
  
  tableName - Name of an existing table or view on which the operation will be performed, in \[schema\_name.]table\_name format, using standard name resolution rules.
  
  columnNames - List of one or more column names, expressions, and aggregate expressions.
  
  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 - Optional parameters.
  
  CREATE\_TEMP\_TABLE: If TRUE, a unique temporary table name will be generated in the sys\_temp schema and used in place of RESULT\_TABLE. If RESULT\_TABLE\_PERSIST is FALSE (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in QUALIFIED\_RESULT\_TABLE\_NAME. Supported values:
  
  TRUE
  
  FALSE
  
  The default value is FALSE.
  
  COLLECTION\_NAME: \[DEPRECATED--please specify the containing schema as part of RESULT\_TABLE and use GPUdb.createSchema to create the schema if non-existent] Name of a schema which is to contain the table specified in RESULT\_TABLE. If the schema provided is non-existent, it will be automatically created.
  
  EXPRESSION: Filter expression to apply to the table prior to computing the aggregate group by.
  
  PIPELINED\_EXPRESSION\_EVALUATION: Evaluate the group-by during last JoinedSet filter plan step. Supported values:
  
  TRUE
  
  FALSE
  
  The default value is FALSE.
  
  HAVING: Filter expression to apply to the aggregated results.
  
  SORT\_ORDER: \[DEPRECATED--use order\_by instead] String indicating how the returned values should be sorted - ascending or descending. Supported values:
  
  ASCENDING: Indicates that the returned values should be sorted in ascending order.
  
  DESCENDING: Indicates that the returned values should be sorted in descending order.
  
  The default value is ASCENDING.
  
  SORT\_BY: \[DEPRECATED--use order\_by instead] String determining how the results are sorted. Supported values:
  
  KEY: Indicates that the returned values should be sorted by key, which corresponds to the grouping columns. If you have multiple grouping columns (and are sorting by key), it will first sort the first grouping column, then the second grouping column, etc.
  
  VALUE: Indicates that the returned values should be sorted by value, which corresponds to the aggregates. If you have multiple aggregates (and are sorting by value), it will first sort by the first aggregate, then the second aggregate, etc.
  
  The default value is VALUE.
  
  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 ''.
  
  STRATEGY\_DEFINITION: The tier strategy for the table and its columns.
  
  COMPRESSION\_CODEC: The default compression codec for the result table's columns.
  
  RESULT\_TABLE: The name of a table used to store the results, in \[schema\_name.]table\_name format, using standard name resolution rules and meeting table naming criteria. Column names (group-by and aggregate fields) need to be given aliases e.g. \["FChar256 as fchar256", "sum(FDouble) as sfd"]. If present, no results are returned in the response. This option is not available if one of the grouping attributes is an unrestricted string (i.e.; not charN) type.
  
  RESULT\_TABLE\_PERSIST: If TRUE, then the result table specified in RESULT\_TABLE will be persisted and will not expire unless a TTL is specified. If FALSE, then the result table will be an in-memory table and will expire unless a TTL is specified otherwise. Supported values:
  
  TRUE
  
  FALSE
  
  The default value is FALSE.
  
  RESULT\_TABLE\_FORCE\_REPLICATED: Force the result table to be replicated (ignores any sharding). Must be used in combination with the RESULT\_TABLE option. Supported values:
  
  TRUE
  
  FALSE
  
  The default value is FALSE.
  
  RESULT\_TABLE\_GENERATE\_PK: If TRUE then set a primary key for the result table. Must be used in combination with the RESULT\_TABLE option. Supported values:
  
  TRUE
  
  FALSE
  
  The default value is FALSE.
  
  RESULT\_TABLE\_GENERATE\_SOFT\_PK: If TRUE then set a soft primary key for the result table. Must be used in combination with the RESULT\_TABLE option. Supported values:
  
  TRUE
  
  FALSE
  
  The default value is FALSE.
  
  TTL: Sets the TTL of the table specified in RESULT\_TABLE.
  
  CHUNK\_SIZE: Indicates the number of records per chunk to be used for the result table. Must be used in combination with the RESULT\_TABLE option.
  
  CHUNK\_COLUMN\_MAX\_MEMORY: Indicates the target maximum data size for each column in a chunk to be used for the result table. Must be used in combination with the RESULT\_TABLE option.
  
  CHUNK\_MAX\_MEMORY: Indicates the target maximum data size for all columns in a chunk to be used for the result table. Must be used in combination with the RESULT\_TABLE option.
  
  CREATE\_INDEXES: Comma-separated list of columns on which to create indexes on the result table. Must be used in combination with the RESULT\_TABLE option.
  
  PARTITION\_TYPE: Partitioning scheme to use for the result table. Supported values:
  
  RANGE: Use range partitioning.
  
  INTERVAL: Use interval partitioning.
  
  LIST: Use list partitioning.
  
  HASH: Use hash partitioning.
  
  SERIES: Use series partitioning.
  
  PARTITION\_KEYS: Comma-separated list of partition keys, which are the columns or column expressions by which records will be assigned to partitions defined by PARTITION\_DEFINITIONS.
  
  PARTITION\_DEFINITIONS: Comma-separated list of partition definitions, whose format depends on the choice of PARTITION\_TYPE. See range partitioning, interval partitioning, list partitioning, hash partitioning, or series partitioning for example formats.
  
  IS\_AUTOMATIC\_PARTITION: If TRUE, a new partition will be created for values which don't fall into an existing partition. Currently only supported for list partitions. Supported values:
  
  TRUE
  
  FALSE
  
  The default value is FALSE.
  
  VIEW\_ID: ID of view of which the result table will be a member. The default value is ''.
  
  PIVOT: Pivot column.
  
  PIVOT\_VALUES: Comma-separated list of the values in the PIVOT column. The list provided will become the column header prefixes in the output.
  
  GROUPING\_SETS: Customize the grouping attribute sets to compute the aggregates. These sets can include ROLLUP or CUBE operators. The attribute sets should be enclosed in parentheses and can include composite attributes. All attributes specified in the grouping sets must present in the group-by attributes.
  
  ROLLUP: This option is used to specify the multilevel aggregates.
  
  CUBE: This option is used to specify the multidimensional aggregates.
  
  SHARD\_KEY: Comma-separated list of the columns to be sharded on; e.g. 'column1, column2'. The columns specified must be present in columnNames. If any alias is given for any column name, the alias must be used, rather than the original column name. The default value is ''.
  
  The default value is an empty Map.
- 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.
  Parameters:
  
  tableName - Name of an existing table or view on which the operation will be performed, in \[schema\_name.]table\_name format, using standard name resolution rules.
  
  columnNames - List of one or more column names, expressions, and aggregate expressions.
  
  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. Supported values:
  
  BINARY: Indicates that the returned records should be binary encoded.
  
  JSON: Indicates that the returned records should be JSON-encoded.
  
  The default value is BINARY.
  
  options - Optional parameters.
  
  CREATE\_TEMP\_TABLE: If TRUE, a unique temporary table name will be generated in the sys\_temp schema and used in place of RESULT\_TABLE. If RESULT\_TABLE\_PERSIST is FALSE (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in QUALIFIED\_RESULT\_TABLE\_NAME. Supported values:
  
  TRUE
  
  FALSE
  
  The default value is FALSE.
  
  COLLECTION\_NAME: \[DEPRECATED--please specify the containing schema as part of RESULT\_TABLE and use GPUdb.createSchema to create the schema if non-existent] Name of a schema which is to contain the table specified in RESULT\_TABLE. If the schema provided is non-existent, it will be automatically created.
  
  EXPRESSION: Filter expression to apply to the table prior to computing the aggregate group by.
  
  PIPELINED\_EXPRESSION\_EVALUATION: Evaluate the group-by during last JoinedSet filter plan step. Supported values:
  
  TRUE
  
  FALSE
  
  The default value is FALSE.
  
  HAVING: Filter expression to apply to the aggregated results.
  
  SORT\_ORDER: \[DEPRECATED--use order\_by instead] String indicating how the returned values should be sorted - ascending or descending. Supported values:
  
  ASCENDING: Indicates that the returned values should be sorted in ascending order.
  
  DESCENDING: Indicates that the returned values should be sorted in descending order.
  
  The default value is ASCENDING.
  
  SORT\_BY: \[DEPRECATED--use order\_by instead] String determining how the results are sorted. Supported values:
  
  KEY: Indicates that the returned values should be sorted by key, which corresponds to the grouping columns. If you have multiple grouping columns (and are sorting by key), it will first sort the first grouping column, then the second grouping column, etc.
  
  VALUE: Indicates that the returned values should be sorted by value, which corresponds to the aggregates. If you have multiple aggregates (and are sorting by value), it will first sort by the first aggregate, then the second aggregate, etc.
  
  The default value is VALUE.
  
  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 ''.
  
  STRATEGY\_DEFINITION: The tier strategy for the table and its columns.
  
  COMPRESSION\_CODEC: The default compression codec for the result table's columns.
  
  RESULT\_TABLE: The name of a table used to store the results, in \[schema\_name.]table\_name format, using standard name resolution rules and meeting table naming criteria. Column names (group-by and aggregate fields) need to be given aliases e.g. \["FChar256 as fchar256", "sum(FDouble) as sfd"]. If present, no results are returned in the response. This option is not available if one of the grouping attributes is an unrestricted string (i.e.; not charN) type.
  
  RESULT\_TABLE\_PERSIST: If TRUE, then the result table specified in RESULT\_TABLE will be persisted and will not expire unless a TTL is specified. If FALSE, then the result table will be an in-memory table and will expire unless a TTL is specified otherwise. Supported values:
  
  TRUE
  
  FALSE
  
  The default value is FALSE.
  
  RESULT\_TABLE\_FORCE\_REPLICATED: Force the result table to be replicated (ignores any sharding). Must be used in combination with the RESULT\_TABLE option. Supported values:
  
  TRUE
  
  FALSE
  
  The default value is FALSE.
  
  RESULT\_TABLE\_GENERATE\_PK: If TRUE then set a primary key for the result table. Must be used in combination with the RESULT\_TABLE option. Supported values:
  
  TRUE
  
  FALSE
  
  The default value is FALSE.
  
  RESULT\_TABLE\_GENERATE\_SOFT\_PK: If TRUE then set a soft primary key for the result table. Must be used in combination with the RESULT\_TABLE option. Supported values:
  
  TRUE
  
  FALSE
  
  The default value is FALSE.
  
  TTL: Sets the TTL of the table specified in RESULT\_TABLE.
  
  CHUNK\_SIZE: Indicates the number of records per chunk to be used for the result table. Must be used in combination with the RESULT\_TABLE option.
  
  CHUNK\_COLUMN\_MAX\_MEMORY: Indicates the target maximum data size for each column in a chunk to be used for the result table. Must be used in combination with the RESULT\_TABLE option.
  
  CHUNK\_MAX\_MEMORY: Indicates the target maximum data size for all columns in a chunk to be used for the result table. Must be used in combination with the RESULT\_TABLE option.
  
  CREATE\_INDEXES: Comma-separated list of columns on which to create indexes on the result table. Must be used in combination with the RESULT\_TABLE option.
  
  PARTITION\_TYPE: Partitioning scheme to use for the result table. Supported values:
  
  RANGE: Use range partitioning.
  
  INTERVAL: Use interval partitioning.
  
  LIST: Use list partitioning.
  
  HASH: Use hash partitioning.
  
  SERIES: Use series partitioning.
  
  PARTITION\_KEYS: Comma-separated list of partition keys, which are the columns or column expressions by which records will be assigned to partitions defined by PARTITION\_DEFINITIONS.
  
  PARTITION\_DEFINITIONS: Comma-separated list of partition definitions, whose format depends on the choice of PARTITION\_TYPE. See range partitioning, interval partitioning, list partitioning, hash partitioning, or series partitioning for example formats.
  
  IS\_AUTOMATIC\_PARTITION: If TRUE, a new partition will be created for values which don't fall into an existing partition. Currently only supported for list partitions. Supported values:
  
  TRUE
  
  FALSE
  
  The default value is FALSE.
  
  VIEW\_ID: ID of view of which the result table will be a member. The default value is ''.
  
  PIVOT: Pivot column.
  
  PIVOT\_VALUES: Comma-separated list of the values in the PIVOT column. The list provided will become the column header prefixes in the output.
  
  GROUPING\_SETS: Customize the grouping attribute sets to compute the aggregates. These sets can include ROLLUP or CUBE operators. The attribute sets should be enclosed in parentheses and can include composite attributes. All attributes specified in the grouping sets must present in the group-by attributes.
  
  ROLLUP: This option is used to specify the multilevel aggregates.
  
  CUBE: This option is used to specify the multidimensional aggregates.
  
  SHARD\_KEY: Comma-separated list of the columns to be sharded on; e.g. 'column1, column2'. The columns specified must be present in columnNames. If any alias is given for any column name, the alias must be used, rather than the original column name. The default value is ''.
  
  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 an existing table or view on which the operation will be performed, in \[schema\_name.]table\_name format, using standard name resolution rules.
  
  Returns:
  
  The current value of tableName.
- setTableName
  
  public AggregateGroupByRequest setTableName(String tableName)
  
  Name of an existing table or view on which the operation will be performed, in \[schema\_name.]table\_name format, using standard name resolution rules.
  
  Parameters:
  
  tableName - The new value for tableName.
  
  Returns:
  
  this to mimic the builder pattern.
- getColumnNames
  
  public List\<String> getColumnNames()
  
  List of one or more column names, expressions, and aggregate expressions.
  
  Returns:
  
  The current value of columnNames.
- setColumnNames
  
  public AggregateGroupByRequest setColumnNames(List\<String> columnNames)
  
  List of one or more column names, expressions, and aggregate expressions.
  
  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 AggregateGroupByRequest 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 AggregateGroupByRequest 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. Supported values:
  
  BINARY: Indicates that the returned records should be binary encoded.
  
  JSON: Indicates that the returned records should be JSON-encoded.
  
  The default value is BINARY.
  Returns:
  
  The current value of encoding.
- setEncoding
  
  public AggregateGroupByRequest setEncoding(String encoding)
  Specifies the encoding for returned records. Supported values:
  
  BINARY: Indicates that the returned records should be binary encoded.
  
  JSON: Indicates that the returned records should be JSON-encoded.
  
  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()
  Optional parameters.
  
  CREATE\_TEMP\_TABLE: If TRUE, a unique temporary table name will be generated in the sys\_temp schema and used in place of RESULT\_TABLE. If RESULT\_TABLE\_PERSIST is FALSE (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in QUALIFIED\_RESULT\_TABLE\_NAME. Supported values:
  
  TRUE
  
  FALSE
  
  The default value is FALSE.
  
  COLLECTION\_NAME: \[DEPRECATED--please specify the containing schema as part of RESULT\_TABLE and use GPUdb.createSchema to create the schema if non-existent] Name of a schema which is to contain the table specified in RESULT\_TABLE. If the schema provided is non-existent, it will be automatically created.
  
  EXPRESSION: Filter expression to apply to the table prior to computing the aggregate group by.
  
  PIPELINED\_EXPRESSION\_EVALUATION: Evaluate the group-by during last JoinedSet filter plan step. Supported values:
  
  TRUE
  
  FALSE
  
  The default value is FALSE.
  
  HAVING: Filter expression to apply to the aggregated results.
  
  SORT\_ORDER: \[DEPRECATED--use order\_by instead] String indicating how the returned values should be sorted - ascending or descending. Supported values:
  
  ASCENDING: Indicates that the returned values should be sorted in ascending order.
  
  DESCENDING: Indicates that the returned values should be sorted in descending order.
  
  The default value is ASCENDING.
  
  SORT\_BY: \[DEPRECATED--use order\_by instead] String determining how the results are sorted. Supported values:
  
  KEY: Indicates that the returned values should be sorted by key, which corresponds to the grouping columns. If you have multiple grouping columns (and are sorting by key), it will first sort the first grouping column, then the second grouping column, etc.
  
  VALUE: Indicates that the returned values should be sorted by value, which corresponds to the aggregates. If you have multiple aggregates (and are sorting by value), it will first sort by the first aggregate, then the second aggregate, etc.
  
  The default value is VALUE.
  
  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 ''.
  
  STRATEGY\_DEFINITION: The tier strategy for the table and its columns.
  
  COMPRESSION\_CODEC: The default compression codec for the result table's columns.
  
  RESULT\_TABLE: The name of a table used to store the results, in \[schema\_name.]table\_name format, using standard name resolution rules and meeting table naming criteria. Column names (group-by and aggregate fields) need to be given aliases e.g. \["FChar256 as fchar256", "sum(FDouble) as sfd"]. If present, no results are returned in the response. This option is not available if one of the grouping attributes is an unrestricted string (i.e.; not charN) type.
  
  RESULT\_TABLE\_PERSIST: If TRUE, then the result table specified in RESULT\_TABLE will be persisted and will not expire unless a TTL is specified. If FALSE, then the result table will be an in-memory table and will expire unless a TTL is specified otherwise. Supported values:
  
  TRUE
  
  FALSE
  
  The default value is FALSE.
  
  RESULT\_TABLE\_FORCE\_REPLICATED: Force the result table to be replicated (ignores any sharding). Must be used in combination with the RESULT\_TABLE option. Supported values:
  
  TRUE
  
  FALSE
  
  The default value is FALSE.
  
  RESULT\_TABLE\_GENERATE\_PK: If TRUE then set a primary key for the result table. Must be used in combination with the RESULT\_TABLE option. Supported values:
  
  TRUE
  
  FALSE
  
  The default value is FALSE.
  
  RESULT\_TABLE\_GENERATE\_SOFT\_PK: If TRUE then set a soft primary key for the result table. Must be used in combination with the RESULT\_TABLE option. Supported values:
  
  TRUE
  
  FALSE
  
  The default value is FALSE.
  
  TTL: Sets the TTL of the table specified in RESULT\_TABLE.
  
  CHUNK\_SIZE: Indicates the number of records per chunk to be used for the result table. Must be used in combination with the RESULT\_TABLE option.
  
  CHUNK\_COLUMN\_MAX\_MEMORY: Indicates the target maximum data size for each column in a chunk to be used for the result table. Must be used in combination with the RESULT\_TABLE option.
  
  CHUNK\_MAX\_MEMORY: Indicates the target maximum data size for all columns in a chunk to be used for the result table. Must be used in combination with the RESULT\_TABLE option.
  
  CREATE\_INDEXES: Comma-separated list of columns on which to create indexes on the result table. Must be used in combination with the RESULT\_TABLE option.
  
  PARTITION\_TYPE: Partitioning scheme to use for the result table. Supported values:
  
  RANGE: Use range partitioning.
  
  INTERVAL: Use interval partitioning.
  
  LIST: Use list partitioning.
  
  HASH: Use hash partitioning.
  
  SERIES: Use series partitioning.
  
  PARTITION\_KEYS: Comma-separated list of partition keys, which are the columns or column expressions by which records will be assigned to partitions defined by PARTITION\_DEFINITIONS.
  
  PARTITION\_DEFINITIONS: Comma-separated list of partition definitions, whose format depends on the choice of PARTITION\_TYPE. See range partitioning, interval partitioning, list partitioning, hash partitioning, or series partitioning for example formats.
  
  IS\_AUTOMATIC\_PARTITION: If TRUE, a new partition will be created for values which don't fall into an existing partition. Currently only supported for list partitions. Supported values:
  
  TRUE
  
  FALSE
  
  The default value is FALSE.
  
  VIEW\_ID: ID of view of which the result table will be a member. The default value is ''.
  
  PIVOT: Pivot column.
  
  PIVOT\_VALUES: Comma-separated list of the values in the PIVOT column. The list provided will become the column header prefixes in the output.
  
  GROUPING\_SETS: Customize the grouping attribute sets to compute the aggregates. These sets can include ROLLUP or CUBE operators. The attribute sets should be enclosed in parentheses and can include composite attributes. All attributes specified in the grouping sets must present in the group-by attributes.
  
  ROLLUP: This option is used to specify the multilevel aggregates.
  
  CUBE: This option is used to specify the multidimensional aggregates.
  
  SHARD\_KEY: Comma-separated list of the columns to be sharded on; e.g. 'column1, column2'. The columns specified must be present in columnNames. If any alias is given for any column name, the alias must be used, rather than the original column name. The default value is ''.
  
  The default value is an empty Map.
  Returns:
  
  The current value of options.
- setOptions
  
  public AggregateGroupByRequest setOptions(Map\<String,String> options)
  Optional parameters.
  
  CREATE\_TEMP\_TABLE: If TRUE, a unique temporary table name will be generated in the sys\_temp schema and used in place of RESULT\_TABLE. If RESULT\_TABLE\_PERSIST is FALSE (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in QUALIFIED\_RESULT\_TABLE\_NAME. Supported values:
  
  TRUE
  
  FALSE
  
  The default value is FALSE.
  
  COLLECTION\_NAME: \[DEPRECATED--please specify the containing schema as part of RESULT\_TABLE and use GPUdb.createSchema to create the schema if non-existent] Name of a schema which is to contain the table specified in RESULT\_TABLE. If the schema provided is non-existent, it will be automatically created.
  
  EXPRESSION: Filter expression to apply to the table prior to computing the aggregate group by.
  
  PIPELINED\_EXPRESSION\_EVALUATION: Evaluate the group-by during last JoinedSet filter plan step. Supported values:
  
  TRUE
  
  FALSE
  
  The default value is FALSE.
  
  HAVING: Filter expression to apply to the aggregated results.
  
  SORT\_ORDER: \[DEPRECATED--use order\_by instead] String indicating how the returned values should be sorted - ascending or descending. Supported values:
  
  ASCENDING: Indicates that the returned values should be sorted in ascending order.
  
  DESCENDING: Indicates that the returned values should be sorted in descending order.
  
  The default value is ASCENDING.
  
  SORT\_BY: \[DEPRECATED--use order\_by instead] String determining how the results are sorted. Supported values:
  
  KEY: Indicates that the returned values should be sorted by key, which corresponds to the grouping columns. If you have multiple grouping columns (and are sorting by key), it will first sort the first grouping column, then the second grouping column, etc.
  
  VALUE: Indicates that the returned values should be sorted by value, which corresponds to the aggregates. If you have multiple aggregates (and are sorting by value), it will first sort by the first aggregate, then the second aggregate, etc.
  
  The default value is VALUE.
  
  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 ''.
  
  STRATEGY\_DEFINITION: The tier strategy for the table and its columns.
  
  COMPRESSION\_CODEC: The default compression codec for the result table's columns.
  
  RESULT\_TABLE: The name of a table used to store the results, in \[schema\_name.]table\_name format, using standard name resolution rules and meeting table naming criteria. Column names (group-by and aggregate fields) need to be given aliases e.g. \["FChar256 as fchar256", "sum(FDouble) as sfd"]. If present, no results are returned in the response. This option is not available if one of the grouping attributes is an unrestricted string (i.e.; not charN) type.
  
  RESULT\_TABLE\_PERSIST: If TRUE, then the result table specified in RESULT\_TABLE will be persisted and will not expire unless a TTL is specified. If FALSE, then the result table will be an in-memory table and will expire unless a TTL is specified otherwise. Supported values:
  
  TRUE
  
  FALSE
  
  The default value is FALSE.
  
  RESULT\_TABLE\_FORCE\_REPLICATED: Force the result table to be replicated (ignores any sharding). Must be used in combination with the RESULT\_TABLE option. Supported values:
  
  TRUE
  
  FALSE
  
  The default value is FALSE.
  
  RESULT\_TABLE\_GENERATE\_PK: If TRUE then set a primary key for the result table. Must be used in combination with the RESULT\_TABLE option. Supported values:
  
  TRUE
  
  FALSE
  
  The default value is FALSE.
  
  RESULT\_TABLE\_GENERATE\_SOFT\_PK: If TRUE then set a soft primary key for the result table. Must be used in combination with the RESULT\_TABLE option. Supported values:
  
  TRUE
  
  FALSE
  
  The default value is FALSE.
  
  TTL: Sets the TTL of the table specified in RESULT\_TABLE.
  
  CHUNK\_SIZE: Indicates the number of records per chunk to be used for the result table. Must be used in combination with the RESULT\_TABLE option.
  
  CHUNK\_COLUMN\_MAX\_MEMORY: Indicates the target maximum data size for each column in a chunk to be used for the result table. Must be used in combination with the RESULT\_TABLE option.
  
  CHUNK\_MAX\_MEMORY: Indicates the target maximum data size for all columns in a chunk to be used for the result table. Must be used in combination with the RESULT\_TABLE option.
  
  CREATE\_INDEXES: Comma-separated list of columns on which to create indexes on the result table. Must be used in combination with the RESULT\_TABLE option.
  
  PARTITION\_TYPE: Partitioning scheme to use for the result table. Supported values:
  
  RANGE: Use range partitioning.
  
  INTERVAL: Use interval partitioning.
  
  LIST: Use list partitioning.
  
  HASH: Use hash partitioning.
  
  SERIES: Use series partitioning.
  
  PARTITION\_KEYS: Comma-separated list of partition keys, which are the columns or column expressions by which records will be assigned to partitions defined by PARTITION\_DEFINITIONS.
  
  PARTITION\_DEFINITIONS: Comma-separated list of partition definitions, whose format depends on the choice of PARTITION\_TYPE. See range partitioning, interval partitioning, list partitioning, hash partitioning, or series partitioning for example formats.
  
  IS\_AUTOMATIC\_PARTITION: If TRUE, a new partition will be created for values which don't fall into an existing partition. Currently only supported for list partitions. Supported values:
  
  TRUE
  
  FALSE
  
  The default value is FALSE.
  
  VIEW\_ID: ID of view of which the result table will be a member. The default value is ''.
  
  PIVOT: Pivot column.
  
  PIVOT\_VALUES: Comma-separated list of the values in the PIVOT column. The list provided will become the column header prefixes in the output.
  
  GROUPING\_SETS: Customize the grouping attribute sets to compute the aggregates. These sets can include ROLLUP or CUBE operators. The attribute sets should be enclosed in parentheses and can include composite attributes. All attributes specified in the grouping sets must present in the group-by attributes.
  
  ROLLUP: This option is used to specify the multilevel aggregates.
  
  CUBE: This option is used to specify the multidimensional aggregates.
  
  SHARD\_KEY: Comma-separated list of the columns to be sharded on; e.g. 'column1, column2'. The columns specified must be present in columnNames. If any alias is given for any column name, the alias must be used, rather than the original column name. The default value is ''.
  
  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 AggregateGroupByRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

AggregateGroupByRequest

AggregateGroupByRequest

AggregateGroupByRequest

Method Details

getClassSchema

getTableName

setTableName

getColumnNames

setColumnNames

getOffset

setOffset

getLimit

setLimit

getEncoding

setEncoding

getOptions

setOptions

getSchema

get

put

equals

toString

hashCode