Documentation

WritePolicy

in package

• Application

`WritePolicy` encapsulates parameters for all write operations.

Table of Contents

Properties

$commit_level  : mixed

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.

$durable_delete  : mixed

$exit_fast_on_exhausted_connection_pool  : mixed

$expiration  : mixed

$filter_expression  : mixed

$generation  : mixed

Generation determines expected generation.

$generation_policy  : mixed

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

$max_retries  : mixed

$read_mode_ap  : mixed

$read_mode_sc  : mixed

$record_exists_action  : mixed

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

$respond_per_each_op  : mixed

$send_key  : mixed

$sleep_multiplier  : mixed

$socket_timeout  : mixed

$total_timeout  : mixed

$use_compression  : mixed

Methods

__construct()  : mixed

getCommitLevel()  : CommitLevel

getDurableDelete()  : bool

DurableDelete leaves a tombstone for the record if the transaction results in a record deletion.

getExitFastOnExhaustedConnectionPool()  : bool

getExpiration()  : Expiration

Expiration determines record expiration in seconds. Also known as TTL (Time-To-Live).

getFilterExpression()  : Expression|null

getGeneration()  : int

getGenerationPolicy()  : GenerationPolicy

getMaxRetries()  : int

*************************************************************************** ReadPolicy Attrs ***************************************************************************

getReadModeAp()  : ReadModeAP

getReadModeSc()  : ReadModeSC

getRecordExistsAction()  : RecordExistsAction

getRespondPerEachOp()  : bool

RespondPerEachOp defines for client.Operate() method, return a result for every operation.

getSendKey()  : bool

getSleepMultiplier()  : float

getSocketTimeout()  : int

getTotalTimeout()  : int

getUseCompression()  : bool

setCommitLevel()  : mixed

setDurableDelete()  : mixed

setExitFastOnExhaustedConnectionPool()  : mixed

setExpiration()  : mixed

setFilterExpression()  : mixed

setGeneration()  : mixed

setGenerationPolicy()  : mixed

setMaxRetries()  : mixed

setReadModeAp()  : mixed

setReadModeSc()  : mixed

setRecordExistsAction()  : mixed

setRespondPerEachOp()  : mixed

setSendKey()  : mixed

setSleepMultiplier()  : mixed

setSocketTimeout()  : mixed

setTotalTimeout()  : mixed

setUseCompression()  : mixed