No Matches
Data Fields | Related Symbols
as_policy_scan Struct Reference

Detailed Description

Scan Policy

Definition at line 1338 of file as_policy.h.

#include "as_policy.h"

+ Collaboration diagram for as_policy_scan:

Data Fields

as_policy_base base
bool durable_delete
uint64_t max_records
uint32_t records_per_second
as_policy_replica replica
uint32_t ttl

Related Symbols

(Note that these are not member symbols.)

static void as_policy_scan_copy (const as_policy_scan *src, as_policy_scan *trg)
static as_policy_scanas_policy_scan_init (as_policy_scan *p)

Friends And Related Symbol Documentation

◆ as_policy_scan_copy()

static void as_policy_scan_copy ( const as_policy_scan * src,
as_policy_scan * trg )

Shallow copy as_policy_scan values.

srcThe source policy.
trgThe target policy.

Definition at line 1899 of file as_policy.h.

◆ as_policy_scan_init()

static as_policy_scan * as_policy_scan_init ( as_policy_scan * p)

Initialize as_policy_scan to default values.

pThe policy to initialize.
The initialized policy.

Definition at line 1879 of file as_policy.h.

References as_policy_base_query_init(), AS_POLICY_REPLICA_SEQUENCE, base, durable_delete, max_records, records_per_second, replica, and ttl.

Field Documentation

◆ base

as_policy_base as_policy_scan::base

Generic policy fields.

Definition at line 1343 of file as_policy.h.

◆ durable_delete

bool as_policy_scan::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 1388 of file as_policy.h.

◆ max_records

uint64_t as_policy_scan::max_records

Approximate number of records to return to client. This number is divided by the number of nodes involved in the scan. The actual number of records returned may be less than max_records if node record counts are small and unbalanced across nodes.

Default: 0 (do not limit record count)

Definition at line 1353 of file as_policy.h.

◆ records_per_second

uint32_t as_policy_scan::records_per_second

Limit returned records per second (rps) rate for each server. Do not apply rps limit if records_per_second is zero.

Default: 0

Definition at line 1361 of file as_policy.h.

◆ replica

as_policy_replica as_policy_scan::replica

Algorithm used to determine target node.

Definition at line 1366 of file as_policy.h.

◆ ttl

uint32_t as_policy_scan::ttl

The default time-to-live (expiration) of the record in seconds. This field will only be used on background scan writes if "as_scan.ttl" is set to AS_RECORD_CLIENT_DEFAULT_TTL.

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 1379 of file as_policy.h.

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