kinetica.ShowTableRequest.Options Struct Reference

Optional parameters. More...

Public Attributes
const string	FORCE_SYNCHRONOUS = "force_synchronous"
	If true then the table sizes will wait for read lock before returning. More...
const string	TRUE = "true"
const string	FALSE = "false"
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	SHOW_CHILDREN = "show_children"
	If table_name is a collection, then true will return information about the children of the collection, and false will return information about the collection itself. 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	GET_COLUMN_INFO = "get_column_info"
	If true then column info (memory usage, etc) will be returned. More...

Detailed Description

Optional parameters.

• FORCE_SYNCHRONOUS: If true then the table sizes will wait for read lock before returning. Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• GET_SIZES: If true then the number of records in each table, along with a cumulative count, will be returned; blank, otherwise. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• SHOW_CHILDREN: If is a collection, then true will return information about the children of the collection, and false will return information about the collection itself. If is a table or view, show_children must be false. If is empty, then show_children must be true. Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• NO_ERROR_IF_NOT_EXISTS: If false will return an error if the provided does not exist. If true then it will return an empty result. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• GET_COLUMN_INFO: If true then column info (memory usage, etc) will be returned. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.

The default value is an empty Dictionary. A set of string constants for the parameter options.

Definition at line 153 of file ShowTable.cs.

Member Data Documentation

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

Definition at line 173 of file ShowTable.cs.

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

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

Supported values:

• TRUE
• FALSE

The default value is TRUE.

Definition at line 171 of file ShowTable.cs.

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

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

Supported values:

• TRUE
• FALSE

The default value is FALSE.

Definition at line 248 of file ShowTable.cs.

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:

• TRUE
• FALSE

The default value is FALSE.

Definition at line 191 of file ShowTable.cs.

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.

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

• TRUE
• FALSE

The default value is FALSE.

Definition at line 231 of file ShowTable.cs.

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

If table_name is a collection, then true will return information about the children of the collection, and false will return information about the collection itself.

If table_name is a table or view, show_children must be false. If table_name is empty, then show_children must be true. Supported values:

• TRUE
• FALSE

The default value is TRUE.

Definition at line 213 of file ShowTable.cs.

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

Definition at line 172 of file ShowTable.cs.

---

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

• Kinetica/Protocol/ShowTable.cs