Skip to main content

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

​
Static Public Attributes

const string DEPENDENCIES = “dependencies”
 Include view dependencies in the output.
 
const string TRUE = “true”
 A boolean constant for the ShowTableRequest.Options options.
 
const string FALSE = “false”
 A boolean constant for the ShowTableRequest.Options options.
 
const string FORCE_SYNCHRONOUS = “force_synchronous”
 If TRUE then the table sizes will wait for read lock before returning.
 
const string GET_ACCESS_DATA = “get_access_data”
 If TRUE then data about the last read, write, alter and create will be returned.
 
const string GET_CACHED_SIZES = “get_cached_sizes”
 If TRUE then the number of records in each table, along with a cumulative count, will be returned; blank, otherwise.
 
const string GET_SIZES = “get_sizes”
 If TRUE then the number of records in each table, along with a cumulative count, will be returned; blank, otherwise.
 
const string REFERENCING_MATERIALIZED_VIEWS = “referencing_materialized_views”
 Include materialized views using this table as a source in the output.
 
const string SKIP_ADDITIONAL_INFO = “skip_additional_info”
 If TRUE then the response will not populate the additional_info field.
 
const string NO_ERROR_IF_NOT_EXISTS = “no_error_if_not_exists”
 If FALSE will return an error if the provided ShowTableRequest.table_name does not exist.
 
const string SKIP_TEMP_SCHEMAS = “skip_temp_schemas”
 If TRUE then the table list will not include tables from SYS_TEMP and other system temporary schemas.
 
const string SHOW_CHILDREN = “show_children”
 If ShowTableRequest.table_name is a schema, then TRUE will return information about the tables and views in the schema, and FALSE will return information about the schema itself.
 
const string GET_COLUMN_INFO = “get_column_info”
 If TRUE then column info (memory usage, etc) will be returned.
 

​
Detailed Description

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

Optional parameters.

Definition at line 50 of file ShowTable.cs.

​
Member Data Documentation

​
◆ DEPENDENCIES

const string kinetica.ShowTableRequest.Options.DEPENDENCIES = “dependencies”
 static

Include view dependencies in the output.

Supported values:

The default value is FALSE.

Definition at line 66 of file ShowTable.cs.

​
◆ FALSE

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

A boolean constant for the ShowTableRequest.Options options.

Definition at line 74 of file ShowTable.cs.

​
◆ FORCE_SYNCHRONOUS

const string kinetica.ShowTableRequest.Options.FORCE_SYNCHRONOUS = “force_synchronous”
 static

If TRUE then the table sizes will wait for read lock before returning.

Supported values:

The default value is TRUE.

Definition at line 92 of file ShowTable.cs.

​
◆ GET_ACCESS_DATA

const string kinetica.ShowTableRequest.Options.GET_ACCESS_DATA = “get_access_data”
 static

If TRUE then data about the last read, write, alter and create will be returned.

Supported values:

The default value is FALSE.

Definition at line 110 of file ShowTable.cs.

​
◆ GET_CACHED_SIZES

const string kinetica.ShowTableRequest.Options.GET_CACHED_SIZES = “get_cached_sizes”
 static

If TRUE then the number of records in each table, along with a cumulative count, will be returned; blank, otherwise.

This version will return the sizes cached at rank 0, which may be stale if there is a multihead insert occurring. Supported values:

The default value is FALSE.

Definition at line 130 of file ShowTable.cs.

​
◆ GET_COLUMN_INFO

const string kinetica.ShowTableRequest.Options.GET_COLUMN_INFO = “get_column_info”
 static

If TRUE then column info (memory usage, etc) will be returned.

Supported values:

The default value is FALSE.

Definition at line 267 of file ShowTable.cs.

​
◆ GET_SIZES

const string kinetica.ShowTableRequest.Options.GET_SIZES = “get_sizes”
 static

If TRUE then the number of records in each table, along with a cumulative count, will be returned; blank, otherwise.

Supported values:

The default value is FALSE.

Definition at line 148 of file ShowTable.cs.

​
◆ NO_ERROR_IF_NOT_EXISTS

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

If FALSE will return an error if the provided ShowTableRequest.table_name does not exist.

If TRUE then it will return an empty result. Supported values:

The default value is FALSE.

Definition at line 204 of file ShowTable.cs.

​
◆ REFERENCING_MATERIALIZED_VIEWS

const string kinetica.ShowTableRequest.Options.REFERENCING_MATERIALIZED_VIEWS = “referencing_materialized_views”
 static

Include materialized views using this table as a source in the output.

Supported values:

The default value is FALSE.

Definition at line 165 of file ShowTable.cs.

​
◆ SHOW_CHILDREN

const string kinetica.ShowTableRequest.Options.SHOW_CHILDREN = “show_children”
 static

If ShowTableRequest.table_name is a schema, then TRUE will return information about the tables and views in the schema, and FALSE will return information about the schema itself.

If ShowTableRequest.table_name is a table or view, SHOW_CHILDREN must be FALSE. If ShowTableRequest.table_name is empty, then SHOW_CHILDREN must be TRUE. Supported values:

The default value is TRUE.

Definition at line 250 of file ShowTable.cs.

​
◆ SKIP_ADDITIONAL_INFO

const string kinetica.ShowTableRequest.Options.SKIP_ADDITIONAL_INFO = “skip_additional_info”
 static

If TRUE then the response will not populate the additional_info field.

Supported values:

The default value is FALSE.

Definition at line 183 of file ShowTable.cs.

​
◆ SKIP_TEMP_SCHEMAS

const string kinetica.ShowTableRequest.Options.SKIP_TEMP_SCHEMAS = “skip_temp_schemas”
 static

If TRUE then the table list will not include tables from SYS_TEMP and other system temporary schemas.

This is the default behavior for non-admin users. Supported values:

The default value is FALSE.

Definition at line 223 of file ShowTable.cs.

​
◆ TRUE

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

A boolean constant for the ShowTableRequest.Options options.

Definition at line 70 of file ShowTable.cs.

The documentation for this struct was generated from the following files:
  • _build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/ShowTable.cs
  • Kinetica/Protocol/ShowTable.cs