aggregate_histogram
- aggregate_histogram(
table_name: string,
column_name: string,
start: number,
end: number,
interval: number,
options?: Record<string, string>,
callback?: GPUdbCallback,
): Promise<AggregateHistogramResponse>Parameters
- table_name: string
Name of the table on which the operation will be performed. Must be an existing table, in [schema_name.]table_name format, using standard name resolution rules.
- column_name: string
Name of a column or an expression of one or more column names over which the histogram will be calculated.
- start: number
Lower end value of the histogram interval, inclusive.
- end: number
Upper end value of the histogram interval, inclusive.
- interval: number
The size of each bin within the start and end parameters.
Optionaloptions: Record<string, string>Optional parameters.
Optionalcallback: GPUdbCallbackOptional callback function
Returns Promise<AggregateHistogramResponse>
Promise<Types.AggregateHistogramResponse> - Promise resolving to the response
- Defined in src/GPUdb.ts:3089
- table_name: string
aggregate_histogram_request
- aggregate_histogram_request(
request: AggregateHistogramRequest,
callback?: GPUdbCallback,
): Promise<AggregateHistogramResponse>Performs a histogram calculation given a table, a column, and an interval function. The
intervalis used to produce bins of that size and the result, computed over the records falling within each bin, is returned. For each bin, the start value is inclusive, but the end value is exclusive—except for the very last bin for which the end value is also inclusive. The value returned for each bin is the number of records in it, except when a column name is provided as a value_column. In this latter case the sum of the values corresponding to the value_column is used as the result instead. The total number of bins requested cannot exceed 10,000.NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service a request that specifies a value_column.
Parameters
- request: AggregateHistogramRequest
Request object containing the parameters for the operation
Optionalcallback: GPUdbCallbackOptional callback function
Returns Promise<AggregateHistogramResponse>
Promise<Types.AggregateHistogramResponse> - Promise resolving to the response
- Defined in src/GPUdb.ts:3046
- request: AggregateHistogramRequest
Performs a histogram calculation given a table, a column, and an interval function. The
intervalis used to produce bins of that size and the result, computed over the records falling within each bin, is returned. For each bin, the start value is inclusive, but the end value is exclusive—except for the very last bin for which the end value is also inclusive. The value returned for each bin is the number of records in it, except when a column name is provided as a value_column. In this latter case the sum of the values corresponding to the value_column is used as the result instead. The total number of bins requested cannot exceed 10,000.NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service a request that specifies a value_column.