Skip to main content

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

Static Public Attributes

const string NO_ERROR_IF_NOT_EXISTS = “no_error_if_not_exists”
 If TRUE and if the table names specified in ShowStatisticsRequest.table_names does not exist, no error is returned.
 
const string TRUE = “true”
 A boolean constant for the ShowStatisticsRequest.Options options.
 
const string FALSE = “false”
 A boolean constant for the ShowStatisticsRequest.Options options.
 
const string COLUMN_NAMES = “column_names”
 Columns, per table in ShowStatisticsRequest.table_names, to collect statistics for wheninput.key options.collect_now is TRUE; ignored otherwise.
 
const string COLLECT_NOW = “collect_now”
 If TRUE, the columns named byinput.key options.column_names are collected synchronously during this request and reflected in the response.
 

Detailed Description

A set of string constants for the parameter ShowStatisticsRequest.options.

Optional parameters.

Definition at line 21 of file ShowStatistics.cs.

Member Data Documentation

◆ COLLECT_NOW

const string kinetica.ShowStatisticsRequest.Options.COLLECT_NOW = “collect_now”
static

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.

Supported values:

The default value is FALSE.

Definition at line 94 of file ShowStatistics.cs.

◆ COLUMN_NAMES

const string kinetica.ShowStatisticsRequest.Options.COLUMN_NAMES = “column_names”
static

Columns, per table in ShowStatisticsRequest.table_names, to collect statistics for wheninput.key options.collect_now is TRUE; ignored otherwise.

Encoded as a ’;‘-separated parallel array aligned with ShowStatisticsRequest.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 ”.

Encoded as a ’;‘-separated parallel array aligned with ShowStatisticsRequest.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 ”.

Definition at line 70 of file ShowStatistics.cs.

◆ FALSE

const string kinetica.ShowStatisticsRequest.Options.FALSE = “false”
static

A boolean constant for the ShowStatisticsRequest.Options options.

Definition at line 56 of file ShowStatistics.cs.

◆ NO_ERROR_IF_NOT_EXISTS

const string kinetica.ShowStatisticsRequest.Options.NO_ERROR_IF_NOT_EXISTS = “no_error_if_not_exists”
static

If TRUE and if the table names specified in ShowStatisticsRequest.table_names does not exist, no error is returned.

If FALSE and if the table names specified in ShowStatisticsRequest.table_names does not exist, then an error is returned. Supported values:

The default value is FALSE.

Definition at line 48 of file ShowStatistics.cs.

◆ TRUE

const string kinetica.ShowStatisticsRequest.Options.TRUE = “true”
static

A boolean constant for the ShowStatisticsRequest.Options options.

Definition at line 52 of file ShowStatistics.cs.


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