◆ aggregateGroupBy() [1/2]
| inline |
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 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.
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 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 (offset is 0 and 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 column_names is an unrestricted-length string.
| request_ | Request object containing the parameters for the operation. |
Definition at line 3794 of file KineticaFunctions.cs.
◆ aggregateGroupBy() [2/2]
| inline |
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 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.
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 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 (offset is 0 and 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 column_names is an unrestricted-length string.
| 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.
|
Definition at line 4493 of file KineticaFunctions.cs.
◆ AggregateGroupByAsync() [1/2]
| inline |
Calculates unique combinations (groups) of values for the given columns in a given table or view and computes aggregates on each unique combination.
(async)
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 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.
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 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 (offset is 0 and 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 column_names is an unrestricted-length string.
| request_ | Request object containing the parameters for the operation. |
| cancellationToken | Cancellation token to cancel the operation. |
Definition at line 3878 of file KineticaFunctions.cs.
◆ AggregateGroupByAsync() [2/2]
| inline |
Calculates unique combinations (groups) of values for the given columns in a given table or view and computes aggregates on each unique combination.
(async)
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 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.
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 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 (offset is 0 and 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 column_names is an unrestricted-length string.
| 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.
|
| cancellationToken | Cancellation token to cancel the operation. |
Definition at line 5107 of file KineticaFunctions.cs.