Struct aerospike::policy::WritePolicy

pub struct WritePolicy {
    pub base_policy: BasePolicy,
    pub record_exists_action: RecordExistsAction,
    pub generation_policy: GenerationPolicy,
    pub commit_level: CommitLevel,
    pub generation: u32,
    pub expiration: Expiration,
    pub send_key: bool,
    pub respond_per_each_op: bool,
    pub durable_delete: bool,
    pub filter_expression: Option<FilterExpression>,
}

WritePolicy encapsulates parameters for all write operations.

Fields

base_policy: BasePolicy

Base policy instance

record_exists_action: RecordExistsAction

RecordExistsAction qualifies how to handle writes where the record already exists.

generation_policy: GenerationPolicy

GenerationPolicy qualifies how to handle record writes based on record generation. The default (NONE) indicates that the generation is not used to restrict writes.

commit_level: CommitLevel

Desired consistency guarantee when committing a transaction on the server. The default (COMMIT_ALL) indicates that the server should wait for master and all replica commits to be successful before returning success to the client.

generation: u32

Generation determines expected generation. Generation is the number of times a record has been modified (including creation) on the server. If a write operation is creating a record, the expected generation would be 0.

expiration: Expiration

Expiration determimes record expiration in seconds. Also known as TTL (Time-To-Live). Seconds record will live before being removed by the server.

send_key: bool

Send user defined key in addition to hash digest on a record put. The default is to not send the user defined key.

respond_per_each_op: bool

For Client::operate() method, return a result for every operation. Some list operations do not return results by default (operations::list::clear() for example). This can sometimes make it difficult to determine the desired result offset in the returned bin’s result list.

Setting RespondPerEachOp to true makes it easier to identify the desired result offset (result offset equals bin’s operate sequence). This only makes sense when multiple list operations are used in one operate call and some of those operations do not return results by default.

durable_delete: bool

If the transaction results in a record deletion, leave a tombstone for the record. This prevents deleted records from reappearing after node failures. Valid for Aerospike Server Enterprise Edition 3.10+ only.

filter_expression: Option<FilterExpression>

Optional Filter Expression

Implementations

impl WritePolicy

pub fn new(gen: u32, exp: Expiration) -> Self

Create a new write policy instance with the specified generation and expiration parameters.

pub const fn filter_expression(&self) -> &Option<FilterExpression>

Get the current Filter expression

Trait Implementations

impl Clone for WritePolicy

fn clone(&self) -> WritePolicy

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WritePolicy

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

Formats the value using the given formatter.

impl Default for WritePolicy

fn default() -> Self

Returns the “default value” for a type.