Kinetica   C#   API  Version 7.2.3.0
kinetica.ShowStatisticsRequest Class Reference

A set of parameters for Kinetica.showStatistics. More...

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

Classes

struct  Options
 A set of string constants for the parameter options. More...
 

Public Member Functions

 ShowStatisticsRequest ()
 Constructs a ShowStatisticsRequest object with default parameters. More...
 
 ShowStatisticsRequest (IList< string > table_names, IDictionary< string, string > options=null)
 Constructs a ShowStatisticsRequest 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

IList< string > table_names = new List<string>() [get, set]
 Names of tables whose metadata will be fetched, each in [schema_name. 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.showStatistics.

Retrieves the collected column statistics for the specified table(s).

Definition at line 16 of file ShowStatistics.cs.

Constructor & Destructor Documentation

◆ ShowStatisticsRequest() [1/2]

kinetica.ShowStatisticsRequest.ShowStatisticsRequest ( )
inline

Constructs a ShowStatisticsRequest object with default parameters.

Definition at line 81 of file ShowStatistics.cs.

◆ ShowStatisticsRequest() [2/2]

kinetica.ShowStatisticsRequest.ShowStatisticsRequest ( IList< string >  table_names,
IDictionary< string, string >  options = null 
)
inline

Constructs a ShowStatisticsRequest object with the specified parameters.

Parameters
table_namesNames of tables whose metadata will be fetched, each in [schema_name.]table_name format, using standard name resolution rules. All provided tables must exist, or an error is returned.
optionsOptional parameters.
  • NO_ERROR_IF_NOT_EXISTS: If TRUE and if the table names specified in table_names does not exist, no error is returned. If FALSE and if the table names specified in table_names does not exist, then an error is returned. Supported values: The default value is FALSE.
The default value is an empty Dictionary.

Definition at line 117 of file ShowStatistics.cs.

Property Documentation

◆ options

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

Optional parameters.

The default value is an empty Dictionary.

Definition at line 77 of file ShowStatistics.cs.

◆ table_names

IList<string> kinetica.ShowStatisticsRequest.table_names = new List<string>()
getset

Names of tables whose metadata will be fetched, each in [schema_name.

]table_name format, using standard name resolution rules.

All provided tables must exist, or an error is returned.

Definition at line 49 of file ShowStatistics.cs.


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