kinetica.AggregateStatisticsRequest Class Reference

A set of parameters for /aggregate/statistics. More...

Inheritance diagram for kinetica.AggregateStatisticsRequest:

Collaboration diagram for kinetica.AggregateStatisticsRequest:

Classes
struct	Options
	Optional parameters. More...
struct	Stats
	Comma separated list of the statistics to calculate, e.g. More...

Public Member Functions
	AggregateStatisticsRequest ()
	Constructs an AggregateStatisticsRequest object with default parameters. More...
	AggregateStatisticsRequest (string table_name, string column_name, string stats, IDictionary< string, string > options=null)
	Constructs an AggregateStatisticsRequest object with the specified parameters. More...
Public Member Functions inherited from kinetica.KineticaData
	KineticaData (KineticaType type)
	Constructor from Kinetica Type More...
	KineticaData (System.Type type=null)
	Default constructor, with optional System.Type More...
object	Get (int fieldPos)
	Retrieve a specific property from this object More...
void	Put (int fieldPos, object fieldValue)
	Write a specific property to this object More...

Properties
string	table_name [get, set]
	Name of the table on which the statistics operation will be performed. More...
string	column_name [get, set]
	Name of the primary column for which the statistics are to be calculated. More...
string	stats [get, set]
	Comma separated list of the statistics to calculate, e.g. More...
IDictionary< string, string >	options [get, set]
	Optional parameters. More...
Properties inherited from kinetica.KineticaData
Schema	Schema [get]
	Avro Schema for this class More...

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

Detailed Description

A set of parameters for /aggregate/statistics.

Calculates the requested statistics of the given column(s) in a given table.
The available statistics are count (number of total objects), mean, stdv (standard deviation), variance, skew, kurtosis, sum, min, max, weighted_average, cardinality (unique count), estimated_cardinality, percentile and percentile_rank.
Estimated cardinality is calculated by using the hyperloglog approximation technique.
Percentiles and percentile ranks are approximate and are calculated using the t-digest algorithm. They must include the desired percentile/percentile_rank. To compute multiple percentiles each value must be specified separately (i.e. 'percentile(75.0),percentile(99.0),percentile_rank(1234.56),percentile_rank(-5)').
The weighted average statistic requires a weight_column_name to be specified in <member name="options">. The weighted average is then defined as the sum of the products of <member name="column_name"> times the weight_column_name values divided by the sum of the weight_column_name values.
Additional columns can be used in the calculation of statistics via the additional_column_names option. Values in these columns will be included in the overall aggregate calculation–individual aggregates will not be calculated per additional column. For instance, requesting the count & mean of <member name="column_name"> x and additional_column_names y & z, where x holds the numbers 1-10, y holds 11-20, and z holds 21-30, would return the total number of x, y, & z values (30), and the single average value across all x, y, & z values (15.5).
The response includes a list of key/value pairs of each statistic requested and its corresponding value.

Definition at line 53 of file AggregateStatistics.cs.

Constructor & Destructor Documentation

kinetica.AggregateStatisticsRequest.AggregateStatisticsRequest ( )

inline

Constructs an AggregateStatisticsRequest object with default parameters.

Definition at line 198 of file AggregateStatistics.cs.

kinetica.AggregateStatisticsRequest.AggregateStatisticsRequest ( string  table_name, string  column_name, string  stats, IDictionary< string, string >  options = null  )

inline

Constructs an AggregateStatisticsRequest object with the specified parameters.

Parameters

table_name	Name of the table on which the statistics operation will be performed.
column_name	Name of the primary column for which the statistics are to be calculated.
stats	Comma separated list of the statistics to calculate, e.g. "sum,mean". Values: count, mean, stdv, variance, skew, kurtosis, sum, min, max, weighted_average, cardinality, estimated_cardinality, percentile, percentile_rank.
options	Optional parameters. additional_column_names A list of comma separated column names over which statistics can be accumulated along with the primary column. All columns listed and must be of the same type. Must not include the column specified in and no column can be listed twice. weight_column_name Name of column used as weighting attribute for the weighted average statistic.

Definition at line 232 of file AggregateStatistics.cs.

Property Documentation

string kinetica.AggregateStatisticsRequest.column_name

getset

Name of the primary column for which the statistics are to be calculated.

Definition at line 165 of file AggregateStatistics.cs.

IDictionary<string, string> kinetica.AggregateStatisticsRequest.options

getset

Optional parameters.

• additional_column_names A list of comma separated column names over which statistics can be accumulated along with the primary column. All columns listed and must be of the same type. Must not include the column specified in and no column can be listed twice.
• weight_column_name Name of column used as weighting attribute for the weighted average statistic.

Definition at line 193 of file AggregateStatistics.cs.

string kinetica.AggregateStatisticsRequest.stats

getset

Comma separated list of the statistics to calculate, e.g.

"sum,mean". Values: count, mean, stdv, variance, skew, kurtosis, sum, min, max, weighted_average, cardinality, estimated_cardinality, percentile, percentile_rank.

Definition at line 172 of file AggregateStatistics.cs.

string kinetica.AggregateStatisticsRequest.table_name

getset

Name of the table on which the statistics operation will be performed.

Definition at line 161 of file AggregateStatistics.cs.

---

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

• Kinetica/Protocol/AggregateStatistics.cs