A set of parameters for Kinetica.showTable(string,IDictionary<string, string>). More...

Inheritance diagram for kinetica.ShowTableRequest:

Collaboration diagram for kinetica.ShowTableRequest:

Classes
struct	Options
	Optional parameters. More...

Public Member Functions
	ShowTableRequest ()
	Constructs a ShowTableRequest object with default parameters. More...

	ShowTableRequest (string table_name, IDictionary< string, string > options=null)
	Constructs a ShowTableRequest object with the specified parameters. More...

Public Member Functions inherited from kinetica.KineticaData
	KineticaData (KineticaType type)
	Constructor from Kinetica Type More...

	KineticaData (System.Type type=null)
	Default constructor, with optional System.Type More...

object	Get (int fieldPos)
	Retrieve a specific property from this object More...

void	Put (int fieldPos, object fieldValue)
	Write a specific property to this object More...

Properties
string	table_name `[get, set]`
	Name of the table for which to retrieve the information. More...

IDictionary< string, string >	options `[get, set]`
	Optional parameters. More...

Properties inherited from kinetica.KineticaData
Schema	Schema `[get]`
	Avro Schema for this class More...

Additional Inherited Members
Static Public Member Functions inherited from kinetica.KineticaData
static RecordSchema	SchemaFromType (System.Type t, KineticaType ktype=null)
	Create an Avro Schema from a System.Type and a KineticaType. More...

Detailed Description

A set of parameters for Kinetica.showTable(string,IDictionary<string, string>).

Retrieves detailed information about tables, views, and collections.
If table_name specifies a table or view, information specific to that entity will be returned.
If table_name specifies a collection, the call can return information about either the collection itself (setting the show_children option to false) or the tables and views it contains (setting show_children to true).
If table_name is empty, information about all collections and top-level tables and views can be returned. Note: show_children must be set to true.
If table_name is '*', information about all tables, collections, and views will be returned. Note: show_children must be set to true.
If the option get_sizes is set to true, then the sizes (objects and elements) of each table are returned (in <member name="sizes"> and <member name="full_sizes">), along with the total number of objects in the requested table (in <member name="total_size"> and <member name="total_full_size">).

Definition at line 40 of file ShowTable.cs.

Constructor & Destructor Documentation

◆ ShowTableRequest() [1/2]

kinetica.ShowTableRequest.ShowTableRequest ( )

inline

Constructs a ShowTableRequest object with default parameters.

Definition at line 368 of file ShowTable.cs.

◆ ShowTableRequest() [2/2]

kinetica.ShowTableRequest.ShowTableRequest	(	string	table_name,
		IDictionary< string, string >	options = `null`
	)

inline

Constructs a ShowTableRequest object with the specified parameters.

Parameters

table_name Name of the table for which to retrieve the information. If blank, then information about all collections and top-level tables and views is returned.

options

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 table sizes 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, while false will return information about the collection itself. If is empty or '*', then show_children must be true (or not specified); otherwise, no results will be returned. 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.

Definition at line 483 of file ShowTable.cs.

Property Documentation

◆ options

IDictionary<string, string> kinetica.ShowTableRequest.options

getset

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 table sizes 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, while false will return information about the collection itself.
If is empty or '*', then show_children must be true (or not specified); otherwise, no results will be returned. 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.

Definition at line 363 of file ShowTable.cs.

◆ table_name

string kinetica.ShowTableRequest.table_name

getset

Name of the table for which to retrieve the information.

If blank, then information about all collections and top-level tables and views is returned.

Definition at line 254 of file ShowTable.cs.

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

Kinetica/Protocol/ShowTable.cs

Classes

Public Member Functions

Properties