A set of parameters for GPUdb::deleteRecords. More…
#include <gpudb/protocol/delete_records.h>
Public Member Functions | |
| DeleteRecordsRequest () | |
| Constructs a DeleteRecordsRequest object with default parameters. | |
| DeleteRecordsRequest (const std::string &tableName_, const std::vector< std::string > &expressions_, const std::map< std::string, std::string > &options_) | |
| Constructs a DeleteRecordsRequest object with the specified parameters. | |
Public Attributes | |
| std::string | tableName |
| Name of the table from which to delete records, in [ schema_name. | |
| std::vector< std::string > | expressions |
| A list of the actual predicates, one for each select; format should follow the guidelines provided here. | |
| std::map< std::string, std::string > | options |
| Optional parameters. | |
Detailed Description
A set of parameters for GPUdb::deleteRecords.
Deletes record(s) matching the provided criteria from the given table. The record selection criteria can either be one or more expressions (matching multiple records), a single record identified by record_id options, or all records when using delete_all_records. Note that the three selection criteria are mutually exclusive. This operation cannot be run on a view. The operation is synchronous meaning that a response will not be available until the request is completely processed and all the matching records are deleted.
Definition at line 27 of file delete_records.h.
Constructor & Destructor Documentation
◆ DeleteRecordsRequest() [1/2]
| inline |
Constructs a DeleteRecordsRequest object with default parameters.
Definition at line 32 of file delete_records.h.
◆ DeleteRecordsRequest() [2/2]
| inline |
Constructs a DeleteRecordsRequest object with the specified parameters.
| [in] | tableName_ | Name of the table from which to delete records, in [schema_name.]table_name format, using standard name resolution rules. Must contain the name of an existing table; not applicable to views. |
| [in] | expressions_ | A list of the actual predicates, one for each select; format should follow the guidelines provided here. Specifying one or more expressions_ is mutually exclusive to specifying record_id in the options_. |
| [in] | options_ | Optional parameters.
|
Definition at line 103 of file delete_records.h.
Member Data Documentation
◆ expressions
| std::vector<std::string> gpudb::DeleteRecordsRequest::expressions |
A list of the actual predicates, one for each select; format should follow the guidelines provided here.
Specifying one or more expressions is mutually exclusive to specifying record_id in the options.
Definition at line 127 of file delete_records.h.
◆ options
| std::map<std::string, std::string> gpudb::DeleteRecordsRequest::options |
Optional parameters.
- delete_records_global_expression: An optional global expression to reduce the search space of the expressions. The default value is ”.
- delete_records_record_id: A record ID identifying a single record, obtained at the time of insertion of the record or by calling GPUdb::getRecordsFromCollection with the return_record_ids option. This option cannot be used to delete records from replicated tables.
- delete_records_delete_all_records: If set to true, all records in the table will be deleted. If set to false, then the option is effectively ignored. Supported values:The default value is delete_records_false.
The default value is an empty map.
Definition at line 164 of file delete_records.h.
◆ tableName
| std::string gpudb::DeleteRecordsRequest::tableName |
Name of the table from which to delete records, in [ schema_name.
\ ]table_name format, using standard name resolution rules. Must contain the name of an existing table; not applicable to views.
Definition at line 117 of file delete_records.h.
The documentation for this struct was generated from the following file:
- gpudb/protocol/delete_records.h