Skip to main content

A set of parameters for Kinetica.clearStatistics. More…

Inheritance diagram for kinetica.ClearStatisticsRequest:
Collaboration diagram for kinetica.ClearStatisticsRequest:

Public Member Functions

 ClearStatisticsRequest ()
 Constructs a ClearStatisticsRequest object with default parameters.
 
 ClearStatisticsRequest (string table_name=null, string column_name=null, IDictionary< string, string > options=null)
 Constructs a ClearStatisticsRequest object with the specified parameters.
 
 ClearStatisticsRequest ()
 Constructs a ClearStatisticsRequest object with default parameters.
 
 ClearStatisticsRequest (string table_name=null, string column_name=null, IDictionary< string, string > options=null)
 Constructs a ClearStatisticsRequest 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.
 
string column_name = "" [get, set]
 Name of the column in ClearStatisticsRequest.table_name for which to clear statistics.
 
IDictionary< string, string > options = new Dictionary<string, string>() [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.clearStatistics.

Clears statistics (cardinality, mean value, etc.) for a column in a specified table.

Definition at line 16 of file ClearStatistics.cs.

Constructor & Destructor Documentation

◆ ClearStatisticsRequest() [1/4]

kinetica.ClearStatisticsRequest.ClearStatisticsRequest ()
inline

Constructs a ClearStatisticsRequest object with default parameters.

Definition at line 44 of file ClearStatistics.cs.

◆ ClearStatisticsRequest() [2/4]

kinetica.ClearStatisticsRequest.ClearStatisticsRequest (stringtable_name = null,
stringcolumn_name = null,
IDictionary< string, string >options = null )
inline

Constructs a ClearStatisticsRequest 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. A value of ’*’ clears statistics on every user table the caller may read (excluding system schemas, views, and temporary tables); when used, column_name must be empty. The default value is ”.
column_nameName of the column in table_name for which to clear statistics. The column must be from an existing table. An empty string clears statistics for all columns in the table. Must be empty when table_name is ’*’. The default value is ”.
optionsOptional parameters. The default value is an empty Dictionary.

Definition at line 64 of file ClearStatistics.cs.

◆ ClearStatisticsRequest() [3/4]

kinetica.ClearStatisticsRequest.ClearStatisticsRequest ()
inline

Constructs a ClearStatisticsRequest object with default parameters.

Definition at line 44 of file ClearStatistics.cs.

◆ ClearStatisticsRequest() [4/4]

kinetica.ClearStatisticsRequest.ClearStatisticsRequest (stringtable_name = null,
stringcolumn_name = null,
IDictionary< string, string >options = null )
inline

Constructs a ClearStatisticsRequest 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. A value of ’*’ clears statistics on every user table the caller may read (excluding system schemas, views, and temporary tables); when used, column_name must be empty. The default value is ”.
column_nameName of the column in table_name for which to clear statistics. The column must be from an existing table. An empty string clears statistics for all columns in the table. Must be empty when table_name is ’*’. The default value is ”.
optionsOptional parameters. The default value is an empty Dictionary.

Definition at line 64 of file ClearStatistics.cs.

Property Documentation

◆ column_name

string kinetica.ClearStatisticsRequest.column_name = ""
getset

Name of the column in ClearStatisticsRequest.table_name for which to clear statistics.

The column must be from an existing table. An empty string clears statistics for all columns in the table. Must be empty when ClearStatisticsRequest.table_name is ’*’. The default value is ”.

Definition at line 35 of file ClearStatistics.cs.

◆ options

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

Optional parameters.

The default value is an empty Dictionary.

Definition at line 40 of file ClearStatistics.cs.

◆ table_name

string kinetica.ClearStatisticsRequest.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 ’*’ clears statistics on every user table the caller may read (excluding system schemas, views, and temporary tables); when used, ClearStatisticsRequest.column_name must be empty. The default value is ”.

Definition at line 26 of file ClearStatistics.cs.


The documentation for this class was generated from the following files:
  • _build/public-os_centos8-arch_amd64-cc_gcc_8.5.0/install/Kinetica/Protocol/ClearStatistics.cs
  • Kinetica/Protocol/ClearStatistics.cs