gpudb::ShowTableRequest Struct Reference

A set of input parameters for 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 const.

Retrieves detailed information about a table, view, or collection, specified in tableName. If the supplied tableName is a collection, the call can return information about either the collection itself or the tables and views it contains. If tableName is empty, information about all collections and top-level tables and views can 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 collection, setting the show_children option to false returns only information about the collection itself; setting show_children to true returns a list of tables and views contained in the collection, along with their corresponding detail.

To retrieve a list of every table, view, and collection in the database, set tableName to '*' and show_children to true.

Definition at line 36 of file show_table.h.

Constructor & Destructor Documentation

gpudb::ShowTableRequest::ShowTableRequest ( )

inline

Constructs a ShowTableRequest object with default parameter values.

Definition at line 42 of file show_table.h.

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 number of records in each table, along with a cumulative count, 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, and false will return information about the collection itself. If tableName is a table or view, show_children must be false. If tableName is empty, then show_children must be true. 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 109 of file show_table.h.

Member Data Documentation

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

Definition at line 116 of file show_table.h.

std::string gpudb::ShowTableRequest::tableName

Definition at line 115 of file show_table.h.

---

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

• gpudb/protocol/show_table.h