public sealed class WritePolicy : Policy| WritePolicy() | Default constructor. |
| WritePolicy(Policy) | Copy write policy from another policy. |
| WritePolicy(WritePolicy) | Copy write policy from another write policy. |
| Txn |
Transaction identifier. If this field is populated, the corresponding
command will be included in the transaction. This field is ignored for scan/query.
Default: null (Inherited from Policy) |
| Clone | Creates a deep copy of this write policy. |
| SetTimeout |
Create a single timeout by setting socketTimeout and totalTimeout
to the same value.
(Inherited from Policy) |
| SetTimeouts |
Set socketTimeout and totalTimeout. If totalTimeout defined and
socketTimeout greater than totalTimeout, set socketTimeout to
totalTimeout.
(Inherited from Policy) |
| commitLevel |
Desired consistency guarantee when committing a command 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.
Default: CommitLevel.COMMIT_ALL |
| compress |
Use zlib compression on command buffers sent to the server and responses received
from the server when the buffer size is greater than 128 bytes. This option will
increase cpu and memory usage(for extra compressed buffers), but decrease the size
of data sent over the network.
This compression feature requires the Enterprise Edition Server. Default: false (Inherited from Policy) |
| durableDelete |
If the command 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.
Default: false (do not tombstone deleted records). |
| expiration |
Record expiration. Also known as ttl (time to live).
Seconds record will live before being removed by the server.
Expiration values:
Default: 0 |
| failOnFilteredOut |
Throw exception if filterExp is defined and that filter evaluates
to false (command ignored). The AerospikeException
will contain result code .
This field is not applicable to batch, scan or query commands. Default: false (Inherited from Policy) |
| filterExp |
Optional expression filter. If filterExp exists and evaluates to false, the
command is ignored.
Default: null (Inherited from Policy) |
| generation |
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. This field is only relevant when
generationPolicy is not NONE.
The server does not support this field for UDF Execute() calls. The read-modify-write usage model can still be enforced inside the UDF code itself. Default: 0 |
| generationPolicy |
Qualify how to handle record writes based on record generation. The default (NONE)
indicates that the generation is not used to restrict writes.
The server does not support this field for UDF Execute() calls. The read-modify-write usage model can still be enforced inside the UDF code itself. Default: GenerationPolicy.NONE |
| maxRetries |
Maximum number of retries before aborting the current command.
The initial attempt is not counted as a retry.
If maxRetries is exceeded, the command will abort with AerospikeException.Timeout. WARNING: Database writes that are not idempotent (such as Add()) should not be retried because the write operation may be performed multiple times if the client timed out previous command attempts. It's important to use a distinct WritePolicy for non-idempotent writes which sets maxRetries = 0; Default for write: 0 (no retries) Default for read: 2 (initial attempt + 2 retries = 3 attempts) Default for scan/query: 5 (6 attempts. See ScanPolicy() comments.) (Inherited from Policy) |
| OnLockingOnly |
Execute the write command only if the record is not already locked by this transaction.
If this field is true and the record is already locked by this transaction, the command
will throw an exception with the MRT_ALREADY_LOCKED
error code.
This field is useful for safely retrying non-idempotent writes as an alternative to simply aborting the transaction. This field is not applicable to record delete commands. Default: false. |
| readModeAP |
Read policy for AP (availability) namespaces.
Default: ONE (Inherited from Policy) |
| readModeSC |
Read policy for SC (strong consistency) namespaces.
Default: SESSION (Inherited from Policy) |
| readTouchTtlPercent |
Determine how record TTL (time to live) is affected on reads. When enabled, the server can
efficiently operate as a read-based LRU cache where the least recently used records are expired.
The value is expressed as a percentage of the TTL sent on the most recent write such that a read
within this interval of the record�s end of life will generate a touch.
For example, if the most recent write had a TTL of 10 hours and read_touch_ttl_percent is set to 80, the next read within 8 hours of the record's end of life (equivalent to 2 hours after the most recent write) will result in a touch, resetting the TTL to another 10 hours. Values:
Default: 0 (Inherited from Policy) |
| recordExistsAction |
Qualify how to handle writes where the record already exists.
Default: RecordExistsAction.UPDATE |
| recordParser |
Alternate record parser.
Default: Use standard record parser. (Inherited from Policy) |
| replica |
Replica algorithm used to determine the target node for a partition derived from a key
or requested in a scan/query.
Default: SEQUENCE (Inherited from Policy) |
| respondAllOps |
For client operate(), return a result for every operation.
Some operations do not return results by default (ListOperation.clear() for example). This can make it difficult to determine the desired result offset in the returned bin's result list. Setting respondAllOps to true makes it easier to identify the desired result offset (result offset equals bin's operate sequence). If there is a map operation in operate(), respondAllOps will be forced to true for that operate() call. Default: false |
| sendKey |
Send user defined key in addition to hash digest on both reads and writes.
If the key is sent on a write, the key will be stored with the record on
the server.
If the key is sent on a read, the server will generate the hash digest from the key and vildate that digest with the digest sent by the client. Unless this is the explicit intent of the developer, avoid sending the key on reads. Default: false (do not send the user defined key) (Inherited from Policy) |
| sleepBetweenRetries |
Milliseconds to sleep between retries. Enter zero to skip sleep.
This field is ignored when maxRetries is zero.
This field is also ignored in async mode.
The sleep only occurs on connection errors and server timeouts which suggest a node is down and the cluster is reforming. The sleep does not occur when the client's socketTimeout expires. Reads do not have to sleep when a node goes down because the cluster does not shut out reads during cluster reformation. The default for reads is zero. The default for writes is also zero because writes are not retried by default. Writes need to wait for the cluster to reform when a node goes down. Immediate write retries on node failure have been shown to consistently result in errors. If maxRetries is greater than zero on a write, then sleepBetweenRetries should be set high enough to allow the cluster to reform (>= 3000ms). Default: 0 (do not sleep between retries) (Inherited from Policy) |
| socketTimeout |
Socket idle timeout in milliseconds when processing a database command.
If socketTimeout is zero and totalTimeout is non-zero, then socketTimeout will be set to totalTimeout. If both socketTimeout and totalTimeout are non-zero and socketTimeout > totalTimeout, then socketTimeout will be set to totalTimeout. If both socketTimeout and totalTimeout are zero, then there will be no socket idle limit. If socketTimeout is not zero and the socket has been idle for at least socketTimeout, both maxRetries and totalTimeout are checked. If maxRetries and totalTimeout are not exceeded, the command is retried. For synchronous methods, socketTimeout is the socket SendTimeout and ReceiveTimeout. For asynchronous methods, the socketTimeout is implemented using the AsyncTimeoutQueue and socketTimeout is only used if totalTimeout is not defined. Default: 30000ms (Inherited from Policy) |
| TimeoutDelay |
Delay milliseconds after socket read timeout in an attempt to recover the socket
in the background. Processing continues on the original command and the user
is still notified at the original command timeout.
When a command is stopped prematurely, the socket must be drained of all incoming data or closed to prevent unread socket data from corrupting the next command that would use that socket. If a socket read timeout occurs and timeoutDelay is greater than zero, the socket will be drained until all data has been read or timeoutDelay is reached. If all data has been read, the socket will be placed back into the connection pool. If timeoutDelay is reached before the draining is complete, the socket will be closed. Sync sockets are drained in the cluster tend thread at periodic intervals. timeoutDelay is not supported for async sockets. Many cloud providers encounter performance problems when sockets are closed by the client when the server still has data left to write (results in socket RST packet). If the socket is fully drained before closing, the socket RST performance penalty can be avoided on these cloud providers. The disadvantage of enabling timeoutDelay is that extra memory/processing is required to drain sockets and additional connections may still be needed for command retries. If timeoutDelay were to be enabled, 3000ms would be a reasonable value. Default: 0 (no delay, connection closed on timeout) (Inherited from Policy) |
| totalTimeout |
Total command timeout in milliseconds.
The totalTimeout is tracked on the client and sent to the server along with the command in the wire protocol. The client will most likely timeout first, but the server also has the capability to timeout the command. If totalTimeout is not zero and totalTimeout is reached before the command completes, the command will abort with AerospikeException.Timeout. If totalTimeout is zero, there will be no total time limit. Default for scan/query: 0 (no time limit) Default for all other commands: 1000ms (Inherited from Policy) |