A set of parameters for GPUdb::clearTables. More…
#include <gpudb/protocol/clear_tables.h>
Public Member Functions | |
| ClearTablesRequest () | |
| Constructs a ClearTablesRequest object with default parameters. | |
| ClearTablesRequest (const std::vector< std::string > &tableNames_, const std::map< std::string, std::string > &options_) | |
| Constructs a ClearTablesRequest object with the specified parameters. | |
Public Attributes | |
| std::vector< std::string > | tableNames |
| Names of the tables to be cleared, in [ schema_name. ]table_name format, using standard name resolution rules. | |
| std::map< std::string, std::string > | options |
| Optional parameters. | |
Detailed Description
A set of parameters for GPUdb::clearTables.
Clears (drops) tables in the database cluster. The operation is synchronous meaning that the tables will be cleared before the function returns. The response payload returns the status of the operation for each table requested.
Definition at line 21 of file clear_tables.h.
Constructor & Destructor Documentation
◆ ClearTablesRequest() [1/2]
| inline |
Constructs a ClearTablesRequest object with default parameters.
Definition at line 26 of file clear_tables.h.
◆ ClearTablesRequest() [2/2]
| inline |
Constructs a ClearTablesRequest object with the specified parameters.
| [in] | tableNames_ | Names of the tables to be cleared, in [schema_name.]table_name format, using standard name resolution rules. Must be existing tables. Empty list clears all available tables, though this behavior is be prevented by default via gpudb.conf parameter ‘disable_clear_all’. The default value is an empty vector. |
| [in] | options_ | Optional parameters.
|
Definition at line 72 of file clear_tables.h.
Member Data Documentation
◆ options
| std::map<std::string, std::string> gpudb::ClearTablesRequest::options |
Optional parameters.
- clear_tables_no_error_if_not_exists: If true and if a table specified in tableNames does not exist no error is returned. If false and if a table specified in tableNames does not exist then an error is returned. Supported values:The default value is clear_tables_false.
The default value is an empty map.
Definition at line 108 of file clear_tables.h.
◆ tableNames
| std::vector<std::string> gpudb::ClearTablesRequest::tableNames |
Names of the tables to be cleared, in [ schema_name. ]table_name format, using standard name resolution rules.
Must be existing tables. Empty list clears all available tables, though this behavior is be prevented by default via gpudb.conf parameter ‘disable_clear_all’. The default value is an empty vector.
Definition at line 87 of file clear_tables.h.
The documentation for this struct was generated from the following file:
- gpudb/protocol/clear_tables.h