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, otherwise the table will be a top-level 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 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). More...

const string	TRUE = "true"

const string	FALSE = "false"

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

Detailed Description

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 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. Values: ascending, descending.
sort_by String determining how the results are sorted. Values: key, 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 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. Values: true, 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 <member name="options">.

Definition at line 153 of file AggregateGroupBy.cs.

Member Data Documentation

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

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

Definition at line 181 of file AggregateGroupBy.cs.

const string kinetica.AggregateGroupByRequest.Options.COLLECTION_NAME = "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 <member name="table_name"> is a collection.

Definition at line 163 of file AggregateGroupBy.cs.

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

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

Definition at line 185 of file AggregateGroupBy.cs.

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

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

Definition at line 167 of file AggregateGroupBy.cs.

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

Definition at line 226 of file AggregateGroupBy.cs.

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

Filter expression to apply to the aggregated results.

Definition at line 171 of file AggregateGroupBy.cs.

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

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

const string kinetica.AggregateGroupByRequest.Options.RESULT_TABLE_PERSIST = "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. Values: true, false.

Definition at line 224 of file AggregateGroupBy.cs.

const string kinetica.AggregateGroupByRequest.Options.SORT_BY = "sort_by"

String determining how the results are sorted.

Values: key, value.

Definition at line 190 of file AggregateGroupBy.cs.

const string kinetica.AggregateGroupByRequest.Options.SORT_ORDER = "sort_order"

String indicating how the returned values should be sorted - ascending or descending.

Values: ascending, descending.

Definition at line 177 of file AggregateGroupBy.cs.

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

Definition at line 225 of file AggregateGroupBy.cs.

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

Sets the TTL of the table specified in result_table.

The value must be the desired TTL in minutes.

Definition at line 231 of file AggregateGroupBy.cs.

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