Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[CLIENT-2536] Docs: add missing policies #501

Merged
merged 3 commits into from
Sep 5, 2023
Merged

[CLIENT-2536] Docs: add missing policies #501

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
75659d3
Add missing batch apply policy
juliannguyen4 Aug 30, 2023
d18313f
add more missing policies
juliannguyen4 Aug 30, 2023
ea7a9f7
remove nonexistent policy
juliannguyen4 Aug 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 15 additions & 4 deletions doc/client.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1586,6 +1586,11 @@ Write Policies

Default: ``0``, meaning 'never compress'

* **replica**
Algorithm used to determine target node. One of the :ref:`POLICY_REPLICA` values.

Default: :data:`aerospike.POLICY_REPLICA_SEQUENCE`

.. _aerospike_read_policies:

Read Policies
Expand Down Expand Up @@ -1753,6 +1758,10 @@ Operate Policies
| Perform durable delete
|
| Default: ``False``
* **deserialize** :class:`bool`
| Should raw bytes representing a list or map be deserialized to a Python list or map. Set to false for backup programs that just need access to raw bytes.
|
| Default: :py:obj:`True`
* **expressions** :class:`list`
| Compiled aerospike expressions :mod:`aerospike_helpers` used for filtering records within a transaction.
|
Expand Down Expand Up @@ -1818,10 +1827,6 @@ Apply Policies
| One of the :ref:`POLICY_REPLICA` values such as :data:`aerospike.POLICY_REPLICA_MASTER`
|
| Default: :data:`aerospike.POLICY_REPLICA_SEQUENCE`
* **gen**
| One of the :ref:`POLICY_GEN` values such as :data:`aerospike.POLICY_GEN_IGNORE`
|
| Default: :data:`aerospike.POLICY_GEN_IGNORE`
* **commit_level**
| One of the :ref:`POLICY_COMMIT_LEVEL` values such as :data:`aerospike.POLICY_COMMIT_LEVEL_ALL`
|
Expand Down Expand Up @@ -1899,6 +1904,8 @@ Remove Policies
| One of the :ref:`POLICY_GEN` values such as :data:`aerospike.POLICY_GEN_IGNORE`
|
| Default: :data:`aerospike.POLICY_GEN_IGNORE`
* **generation** (:class:`int`)
| The generation of the record. This value is limited to a 16-bit unsigned integer.
* **durable_delete** (:class:`bool`)
| Perform durable delete
|
Expand Down Expand Up @@ -2110,6 +2117,10 @@ Batch Apply Policies
| Note that the TTL value will be employed ONLY on write/update calls.
|
| Default: 0
* **durable_delete** :class:`bool`
| 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: :py:obj:`False` (do not tombstone deleted records).
dwelch-spike marked this conversation as resolved.
Show resolved Hide resolved
* **expressions** :class:`list`
| Compiled aerospike expressions :mod:`aerospike_helpers` used for filtering records within a transaction.
|
Expand Down