GPUdb C++ API  Version 6.1.0.0
Public Member Functions | Public Attributes | List of all members
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 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 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).

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.

Definition at line 171 of file show_table.h.

Constructor & Destructor Documentation

◆ ShowTableResponse()

gpudb::ShowTableResponse::ShowTableResponse ( )
inline

Constructs a ShowTableResponse object with default parameter values.

Definition at line 177 of file show_table.h.

Member Data Documentation

◆ additionalInfo

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

Definition at line 201 of file show_table.h.

◆ fullSizes

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

Definition at line 203 of file show_table.h.

◆ joinSizes

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

Definition at line 204 of file show_table.h.

◆ properties

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

Definition at line 200 of file show_table.h.

◆ sizes

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

Definition at line 202 of file show_table.h.

◆ tableDescriptions

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

Definition at line 196 of file show_table.h.

◆ tableName

std::string gpudb::ShowTableResponse::tableName

Definition at line 194 of file show_table.h.

◆ tableNames

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

Definition at line 195 of file show_table.h.

◆ totalFullSize

int64_t gpudb::ShowTableResponse::totalFullSize

Definition at line 206 of file show_table.h.

◆ totalSize

int64_t gpudb::ShowTableResponse::totalSize

Definition at line 205 of file show_table.h.

◆ typeIds

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

Definition at line 197 of file show_table.h.

◆ typeLabels

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

Definition at line 199 of file show_table.h.

◆ typeSchemas

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

Definition at line 198 of file show_table.h.

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