gpudb::ShowTableResponse Struct Reference

A set of output parameters for const. More...

#include <gpudb/protocol/show_table.h>

Public Member Functions
	ShowTableResponse ()
	Constructs a ShowTableResponse object with default parameter values. More...

Public Attributes
std::string	tableName
std::vector< std::string >	tableNames
std::vector< std::vector < std::string > >	tableDescriptions
std::vector< std::string >	typeIds
std::vector< std::string >	typeSchemas
std::vector< std::string >	typeLabels
std::vector< std::map < std::string, std::vector < std::string > > >	properties
std::vector< std::map < std::string, std::string > >	additionalInfo
std::vector< int64_t >	sizes
std::vector< int64_t >	fullSizes
std::vector< double >	joinSizes
int64_t	totalSize
int64_t	totalFullSize
std::map< std::string, std::string >	info

Detailed Description

A set of output 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 189 of file show_table.h.

Constructor & Destructor Documentation

gpudb::ShowTableResponse::ShowTableResponse ( )

inline

Constructs a ShowTableResponse object with default parameter values.

Definition at line 195 of file show_table.h.

Member Data Documentation

std::vector<std::map<std::string, std::string> > gpudb::ShowTableResponse::additionalInfo

Definition at line 220 of file show_table.h.

std::vector<int64_t> gpudb::ShowTableResponse::fullSizes

Definition at line 222 of file show_table.h.

std::map<std::string, std::string> gpudb::ShowTableResponse::info

Definition at line 226 of file show_table.h.

std::vector<double> gpudb::ShowTableResponse::joinSizes

Definition at line 223 of file show_table.h.

std::vector<std::map<std::string, std::vector<std::string> > > gpudb::ShowTableResponse::properties

Definition at line 219 of file show_table.h.

std::vector<int64_t> gpudb::ShowTableResponse::sizes

Definition at line 221 of file show_table.h.

std::vector<std::vector<std::string> > gpudb::ShowTableResponse::tableDescriptions

Definition at line 215 of file show_table.h.

std::string gpudb::ShowTableResponse::tableName

Definition at line 213 of file show_table.h.

std::vector<std::string> gpudb::ShowTableResponse::tableNames

Definition at line 214 of file show_table.h.

int64_t gpudb::ShowTableResponse::totalFullSize

Definition at line 225 of file show_table.h.

int64_t gpudb::ShowTableResponse::totalSize

Definition at line 224 of file show_table.h.

std::vector<std::string> gpudb::ShowTableResponse::typeIds

Definition at line 216 of file show_table.h.

std::vector<std::string> gpudb::ShowTableResponse::typeLabels

Definition at line 218 of file show_table.h.

std::vector<std::string> gpudb::ShowTableResponse::typeSchemas

Definition at line 217 of file show_table.h.

---

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

• gpudb/protocol/show_table.h