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 ShowTableRequest.options. More...

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

	ShowTableRequest (string table\_name, IDictionary\< string, string > options=null)
	Constructs a ShowTableRequest object with the specified parameters.

	ShowTableRequest ()
	Constructs a ShowTableRequest object with default parameters.

	ShowTableRequest (string table\_name, IDictionary\< string, string > options=null)
	Constructs a ShowTableRequest object with the specified parameters.

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

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

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

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

	KineticaData (KineticaType type)
	Constructor from Kinetica Type.

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

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

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

Properties
string	table\_name `\[get, set]`
	Name of the table for which to retrieve the information, in \[schema\_name.

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

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

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.

static ? RecordSchema	SchemaFromType (System.Type t, KineticaType? ktype=null)
	Create an Avro Schema from a System.Type and a KineticaType.

Detailed Description

A set of parameters for Kinetica.showTable.

Retrieves detailed information about a table, view, or schema, specified in ShowTableRequest.table\_name. If the supplied ShowTableRequest.table\_name is a schema the call can return information about either the schema itself or the tables and views it contains. If ShowTableRequest.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 ShowTableRequest.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 45 of file ShowTable.cs.

Constructor & Destructor Documentation

◆ ShowTableRequest() \[1/4]

kinetica.ShowTableRequest.ShowTableRequest

(

)

inline

Constructs a ShowTableRequest object with default parameters.

Definition at line 553 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.
REFERENCING\_MATERIALIZED\_VIEWS: Include materialized views using this table as a source in the output. 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 832 of file ShowTable.cs.

◆ ShowTableRequest() \[3/4]

kinetica.ShowTableRequest.ShowTableRequest

(

)

inline

Constructs a ShowTableRequest object with default parameters.

Definition at line 553 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.
REFERENCING\_MATERIALIZED\_VIEWS: Include materialized views using this table as a source in the output. 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 832 of file ShowTable.cs.

Property Documentation

◆ options

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

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.
REFERENCING\_MATERIALIZED\_VIEWS: Include materialized views using this table as a source in the output. 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 ShowTableRequest.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 ShowTableRequest.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 ShowTableRequest.table\_name is a table or view, SHOW\_CHILDREN must be FALSE. If ShowTableRequest.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 549 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 276 of file ShowTable.cs.

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

\_build/public-os\_ubuntu24.04-arch\_amd64-cc\_gcc\_13.3.0/install/Kinetica/Protocol/ShowTable.cs
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