> ## Documentation Index > Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt > Use this file to discover all available pages before exploring further. # kinetica.AggregateGroupByRequest > kinetica.AggregateGroupByRequest — Kinetica C# API

A set of parameters for Kinetica.aggregateGroupBy. More...

Inheritance diagram for kinetica.AggregateGroupByRequest:
Collaboration diagram for kinetica.AggregateGroupByRequest:

Classes
struct   Encoding
  A set of string constants for the parameter AggregateGroupByRequest.encoding. More...
 
struct   Options
  A set of string constants for the parameter AggregateGroupByRequest.options. More...
 

Public Member Functions
  AggregateGroupByRequest ()
  Constructs an AggregateGroupByRequest object with default parameters.
 
  AggregateGroupByRequest (string table\_name, IList\< string > column\_names, long? offset=null, long? limit=null, IDictionary\< string, string > options=null)
  Constructs an AggregateGroupByRequest object with the specified parameters.
 
  AggregateGroupByRequest (string table\_name, IList\< string > column\_names, long? offset=null, long? limit=null, string encoding=null, IDictionary\< string, string > options=null)
  Constructs an AggregateGroupByRequest object with the specified parameters.
 
  AggregateGroupByRequest ()
  Constructs an AggregateGroupByRequest object with default parameters.
 
  AggregateGroupByRequest (string table\_name, IList\< string > column\_names, long? offset=null, long? limit=null, IDictionary\< string, string > options=null)
  Constructs an AggregateGroupByRequest object with the specified parameters.
 
  AggregateGroupByRequest (string table\_name, IList\< string > column\_names, long? offset=null, long? limit=null, string encoding=null, IDictionary\< string, string > options=null)
  Constructs an AggregateGroupByRequest object with the specified parameters.
 
 Public Member Functions inherited from kinetica.KineticaData
  KineticaData (KineticaType type)
  Constructor from Kinetica Type.
 
  KineticaData (System.Type type=null)
  Default constructor, with optional System.Type.
 
object  Get (int fieldPos)
  Retrieve a specific property from this object.
 
void  Put (int fieldPos, object fieldValue)
  Write a specific property to this object.
 
  KineticaData (KineticaType type)
  Constructor from Kinetica Type.
 
  KineticaData (System.Type type=null)
  Default constructor, with optional System.Type.
 
object  Get (int fieldPos)
  Retrieve a specific property from this object.
 
void  Put (int fieldPos, object fieldValue)
  Write a specific property to this object.
 

Properties
string  table\_name \[get, set]
  Name of an existing table or view on which the operation will be performed, in \[schema\_name.
 
IList\< string >  column\_names = new List\() \[get, set]
  List of one or more column names, expressions, and aggregate expressions.
 
long  offset = 0 \[get, set]
  A positive integer indicating the number of initial results to skip (this can be useful for paging through the results).
 
long  limit = -9999 \[get, set]
  A positive integer indicating the maximum number of results to be returned, or END\_OF\_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned.
 
string  encoding = Encoding.BINARY \[get, set]
  Specifies the encoding for returned records.
 
IDictionary\< string, string >  options = new Dictionary\() \[get, set]
  Optional parameters.
 
 Properties inherited from kinetica.KineticaData
Schema  Schema \[get]
  Avro Schema for this class.
 

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.
 
static ? RecordSchema  SchemaFromType (System.Type t, KineticaType? ktype=null)
  Create an Avro Schema from a System.Type and a KineticaType.
 

Detailed Description

A set of parameters for Kinetica.aggregateGroupBy.

Calculates unique combinations (groups) of values for the given columns in a given table or view and computes aggregates on each unique combination. This is somewhat analogous to an SQL-style SELECT...GROUP BY.

For aggregation details and examples, see Aggregation. For limitations, see Aggregation Limitations.

Any column(s) can be grouped on, and all column types except unrestricted-length strings may be used for computing applicable aggregates.

The results can be paged via the AggregateGroupByRequest.offset and AggregateGroupByRequest.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"{"}"}.

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

Available grouping functions are Rollup, Cube, and Grouping Sets

This service also provides support for Pivot operations.

Filtering on aggregates is supported via expressions using aggregation functions supplied to HAVING.

The response is returned as a dynamic schema. For details see: dynamic schemas documentation.

If a RESULT\_TABLE name is specified in the AggregateGroupByRequest.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) and all result records are selected (AggregateGroupByRequest.offset is 0 and AggregateGroupByRequest.limit is -9999), 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 AggregateGroupByRequest.column\_names is an unrestricted-length string.

Definition at line 73 of file AggregateGroupBy.cs.

Constructor & Destructor Documentation

◆ AggregateGroupByRequest() \[1/6]

kinetica.AggregateGroupByRequest.AggregateGroupByRequest ( )
inline

Constructs an AggregateGroupByRequest object with default parameters.

Definition at line 1155 of file AggregateGroupBy.cs.

◆ AggregateGroupByRequest() \[2/6]

kinetica.AggregateGroupByRequest.AggregateGroupByRequest ( string table\_name,
IList\< string > column\_names,
long? offset = null,
long? limit = null,
IDictionary\< string, string > options = null )
inline

Constructs an AggregateGroupByRequest object with the specified parameters.

Parameters
table\_name Name of an existing table or view on which the operation will be performed, in \[schema\_name.]table\_name format, using standard name resolution rules.
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 default value is 0. 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 maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server's own limit, defined by the max\_get\_records\_size parameter in the server configuration. Use has\_more\_records to see if more records exist in the result to be fetched, and offset and limit to request subsequent pages of results. The default value is -9999.
options Optional parameters.
  • 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. 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.
  • 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.
  • EXPRESSION: Filter expression to apply to the table prior to computing the aggregate group by.
  • PIPELINED\_EXPRESSION\_EVALUATION: Evaluate the group-by during last JoinedSet filter plan step. Supported values: The default value is FALSE.
  • HAVING: Filter expression to apply to the aggregated results.
  • 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.
  • 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.
  • 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 ''.
  • STRATEGY\_DEFINITION: The tier strategy for the table and its columns.
  • COMPRESSION\_CODEC: The default compression codec for the result table's columns.
  • 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.
  • 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: 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. Supported values: The default value is FALSE.
  • 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. Supported values: The default value is FALSE.
  • RESULT\_TABLE\_GENERATE\_SOFT\_PK: 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.
  • TTL: Sets the TTL of the table specified in RESULT\_TABLE.
  • 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.
  • 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.
  • 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.
  • 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.
  • PARTITION\_TYPE: Partitioning scheme to use for the result table. Supported values:
  • 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.
  • 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.
  • IS\_AUTOMATIC\_PARTITION: 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.
  • VIEW\_ID: ID of view of which the result table will be a member. The default value is ''.
  • PIVOT: Pivot column.
  • PIVOT\_VALUES: Comma-separated list of the values in the PIVOT column. The list provided will become the column header prefixes in the output.
  • 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.
  • ROLLUP: This option is used to specify the multilevel aggregates.
  • CUBE: This option is used to specify the multidimensional aggregates.
  • 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 ''.
The default value is an empty Dictionary.

Definition at line 1699 of file AggregateGroupBy.cs.

◆ AggregateGroupByRequest() \[3/6]

kinetica.AggregateGroupByRequest.AggregateGroupByRequest ( string table\_name,
IList\< string > column\_names,
long? offset = null,
long? limit = null,
string encoding = null,
IDictionary\< string, string > options = null )
inline

Constructs an AggregateGroupByRequest object with the specified parameters.

Parameters
table\_name Name of an existing table or view on which the operation will be performed, in \[schema\_name.]table\_name format, using standard name resolution rules.
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 default value is 0. 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 maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server's own limit, defined by the max\_get\_records\_size parameter in the server configuration. Use has\_more\_records to see if more records exist in the result to be fetched, and offset and limit to request subsequent pages of results. The default value is -9999.
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.
  • 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. 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.
  • 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.
  • EXPRESSION: Filter expression to apply to the table prior to computing the aggregate group by.
  • PIPELINED\_EXPRESSION\_EVALUATION: Evaluate the group-by during last JoinedSet filter plan step. Supported values: The default value is FALSE.
  • HAVING: Filter expression to apply to the aggregated results.
  • 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.
  • 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.
  • 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 ''.
  • STRATEGY\_DEFINITION: The tier strategy for the table and its columns.
  • COMPRESSION\_CODEC: The default compression codec for the result table's columns.
  • 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.
  • 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: 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. Supported values: The default value is FALSE.
  • 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. Supported values: The default value is FALSE.
  • RESULT\_TABLE\_GENERATE\_SOFT\_PK: 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.
  • TTL: Sets the TTL of the table specified in RESULT\_TABLE.
  • 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.
  • 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.
  • 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.
  • 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.
  • PARTITION\_TYPE: Partitioning scheme to use for the result table. Supported values:
  • 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.
  • 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.
  • IS\_AUTOMATIC\_PARTITION: 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.
  • VIEW\_ID: ID of view of which the result table will be a member. The default value is ''.
  • PIVOT: Pivot column.
  • PIVOT\_VALUES: Comma-separated list of the values in the PIVOT column. The list provided will become the column header prefixes in the output.
  • 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.
  • ROLLUP: This option is used to specify the multilevel aggregates.
  • CUBE: This option is used to specify the multidimensional aggregates.
  • 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 ''.
The default value is an empty Dictionary.

Definition at line 2274 of file AggregateGroupBy.cs.

◆ AggregateGroupByRequest() \[4/6]

kinetica.AggregateGroupByRequest.AggregateGroupByRequest ( )
inline

Constructs an AggregateGroupByRequest object with default parameters.

Definition at line 1155 of file AggregateGroupBy.cs.

◆ AggregateGroupByRequest() \[5/6]

kinetica.AggregateGroupByRequest.AggregateGroupByRequest ( string table\_name,
IList\< string > column\_names,
long? offset = null,
long? limit = null,
IDictionary\< string, string > options = null )
inline

Constructs an AggregateGroupByRequest object with the specified parameters.

Parameters
table\_name Name of an existing table or view on which the operation will be performed, in \[schema\_name.]table\_name format, using standard name resolution rules.
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 default value is 0. 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 maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server's own limit, defined by the max\_get\_records\_size parameter in the server configuration. Use has\_more\_records to see if more records exist in the result to be fetched, and offset and limit to request subsequent pages of results. The default value is -9999.
options Optional parameters.
  • 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. 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.
  • 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.
  • EXPRESSION: Filter expression to apply to the table prior to computing the aggregate group by.
  • PIPELINED\_EXPRESSION\_EVALUATION: Evaluate the group-by during last JoinedSet filter plan step. Supported values: The default value is FALSE.
  • HAVING: Filter expression to apply to the aggregated results.
  • 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.
  • 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.
  • 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 ''.
  • STRATEGY\_DEFINITION: The tier strategy for the table and its columns.
  • COMPRESSION\_CODEC: The default compression codec for the result table's columns.
  • 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.
  • 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: 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. Supported values: The default value is FALSE.
  • 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. Supported values: The default value is FALSE.
  • RESULT\_TABLE\_GENERATE\_SOFT\_PK: 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.
  • TTL: Sets the TTL of the table specified in RESULT\_TABLE.
  • 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.
  • 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.
  • 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.
  • 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.
  • PARTITION\_TYPE: Partitioning scheme to use for the result table. Supported values:
  • 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.
  • 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.
  • IS\_AUTOMATIC\_PARTITION: 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.
  • VIEW\_ID: ID of view of which the result table will be a member. The default value is ''.
  • PIVOT: Pivot column.
  • PIVOT\_VALUES: Comma-separated list of the values in the PIVOT column. The list provided will become the column header prefixes in the output.
  • 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.
  • ROLLUP: This option is used to specify the multilevel aggregates.
  • CUBE: This option is used to specify the multidimensional aggregates.
  • 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 ''.
The default value is an empty Dictionary.

Definition at line 1699 of file AggregateGroupBy.cs.

◆ AggregateGroupByRequest() \[6/6]

kinetica.AggregateGroupByRequest.AggregateGroupByRequest ( string table\_name,
IList\< string > column\_names,
long? offset = null,
long? limit = null,
string encoding = null,
IDictionary\< string, string > options = null )
inline

Constructs an AggregateGroupByRequest object with the specified parameters.

Parameters
table\_name Name of an existing table or view on which the operation will be performed, in \[schema\_name.]table\_name format, using standard name resolution rules.
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 default value is 0. 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 maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server's own limit, defined by the max\_get\_records\_size parameter in the server configuration. Use has\_more\_records to see if more records exist in the result to be fetched, and offset and limit to request subsequent pages of results. The default value is -9999.
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.
  • 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. 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.
  • 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.
  • EXPRESSION: Filter expression to apply to the table prior to computing the aggregate group by.
  • PIPELINED\_EXPRESSION\_EVALUATION: Evaluate the group-by during last JoinedSet filter plan step. Supported values: The default value is FALSE.
  • HAVING: Filter expression to apply to the aggregated results.
  • 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.
  • 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.
  • 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 ''.
  • STRATEGY\_DEFINITION: The tier strategy for the table and its columns.
  • COMPRESSION\_CODEC: The default compression codec for the result table's columns.
  • 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.
  • 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: 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. Supported values: The default value is FALSE.
  • 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. Supported values: The default value is FALSE.
  • RESULT\_TABLE\_GENERATE\_SOFT\_PK: 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.
  • TTL: Sets the TTL of the table specified in RESULT\_TABLE.
  • 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.
  • 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.
  • 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.
  • 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.
  • PARTITION\_TYPE: Partitioning scheme to use for the result table. Supported values:
  • 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.
  • 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.
  • IS\_AUTOMATIC\_PARTITION: 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.
  • VIEW\_ID: ID of view of which the result table will be a member. The default value is ''.
  • PIVOT: Pivot column.
  • PIVOT\_VALUES: Comma-separated list of the values in the PIVOT column. The list provided will become the column header prefixes in the output.
  • 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.
  • ROLLUP: This option is used to specify the multilevel aggregates.
  • CUBE: This option is used to specify the multidimensional aggregates.
  • 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 ''.
The default value is an empty Dictionary.

Definition at line 2274 of file AggregateGroupBy.cs.

Property Documentation

◆ column\_names

IList\< string > kinetica.AggregateGroupByRequest.column\_names = new List\()
getset

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

Definition at line 588 of file AggregateGroupBy.cs.

◆ encoding

string kinetica.AggregateGroupByRequest.encoding = Encoding.BINARY
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 631 of file AggregateGroupBy.cs.

◆ limit

long kinetica.AggregateGroupByRequest.limit = -9999
getset

A positive integer indicating the maximum number of results to be returned, or END\_OF\_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned.

The number of records returned will never exceed the server's own limit, defined by the max\_get\_records\_size parameter in the server configuration. Use has\_more\_records to see if more records exist in the result to be fetched, and AggregateGroupByRequest.offset and AggregateGroupByRequest.limit to request subsequent pages of results. The default value is -9999.

Definition at line 609 of file AggregateGroupBy.cs.

◆ offset

long kinetica.AggregateGroupByRequest.offset = 0
getset

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

The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX\_INT.

Definition at line 594 of file AggregateGroupBy.cs.

◆ options

IDictionary\< string, string > kinetica.AggregateGroupByRequest.options = new Dictionary\()
getset

Optional parameters.

The default value is an empty Dictionary.

Definition at line 1151 of file AggregateGroupBy.cs.

◆ table\_name

string kinetica.AggregateGroupByRequest.table\_name
getset

Name of an existing table or view on which the operation will be performed, in \[schema\_name.

]table\_name format, using standard name resolution rules.

Definition at line 584 of file AggregateGroupBy.cs.

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