A set of parameters for GPUdb::showSchema. More…
#include <gpudb/protocol/show_schema.h>
Public Member Functions | |
| ShowSchemaRequest () | |
| Constructs a ShowSchemaRequest object with default parameters. | |
| ShowSchemaRequest (const std::string &schemaName_, const std::map< std::string, std::string > &options_) | |
| Constructs a ShowSchemaRequest object with the specified parameters. | |
Public Attributes | |
| std::string | schemaName |
| Name of the schema for which to retrieve the information. | |
| std::map< std::string, std::string > | options |
| Optional parameters. | |
Detailed Description
A set of parameters for GPUdb::showSchema.
Retrieves information about a schema (or all schemas), as specified in schemaName.
Definition at line 19 of file show_schema.h.
Constructor & Destructor Documentation
◆ ShowSchemaRequest() [1/2]
| inline |
Constructs a ShowSchemaRequest object with default parameters.
Definition at line 24 of file show_schema.h.
◆ ShowSchemaRequest() [2/2]
| inline |
Constructs a ShowSchemaRequest object with the specified parameters.
Parameters
| [in] | schemaName_ | Name of the schema for which to retrieve the information. If blank, then info for all schemas is returned. |
| [in] | options_ | Optional parameters.
|
Definition at line 61 of file show_schema.h.
Member Data Documentation
◆ options
| std::map<std::string, std::string> gpudb::ShowSchemaRequest::options |
Optional parameters.
- show_schema_no_error_if_not_exists: If false will return an error if the provided schemaName does not exist. If true then it will return an empty result if the provided schemaName does not exist. Supported values:The default value is show_schema_false.
The default value is an empty map.
Definition at line 92 of file show_schema.h.
◆ schemaName
| std::string gpudb::ShowSchemaRequest::schemaName |
Name of the schema for which to retrieve the information.
If blank, then info for all schemas is returned.
Definition at line 71 of file show_schema.h.
The documentation for this struct was generated from the following file:
- gpudb/protocol/show_schema.h