◆ showTable() \[1/2]

ShowTableResponse kinetica.Kinetica.showTable

(

request\_

)

inline

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

Parameters

request\_

Request object containing the parameters for the operation.

Returns

Response object containing the result of the operation.

Definition at line 62051 of file KineticaFunctions.cs.

◆ showTable() \[2/2]

ShowTableResponse kinetica.Kinetica.showTable	(	string	table\_name,
		IDictionary\< string, string >	options = null )

inline

Retrieves detailed information about a table, view, or schema, specified in table\_name .

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.

Returns

Response object containing the result of the operation.

Definition at line 62434 of file KineticaFunctions.cs.

◆ ShowTableAsync() \[1/2]

async System.Threading.Tasks.Task\< ShowTableResponse > kinetica.Kinetica.ShowTableAsync	(	ShowTableRequest	request\_,
		System.Threading.CancellationToken	cancellationToken = default )

inline

Retrieves detailed information about a table, view, or schema, specified in table\_name.

(async)

Parameters

request\_	Request object containing the parameters for the operation.
cancellationToken	Cancellation token to cancel the operation.

Returns

Task that returns the response object containing the result of the operation.

Definition at line 62109 of file KineticaFunctions.cs.

◆ ShowTableAsync() \[2/2]

async System.Threading.Tasks.Task\< ShowTableResponse > kinetica.Kinetica.ShowTableAsync	(	string	table\_name,
		IDictionary\< string, string >	options = null,
		System.Threading.CancellationToken	cancellationToken = default )

inline

Retrieves detailed information about a table, view, or schema, specified in table\_name .

(async)

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.
cancellationToken	Cancellation token to cancel the operation.

Returns

Task that returns the response object containing the result of the operation.

Definition at line 62750 of file KineticaFunctions.cs.