No Matches
Data Fields | Related Symbols
as_policy_write Struct Reference

Detailed Description

Write Policy

Definition at line 625 of file as_policy.h.

#include "as_policy.h"

+ Collaboration diagram for as_policy_write:

Data Fields

as_policy_base base
as_policy_commit_level commit_level
uint32_t compression_threshold
bool durable_delete
as_policy_exists exists
as_policy_gen gen
as_policy_key key
as_policy_replica replica
uint32_t ttl

Related Symbols

(Note that these are not member symbols.)

static void as_policy_write_copy (const as_policy_write *src, as_policy_write *trg)
static as_policy_writeas_policy_write_init (as_policy_write *p)

Friends And Related Symbol Documentation

◆ as_policy_write_copy()

static void as_policy_write_copy ( const as_policy_write * src,
as_policy_write * trg )

Shallow copy as_policy_write values.

srcThe source policy.
trgThe target policy.

Definition at line 1638 of file as_policy.h.

◆ as_policy_write_init()

static as_policy_write * as_policy_write_init ( as_policy_write * p)

Field Documentation

◆ base

as_policy_base as_policy_write::base

Generic policy fields.

Definition at line 630 of file as_policy.h.

◆ commit_level

as_policy_commit_level as_policy_write::commit_level

Specifies the number of replicas required to be committed successfully when writing before returning transaction succeeded.

Definition at line 646 of file as_policy.h.

◆ compression_threshold

uint32_t as_policy_write::compression_threshold

Minimum record size beyond which it is compressed and sent to the server.

Definition at line 675 of file as_policy.h.

◆ durable_delete

bool as_policy_write::durable_delete

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 only.

Default: false (do not tombstone deleted records).

Definition at line 684 of file as_policy.h.

◆ exists

as_policy_exists as_policy_write::exists

Specifies the behavior for the existence of the record.

Definition at line 656 of file as_policy.h.

◆ gen

as_policy_gen as_policy_write::gen

Specifies the behavior for the generation value.

Definition at line 651 of file as_policy.h.

◆ key

as_policy_key as_policy_write::key

Specifies the behavior for the key.

Definition at line 635 of file as_policy.h.

◆ replica

as_policy_replica as_policy_write::replica

Algorithm used to determine target node.

Definition at line 640 of file as_policy.h.

◆ ttl

uint32_t as_policy_write::ttl

The default time-to-live (expiration) of the record in seconds. This field will only be used if "as_record.ttl" is set to AS_RECORD_CLIENT_DEFAULT_TTL. The as_record instance is passed in to write functions along with as_policy_write.

There are also special values that can be set in the record ttl:

  • AS_RECORD_DEFAULT_TTL: Use the server default ttl from the namespace.
  • AS_RECORD_NO_EXPIRE_TTL: Do not expire the record.
  • AS_RECORD_NO_CHANGE_TTL: Keep the existing record ttl when the record is updated.

Definition at line 670 of file as_policy.h.

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