A set of parameters for Kinetica.showTable. More...

Inheritance diagram for kinetica.ShowTableRequest:

Collaboration diagram for kinetica.ShowTableRequest:

Classes
struct	Options
	A set of string constants for the parameter options. 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...

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

	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, in [schema_name. More...

IDictionary< string, string >	options = new Dictionary<string, string>() `[get, set]`
	Optional parameters. More...

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

Properties inherited from Avro.Specific.ISpecificRecord
Schema	Schema `[get]`

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

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.

Retrieves detailed information about a table, view, or schema, specified in table_name. If the supplied table_name is a schema the call can return information about either the schema itself or the tables and views it contains. If table_name is empty, information about all schemas will be returned.

If the option GET_SIZES is set to TRUE, then the number of records in each table is returned (in sizes and full_sizes), along with the total number of objects across all requested tables (in total_size and total_full_size).

For a schema, setting the SHOW_CHILDREN option to FALSE returns only information about the schema itself; setting SHOW_CHILDREN to TRUE returns a list of tables and views contained in the schema, along with their corresponding detail.

To retrieve a list of every table, view, and schema in the database, set table_name to '*' and SHOW_CHILDREN to TRUE. When doing this, the returned total_size and total_full_size will not include the sizes of non-base tables (e.g., filters, views, joins, etc.).

Definition at line 43 of file ShowTable.cs.

Constructor & Destructor Documentation

◆ ShowTableRequest() [1/4]

kinetica.ShowTableRequest.ShowTableRequest ( )

inline

Constructs a ShowTableRequest object with default parameters.

Definition at line 420 of file ShowTable.cs.

◆ ShowTableRequest() [2/4]

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, in [schema_name.]table_name format, using standard name resolution rules. If blank, then returns information about all tables and views.

options

Optional parameters.

DEPENDENCIES: Include view dependencies in the output. Supported values:
- TRUE
- FALSE
The default value is FALSE.
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_ACCESS_DATA: If TRUE then data about the last read, write, alter and create will be returned. Supported values:
- TRUE
- FALSE
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 occurring. Supported values:
- TRUE
- FALSE
The default value is FALSE.
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.
SKIP_ADDITIONAL_INFO: If TRUE then the response will not populate the additional_info field. Supported values:
- TRUE
- FALSE
The default value is FALSE.
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.
SKIP_TEMP_SCHEMAS: If TRUE then the table list will not include tables from SYS_TEMP and other system temporary schemas. This is the default behavior for non-admin users. Supported values:
- TRUE
- FALSE
The default value is FALSE.
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:
- TRUE
- FALSE
The default value is TRUE.
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 627 of file ShowTable.cs.

◆ ShowTableRequest() [3/4]

kinetica.ShowTableRequest.ShowTableRequest ( )

inline

Constructs a ShowTableRequest object with default parameters.

Definition at line 420 of file ShowTable.cs.

◆ ShowTableRequest() [4/4]

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, in [schema_name.]table_name format, using standard name resolution rules. If blank, then returns information about all tables and views.

options

Optional parameters.

DEPENDENCIES: Include view dependencies in the output. Supported values:
- TRUE
- FALSE
The default value is FALSE.
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_ACCESS_DATA: If TRUE then data about the last read, write, alter and create will be returned. Supported values:
- TRUE
- FALSE
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 occurring. Supported values:
- TRUE
- FALSE
The default value is FALSE.
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.
SKIP_ADDITIONAL_INFO: If TRUE then the response will not populate the additional_info field. Supported values:
- TRUE
- FALSE
The default value is FALSE.
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.
SKIP_TEMP_SCHEMAS: If TRUE then the table list will not include tables from SYS_TEMP and other system temporary schemas. This is the default behavior for non-admin users. Supported values:
- TRUE
- FALSE
The default value is FALSE.
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:
- TRUE
- FALSE
The default value is TRUE.
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 627 of file ShowTable.cs.

Property Documentation

◆ options

IDictionary< string, string > kinetica.ShowTableRequest.options = new Dictionary<string, string>()

getset

Optional parameters.

DEPENDENCIES: Include view dependencies in the output. Supported values:
- TRUE
- FALSE
The default value is FALSE.
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_ACCESS_DATA: If TRUE then data about the last read, write, alter and create will be returned. Supported values:
- TRUE
- FALSE
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 occurring. Supported values:
- TRUE
- FALSE
The default value is FALSE.
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.
SKIP_ADDITIONAL_INFO: If TRUE then the response will not populate the additional_info field. Supported values:
- TRUE
- FALSE
The default value is FALSE.
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.
SKIP_TEMP_SCHEMAS: If TRUE then the table list will not include tables from SYS_TEMP and other system temporary schemas. This is the default behavior for non-admin users. Supported values:
- TRUE
- FALSE
The default value is FALSE.
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:
- TRUE
- FALSE
The default value is TRUE.
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 416 of file ShowTable.cs.

◆ table_name

string kinetica.ShowTableRequest.table_name

getset

Name of the table for which to retrieve the information, in [schema_name.

]table_name format, using standard name resolution rules.

If blank, then returns information about all tables and views.

Definition at line 217 of file ShowTable.cs.

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

_build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/ShowTable.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ShowTableRequest() [1/4]

◆ ShowTableRequest() [2/4]

◆ ShowTableRequest() [3/4]

◆ ShowTableRequest() [4/4]

Property Documentation

◆ options

◆ table_name