> ## 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. # aggregate_group_by
aggregate\_group\_by(table\_name=None, column\_names=None, offset=0, limit=-9999, encoding='binary', options={"{"}{"}"})\[source]

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 input parameter offset and input parameter 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”{"}"}.

Input parameter 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 input parameter 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 (input parameter offset is 0 and input parameter 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 input parameter column\_names is an unrestricted-length string.

Parameters

table\_name (str) –

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 str) –

List of one or more column names, expressions, and aggregate expressions. The user can provide a single element (which will be automatically promoted to a list internally) or a list.

offset (long) –

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 (long) –

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 output parameter has\_more\_records to see if more records exist in the result to be fetched, and input parameter offset and input parameter limit to request subsequent pages of results. The default value is -9999.

encoding (str) –

Specifies the encoding for returned records. Allowed values are:

  • 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 (dict of str to str) –

Optional parameters. Allowed keys are:

  • 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. Allowed values are:

    • true

    • false

    The default value is ‘false’.

  • collection\_name – \[DEPRECATED–please specify the containing schema as part of result\_table and use GPUdb.create\_schema() 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. Allowed values are:

    • true

    • false

    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. Allowed values are:

    • 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. Allowed values are:

    • 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. Allowed values are:

    • 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. Allowed values are:

    • true

    • false

    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. Allowed values are:

    • true

    • false

    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. Allowed values are:

    • true

    • false

    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. Allowed values are:

  • 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. Allowed values are:

    • true

    • false

    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 input parameter 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 dict ( {"{"}{"}"} ).

Returns

A dict with the following entries–

response\_schema\_str (str) –

Avro schema of output parameter binary\_encoded\_response or output parameter json\_encoded\_response.

binary\_encoded\_response (bytes) –

Avro binary encoded response.

json\_encoded\_response (str) –

Avro JSON encoded response.

total\_number\_of\_records (long) –

Total/Filtered number of records. This may be an over-estimate if a limit was applied and there are additional records (i.e., when output parameter has\_more\_records is true).

has\_more\_records (bool) –

Too many records. Returned a partial set.

info (dict of str to str) –

Additional information. Allowed keys are:

  • qualified\_result\_table\_name – The fully qualified name of the table (i.e. including the schema) used to store the results.

The default value is an empty dict ( {"{"}{"}"} ).

record\_type (RecordType or None) –

A RecordType object using which the user can decode the binary data by using GPUdbRecord.decode\_binary\_data(). If JSON encoding is used, then None.