Skip to content

Commit

Permalink
[CLIENT-3272] Docs: rename read/write operations to commands (#714)
Browse files Browse the repository at this point in the history
  • Loading branch information
juliannguyen4 committed Jan 22, 2025
1 parent 048310f commit 4f22e0a
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions aerospike_helpers/batch/records.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ def __init__(self, key: tuple) -> None:


class Write(BatchRecord):
""" Write is used for executing Batch write operations with batch_write and retrieving batch write results.
""" Write is used for executing Batch write commands with batch_write and retrieving batch write results.
Attributes:
key (:obj:`tuple`): The aerospike key to operate on.
Expand Down Expand Up @@ -109,7 +109,7 @@ def __init__(


class Read(BatchRecord):
""" Read is used for executing Batch read operations with batch_write and retrieving results.
""" Read is used for executing Batch read commands with batch_write and retrieving results.
Attributes:
key (:obj:`tuple`): The aerospike key to operate on.
Expand Down
2 changes: 1 addition & 1 deletion doc/aerospike.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Client
# Configure the client to first connect to a cluster node at 127.0.0.1
# The client will learn about the other nodes in the cluster from the seed node.
# Also sets a top level policy for read operations
# Also sets a top level policy for read commands
config = {
'hosts': [ ('127.0.0.1', 3000) ],
'policies': {'read': {'total_timeout': 1000}},
Expand Down
4 changes: 2 additions & 2 deletions doc/client.rst
Original file line number Diff line number Diff line change
Expand Up @@ -364,7 +364,7 @@ Batch Operations

.. method:: batch_operate(keys: list, ops: list, [policy_batch: dict], [policy_batch_write: dict], [ttl: int]) -> BatchRecords

Perform the same read/write commands on multiple keys.
Perform the same read/write operations on multiple keys.

.. note:: Prior to Python client 14.0.0, using the :meth:`~batch_operate()` method with only read operations caused an error.
This bug was fixed in version 14.0.0.
Expand Down Expand Up @@ -1498,7 +1498,7 @@ Record Tuple

.. object:: record

The record tuple which is returned by various read operations. It has the structure:
The record tuple which is returned by various read commands. It has the structure:

``(key, meta, bins)``

Expand Down
2 changes: 1 addition & 1 deletion doc/geojson.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ It also enables queries for regions that contain a given point using:

On the client side, wrapping geospatial data in an instance of the
:class:`aerospike.GeoJSON` class enables serialization of the data into the
correct type during a write operation, such as :meth:`~aerospike.Client.put`.
correct type during a write operation, such as in :meth:`~aerospike.Client.put`.

When reading a record from the server, bins with geospatial data will be
deserialized into a :class:`~aerospike.GeoJSON` instance.
Expand Down

0 comments on commit 4f22e0a

Please sign in to comment.