Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
Public Attributes | List of all members
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 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 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 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: 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: The default value is FALSE.
  • GET_CACHED_SIZES: 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 occuring. Supported values: The default value is FALSE.
  • SHOW_CHILDREN: If 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 is a table or view, show_children must be false. If is empty, then show_children must be true. Supported values: 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: The default value is FALSE.
  • GET_COLUMN_INFO: If true then column info (memory usage, etc) will be returned. Supported values: The default value is FALSE.

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

Definition at line 180 of file ShowTable.cs.

Member Data Documentation

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

Definition at line 200 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:

The default value is TRUE.

Definition at line 198 of file ShowTable.cs.

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.

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

The default value is FALSE.

Definition at line 237 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:

The default value is FALSE.

Definition at line 294 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:

The default value is FALSE.

Definition at line 218 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:

The default value is FALSE.

Definition at line 277 of file ShowTable.cs.

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.

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:

The default value is TRUE.

Definition at line 259 of file ShowTable.cs.

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

Definition at line 199 of file ShowTable.cs.

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