A set of parameters for GPUdb::showTablesByType. More…
#include <gpudb/protocol/show_tables_by_type.h>
Public Member Functions | |
| ShowTablesByTypeRequest () | |
| Constructs a ShowTablesByTypeRequest object with default parameters. | |
| ShowTablesByTypeRequest (const std::string &typeId_, const std::string &label_, const std::map< std::string, std::string > &options_) | |
| Constructs a ShowTablesByTypeRequest object with the specified parameters. | |
Public Attributes | |
| std::string | typeId |
| Type id returned by a call to GPUdb::createType. | |
| std::string | label |
| Optional user supplied label which can be used instead of the type_id to retrieve all tables with the given label. | |
| std::map< std::string, std::string > | options |
| Optional parameters. | |
Detailed Description
A set of parameters for GPUdb::showTablesByType.
Gets names of the tables whose type matches the given criteria. Each table has a particular type. This type comprises the schema and properties of the table and sometimes a type label. This function allows a look up of the existing tables based on full or partial type information. The operation is synchronous.
Definition at line 22 of file show_tables_by_type.h.
Constructor & Destructor Documentation
◆ ShowTablesByTypeRequest() [1/2]
| inline |
Constructs a ShowTablesByTypeRequest object with default parameters.
Definition at line 27 of file show_tables_by_type.h.
◆ ShowTablesByTypeRequest() [2/2]
| inline |
Constructs a ShowTablesByTypeRequest object with the specified parameters.
| [in] | typeId_ | Type id returned by a call to GPUdb::createType. |
| [in] | label_ | Optional user supplied label which can be used instead of the type_id to retrieve all tables with the given label. |
| [in] | options_ | Optional parameters. The default value is an empty map. |
Definition at line 47 of file show_tables_by_type.h.
Member Data Documentation
◆ label
| std::string gpudb::ShowTablesByTypeRequest::label |
Optional user supplied label which can be used instead of the type_id to retrieve all tables with the given label.
Definition at line 65 of file show_tables_by_type.h.
◆ options
| std::map<std::string, std::string> gpudb::ShowTablesByTypeRequest::options |
Optional parameters.
The default value is an empty map.
Definition at line 70 of file show_tables_by_type.h.
◆ typeId
| std::string gpudb::ShowTablesByTypeRequest::typeId |
Type id returned by a call to GPUdb::createType.
Definition at line 59 of file show_tables_by_type.h.
The documentation for this struct was generated from the following file:
- gpudb/protocol/show_tables_by_type.h