Skip to main content

A set of parameters for Kinetica.showStatistics. More…

Inheritance diagram for kinetica.ShowStatisticsRequest:
[legend]
Collaboration diagram for kinetica.ShowStatisticsRequest:
[legend]

​
Classes

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

​
Public Member Functions

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

IList< string > table_names = new List<string>() [get, set]
 Names of tables whose metadata will be fetched, each in [schema_name.
 
 Properties inherited from kinetica.KineticaData
Schema Schema [get]
 Avro Schema for this class.
 
IDictionary< string, string > options = new Dictionary<string, string>() [get, set]
 Optional parameters.
 
 ShowStatisticsRequest ()
 Constructs a ShowStatisticsRequest object with default parameters.
 
 ShowStatisticsRequest (IList< string > table_names, IDictionary< string, string > options=null)
 Constructs a ShowStatisticsRequest object with the specified parameters.
 

​
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.showStatistics.

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

Definition at line 16 of file ShowStatistics.cs.

​
Constructor & Destructor Documentation

​
◆ ShowStatisticsRequest() [1/4]

kinetica.ShowStatisticsRequest.ShowStatisticsRequest ()
 inline

Constructs a ShowStatisticsRequest object with default parameters.

Definition at line 189 of file ShowStatistics.cs.

​
◆ ShowStatisticsRequest() [2/4]

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. A single entry of _* expands to every user table the caller may read (excluding system schemas, views, and temporary tables); when used it must be the only entry.
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.
  • COLUMN_NAMES: Columns, per table in table_names , to collect statistics for wheninput.key options.collect_now is TRUE; ignored otherwise. Encoded as a ’;‘-separated parallel array aligned with table_names (e.g. X,Y;Z requests columns x,y for the first table and z for the second). A value of _* expands to every collectable column on each table (geometry, vector, JSON, and array columns are skipped). An explicit list may not be combined with a _* table_names wildcard. The default value is ”.
  • COLLECT_NOW: If TRUE, the columns named byinput.key options.column_names are collected synchronously during this request and reflected in the response. Default FALSE. Supported values:The default value is FALSE.
The default value is an empty Dictionary.

Definition at line 277 of file ShowStatistics.cs.

​
◆ ShowStatisticsRequest() [3/4]

kinetica.ShowStatisticsRequest.ShowStatisticsRequest ()
 inline

Constructs a ShowStatisticsRequest object with default parameters.

Definition at line 185 of file ShowStatistics.cs.

​
◆ ShowStatisticsRequest() [4/4]

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. A single entry of ’*’ expands to every user table the caller may read (excluding system schemas, views, and temporary tables); when used it must be the only entry.
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.
  • COLUMN_NAMES: Columns, per table in table_names , to collect statistics for wheninput.key options.collect_now is TRUE; ignored otherwise. Encoded as a ’;‘-separated parallel array aligned with table_names (e.g. ‘x,y;z’ requests columns x,y for the first table and z for the second). A value of '' expands to every collectable column on each table (geometry, vector, JSON, and array columns are skipped). An explicit list may not be combined with a '' table_names wildcard. The default value is ”.
  • COLLECT_NOW: If TRUE, the columns named byinput.key options.column_names are collected synchronously during this request and reflected in the response. Supported values:The default value is FALSE.
The default value is an empty Dictionary.

Definition at line 271 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.

The default value is an empty Dictionary.

Definition at line 185 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. A single entry of _* expands to every user table the caller may read (excluding system schemas, views, and temporary tables); when used it must be the only entry.

]table_name format, using standard name resolution rules.

All provided tables must exist, or an error is returned. A single entry of ’*’ expands to every user table the caller may read (excluding system schemas, views, and temporary tables); when used it must be the only entry.

Definition at line 105 of file ShowStatistics.cs.

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