A set of parameters for GPUdb::showTable. More...

#include <gpudb/protocol/show_table.h>

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

	ShowTableRequest (const std::string &tableName_, const std::map< std::string, std::string > &options_)
	Constructs a ShowTableRequest object with the specified parameters. More...

Public Attributes
std::string	tableName
	Name of the table for which to retrieve the information, in [ schema_name. ]table_name format, using standard name resolution rules. More...

std::map< std::string, std::string >	options
	Optional parameters. More...

Detailed Description

A set of parameters for GPUdb::showTable.

Retrieves detailed information about a table, view, or schema, specified in tableName. If the supplied tableName is a schema the call can return information about either the schema itself or the tables and views it contains. If tableName 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 fullSizes), along with the total number of objects across all requested tables (in totalSize and totalFullSize).

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 tableName to '*' and show_children to true. When doing this, the returned totalSize and totalFullSize will not include the sizes of non-base tables (e.g., filters, views, joins, etc.).

Definition at line 44 of file show_table.h.

Constructor & Destructor Documentation

◆ ShowTableRequest() [1/2]

gpudb::ShowTableRequest::ShowTableRequest ( )

inline

Constructs a ShowTableRequest object with default parameters.

Definition at line 49 of file show_table.h.

◆ ShowTableRequest() [2/2]

gpudb::ShowTableRequest::ShowTableRequest	(	const std::string &	tableName_,
		const std::map< std::string, std::string > &	options_
	)

inline

Constructs a ShowTableRequest object with the specified parameters.

Parameters

[in]	tableName_	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.
[in]	options_	Optional parameters. show_table_dependencies: Include view dependencies in the output. Supported values: show_table_true show_table_false The default value is show_table_false. show_table_force_synchronous: If true then the table sizes will wait for read lock before returning. Supported values: show_table_true show_table_false The default value is show_table_true. show_table_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 occuring. Supported values: show_table_true show_table_false The default value is show_table_false. show_table_get_sizes: If true then the number of records in each table, along with a cumulative count, will be returned; blank, otherwise. Supported values: show_table_true show_table_false The default value is show_table_false. show_table_no_error_if_not_exists: If false will return an error if the provided tableName_ does not exist. If true then it will return an empty result. Supported values: show_table_true show_table_false The default value is show_table_false. show_table_show_children: If tableName_ 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 tableName_ is a table or view, show_children must be false. If tableName_ is empty, then show_children must be true. Supported values: show_table_true show_table_false The default value is show_table_true. show_table_get_column_info: If true then column info (memory usage, etc) will be returned. Supported values: show_table_true show_table_false The default value is show_table_false. The default value is an empty map.

Definition at line 194 of file show_table.h.

Member Data Documentation

◆ options

std::map<std::string, std::string> gpudb::ShowTableRequest::options

Optional parameters.

show_table_dependencies: Include view dependencies in the output. Supported values:
- show_table_true
- show_table_false
The default value is show_table_false.
show_table_force_synchronous: If true then the table sizes will wait for read lock before returning. Supported values:
- show_table_true
- show_table_false
The default value is show_table_true.
show_table_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 occuring. Supported values:
- show_table_true
- show_table_false
The default value is show_table_false.
show_table_get_sizes: If true then the number of records in each table, along with a cumulative count, will be returned; blank, otherwise. Supported values:
- show_table_true
- show_table_false
The default value is show_table_false.
show_table_no_error_if_not_exists: If false will return an error if the provided tableName does not exist. If true then it will return an empty result. Supported values:
- show_table_true
- show_table_false
The default value is show_table_false.
show_table_show_children: If tableName 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 tableName is a table or view, show_children must be false. If tableName is empty, then show_children must be true. Supported values:
- show_table_true
- show_table_false
The default value is show_table_true.
show_table_get_column_info: If true then column info (memory usage, etc) will be returned. Supported values:
- show_table_true
- show_table_false
The default value is show_table_false.

The default value is an empty map.

Definition at line 303 of file show_table.h.

◆ tableName

std::string gpudb::ShowTableRequest::tableName

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 207 of file show_table.h.

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

gpudb/protocol/show_table.h

Public Member Functions