gpudb::AggregateHistogramRequest Struct Reference

A set of input parameters for const. More...

#include <gpudb/protocol/aggregate_histogram.h>

Public Member Functions
	AggregateHistogramRequest ()
	Constructs an AggregateHistogramRequest object with default parameter values. More...
	AggregateHistogramRequest (const std::string &tableName_, const std::string &columnName_, const double start_, const double end_, const double interval_, const std::map< std::string, std::string > &options_)
	Constructs an AggregateHistogramRequest object with the specified parameters. More...

Public Attributes
std::string	tableName
std::string	columnName
double	start
double	end
double	interval
std::map< std::string, std::string >	options

Detailed Description

A set of input parameters for const.

Performs a histogram calculation given a table, a column, and an interval function. The interval is 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 option.

Definition at line 31 of file aggregate_histogram.h.

Constructor & Destructor Documentation

gpudb::AggregateHistogramRequest::AggregateHistogramRequest ( )

inline

Constructs an AggregateHistogramRequest object with default parameter values.

Definition at line 38 of file aggregate_histogram.h.

gpudb::AggregateHistogramRequest::AggregateHistogramRequest ( const std::string &  tableName_, const std::string &  columnName_, const double  start_, const double  end_, const double  interval_, const std::map< std::string, std::string > &  options_  )

inline

Constructs an AggregateHistogramRequest object with the specified parameters.

Parameters

[in]	tableName_	Name of the table on which the operation will be performed. Must be an existing table or collection.
[in]	columnName_	Name of a column or an expression of one or more column names over which the histogram will be calculated.
[in]	start_	Lower end value of the histogram interval, inclusive.
[in]	end_	Upper end value of the histogram interval, inclusive.
[in]	interval_	The size of each bin within the start and end parameters.
[in]	options_	Optional parameters. gpudb::aggregate_histogram_value_column: The name of the column to use when calculating the bin values (values are summed). The column must be a numerical type (int, double, long, float).

Definition at line 75 of file aggregate_histogram.h.

Member Data Documentation

std::string gpudb::AggregateHistogramRequest::columnName

Definition at line 86 of file aggregate_histogram.h.

double gpudb::AggregateHistogramRequest::end

Definition at line 88 of file aggregate_histogram.h.

double gpudb::AggregateHistogramRequest::interval

Definition at line 89 of file aggregate_histogram.h.

std::map<std::string, std::string> gpudb::AggregateHistogramRequest::options

Definition at line 90 of file aggregate_histogram.h.

double gpudb::AggregateHistogramRequest::start

Definition at line 87 of file aggregate_histogram.h.

std::string gpudb::AggregateHistogramRequest::tableName

Definition at line 85 of file aggregate_histogram.h.

---

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

• gpudb/protocol/aggregate_histogram.h