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

Constructor & Destructor Documentation

gpudb::ShowTableResponse::ShowTableResponse ( )

inline

Constructs a ShowTableResponse object with default parameter values.

Definition at line 172 of file show_table.h.

Member Data Documentation

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

Definition at line 196 of file show_table.h.

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

Definition at line 198 of file show_table.h.

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

Definition at line 199 of file show_table.h.

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

Definition at line 195 of file show_table.h.

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

Definition at line 197 of file show_table.h.

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

Definition at line 191 of file show_table.h.

std::string gpudb::ShowTableResponse::tableName

Definition at line 189 of file show_table.h.

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

Definition at line 190 of file show_table.h.

int64_t gpudb::ShowTableResponse::totalFullSize

Definition at line 201 of file show_table.h.

int64_t gpudb::ShowTableResponse::totalSize

Definition at line 200 of file show_table.h.

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

Definition at line 192 of file show_table.h.

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

Definition at line 194 of file show_table.h.

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

Definition at line 193 of file show_table.h.

---

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

• gpudb/protocol/show_table.h