Struct MultiDeleteRequest

pub struct MultiDeleteRequest { /* private fields */ }

Struct used for deleting a range of rows from a NoSQL table.

Implementations

impl MultiDeleteRequest

pub fn new(table_name: &str, partial_key: &FieldValue) -> MultiDeleteRequest

Create a new MultiDeleteRequest.

table_name specifies the name of table for the request. It is required and must be non-empty.

partial_key specifies the partial key used for the request. It is required and must be non-nil.

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

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) -> MultiDeleteRequest

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

The compartment may be specified as either a name (or path for nested compartments) or as an id (OCID). A name (vs id) can only be used when authenticated using a specific user identity. It is not available if the associated handle authenticated as an Instance Principal (which can be done when calling the service from a compute instance in the Oracle Cloud Infrastructure: see HandleBuilder::cloud_auth_from_instance().)

If no compartment is given, the root compartment of the tenancy will be used.

pub fn field_range(self, field_range: FieldRange) -> MultiDeleteRequest

Specifiy the FieldRange to be used for the operation.

It is optional, but required to delete a specific range of rows.

pub fn continuation_key(self, key: Vec<u8>) -> MultiDeleteRequest

Specify the continuation key to use to continue the operation.

This is typically populated from a previous MultiDeleteResult::continuation_key().

pub fn max_write_kb(self, max_write_kb: i32) -> MultiDeleteRequest

Specify the limit on the total KB write during this operation.

This is optional and has no effect for on-premise. When used for the cloud service, if this value is not set, or set to 0, there is no application-defined limit.

This value can only reduce the system defined limit. An attempt to increase the limit beyond the system defined limit will cause an IllegalArgument error.

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

Trait Implementations

impl Debug for MultiDeleteRequest

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

Formats the value using the given formatter.

impl Default for MultiDeleteRequest

fn default() -> MultiDeleteRequest

Returns the “default value” for a type.