> ## Documentation Index > Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt > Use this file to discover all available pages before exploring further. # kinetica.CollectStatisticsRequest > kinetica.CollectStatisticsRequest — Kinetica C# API

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.
 
  CollectStatisticsRequest (string table\_name, IList\< string > column\_names, IDictionary\< string, string > options=null)
  Constructs a CollectStatisticsRequest object with the specified parameters.
 
  CollectStatisticsRequest ()
  Constructs a CollectStatisticsRequest object with default parameters.
 
  CollectStatisticsRequest (string table\_name, IList\< string > column\_names, IDictionary\< string, string > options=null)
  Constructs a CollectStatisticsRequest object with the specified parameters.
 
 Public Member Functions inherited from kinetica.KineticaData
  KineticaData (KineticaType type)
  Constructor from Kinetica Type.
 
  KineticaData (System.Type type=null)
  Default constructor, with optional System.Type.
 
object  Get (int fieldPos)
  Retrieve a specific property from this object.
 
void  Put (int fieldPos, object fieldValue)
  Write a specific property to this object.
 
  KineticaData (KineticaType type)
  Constructor from Kinetica Type.
 
  KineticaData (System.Type type=null)
  Default constructor, with optional System.Type.
 
object  Get (int fieldPos)
  Retrieve a specific property from this object.
 
void  Put (int fieldPos, object fieldValue)
  Write a specific property to this object.
 

Properties
string  table\_name \[get, set]
  Name of a table, in \[schema\_name.
 
IList\< string >  column\_names = new List\() \[get, set]
  List of one or more column names in CollectStatisticsRequest.table\_name for which to collect statistics (cardinality, mean value, etc.).
 
IDictionary\< string, string >  options = new Dictionary\() \[get, set]
  Optional parameters.
 
 Properties inherited from kinetica.KineticaData
Schema  Schema \[get]
  Avro Schema for this class.
 

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.
 
static ? RecordSchema  SchemaFromType (System.Type t, KineticaType? ktype=null)
  Create an Avro Schema from a System.Type and a KineticaType.
 

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/4]

kinetica.CollectStatisticsRequest.CollectStatisticsRequest ( )
inline

Constructs a CollectStatisticsRequest object with default parameters.

Definition at line 43 of file CollectStatistics.cs.

◆ CollectStatisticsRequest() \[2/4]

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\_name Name of a table, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing table. A value of \_\* collects statistics on every user table the caller may read (excluding system schemas, views, and temporary tables); when used, column\_names must be \_\["\*"].
column\_names List of one or more column names in table\_name for which to collect statistics (cardinality, mean value, etc.). A single entry of \_\* expands to every collectable column on the table (geometry, vector, JSON, and array columns are skipped).
options Optional parameters. The default value is an empty Dictionary.

Definition at line 62 of file CollectStatistics.cs.

◆ CollectStatisticsRequest() \[3/4]

kinetica.CollectStatisticsRequest.CollectStatisticsRequest ( )
inline

Constructs a CollectStatisticsRequest object with default parameters.

Definition at line 43 of file CollectStatistics.cs.

◆ CollectStatisticsRequest() \[4/4]

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\_name Name of a table, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing table. A value of '' collects statistics on every user table the caller may read (excluding system schemas, views, and temporary tables); when used, column\_names must be ''.
column\_names List of one or more column names in table\_name for which to collect statistics (cardinality, mean value, etc.). A single entry of '\*' expands to every collectable column on the table (geometry, vector, JSON, and array columns are skipped).
options Optional parameters. The default value is an empty Dictionary.

Definition at line 62 of file CollectStatistics.cs.

Property Documentation

◆ column\_names

IList\< string > kinetica.CollectStatisticsRequest.column\_names = new List\()
getset

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

A single entry of \_\* expands to every collectable column on the table (geometry, vector, JSON, and array columns are skipped).

A single entry of '\*' expands to every collectable column on the table (geometry, vector, JSON, and array columns are skipped).

Definition at line 34 of file CollectStatistics.cs.

◆ options

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

Optional parameters.

The default value is an empty Dictionary.

Definition at line 39 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. A value of \_\* collects statistics on every user table the caller may read (excluding system schemas, views, and temporary tables); when used, CollectStatisticsRequest.column\_names must be \_\["\*"].

]table\_name format, using standard name resolution rules.

Must be an existing table. A value of '' collects statistics on every user table the caller may read (excluding system schemas, views, and temporary tables); when used, CollectStatisticsRequest.column\_names must be ''.

Definition at line 26 of file CollectStatistics.cs.

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