Skip to content

Commit

Permalink
Revert previous explanation about ttl options in policies only being …
Browse files Browse the repository at this point in the history
…usable in client config
  • Loading branch information
juliannguyen4 committed Nov 8, 2023
1 parent 45da849 commit dee00ae
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 9 deletions.
11 changes: 4 additions & 7 deletions doc/client.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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:

Expand Down
3 changes: 1 addition & 2 deletions doc/scan.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand Down

0 comments on commit dee00ae

Please sign in to comment.