Skip to content

[CLIENT-4944] Add documentation for "key" policy option's new behavior regarding precedence rules #1139

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

Draft
juliannguyen4 wants to merge 1 commit into
base: dev
Choose a base branch
from
Draft

[CLIENT-4944] Add documentation for "key" policy option's new behavior regarding precedence rules #1139

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
35 changes: 7 additions & 28 deletions doc/client.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1772,10 +1772,7 @@ Write Policies
.. hlist::
:columns: 1

* **key**
| One of the :ref:`POLICY_KEY` values such as :data:`aerospike.POLICY_KEY_DIGEST`
|
| Default: :data:`aerospike.POLICY_KEY_DIGEST`
* .. include:: ./key.rst
* **exists**
| One of the :ref:`POLICY_EXISTS` values such as :data:`aerospike.POLICY_EXISTS_CREATE`
|
Expand Down Expand Up @@ -1887,10 +1884,7 @@ Operate Policies
.. hlist::
:columns: 1

* **key**
| One of the :ref:`POLICY_KEY` values such as :data:`aerospike.POLICY_KEY_DIGEST`
|
| Default: :data:`aerospike.POLICY_KEY_DIGEST`
* .. include:: ./key.rst
* **gen**
| One of the :ref:`POLICY_GEN` values such as :data:`aerospike.POLICY_GEN_IGNORE`
|
Expand Down Expand Up @@ -1974,10 +1968,7 @@ Apply Policies
.. hlist::
:columns: 1

* **key**
| One of the :ref:`POLICY_KEY` values such as :data:`aerospike.POLICY_KEY_DIGEST`
|
| Default: :data:`aerospike.POLICY_KEY_DIGEST`
* .. include:: ./key.rst
* **replica**
| One of the :ref:`POLICY_REPLICA` values such as :data:`aerospike.POLICY_REPLICA_MASTER`
|
Expand Down Expand Up @@ -2011,10 +2002,7 @@ Remove Policies
.. hlist::
:columns: 1

* **key**
| One of the :ref:`POLICY_KEY` values such as :data:`aerospike.POLICY_KEY_DIGEST`
|
| Default: :data:`aerospike.POLICY_KEY_DIGEST`
* .. include:: ./key.rst
* **commit_level**
| One of the :ref:`POLICY_COMMIT_LEVEL` values such as :data:`aerospike.POLICY_COMMIT_LEVEL_ALL`
|
Expand Down Expand Up @@ -2140,10 +2128,7 @@ Batch Write Policies
.. hlist::
:columns: 1

* **key**
| One of the :ref:`POLICY_KEY` values such as :data:`aerospike.POLICY_KEY_DIGEST`
|
| Default: :data:`aerospike.POLICY_KEY_DIGEST`
* .. include:: ./key.rst
* **commit_level**
| One of the :ref:`POLICY_COMMIT_LEVEL` values such as :data:`aerospike.POLICY_COMMIT_LEVEL_ALL`
|
Expand Down Expand Up @@ -2195,10 +2180,7 @@ Batch Apply Policies
.. hlist::
:columns: 1

* **key**
| One of the :ref:`POLICY_KEY` values such as :data:`aerospike.POLICY_KEY_DIGEST`
|
| Default: :data:`aerospike.POLICY_KEY_DIGEST`
* .. include:: ./key.rst
* **commit_level**
| One of the :ref:`POLICY_COMMIT_LEVEL` values such as :data:`aerospike.POLICY_COMMIT_LEVEL_ALL`
|
Expand Down Expand Up @@ -2234,10 +2216,7 @@ Batch Remove Policies
.. hlist::
:columns: 1

* **key**
| One of the :ref:`POLICY_KEY` values such as :data:`aerospike.POLICY_KEY_DIGEST`
|
| Default: :data:`aerospike.POLICY_KEY_DIGEST`
* .. include:: ./key.rst
* **commit_level**
| One of the :ref:`POLICY_COMMIT_LEVEL` values such as :data:`aerospike.POLICY_COMMIT_LEVEL_ALL`
|
Expand Down
5 changes: 5 additions & 0 deletions doc/key.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
**key**

One of the :ref:`POLICY_KEY` values such as :data:`aerospike.POLICY_KEY_DIGEST`

Default: :data:`aerospike.POLICY_KEY_DIGEST`
Loading