A set of parameters for GPUdb::dropSchema. More…
#include <gpudb/protocol/drop_schema.h>
Public Member Functions | |
| DropSchemaRequest () | |
| Constructs a DropSchemaRequest object with default parameters. | |
| DropSchemaRequest (const std::string &schemaName_, const std::map< std::string, std::string > &options_) | |
| Constructs a DropSchemaRequest object with the specified parameters. | |
Public Attributes | |
| std::string | schemaName |
| Name of the schema to be dropped. | |
| std::map< std::string, std::string > | options |
| Optional parameters. | |
Detailed Description
A set of parameters for GPUdb::dropSchema.
Drops an existing SQL-style schema, specified in schemaName.
Definition at line 18 of file drop_schema.h.
Constructor & Destructor Documentation
◆ DropSchemaRequest() [1/2]
| inline |
Constructs a DropSchemaRequest object with default parameters.
Definition at line 23 of file drop_schema.h.
◆ DropSchemaRequest() [2/2]
| inline |
Constructs a DropSchemaRequest object with the specified parameters.
Parameters
| [in] | schemaName_ | Name of the schema to be dropped. Must be an existing schema. |
| [in] | options_ | Optional parameters.
|
Definition at line 77 of file drop_schema.h.
Member Data Documentation
◆ options
| std::map<std::string, std::string> gpudb::DropSchemaRequest::options |
Optional parameters.
- drop_schema_no_error_if_not_exists: If true and if the schema specified in schemaName does not exist, no error is returned. If false and if the schema specified in schemaName does not exist, then an error is returned. Supported values:The default value is drop_schema_false.
- drop_schema_cascade: If true, all tables within the schema will be dropped. If false, the schema will be dropped only if empty. Supported values:The default value is drop_schema_false.
The default value is an empty map.
Definition at line 119 of file drop_schema.h.
◆ schemaName
| std::string gpudb::DropSchemaRequest::schemaName |
Name of the schema to be dropped.
Must be an existing schema.
Definition at line 86 of file drop_schema.h.
The documentation for this struct was generated from the following file:
- gpudb/protocol/drop_schema.h