Optional parameters. More...

Public Attributes
const string	COLLECTION_NAME = "collection_name"
	Name of a collection 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	HAVING = "having"
	Filter expression to apply to the aggregated results. More...

const string	SORT_ORDER = "sort_order"
	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"
	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	RESULT_TABLE = "result_table"
	The name of the table used to store the results. 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	TRUE = "true"

const string	FALSE = "false"

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	TTL = "ttl"
	Sets the TTL of the table specified in result_table. More...

const string	CHUNK_SIZE = "chunk_size"
	Indicates the chunk size to be used for the result table. More...

const string	MATERIALIZE_ON_GPU = "materialize_on_gpu"
	If true then the columns of the groupby result table will be cached on the GPU. More...

Detailed Description

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. Additionally this option is invalid if 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 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.
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.
TTL: Sets the TTL of the table specified in result_table.
CHUNK_SIZE: Indicates the chunk size to be used for the result table. Must be used in combination with the result_table option.
MATERIALIZE_ON_GPU: If true then the columns of the groupby result table will be cached on the GPU. Must be used in combination with the result_table option. Supported values:
- TRUE
- FALSE
The default value is FALSE.

A set of string constants for the parameter options.

Definition at line 266 of file AggregateGroupBy.cs.

Member Data Documentation

◆ ASCENDING

const string kinetica.AggregateGroupByRequest.Options.ASCENDING = "ascending"

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

Definition at line 308 of file AggregateGroupBy.cs.

◆ CHUNK_SIZE

const string kinetica.AggregateGroupByRequest.Options.CHUNK_SIZE = "chunk_size"

Indicates the chunk size to be used for the result table.

Must be used in combination with the result_table option.

Definition at line 405 of file AggregateGroupBy.cs.

◆ COLLECTION_NAME

const string kinetica.AggregateGroupByRequest.Options.COLLECTION_NAME = "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. Additionally this option is invalid if table_name is a collection.

Definition at line 275 of file AggregateGroupBy.cs.

◆ DESCENDING

const string kinetica.AggregateGroupByRequest.Options.DESCENDING = "descending"

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

Definition at line 312 of file AggregateGroupBy.cs.

◆ EXPRESSION

const string kinetica.AggregateGroupByRequest.Options.EXPRESSION = "expression"

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

Definition at line 279 of file AggregateGroupBy.cs.

◆ FALSE

const string kinetica.AggregateGroupByRequest.Options.FALSE = "false"

Definition at line 385 of file AggregateGroupBy.cs.

◆ HAVING

const string kinetica.AggregateGroupByRequest.Options.HAVING = "having"

Filter expression to apply to the aggregated results.

Definition at line 283 of file AggregateGroupBy.cs.

◆ KEY

const string kinetica.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 345 of file AggregateGroupBy.cs.

◆ MATERIALIZE_ON_GPU

const string kinetica.AggregateGroupByRequest.Options.MATERIALIZE_ON_GPU = "materialize_on_gpu"

If true then the columns of the groupby result table will be cached on the GPU.

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

TRUE
FALSE

The default value is FALSE.

Definition at line 423 of file AggregateGroupBy.cs.

◆ RESULT_TABLE

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

Definition at line 363 of file AggregateGroupBy.cs.

◆ RESULT_TABLE_FORCE_REPLICATED

const string kinetica.AggregateGroupByRequest.Options.RESULT_TABLE_FORCE_REPLICATED = "result_table_force_replicated"

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

Must be used in combination with the result_table option.

Definition at line 390 of file AggregateGroupBy.cs.

◆ RESULT_TABLE_GENERATE_PK

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

Definition at line 395 of file AggregateGroupBy.cs.

◆ RESULT_TABLE_PERSIST

const string kinetica.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.

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.

Definition at line 383 of file AggregateGroupBy.cs.

◆ SORT_BY

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

Definition at line 338 of file AggregateGroupBy.cs.

◆ SORT_ORDER

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

Definition at line 304 of file AggregateGroupBy.cs.

◆ TRUE

const string kinetica.AggregateGroupByRequest.Options.TRUE = "true"

Definition at line 384 of file AggregateGroupBy.cs.

◆ TTL

const string kinetica.AggregateGroupByRequest.Options.TTL = "ttl"

Sets the TTL of the table specified in result_table.

Definition at line 400 of file AggregateGroupBy.cs.

◆ VALUE

const string kinetica.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 352 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_SIZE

◆ COLLECTION_NAME

◆ DESCENDING

◆ EXPRESSION

◆ FALSE

◆ HAVING

◆ KEY

◆ MATERIALIZE_ON_GPU

◆ RESULT_TABLE

◆ RESULT_TABLE_FORCE_REPLICATED

◆ RESULT_TABLE_GENERATE_PK

◆ RESULT_TABLE_PERSIST

◆ SORT_BY

◆ SORT_ORDER

◆ TRUE

◆ TTL

◆ VALUE