Kinetica C# API  Version 6.0.1.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 GET_SIZES = "get_sizes"
 If true then the table sizes will be returned; blank, otherwise. More...
 
const string TRUE = "true"
 
const string FALSE = "false"
 
const string SHOW_CHILDREN = "show_children"
 If <member name="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 <member name="table_name"> does not exist. More...
 

Detailed Description

Optional parameters.

  • get_sizes If true then the table sizes will be returned; blank, otherwise. Values: true, 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. Values: true, false.
  • 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. Values: true, false.


A set of string constants for the parameter <member name="options">.

Definition at line 70 of file ShowTable.cs.

Member Data Documentation

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

Definition at line 78 of file ShowTable.cs.

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

If true then the table sizes will be returned; blank, otherwise.

Values: true, false.

Definition at line 76 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 <member name="table_name"> does not exist.

If true then it will return an empty result. Values: true, false.

Definition at line 94 of file ShowTable.cs.

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

If <member name="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 <member name="table_name"> is a table or view, show_children must be false. If <member name="table_name"> is empty, then show_children must be true. Values: true, false.

Definition at line 88 of file ShowTable.cs.

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

Definition at line 77 of file ShowTable.cs.

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