A set of input parameters for showTable(const ShowTableRequest&) const. More...

#include <gpudb/protocol/show_table.h>

Public Member Functions
	ShowTableRequest ()
	Constructs a ShowTableRequest object with default parameter values. 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

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

Detailed Description

A set of input parameters for showTable(const ShowTableRequest&) const.

Retrieves detailed information about tables, views, and collections.

If tableName specifies a table or view, information specific to that entity will be returned.

If tableName specifies a collection, the call can return information about either the collection itself (setting the show_children option to false) or the tables and views it contains (setting show_children to true).

If tableName is empty, information about all collections and top-level tables and views can be returned. Note: show_children must be set to true.

If tableName is '*', information about all tables, collections, and views will be returned. Note: show_children must be set to true.

If the option get_sizes is set to true, then the sizes (objects and elements) of each table are returned (in sizes and fullSizes), along with the total number of objects in the requested table (in totalSize and totalFullSize).

Definition at line 38 of file show_table.h.

Constructor & Destructor Documentation

◆ ShowTableRequest() [1/2]

gpudb::ShowTableRequest::ShowTableRequest ( )

inline

Constructs a ShowTableRequest object with default parameter values.

Definition at line 44 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. If blank, then information about all collections and top-level tables and views is returned.
[in]	options_	Optional parameters. gpudb::show_table_force_synchronous: If true then the table sizes will wait for read lock before returning. gpudb::show_table_true gpudb::show_table_false The default value is gpudb::show_table_true. gpudb::show_table_get_sizes: If true then the table sizes will be returned; blank, otherwise. gpudb::show_table_true gpudb::show_table_false The default value is gpudb::show_table_false. gpudb::show_table_show_children: If tableName is a collection, then true will return information about the children of the collection, while false will return information about the collection itself. If tableName is empty or '', then show_children* must be true (or not specified); otherwise, no results will be returned. gpudb::show_table_true gpudb::show_table_false The default value is gpudb::show_table_true. gpudb::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. gpudb::show_table_true gpudb::show_table_false The default value is gpudb::show_table_false. gpudb::show_table_get_column_info: If true then column info (memory usage, etc) will be returned. gpudb::show_table_true gpudb::show_table_false The default value is gpudb::show_table_false.

Definition at line 111 of file show_table.h.

Member Data Documentation

◆ options

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

Definition at line 118 of file show_table.h.

◆ tableName

std::string gpudb::ShowTableRequest::tableName

Definition at line 117 of file show_table.h.

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

gpudb/protocol/show_table.h

Public Member Functions