gpudb::DeleteRecordsRequest Struct Reference

A set of input parameters for const. More...

#include <gpudb/protocol/delete_records.h>

Public Member Functions
	DeleteRecordsRequest ()
	Constructs a DeleteRecordsRequest object with default parameter values. More...
	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. More...

Public Attributes
std::string	tableName
std::vector< std::string >	expressions
std::map< std::string, std::string >	options

Detailed Description

A set of input parameters for const.

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 collection or 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 25 of file delete_records.h.

Constructor & Destructor Documentation

gpudb::DeleteRecordsRequest::DeleteRecordsRequest ( )

inline

Constructs a DeleteRecordsRequest object with default parameter values.

Definition at line 32 of file delete_records.h.

gpudb::DeleteRecordsRequest::DeleteRecordsRequest ( const std::string &  tableName_, const std::vector< std::string > &  expressions_, const std::map< std::string, std::string > &  options_  )

inline

Constructs a DeleteRecordsRequest object with the specified parameters.

Parameters

[in]	tableName_	Name of the table from which to delete records. The set must be a currently existing table and not a collection or a view.
[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. gpudb::delete_records_global_expression: An optional global expression to reduce the search space of the expressions. The default value is ''. gpudb::delete_records_record_id: A record ID identifying a single record, obtained at the time of /insert/records or by calling /get/records/fromcollection with the return_record_ids option. This option cannot be used to delete records from replicated tables. gpudb::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. gpudb::delete_records_true gpudb::delete_records_false The default value is gpudb::delete_records_false.

Definition at line 83 of file delete_records.h.

Member Data Documentation

std::vector<std::string> gpudb::DeleteRecordsRequest::expressions

Definition at line 91 of file delete_records.h.

std::map<std::string, std::string> gpudb::DeleteRecordsRequest::options

Definition at line 92 of file delete_records.h.

std::string gpudb::DeleteRecordsRequest::tableName

Definition at line 90 of file delete_records.h.

---

The documentation for this struct was generated from the following file:

• gpudb/protocol/delete_records.h