Skip to main content

A set of string constants for the parameter AggregateGroupByRequest.options. More…

​
Static Public Attributes

const string CREATE_TEMP_TABLE = “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.
 
const string TRUE = “true”
 A boolean constant for the AggregateGroupByRequest.Options options.
 
const string FALSE = “false”
 A boolean constant for the AggregateGroupByRequest.Options options.
 
const string COLLECTION_NAME = “collection_name”
 [DEPRECATED–please specify the containing schema as part of RESULT_TABLE and use Kinetica.createSchema to create the schema if non-existent] Name of a schema which is to contain the table specified in RESULT_TABLE.
 
const string EXPRESSION = “expression”
 Filter expression to apply to the table prior to computing the aggregate group by.
 
const string PIPELINED_EXPRESSION_EVALUATION = “pipelined_expression_evaluation”
 Evaluate the group-by during last JoinedSet filter plan step.
 
const string HAVING = “having”
 Filter expression to apply to the aggregated results.
 
const string SORT_ORDER = “sort_order”
 [DEPRECATED–use order_by instead] String indicating how the returned values should be sorted - ascending or descending.
 
const string ASCENDING = “ascending”
 Indicates that the returned values should be sorted in ascending order.
 
const string DESCENDING = “descending”
 Indicates that the returned values should be sorted in descending order.
 
const string SORT_BY = “sort_by”
 [DEPRECATED–use order_by instead] String determining how the results are sorted.
 
const string KEY = “key”
 Indicates that the returned values should be sorted by key, which corresponds to the grouping columns.
 
const string VALUE = “value”
 Indicates that the returned values should be sorted by value, which corresponds to the aggregates.
 
const string ORDER_BY = “order_by”
 Comma-separated list of the columns to be sorted by as well as the sort direction, e.g., ‘timestamp asc, x desc’.
 
const string STRATEGY_DEFINITION = “strategy_definition”
 The tier strategy for the table and its columns.
 
const string COMPRESSION_CODEC = “compression_codec”
 The default compression codec for the result table’s columns.
 
const string RESULT_TABLE = “result_table”
 The name of a table used to store the results, in [schema_name.
 
const string RESULT_TABLE_PERSIST = “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.
 
const string RESULT_TABLE_FORCE_REPLICATED = “result_table_force_replicated”
 Force the result table to be replicated (ignores any sharding).
 
const string RESULT_TABLE_GENERATE_PK = “result_table_generate_pk”
 If TRUE then set a primary key for the result table.
 
const string RESULT_TABLE_GENERATE_SOFT_PK = “result_table_generate_soft_pk”
 If TRUE then set a soft primary key for the result table.
 
const string TTL = “ttl”
 Sets the TTL of the table specified in RESULT_TABLE.
 
const string CHUNK_SIZE = “chunk_size”
 Indicates the number of records per chunk to be used for the result table.
 
const string CHUNK_COLUMN_MAX_MEMORY = “chunk_column_max_memory”
 Indicates the target maximum data size for each column in a chunk to be used for the result table.
 
const string CHUNK_MAX_MEMORY = “chunk_max_memory”
 Indicates the target maximum data size for all columns in a chunk to be used for the result table.
 
const string CREATE_INDEXES = “create_indexes”
 Comma-separated list of columns on which to create indexes on the result table.
 
const string PARTITION_TYPE = “partition_type”
 Partitioning scheme to use for the result table.
 
const string RANGE = “RANGE”
 Use range partitioning.
 
const string INTERVAL = “INTERVAL”
 Use interval partitioning.
 
const string LIST = “LIST”
 Use list partitioning.
 
const string HASH = “HASH”
 Use hash partitioning.
 
const string SERIES = “SERIES”
 Use series partitioning.
 
const string PARTITION_KEYS = “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.
 
const string PARTITION_DEFINITIONS = “partition_definitions”
 Comma-separated list of partition definitions, whose format depends on the choice of PARTITION_TYPE.
 
const string IS_AUTOMATIC_PARTITION = “is_automatic_partition”
 If TRUE, a new partition will be created for values which don’t fall into an existing partition.
 
const string VIEW_ID = “view_id”
 ID of view of which the result table will be a member.
 
const string PIVOT = “pivot”
 Pivot column.
 
const string PIVOT_VALUES = “pivot_values”
 Comma-separated list of the values in the PIVOT column.
 
const string GROUPING_SETS = “grouping_sets”
 Customize the grouping attribute sets to compute the aggregates.
 
const string ROLLUP = “rollup”
 This option is used to specify the multilevel aggregates.
 
const string CUBE = “cube”
 This option is used to specify the multidimensional aggregates.
 
const string SHARD_KEY = “shard_key”
 Comma-separated list of the columns to be sharded on; e.g.
 

​
Detailed Description

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

Optional parameters.

Definition at line 93 of file AggregateGroupBy.cs.

​
Member Data Documentation

​
◆ ASCENDING

const string kinetica.AggregateGroupByRequest.Options.ASCENDING = “ascending”
 static

Indicates that the returned values should be sorted in ascending order.

Definition at line 202 of file AggregateGroupBy.cs.

​
◆ CHUNK_COLUMN_MAX_MEMORY

const string kinetica.AggregateGroupByRequest.Options.CHUNK_COLUMN_MAX_MEMORY = “chunk_column_max_memory”
 static

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.

Definition at line 401 of file AggregateGroupBy.cs.

​
◆ CHUNK_MAX_MEMORY

const string kinetica.AggregateGroupByRequest.Options.CHUNK_MAX_MEMORY = “chunk_max_memory”
 static

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.

Definition at line 408 of file AggregateGroupBy.cs.

​
◆ CHUNK_SIZE

const string kinetica.AggregateGroupByRequest.Options.CHUNK_SIZE = “chunk_size”
 static

Indicates the number of records per chunk to be used for the result table.

Must be used in combination with the RESULT_TABLE option.

Definition at line 394 of file AggregateGroupBy.cs.

​
◆ COLLECTION_NAME

const string kinetica.AggregateGroupByRequest.Options.COLLECTION_NAME = “collection_name”
 static

[DEPRECATED–please specify the containing schema as part of RESULT_TABLE and use Kinetica.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.

Definition at line 145 of file AggregateGroupBy.cs.

​
◆ COMPRESSION_CODEC

const string kinetica.AggregateGroupByRequest.Options.COMPRESSION_CODEC = “compression_codec”
 static

The default compression codec for the result table’s columns.

Definition at line 267 of file AggregateGroupBy.cs.

​
◆ CREATE_INDEXES

const string kinetica.AggregateGroupByRequest.Options.CREATE_INDEXES = “create_indexes”
 static

Comma-separated list of columns on which to create indexes on the result table.

Must be used in combination with the RESULT_TABLE option.

Definition at line 415 of file AggregateGroupBy.cs.

​
◆ CREATE_TEMP_TABLE

const string kinetica.AggregateGroupByRequest.Options.CREATE_TEMP_TABLE = “create_temp_table”
 static

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:

The default value is FALSE.

Definition at line 124 of file AggregateGroupBy.cs.

​
◆ CUBE

const string kinetica.AggregateGroupByRequest.Options.CUBE = “cube”
 static

This option is used to specify the multidimensional aggregates.

Definition at line 569 of file AggregateGroupBy.cs.

​
◆ DESCENDING

const string kinetica.AggregateGroupByRequest.Options.DESCENDING = “descending”
 static

Indicates that the returned values should be sorted in descending order.

Definition at line 206 of file AggregateGroupBy.cs.

​
◆ EXPRESSION

const string kinetica.AggregateGroupByRequest.Options.EXPRESSION = “expression”
 static

Filter expression to apply to the table prior to computing the aggregate group by.

Definition at line 149 of file AggregateGroupBy.cs.

​
◆ FALSE

const string kinetica.AggregateGroupByRequest.Options.FALSE = “false”
 static

A boolean constant for the AggregateGroupByRequest.Options options.

Definition at line 132 of file AggregateGroupBy.cs.

​
◆ GROUPING_SETS

const string kinetica.AggregateGroupByRequest.Options.GROUPING_SETS = “grouping_sets”
 static

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.

Definition at line 561 of file AggregateGroupBy.cs.

​
◆ HASH

const string kinetica.AggregateGroupByRequest.Options.HASH = “HASH”
 static

Use hash partitioning.

Definition at line 483 of file AggregateGroupBy.cs.

​
◆ HAVING

const string kinetica.AggregateGroupByRequest.Options.HAVING = “having”
 static

Filter expression to apply to the aggregated results.

Definition at line 173 of file AggregateGroupBy.cs.

​
◆ INTERVAL

const string kinetica.AggregateGroupByRequest.Options.INTERVAL = “INTERVAL”
 static

Use interval partitioning.

Definition at line 473 of file AggregateGroupBy.cs.

​
◆ IS_AUTOMATIC_PARTITION

const string kinetica.AggregateGroupByRequest.Options.IS_AUTOMATIC_PARTITION = “is_automatic_partition”
 static

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:

The default value is FALSE.

Definition at line 538 of file AggregateGroupBy.cs.

​
◆ KEY

const string kinetica.AggregateGroupByRequest.Options.KEY = “key”
 static

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.

Definition at line 243 of file AggregateGroupBy.cs.

​
◆ LIST

const string kinetica.AggregateGroupByRequest.Options.LIST = “LIST”
 static

Use list partitioning.

Definition at line 478 of file AggregateGroupBy.cs.

​
◆ ORDER_BY

const string kinetica.AggregateGroupByRequest.Options.ORDER_BY = “order_by”
 static

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

Definition at line 256 of file AggregateGroupBy.cs.

​
◆ PARTITION_DEFINITIONS

const string kinetica.AggregateGroupByRequest.Options.PARTITION_DEFINITIONS = “partition_definitions”
 static

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.

Definition at line 513 of file AggregateGroupBy.cs.

​
◆ PARTITION_KEYS

const string kinetica.AggregateGroupByRequest.Options.PARTITION_KEYS = “partition_keys”
 static

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.

Definition at line 495 of file AggregateGroupBy.cs.

​
◆ PARTITION_TYPE

const string kinetica.AggregateGroupByRequest.Options.PARTITION_TYPE = “partition_type”
 static

Partitioning scheme to use for the result table.

Supported values:

Definition at line 463 of file AggregateGroupBy.cs.

​
◆ PIPELINED_EXPRESSION_EVALUATION

const string kinetica.AggregateGroupByRequest.Options.PIPELINED_EXPRESSION_EVALUATION = “pipelined_expression_evaluation”
 static

Evaluate the group-by during last JoinedSet filter plan step.

Supported values:

The default value is FALSE.

Definition at line 169 of file AggregateGroupBy.cs.

​
◆ PIVOT

const string kinetica.AggregateGroupByRequest.Options.PIVOT = “pivot”
 static

Pivot column.

Definition at line 546 of file AggregateGroupBy.cs.

​
◆ PIVOT_VALUES

const string kinetica.AggregateGroupByRequest.Options.PIVOT_VALUES = “pivot_values”
 static

Comma-separated list of the values in the PIVOT column.

The list provided will become the column header prefixes in the output.

Definition at line 553 of file AggregateGroupBy.cs.

​
◆ RANGE

const string kinetica.AggregateGroupByRequest.Options.RANGE = “RANGE”
 static

Use range partitioning.

Definition at line 468 of file AggregateGroupBy.cs.

​
◆ RESULT_TABLE

const string kinetica.AggregateGroupByRequest.Options.RESULT_TABLE = “result_table”
 static

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.

Definition at line 280 of file AggregateGroupBy.cs.

​
◆ RESULT_TABLE_FORCE_REPLICATED

const string kinetica.AggregateGroupByRequest.Options.RESULT_TABLE_FORCE_REPLICATED = “result_table_force_replicated”
 static

Force the result table to be replicated (ignores any sharding).

Must be used in combination with the RESULT_TABLE option. Supported values:

The default value is FALSE.

Definition at line 333 of file AggregateGroupBy.cs.

​
◆ RESULT_TABLE_GENERATE_PK

const string kinetica.AggregateGroupByRequest.Options.RESULT_TABLE_GENERATE_PK = “result_table_generate_pk”
 static

If TRUE then set a primary key for the result table.

Must be used in combination with the RESULT_TABLE option. Supported values:

The default value is FALSE.

Definition at line 357 of file AggregateGroupBy.cs.

​
◆ RESULT_TABLE_GENERATE_SOFT_PK

const string kinetica.AggregateGroupByRequest.Options.RESULT_TABLE_GENERATE_SOFT_PK = “result_table_generate_soft_pk”
 static

If TRUE then set a soft primary key for the result table.

Must be used in combination with the RESULT_TABLE option. Supported values:

The default value is FALSE.

Definition at line 381 of file AggregateGroupBy.cs.

​
◆ RESULT_TABLE_PERSIST

const string kinetica.AggregateGroupByRequest.Options.RESULT_TABLE_PERSIST = “result_table_persist”
 static

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:

The default value is FALSE.

Definition at line 310 of file AggregateGroupBy.cs.

​
◆ ROLLUP

const string kinetica.AggregateGroupByRequest.Options.ROLLUP = “rollup”
 static

This option is used to specify the multilevel aggregates.

Definition at line 565 of file AggregateGroupBy.cs.

​
◆ SERIES

const string kinetica.AggregateGroupByRequest.Options.SERIES = “SERIES”
 static

Use series partitioning.

Definition at line 488 of file AggregateGroupBy.cs.

​
◆ SHARD_KEY

const string kinetica.AggregateGroupByRequest.Options.SHARD_KEY = “shard_key”
 static

Comma-separated list of the columns to be sharded on; e.g.

‘column1, column2’.

The columns specified must be present in AggregateGroupByRequest.column_names. If any alias is given for any column name, the alias must be used, rather than the original column name. The default value is ”.

Definition at line 577 of file AggregateGroupBy.cs.

​
◆ SORT_BY

const string kinetica.AggregateGroupByRequest.Options.SORT_BY = “sort_by”
 static

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

Definition at line 236 of file AggregateGroupBy.cs.

​
◆ SORT_ORDER

const string kinetica.AggregateGroupByRequest.Options.SORT_ORDER = “sort_order”
 static

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

Definition at line 198 of file AggregateGroupBy.cs.

​
◆ STRATEGY_DEFINITION

const string kinetica.AggregateGroupByRequest.Options.STRATEGY_DEFINITION = “strategy_definition”
 static

The tier strategy for the table and its columns.

Definition at line 261 of file AggregateGroupBy.cs.

​
◆ TRUE

const string kinetica.AggregateGroupByRequest.Options.TRUE = “true”
 static

A boolean constant for the AggregateGroupByRequest.Options options.

Definition at line 128 of file AggregateGroupBy.cs.

​
◆ TTL

const string kinetica.AggregateGroupByRequest.Options.TTL = “ttl”
 static

Sets the TTL of the table specified in RESULT_TABLE.

Definition at line 387 of file AggregateGroupBy.cs.

​
◆ VALUE

const string kinetica.AggregateGroupByRequest.Options.VALUE = “value”
 static

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.

Definition at line 250 of file AggregateGroupBy.cs.

​
◆ VIEW_ID

const string kinetica.AggregateGroupByRequest.Options.VIEW_ID = “view_id”
 static

ID of view of which the result table will be a member.

The default value is ”.

Definition at line 543 of file AggregateGroupBy.cs.

The documentation for this struct was generated from the following files: