Skip to content

Commit

Permalink
Update remove documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
aerospikerobertmarks committed Apr 9, 2019
1 parent aba35af commit 2cb525b
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions doc/client.rst
Original file line number Diff line number Diff line change
Expand Up @@ -357,12 +357,13 @@ Record Operations
client.close()
.. method:: remove(key[, policy])
.. method:: remove(key[meta, policy])

Remove a record matching the *key* from the cluster.

:param tuple key: a :ref:`aerospike_key_tuple` associated with the record.
:param dict policy: optional :ref:`aerospike_remove_policies`.
:param dict meta: Optional dictonary allowing a user to specify the expected generation of the record.
:param dict policy: optional :ref:`aerospike_remove_policies`. May be passed as a keyword argument.
:raises: a subclass of :exc:`~aerospike.exception.AerospikeError`.

.. code-block:: python
Expand All @@ -373,7 +374,7 @@ Record Operations
client = aerospike.client(config).connect()
key = ('test', 'demo', 1)
client.remove(key, {'retry': aerospike.POLICY_RETRY_ONCE
client.remove(key, meta={'gen': 5}, policy={'gen': aerospike.POLICY_GEN_EQ})
client.close()
Expand Down

0 comments on commit 2cb525b

Please sign in to comment.