AggregateGroupByRequest.Options (Kinetica Java API 6.0.1 API)

java.lang.Object
- com.gpudb.protocol.AggregateGroupByRequest.Options

Enclosing class:

AggregateGroupByRequest
```
public static final class AggregateGroupByRequest.Options
extends Object
```
Optional parameters.
- COLLECTION_NAME: Name of a collection which is to contain the table specified in result_table, otherwise the table will be a top-level table. If the collection does not allow duplicate types and it contains a table of the same type as the given one, then this table creation request will fail. Additionally this option is invalid if tableName is a collection.
- 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. 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: 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 KEY.
- RESULT_TABLE: The name of the table used to store the results. Has the same naming restrictions as tables. 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 as a regular table (it will not be automatically cleared unless a ttl is provided, and the table data can be modified in subsequent operations). If false then the result table will be a read-only, memory-only temporary table. Supported values:
  - TRUE
  - FALSE
  The default value is FALSE.
- TTL: Sets the TTL of the table specified in result_table. The value must be the desired TTL in minutes.
A set of string constants for the parameter options.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ASCENDING` Indicates that the returned values should be sorted in ascending order.
`static String`	`COLLECTION_NAME` Name of a collection which is to contain the table specified in `result_table`, otherwise the table will be a top-level table.
`static String`	`DESCENDING` Indicates that the returned values should be sorted in descending order.
`static String`	`EXPRESSION` Filter expression to apply to the table prior to computing the aggregate group by.
`static String`	`FALSE`
`static String`	`HAVING` Filter expression to apply to the aggregated results.
`static String`	`KEY` Indicates that the returned values should be sorted by key, which corresponds to the grouping columns.
`static String`	`RESULT_TABLE` The name of the table used to store the results.
`static String`	`RESULT_TABLE_PERSIST` If `true` then the result table specified in `result_table` will be persisted as a regular table (it will not be automatically cleared unless a `ttl` is provided, and the table data can be modified in subsequent operations).
`static String`	`SORT_BY` String determining how the results are sorted.
`static String`	`SORT_ORDER` String indicating how the returned values should be sorted - ascending or descending.
`static String`	`TRUE`
`static String`	`TTL` Sets the TTL of the table specified in `result_table`.
`static String`	`VALUE` Indicates that the returned values should be sorted by value, which corresponds to the aggregates.

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - COLLECTION_NAME
```
public static final String COLLECTION_NAME
```
    Name of a collection which is to contain the table specified in result_table, otherwise the table will be a top-level table. If the collection does not allow duplicate types and it contains a table of the same type as the given one, then this table creation request will fail. Additionally this option is invalid if tableName is a collection.
    
    See Also:
    Constant Field Values
  - EXPRESSION
```
public static final String EXPRESSION
```
    Filter expression to apply to the table prior to computing the aggregate group by.
    
    See Also:
    Constant Field Values
  - HAVING
```
public static final String HAVING
```
    Filter expression to apply to the aggregated results.
    
    See Also:
    Constant Field Values
  - SORT_ORDER
```
public static final String SORT_ORDER
```
    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.
    See Also:
    Constant Field Values
  - ASCENDING
```
public static final String ASCENDING
```
    Indicates that the returned values should be sorted in ascending order.
    
    See Also:
    Constant Field Values
  - DESCENDING
```
public static final String DESCENDING
```
    Indicates that the returned values should be sorted in descending order.
    
    See Also:
    Constant Field Values
  - SORT_BY
```
public static final String SORT_BY
```
    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 KEY.
    See Also:
    Constant Field Values
  - KEY
```
public static final String 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.
    
    See Also:
    Constant Field Values
  - VALUE
```
public static final String 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.
    
    See Also:
    Constant Field Values
  - RESULT_TABLE
```
public static final String RESULT_TABLE
```
    The name of the table used to store the results. Has the same naming restrictions as tables. 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.
    
    See Also:
    Constant Field Values
  - RESULT_TABLE_PERSIST
```
public static final String RESULT_TABLE_PERSIST
```
    If true then the result table specified in result_table will be persisted as a regular table (it will not be automatically cleared unless a ttl is provided, and the table data can be modified in subsequent operations). If false then the result table will be a read-only, memory-only temporary table. Supported values:
    - TRUE
    - FALSE
    The default value is FALSE.
    See Also:
    Constant Field Values
  - TRUE
```
public static final String TRUE
```
    See Also:
    Constant Field Values
  - FALSE
```
public static final String FALSE
```
    See Also:
    Constant Field Values
  - TTL
```
public static final String TTL
```
    Sets the TTL of the table specified in result_table. The value must be the desired TTL in minutes.
    
    See Also:
    Constant Field Values

Class AggregateGroupByRequest.Options

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

COLLECTION_NAME

EXPRESSION

HAVING

SORT_ORDER

ASCENDING

DESCENDING

SORT_BY

KEY

VALUE

RESULT_TABLE

RESULT_TABLE_PERSIST

TRUE

FALSE

TTL