Kinetica C# API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
kinetica.CollectStatisticsRequest Class Reference

A set of parameters for Kinetica.collectStatistics(string,IList{string},IDictionary{string, string}). More...

+ Inheritance diagram for kinetica.CollectStatisticsRequest:
+ Collaboration diagram for kinetica.CollectStatisticsRequest:

Public Member Functions

 CollectStatisticsRequest ()
 Constructs a CollectStatisticsRequest object with default parameters. More...
 
 CollectStatisticsRequest (string table_name, IList< string > column_names, IDictionary< string, string > options=null)
 Constructs a CollectStatisticsRequest 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 a table. Must be an existing table. More...
 
IList< string > column_names [get, set]
 List of one or more column names in for which to collect statistics (cardinality, mean value, etc.). More...
 
IDictionary< string, string > options = new List<string>() [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 Kinetica.collectStatistics(string,IList{string},IDictionary{string, string}).


Collect statistics for a column(s) in a specified table.

Definition at line 19 of file CollectStatistics.cs.

Constructor & Destructor Documentation

kinetica.CollectStatisticsRequest.CollectStatisticsRequest ( )
inline

Constructs a CollectStatisticsRequest object with default parameters.

Definition at line 37 of file CollectStatistics.cs.

kinetica.CollectStatisticsRequest.CollectStatisticsRequest ( string  table_name,
IList< string >  column_names,
IDictionary< string, string >  options = null 
)
inline

Constructs a CollectStatisticsRequest object with the specified parameters.

Parameters
table_nameName of a table. Must be an existing table.
column_namesList of one or more column names in for which to collect statistics (cardinality, mean value, etc.).
optionsOptional parameters. The default value is an empty Dictionary.

Definition at line 50 of file CollectStatistics.cs.

Property Documentation

IList<string> kinetica.CollectStatisticsRequest.column_names
getset

List of one or more column names in for which to collect statistics (cardinality, mean value, etc.).

Definition at line 28 of file CollectStatistics.cs.

IDictionary<string, string> kinetica.CollectStatisticsRequest.options = new List<string>()
getset

Optional parameters.

The default value is an empty Dictionary.

Definition at line 32 of file CollectStatistics.cs.

string kinetica.CollectStatisticsRequest.table_name
getset

Name of a table. Must be an existing table.

Definition at line 23 of file CollectStatistics.cs.


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