From dee00aed573a04db7808076f1b3155b41ce27552 Mon Sep 17 00:00:00 2001 From: Julian Nguyen <109386615+juliannguyen4@users.noreply.github.com> Date: Wed, 8 Nov 2023 10:59:49 -0800 Subject: [PATCH] Revert previous explanation about ttl options in policies only being usable in client config --- doc/client.rst | 11 ++++------- doc/scan.rst | 3 +-- 2 files changed, 5 insertions(+), 9 deletions(-) diff --git a/doc/client.rst b/doc/client.rst index c52a614c84..13cd4b4dd2 100755 --- a/doc/client.rst +++ b/doc/client.rst @@ -1577,9 +1577,8 @@ Write Policies | | Default: :data:`aerospike.POLICY_EXISTS_IGNORE` * **ttl** - The default time-to-live (expiration) of the record in seconds. This field should only be set - in a write policy passed to the client configuration dictionary and will only be used if the write - transaction: + The default time-to-live (expiration) of the record in seconds. This field will only be used if + the write transaction: 1. Doesn't contain a metadata dictionary with a ``ttl`` value. 2. Contains a metadata dictionary with a ``ttl`` value set to :data:`aerospike.TTL_CLIENT_DEFAULT`. @@ -1751,8 +1750,7 @@ Operate Policies | | Default: :data:`aerospike.POLICY_GEN_IGNORE` * **ttl** (:class:`int`) - The default time-to-live (expiration) of the record in seconds. This field should only be set in - an operate policy passed to the client configuration dictionary and will only be used if an + The default time-to-live (expiration) of the record in seconds. This field will only be used if an operate transaction: 1. Doesn't contain a metadata dictionary with a ``ttl`` value. @@ -2110,8 +2108,7 @@ Batch Write Policies | | Default: None * **ttl** :class:`int` - The time-to-live (expiration) in seconds to apply to every record in the batch. This field should only be set - in a batch write policy that is passed to a client configuration dictionary and will only be + The time-to-live (expiration) in seconds to apply to every record in the batch. This field will only be used if: 1. A :meth:`~aerospike.Client.batch_write` call contains a :class:`~aerospike_helpers.batch.records.Write` that: diff --git a/doc/scan.rst b/doc/scan.rst index 4671c7bd4f..cccc04a91e 100755 --- a/doc/scan.rst +++ b/doc/scan.rst @@ -577,8 +577,7 @@ Policies | | Default: ``aerospike.POLICY_REPLICA_SEQUENCE`` * **ttl** (:class:`int`) - The default time-to-live (expiration) of the record in seconds. This field should only be set - in a scan policy passed to the client configuration dictionary and will only be used on + The default time-to-live (expiration) of the record in seconds. This field will only be used on background scan writes if :py:attr:`aerospike.Scan.ttl` is set to :data:`aerospike.TTL_CLIENT_DEFAULT`.