gpudb::ShowTableRequest Struct Reference

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 a particular GPUdb table, specified in tableName. If the supplied tableName is a collection, the call returns a list of tables contained in the collection, and for each table it returns the description, type id, schema, type label, type properties, and additional information including TTL. If tableName is empty it will return all top-level tables including all collections and top-level child tables (i.e. tables with no parent).

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

If the option 'show_children' is set to 'false' then for a collection it only returns information about the collection itself, not about the child tables. If 'show_children' is set to 'true' then it will return information about each of the children, but not the collection.

Running with 'show_children' = 'true' on a child table will return an error.

Running with 'show_children' = 'false' with tableName empty will return an error.

If the requested table is blank, then information is returned about all top-level tables including collections.

Definition at line 43 of file show_table.h.

Constructor & Destructor Documentation

gpudb::ShowTableRequest::ShowTableRequest ( )

inline

Constructs a ShowTableRequest object with default parameter values.

Definition at line 49 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 is returned.
[in]	options	Optional parameters. get_sizes: If 'true' then the table sizes will be returned; otherwise they will be returned blank. Values: 'true', 'false'. 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 child table, 'show_children' must be 'false'. If tableName is empty then 'show_children' must be 'true'. Values: 'true', 'false'. Default value is an empty std::map.

Definition at line 79 of file show_table.h.

Member Data Documentation

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

Definition at line 86 of file show_table.h.

std::string gpudb::ShowTableRequest::tableName

Definition at line 85 of file show_table.h.

---

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

• gpudb/protocol/show_table.h