Struct DeleteRequest

pub struct DeleteRequest { /* private fields */ }

Struct used for deleting a single row from a table in the NoSQL Database.

This request can be used to perform unconditional and conditional deletes:

• Delete any existing row. This is the default.
• Succeed only if the row exists and its Version matches a specific Version. Use if_version() for this case.

Information about the existing row can be returned from a delete operation using return_row(true). Requesting this information incurs additional cost and may affect operation latency.

Implementations

impl DeleteRequest

pub fn new(table_name: &str, key: MapValue) -> DeleteRequest

Create a new DeleteRequest.

table_name and key are required and must be non-empty.

key must contain all fields required to construct the primary key for the table.

pub fn timeout(self, t: &Duration) -> Self

Specify the timeout value for the request.

This is optional. If set, it must be greater than or equal to 1 millisecond, otherwise an IllegalArgument error will be returned. If not set, the default timeout value configured for the Handle is used.

pub fn compartment_id(self, compartment_id: &str) -> Self

Cloud Service only: set the name or id of a compartment to be used for this operation.

If the associated handle authenticated as an Instance Principal, this value must be an OCID. In all other cases, the value may be specified as either a name (or path for nested compartments) or as an OCID.

If no compartment is given, the default compartment id for the handle is used. If that value was not specified, the root compartment of the tenancy will be used.

pub fn if_version(self, version: &Version) -> DeleteRequest

Succeed only if the record already exists its version matches the given version.

pub fn return_row(self, val: bool) -> DeleteRequest

Return information about the existing row. Requesting this information incurs additional cost and may affect operation latency.

pub fn set_abort_on_fail(self, val: bool) -> DeleteRequest

pub async fn execute(&self, h: &Handle) -> Result<DeleteResult, NoSQLError>

Trait Implementations

impl Debug for DeleteRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for DeleteRequest

fn default() -> DeleteRequest

Returns the “default value” for a type.