Kinetica   C#   API  Version 7.2.3.0
kinetica.ShowTableRequest.Options Struct Reference

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

Public Attributes

const string DEPENDENCIES = "dependencies"
 Include view dependencies in the output. More...
 
const string TRUE = "true"
 
const string FALSE = "false"
 
const string FORCE_SYNCHRONOUS = "force_synchronous"
 If TRUE then the table sizes will wait for read lock before returning. More...
 
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. More...
 
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. More...
 
const string NO_ERROR_IF_NOT_EXISTS = "no_error_if_not_exists"
 If FALSE will return an error if the provided table_name does not exist. More...
 
const string SHOW_CHILDREN = "show_children"
 If 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. More...
 
const string GET_COLUMN_INFO = "get_column_info"
 If TRUE then column info (memory usage, etc) will be returned. More...
 

Detailed Description

A set of string constants for the parameter options.

Optional parameters.

Definition at line 48 of file ShowTable.cs.

Member Data Documentation

◆ DEPENDENCIES

const string kinetica.ShowTableRequest.Options.DEPENDENCIES = "dependencies"

Include view dependencies in the output.

Supported values:

The default value is FALSE.

Definition at line 62 of file ShowTable.cs.

◆ FALSE

const string kinetica.ShowTableRequest.Options.FALSE = "false"

Definition at line 65 of file ShowTable.cs.

◆ FORCE_SYNCHRONOUS

const string kinetica.ShowTableRequest.Options.FORCE_SYNCHRONOUS = "force_synchronous"

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

Supported values:

The default value is TRUE.

Definition at line 80 of file ShowTable.cs.

◆ GET_CACHED_SIZES

const string kinetica.ShowTableRequest.Options.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.

Supported values:

The default value is FALSE.

Definition at line 96 of file ShowTable.cs.

◆ GET_COLUMN_INFO

const string kinetica.ShowTableRequest.Options.GET_COLUMN_INFO = "get_column_info"

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

Supported values:

The default value is FALSE.

Definition at line 161 of file ShowTable.cs.

◆ GET_SIZES

const string kinetica.ShowTableRequest.Options.GET_SIZES = "get_sizes"

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 112 of file ShowTable.cs.

◆ NO_ERROR_IF_NOT_EXISTS

const string kinetica.ShowTableRequest.Options.NO_ERROR_IF_NOT_EXISTS = "no_error_if_not_exists"

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

Supported values:

The default value is FALSE.

Definition at line 128 of file ShowTable.cs.

◆ SHOW_CHILDREN

const string kinetica.ShowTableRequest.Options.SHOW_CHILDREN = "show_children"

If 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.

Supported values:

The default value is TRUE.

Definition at line 146 of file ShowTable.cs.

◆ TRUE

const string kinetica.ShowTableRequest.Options.TRUE = "true"

Definition at line 64 of file ShowTable.cs.


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