com.gpudb.protocol

Class AggregateGroupByRequest.Options

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. If the collection provided is non-existent, the collection will be automatically created. If empty, then the table will be a top-level table.
• 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 VALUE.
• 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 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.
• 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.
• 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.
• VIEW_ID: ID of view of which the result table will be a member. The default value is ''.
• MATERIALIZE_ON_GPU: No longer used. See Resource Management Concepts for information about how resources are managed, Tier Strategy Concepts for how resources are targeted for VRAM, and Tier Strategy Usage for how to specify a table's priority in VRAM. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• PIVOT: pivot column
• PIVOT_VALUES: The value list provided will become the column headers in the output. Should be the values from the pivot_column.
• GROUPING_SETS: Customize the grouping attribute sets to compute the aggregates. These sets can include ROLLUP or CUBE operartors. The attribute sets should be enclosed in paranthesis and can include composite attributes. All attributes specified in the grouping sets must present in the groupby attributes.
• ROLLUP: This option is used to specify the multilevel aggregates.
• CUBE: This option is used to specify the multidimensional aggregates.

The default value is an empty Map. 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	CHUNK_SIZE Indicates the number of records per chunk to be used for the result table.
static String	COLLECTION_NAME Name of a collection which is to contain the table specified in result_table.
static String	CREATE_INDEXES Comma-separated list of columns on which to create indexes on the result table.
static String	CUBE This option is used to specify the multidimensional aggregates.
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	GROUPING_SETS Customize the grouping attribute sets to compute the aggregates.
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	MATERIALIZE_ON_GPU No longer used.
static String	PIVOT pivot column
static String	PIVOT_VALUES The value list provided will become the column headers in the output.
static String	RESULT_TABLE The name of the table used to store the results.
static String	RESULT_TABLE_FORCE_REPLICATED Force the result table to be replicated (ignores any sharding).
static String	RESULT_TABLE_GENERATE_PK If true then set a primary key for the result table.
static String	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.
static String	ROLLUP This option is used to specify the multilevel aggregates.
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.
static String	VIEW_ID ID of view of which the result table will be a member.

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. If the collection provided is non-existent, the collection will be automatically created. If empty, then the table will be a top-level table.

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

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

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

RESULT_TABLE_FORCE_REPLICATED

public static final String 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.

See Also:

Constant Field Values

RESULT_TABLE_GENERATE_PK

public static final String 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.

See Also:

Constant Field Values

TTL

public static final String TTL

Sets the TTL of the table specified in result_table.

See Also:

Constant Field Values

CHUNK_SIZE

public static final String 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.

See Also:

Constant Field Values

CREATE_INDEXES

public static final String 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.

See Also:

Constant Field Values

VIEW_ID

public static final String VIEW_ID

ID of view of which the result table will be a member. The default value is ''.

See Also:

Constant Field Values

MATERIALIZE_ON_GPU

public static final String MATERIALIZE_ON_GPU

No longer used. See Resource Management Concepts for information about how resources are managed, Tier Strategy Concepts for how resources are targeted for VRAM, and Tier Strategy Usage for how to specify a table's priority in VRAM. Supported values:

• TRUE
• FALSE

The default value is FALSE.

See Also:

Constant Field Values

PIVOT

public static final String PIVOT

pivot column

See Also:

Constant Field Values

PIVOT_VALUES

public static final String PIVOT_VALUES

The value list provided will become the column headers in the output. Should be the values from the pivot_column.

See Also:

Constant Field Values

GROUPING_SETS

public static final String GROUPING_SETS

Customize the grouping attribute sets to compute the aggregates. These sets can include ROLLUP or CUBE operartors. The attribute sets should be enclosed in paranthesis and can include composite attributes. All attributes specified in the grouping sets must present in the groupby attributes.

See Also:

Constant Field Values

ROLLUP

public static final String ROLLUP

This option is used to specify the multilevel aggregates.

See Also:

Constant Field Values

CUBE

public static final String CUBE

This option is used to specify the multidimensional aggregates.

See Also:

Constant Field Values