A set of parameters for Kinetica.aggregateGroupBy(string,IList<string>,long,long,IDictionary<string, string>). More...

Inheritance diagram for kinetica.AggregateGroupByRequest:

Collaboration diagram for kinetica.AggregateGroupByRequest:

Classes
struct	Encoding
	Specifies the encoding for returned records. More...

struct	Options
	Optional parameters. More...

Public Member Functions
	AggregateGroupByRequest ()
	Constructs an AggregateGroupByRequest object with default parameters. More...

	AggregateGroupByRequest (string table_name, IList< string > column_names, long offset, long limit=1000, IDictionary< string, string > options=null)
	Constructs an AggregateGroupByRequest object with the specified parameters. More...

	AggregateGroupByRequest (string table_name, IList< string > column_names, long offset, long limit=1000, string encoding=null, IDictionary< string, string > options=null)
	Constructs an AggregateGroupByRequest object with the specified parameters. More...

Public Member Functions inherited from kinetica.KineticaData
	KineticaData (KineticaType type)
	Constructor from Kinetica Type More...

	KineticaData (System.Type type=null)
	Default constructor, with optional System.Type More...

object	Get (int fieldPos)
	Retrieve a specific property from this object More...

void	Put (int fieldPos, object fieldValue)
	Write a specific property to this object More...

Properties
string	table_name `[get, set]`
	Name of the table on which the operation will be performed. More...

IList< string >	column_names `[get, set]`
	List of one or more column names, expressions, and aggregate expressions. More...

long	offset = new List<string>() `[get, set]`
	A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). More...

long	limit `[get, set]`
	A positive integer indicating the maximum number of results to be returned Or END_OF_SET (-9999) to indicate that the max number of results should be returned. More...

string	encoding = 1000 `[get, set]`
	Specifies the encoding for returned records. More...

IDictionary< string, string >	options = Encoding.BINARY `[get, set]`
	Optional parameters. More...

Properties inherited from kinetica.KineticaData
Schema	Schema `[get]`
	Avro Schema for this class More...

Additional Inherited Members
Static Public Member Functions inherited from kinetica.KineticaData
static RecordSchema	SchemaFromType (System.Type t, KineticaType ktype=null)
	Create an Avro Schema from a System.Type and a KineticaType. More...

Detailed Description

A set of parameters for Kinetica.aggregateGroupBy(string,IList<string>,long,long,IDictionary<string, string>).

Calculates unique combinations (groups) of values for the given columns in a given table/view/collection and computes aggregates on each unique combination. This is somewhat analogous to an SQL-style SELECT...GROUP BY.
Any column(s) can be grouped on, and all column types except unrestricted-length strings may be used for computing applicable aggregates; columns marked as store-only are unable to be used in grouping or aggregation.
The results can be paged via the offset and limit parameters. For example, to get 10 groups with the largest counts the inputs would be: limit=10, options={"sort_order":"descending", "sort_by":"value"}.
options can be used to customize behavior of this call e.g. filtering or sorting the results.
To group by columns 'x' and 'y' and compute the number of objects within each group, use: column_names=['x','y','count(*)'].
To also compute the sum of 'z' over each group, use: column_names=['x','y','count(*)','sum(z)'].
Available aggregation functions are: count(*), sum, min, max, avg, mean, stddev, stddev_pop, stddev_samp, var, var_pop, var_samp, arg_min, arg_max and count_distinct.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
If a result_table name is specified in the options, the results are stored in a new table with that name–no results are returned in the response. Both the table name and resulting column names must adhere to standard naming conventions; column/aggregation expressions will need to be aliased. If the source table's shard key is used as the grouping column(s), the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available when any of the values of column_names is an unrestricted-length string.

Definition at line 68 of file AggregateGroupBy.cs.

Constructor & Destructor Documentation

◆ AggregateGroupByRequest() [1/3]

kinetica.AggregateGroupByRequest.AggregateGroupByRequest ( )

inline

Constructs an AggregateGroupByRequest object with default parameters.

Definition at line 632 of file AggregateGroupBy.cs.

◆ AggregateGroupByRequest() [2/3]

kinetica.AggregateGroupByRequest.AggregateGroupByRequest	(	string	table_name,
		IList< string >	column_names,
		long	offset,
		long	limit = `1000`,
		IDictionary< string, string >	options = `null`
	)

inline

Constructs an AggregateGroupByRequest object with the specified parameters.

Parameters

table_name	Name of the table on which the operation will be performed. Must be an existing table/view/collection.
column_names	List of one or more column names, expressions, and aggregate expressions.
offset	A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limit	A positive integer indicating the maximum number of results to be returned Or END_OF_SET (-9999) to indicate that the max number of results should be returned.
options	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.

Definition at line 810 of file AggregateGroupBy.cs.

◆ AggregateGroupByRequest() [3/3]

kinetica.AggregateGroupByRequest.AggregateGroupByRequest	(	string	table_name,
		IList< string >	column_names,
		long	offset,
		long	limit = `1000`,
		string	encoding = `null`,
		IDictionary< string, string >	options = `null`
	)

inline

Constructs an AggregateGroupByRequest object with the specified parameters.

Parameters

table_name	Name of the table on which the operation will be performed. Must be an existing table/view/collection.
column_names	List of one or more column names, expressions, and aggregate expressions.
offset	A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limit	A positive integer indicating the maximum number of results to be returned Or END_OF_SET (-9999) to indicate that the max number of results should be returned.
encoding	Specifies the encoding for returned records. Supported values: BINARY: Indicates that the returned records should be binary encoded. JSON: Indicates that the returned records should be json encoded. The default value is BINARY.
options	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.

Definition at line 1020 of file AggregateGroupBy.cs.

Property Documentation

◆ column_names

IList<string> kinetica.AggregateGroupByRequest.column_names

getset

List of one or more column names, expressions, and aggregate expressions.

Definition at line 433 of file AggregateGroupBy.cs.

◆ encoding

string kinetica.AggregateGroupByRequest.encoding = 1000

getset

Specifies the encoding for returned records.

Supported values:

BINARY: Indicates that the returned records should be binary encoded.
JSON: Indicates that the returned records should be json encoded.

The default value is BINARY.

Definition at line 465 of file AggregateGroupBy.cs.

◆ limit

long kinetica.AggregateGroupByRequest.limit

getset

A positive integer indicating the maximum number of results to be returned Or END_OF_SET (-9999) to indicate that the max number of results should be returned.

Definition at line 444 of file AggregateGroupBy.cs.

◆ offset

long kinetica.AggregateGroupByRequest.offset = new List<string>()

getset

A positive integer indicating the number of initial results to skip (this can be useful for paging through the results).

The minimum allowed value is 0. The maximum allowed value is MAX_INT.

Definition at line 439 of file AggregateGroupBy.cs.

◆ options

IDictionary<string, string> kinetica.AggregateGroupByRequest.options = Encoding.BINARY

getset

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.

Definition at line 627 of file AggregateGroupBy.cs.

◆ table_name

string kinetica.AggregateGroupByRequest.table_name

getset

Name of the table on which the operation will be performed.

Must be an existing table/view/collection.

Definition at line 429 of file AggregateGroupBy.cs.

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

Kinetica/Protocol/AggregateGroupBy.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AggregateGroupByRequest() [1/3]

◆ AggregateGroupByRequest() [2/3]

◆ AggregateGroupByRequest() [3/3]

Property Documentation

◆ column_names

◆ encoding

◆ limit

◆ offset

◆ options

◆ table_name