Skip to main content
Source

pub async fn show_table( &self, table_name: String, ) -> Result<ShowTableResponse, KineticaError>

Show information about tables, views, or schemas.

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

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

Show information about tables, views, or schemas.

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

  • 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 - The optional parameters; any left unset take the server’s defaults.

Sends a pre-built ShowTableRequest to the /show/table endpoint.

Sends a pre-built ShowTableRequest to a specific worker URL, bypassing HA head-node selection. Used for multi-head access.