Documentation

BatchDeletePolicy
in package

BatchDeletePolicy is used in batch delete commands.

Table of Contents

Properties

$commit_level  : mixed
$durable_delete  : mixed
$filter_expression  : mixed
$generation  : mixed
$send_key  : mixed

Methods

__construct()  : mixed
getCommitLevel()  : 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.
getDurableDelete()  : bool
If the transaction results in a record deletion, leave a tombstone for the record.
getFilterExpression()  : Expression|null
FilterExpression is optional expression filter. If FilterExpression exists and evaluates to false, the specific batch key request is not performed and BatchRecord.ResultCode is set to type.FILTERED_OUT.
getGeneration()  : int
Expected generation. Generation is the number of times a record has been modified (including creation) on the server. This field is only relevant when generationPolicy is not NONE.
getSendKey()  : bool
Send user defined key in addition to hash digest.
setCommitLevel()  : mixed
setDurableDelete()  : mixed
setFilterExpression()  : mixed
setGeneration()  : mixed
setSendKey()  : mixed

Properties

Methods

getCommitLevel()

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.

public getCommitLevel() : CommitLevel

Default: CommitLevel.COMMIT_ALL

Return values
CommitLevel

getDurableDelete()

If the transaction results in a record deletion, leave a tombstone for the record.

public getDurableDelete() : bool

This prevents deleted records from reappearing after node failures. Valid for Aerospike Server Enterprise Edition only. Default: false (do not tombstone deleted records).

Return values
bool

getFilterExpression()

FilterExpression is optional expression filter. If FilterExpression exists and evaluates to false, the specific batch key request is not performed and BatchRecord.ResultCode is set to type.FILTERED_OUT.

public getFilterExpression() : Expression|null

Default: nil

Return values
Expression|null

getGeneration()

Expected generation. Generation is the number of times a record has been modified (including creation) on the server. This field is only relevant when generationPolicy is not NONE.

public getGeneration() : int

Default: 0

Return values
int

getSendKey()

Send user defined key in addition to hash digest.

public getSendKey() : bool

If true, the key will be stored with the tombstone record on the server. Default: false (do not send the user defined key)

Return values
bool

setFilterExpression()

public setFilterExpression(mixed $filter_expression) : mixed
Parameters
$filter_expression : mixed

        
On this page

Search results