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

Constructor & Destructor Documentation

gpudb::ShowTableResponse::ShowTableResponse ( )

inline

Constructs a ShowTableResponse object with default parameter values.

Definition at line 222 of file show_table.h.

Member Data Documentation

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

Definition at line 247 of file show_table.h.

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

Definition at line 249 of file show_table.h.

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

Definition at line 253 of file show_table.h.

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

Definition at line 250 of file show_table.h.

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

Definition at line 246 of file show_table.h.

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

Definition at line 248 of file show_table.h.

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

Definition at line 242 of file show_table.h.

std::string gpudb::ShowTableResponse::tableName

Definition at line 240 of file show_table.h.

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

Definition at line 241 of file show_table.h.

int64_t gpudb::ShowTableResponse::totalFullSize

Definition at line 252 of file show_table.h.

int64_t gpudb::ShowTableResponse::totalSize

Definition at line 251 of file show_table.h.

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

Definition at line 243 of file show_table.h.

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

Definition at line 245 of file show_table.h.

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

Definition at line 244 of file show_table.h.

---

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

• gpudb/protocol/show_table.h