gpudb::ShowTableResponse Struct Reference

A set of output parameters for showTable(const ShowTableRequest&) 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

Detailed Description

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

Constructor & Destructor Documentation

ShowTableResponse()

gpudb::ShowTableResponse::ShowTableResponse ( )

inline

Constructs a ShowTableResponse object with default parameter values.

Definition at line 199 of file show_table.h.

Member Data Documentation

additionalInfo

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

Definition at line 223 of file show_table.h.

fullSizes

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

Definition at line 225 of file show_table.h.

joinSizes

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

Definition at line 226 of file show_table.h.

properties

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

Definition at line 222 of file show_table.h.

sizes

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

Definition at line 224 of file show_table.h.

tableDescriptions

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

Definition at line 218 of file show_table.h.

tableName

std::string gpudb::ShowTableResponse::tableName

Definition at line 216 of file show_table.h.

tableNames

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

Definition at line 217 of file show_table.h.

totalFullSize

int64_t gpudb::ShowTableResponse::totalFullSize

Definition at line 228 of file show_table.h.

totalSize

int64_t gpudb::ShowTableResponse::totalSize

Definition at line 227 of file show_table.h.

typeIds

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

Definition at line 219 of file show_table.h.

typeLabels

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

Definition at line 221 of file show_table.h.

typeSchemas

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

Definition at line 220 of file show_table.h.

---

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

• gpudb/protocol/show_table.h