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

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

const string	TRUE = "true"

const string	FALSE = "false"

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

const string	EXPRESSION = "expression"
	Filter expression to apply to the table prior to computing the aggregate group by. More...

const string	PIPELINED_EXPRESSION_EVALUATION = "pipelined_expression_evaluation"
	Evaluate the group-by during last JoinedSet filter plan step. More...

const string	HAVING = "having"
	Filter expression to apply to the aggregated results. More...

const string	SORT_ORDER = "sort_order"
	[DEPRECATED–use order_by instead] String indicating how the returned values should be sorted - ascending or descending. More...

const string	ASCENDING = "ascending"
	Indicates that the returned values should be sorted in ascending order. More...

const string	DESCENDING = "descending"
	Indicates that the returned values should be sorted in descending order. More...

const string	SORT_BY = "sort_by"
	[DEPRECATED–use order_by instead] String determining how the results are sorted. More...

const string	KEY = "key"
	Indicates that the returned values should be sorted by key, which corresponds to the grouping columns. More...

const string	VALUE = "value"
	Indicates that the returned values should be sorted by value, which corresponds to the aggregates. More...

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

const string	STRATEGY_DEFINITION = "strategy_definition"
	The tier strategy for the table and its columns. More...

const string	COMPRESSION_CODEC = "compression_codec"
	The default compression codec for the result table's columns. More...

const string	RESULT_TABLE = "result_table"
	The name of a table used to store the results, in [schema_name. More...

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

const string	RESULT_TABLE_FORCE_REPLICATED = "result_table_force_replicated"
	Force the result table to be replicated (ignores any sharding). More...

const string	RESULT_TABLE_GENERATE_PK = "result_table_generate_pk"
	If TRUE then set a primary key for the result table. More...

const string	RESULT_TABLE_GENERATE_SOFT_PK = "result_table_generate_soft_pk"
	If TRUE then set a soft primary key for the result table. More...

const string	TTL = "ttl"
	Sets the TTL of the table specified in RESULT_TABLE. More...

const string	CHUNK_SIZE = "chunk_size"
	Indicates the number of records per chunk to be used for the result table. More...

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

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

const string	CREATE_INDEXES = "create_indexes"
	Comma-separated list of columns on which to create indexes on the result table. More...

const string	PARTITION_TYPE = "partition_type"
	Partitioning scheme to use for the result table. More...

const string	RANGE = "RANGE"
	Use range partitioning. More...

const string	INTERVAL = "INTERVAL"
	Use interval partitioning. More...

const string	LIST = "LIST"
	Use list partitioning. More...

const string	HASH = "HASH"
	Use hash partitioning. More...

const string	SERIES = "SERIES"
	Use series partitioning. More...

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

const string	PARTITION_DEFINITIONS = "partition_definitions"
	Comma-separated list of partition definitions, whose format depends on the choice of PARTITION_TYPE. More...

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

const string	VIEW_ID = "view_id"
	ID of view of which the result table will be a member. More...

const string	PIVOT = "pivot"
	Pivot column. More...

const string	PIVOT_VALUES = "pivot_values"
	Comma-separated list of the values in the PIVOT column. More...

const string	GROUPING_SETS = "grouping_sets"
	Customize the grouping attribute sets to compute the aggregates. More...

const string	ROLLUP = "rollup"
	This option is used to specify the multilevel aggregates. More...

const string	CUBE = "cube"
	This option is used to specify the multidimensional aggregates. More...

const string	SHARD_KEY = "shard_key"
	Comma-separated list of the columns to be sharded on; e.g. More...

Detailed Description

A set of string constants for the parameter options.

Optional parameters.

Definition at line 88 of file AggregateGroupBy.cs.

Member Data Documentation

◆ ASCENDING

const string AggregateGroupByRequest.Options.ASCENDING = "ascending"

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

Definition at line 166 of file AggregateGroupBy.cs.

◆ CHUNK_COLUMN_MAX_MEMORY

const string AggregateGroupByRequest.Options.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.

Must be used in combination with the RESULT_TABLE option.

Definition at line 321 of file AggregateGroupBy.cs.

◆ CHUNK_MAX_MEMORY

const string AggregateGroupByRequest.Options.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.

Must be used in combination with the RESULT_TABLE option.

Definition at line 328 of file AggregateGroupBy.cs.

◆ CHUNK_SIZE

const string AggregateGroupByRequest.Options.CHUNK_SIZE = "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.

Definition at line 314 of file AggregateGroupBy.cs.

◆ COLLECTION_NAME

const string AggregateGroupByRequest.Options.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.

If the schema provided is non-existent, it will be automatically created.

Definition at line 118 of file AggregateGroupBy.cs.

◆ COMPRESSION_CODEC

const string AggregateGroupByRequest.Options.COMPRESSION_CODEC = "compression_codec"

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

Definition at line 226 of file AggregateGroupBy.cs.

◆ CREATE_INDEXES

const string AggregateGroupByRequest.Options.CREATE_INDEXES = "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.

Definition at line 335 of file AggregateGroupBy.cs.

◆ CREATE_TEMP_TABLE

const string AggregateGroupByRequest.Options.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.

Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 105 of file AggregateGroupBy.cs.

◆ CUBE

const string AggregateGroupByRequest.Options.CUBE = "cube"

This option is used to specify the multidimensional aggregates.

Definition at line 468 of file AggregateGroupBy.cs.

◆ DESCENDING

const string AggregateGroupByRequest.Options.DESCENDING = "descending"

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

Definition at line 170 of file AggregateGroupBy.cs.

◆ EXPRESSION

const string AggregateGroupByRequest.Options.EXPRESSION = "expression"

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

Definition at line 122 of file AggregateGroupBy.cs.

◆ FALSE

const string AggregateGroupByRequest.Options.FALSE = "false"

Definition at line 108 of file AggregateGroupBy.cs.

◆ GROUPING_SETS

const string AggregateGroupByRequest.Options.GROUPING_SETS = "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.

Definition at line 460 of file AggregateGroupBy.cs.

◆ HASH

const string AggregateGroupByRequest.Options.HASH = "HASH"

Use hash partitioning.

Definition at line 393 of file AggregateGroupBy.cs.

◆ HAVING

const string AggregateGroupByRequest.Options.HAVING = "having"

Filter expression to apply to the aggregated results.

Definition at line 141 of file AggregateGroupBy.cs.

◆ INTERVAL

const string AggregateGroupByRequest.Options.INTERVAL = "INTERVAL"

Use interval partitioning.

Definition at line 383 of file AggregateGroupBy.cs.

◆ IS_AUTOMATIC_PARTITION

const string AggregateGroupByRequest.Options.IS_AUTOMATIC_PARTITION = "is_automatic_partition"

If TRUE, a new partition will be created for values which don't fall into an existing partition.

Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 438 of file AggregateGroupBy.cs.

◆ KEY

const string AggregateGroupByRequest.Options.KEY = "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.

Definition at line 202 of file AggregateGroupBy.cs.

◆ LIST

const string AggregateGroupByRequest.Options.LIST = "LIST"

Use list partitioning.

Definition at line 388 of file AggregateGroupBy.cs.

◆ ORDER_BY

const string AggregateGroupByRequest.Options.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'.

The default value is ''.

Definition at line 215 of file AggregateGroupBy.cs.

◆ PARTITION_DEFINITIONS

const string AggregateGroupByRequest.Options.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.

Definition at line 422 of file AggregateGroupBy.cs.

◆ PARTITION_KEYS

const string AggregateGroupByRequest.Options.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.

Definition at line 405 of file AggregateGroupBy.cs.

◆ PARTITION_TYPE

const string AggregateGroupByRequest.Options.PARTITION_TYPE = "partition_type"

Partitioning scheme to use for the result table.

Supported values:

Definition at line 373 of file AggregateGroupBy.cs.

◆ PIPELINED_EXPRESSION_EVALUATION

const string AggregateGroupByRequest.Options.PIPELINED_EXPRESSION_EVALUATION = "pipelined_expression_evaluation"

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

Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 137 of file AggregateGroupBy.cs.

◆ PIVOT

const string AggregateGroupByRequest.Options.PIVOT = "pivot"

Pivot column.

Definition at line 446 of file AggregateGroupBy.cs.

◆ PIVOT_VALUES

const string AggregateGroupByRequest.Options.PIVOT_VALUES = "pivot_values"

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 452 of file AggregateGroupBy.cs.

◆ RANGE

const string AggregateGroupByRequest.Options.RANGE = "RANGE"

Use range partitioning.

Definition at line 378 of file AggregateGroupBy.cs.

◆ RESULT_TABLE

const string AggregateGroupByRequest.Options.RESULT_TABLE = "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.

Definition at line 239 of file AggregateGroupBy.cs.

◆ RESULT_TABLE_FORCE_REPLICATED

const string AggregateGroupByRequest.Options.RESULT_TABLE_FORCE_REPLICATED = "result_table_force_replicated"

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

Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 272 of file AggregateGroupBy.cs.

◆ RESULT_TABLE_GENERATE_PK

const string AggregateGroupByRequest.Options.RESULT_TABLE_GENERATE_PK = "result_table_generate_pk"

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

Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 287 of file AggregateGroupBy.cs.

◆ RESULT_TABLE_GENERATE_SOFT_PK

const string AggregateGroupByRequest.Options.RESULT_TABLE_GENERATE_SOFT_PK = "result_table_generate_soft_pk"

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

Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 302 of file AggregateGroupBy.cs.

◆ RESULT_TABLE_PERSIST

const string AggregateGroupByRequest.Options.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.

Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 257 of file AggregateGroupBy.cs.

◆ ROLLUP

const string AggregateGroupByRequest.Options.ROLLUP = "rollup"

This option is used to specify the multilevel aggregates.

Definition at line 464 of file AggregateGroupBy.cs.

◆ SERIES

const string AggregateGroupByRequest.Options.SERIES = "SERIES"

Use series partitioning.

Definition at line 398 of file AggregateGroupBy.cs.

◆ SHARD_KEY

const string AggregateGroupByRequest.Options.SHARD_KEY = "shard_key"

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

'column1, column2'.

The columns specified must be present in 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 476 of file AggregateGroupBy.cs.

◆ SORT_BY

const string AggregateGroupByRequest.Options.SORT_BY = "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.

Definition at line 195 of file AggregateGroupBy.cs.

◆ SORT_ORDER

const string AggregateGroupByRequest.Options.SORT_ORDER = "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.

Definition at line 162 of file AggregateGroupBy.cs.

◆ STRATEGY_DEFINITION

const string AggregateGroupByRequest.Options.STRATEGY_DEFINITION = "strategy_definition"

The tier strategy for the table and its columns.

Definition at line 220 of file AggregateGroupBy.cs.

◆ TRUE

const string AggregateGroupByRequest.Options.TRUE = "true"

Definition at line 107 of file AggregateGroupBy.cs.

◆ TTL

const string AggregateGroupByRequest.Options.TTL = "ttl"

Sets the TTL of the table specified in RESULT_TABLE.

Definition at line 307 of file AggregateGroupBy.cs.

◆ VALUE

const string AggregateGroupByRequest.Options.VALUE = "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.

Definition at line 209 of file AggregateGroupBy.cs.

◆ VIEW_ID

const string AggregateGroupByRequest.Options.VIEW_ID = "view_id"

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

The default value is ''.

Definition at line 443 of file AggregateGroupBy.cs.

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

Kinetica/Protocol/AggregateGroupBy.cs

Public Attributes

Detailed Description

Member Data Documentation

◆ ASCENDING

◆ CHUNK_COLUMN_MAX_MEMORY

◆ CHUNK_MAX_MEMORY

◆ CHUNK_SIZE

◆ COLLECTION_NAME

◆ COMPRESSION_CODEC

◆ CREATE_INDEXES

◆ CREATE_TEMP_TABLE

◆ CUBE

◆ DESCENDING

◆ EXPRESSION

◆ FALSE

◆ GROUPING_SETS

◆ HASH

◆ HAVING

◆ INTERVAL

◆ IS_AUTOMATIC_PARTITION

◆ KEY

◆ LIST

◆ ORDER_BY

◆ PARTITION_DEFINITIONS

◆ PARTITION_KEYS

◆ PARTITION_TYPE

◆ PIPELINED_EXPRESSION_EVALUATION

◆ PIVOT

◆ PIVOT_VALUES

◆ RANGE

◆ RESULT_TABLE

◆ RESULT_TABLE_FORCE_REPLICATED

◆ RESULT_TABLE_GENERATE_PK

◆ RESULT_TABLE_GENERATE_SOFT_PK

◆ RESULT_TABLE_PERSIST

◆ ROLLUP

◆ SERIES

◆ SHARD_KEY

◆ SORT_BY

◆ SORT_ORDER

◆ STRATEGY_DEFINITION

◆ TRUE

◆ TTL

◆ VALUE

◆ VIEW_ID