A set of parameters for GPUdb::showTypes. More…
#include <gpudb/protocol/show_types.h>
Public Member Functions | |
| ShowTypesRequest () | |
| Constructs a ShowTypesRequest object with default parameters. | |
| ShowTypesRequest (const std::string &typeId_, const std::string &label_, const std::map< std::string, std::string > &options_) | |
| Constructs a ShowTypesRequest object with the specified parameters. | |
Public Attributes | |
| std::string | typeId |
| Type Id returned in response to a call to GPUdb::createType. | |
| std::string | label |
| Option string that was supplied by user in a call to GPUdb::createType. | |
| std::map< std::string, std::string > | options |
| Optional parameters. | |
Detailed Description
A set of parameters for GPUdb::showTypes.
Retrieves information for the specified data type ID or type label. For all data types that match the input criteria, the database returns the type ID, the type schema, the label (if available), and the type’s column properties.
Definition at line 20 of file show_types.h.
Constructor & Destructor Documentation
◆ ShowTypesRequest() [1/2]
| inline |
Constructs a ShowTypesRequest object with default parameters.
Definition at line 25 of file show_types.h.
◆ ShowTypesRequest() [2/2]
| inline |
Constructs a ShowTypesRequest object with the specified parameters.
| [in] | typeId_ | Type Id returned in response to a call to GPUdb::createType. |
| [in] | label_ | Option string that was supplied by user in a call to GPUdb::createType. |
| [in] | options_ | Optional parameters.
|
Definition at line 60 of file show_types.h.
Member Data Documentation
◆ label
| std::string gpudb::ShowTypesRequest::label |
Option string that was supplied by user in a call to GPUdb::createType.
Definition at line 79 of file show_types.h.
◆ options
| std::map<std::string, std::string> gpudb::ShowTypesRequest::options |
Optional parameters.
- show_types_no_join_types: When set to ‘true’, no join types will be included. Supported values:The default value is show_types_false.
The default value is an empty map.
Definition at line 97 of file show_types.h.
◆ typeId
| std::string gpudb::ShowTypesRequest::typeId |
Type Id returned in response to a call to GPUdb::createType.
Definition at line 72 of file show_types.h.
The documentation for this struct was generated from the following file:
- gpudb/protocol/show_types.h