Kinetica   C#   API  Version 7.2.3.0
kinetica.CollectStatisticsRequest Class Reference

A set of parameters for Kinetica.collectStatistics. 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, in [schema_name. More...
 
IList< string > column_names = new List<string>() [get, set]
 List of one or more column names in table_name for which to collect statistics (cardinality, mean value, etc.). More...
 
IDictionary< string, string > options = new Dictionary<string, 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.

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

Definition at line 16 of file CollectStatistics.cs.

Constructor & Destructor Documentation

◆ CollectStatisticsRequest() [1/2]

kinetica.CollectStatisticsRequest.CollectStatisticsRequest ( )
inline

Constructs a CollectStatisticsRequest object with default parameters.

Definition at line 36 of file CollectStatistics.cs.

◆ CollectStatisticsRequest() [2/2]

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, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table.
column_namesList of one or more column names in table_name for which to collect statistics (cardinality, mean value, etc.).
optionsOptional parameters. The default value is an empty Dictionary.

Definition at line 51 of file CollectStatistics.cs.

Property Documentation

◆ column_names

IList<string> kinetica.CollectStatisticsRequest.column_names = new List<string>()
getset

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

Definition at line 27 of file CollectStatistics.cs.

◆ options

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

Optional parameters.

The default value is an empty Dictionary.

Definition at line 32 of file CollectStatistics.cs.

◆ table_name

string kinetica.CollectStatisticsRequest.table_name
getset

Name of a table, in [schema_name.

]table_name format, using standard name resolution rules.

Must be an existing table.

Definition at line 22 of file CollectStatistics.cs.


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