Merge remote-tracking branch 'origin/v20' into CLIENT-681-2025

Author: juliannguyen4

aerospike-stubs/aerospike.pyi

@@ -461,7 +461,6 @@ class Client:
     def index_map_values_create(self, ns: str, set: str, bin: str, index_datatype: int, name: str, policy: dict = ..., ctx: Optional[list] = ...) -> None: ...
     def index_set_create(self, ns: str, set: str, name: str, policy: dict = ...) -> None: ...
 
-    def index_cdt_create(self, ns: str, set: str, bin: str, index_type: int, index_datatype: int, name: str, ctx: list, policy: dict = ...) -> int: ...
     def index_expr_create(self, ns: str, set: str, index_type: int, index_datatype: int, expressions: list, name: str, policy: dict = ...) -> None: ...
 
     def index_remove(self, ns, name: str, policy: dict = ...) -> None: ...
@@ -479,7 +478,7 @@ class Client:
     def put(self, key: tuple, bins: dict, meta: dict = ..., policy: dict = ..., serializer = ...) -> None: ...
     def query(self, namespace: str, set: Optional[str] = None) -> Query: ...
     def query_apply(self, ns: str, set: str, predicate: tuple, module: str, function: str, args: list = ..., policy: dict = ...) -> int: ...
-    def remove(self, key: tuple, meta: dict = ..., policy: dict = ...) -> None: ...
+    def remove(self, key: tuple, policy: dict = ...) -> None: ...
     def remove_bin(self, key: tuple, list: list, meta: dict = ..., policy: dict = ...) -> None: ...
     def scan(self, namespace: str, set: Optional[str] = None) -> Scan: ...
     def scan_apply(self, ns: str, set: str, module: str, function: str, args: list = ..., policy: dict = ..., options: dict = ...) -> int: ...

aerospike_helpers/batch/records.py

@@ -65,8 +65,6 @@ def __init__(self, key: tuple) -> None:
 class Write(BatchRecord):
     """ Write is used for executing Batch write commands with batch_write and retrieving batch write results.
 
-        .. include:: ./deprecate_meta_ttl.rst
-
         Attributes:
             key (:obj:`tuple`): The aerospike key to send the command to.
             record (:obj:`tuple`): The record corresponding to the requested key.
@@ -76,7 +74,7 @@ class Write(BatchRecord):
             to the server.
             ops (:ref:`aerospike_operation_helpers.operations`): A list of aerospike operation dictionaries to perform
                 on the record at key.
-            meta (dict): the metadata to set for this command
+            meta (dict): the expected generation for this record
             policy (:ref:`aerospike_batch_write_policies`, optional): An optional dictionary of batch write policy
                 flags.
     """
@@ -120,9 +118,6 @@ def __init__(
 class Read(BatchRecord):
     """ Read is used for executing Batch read commands with batch_write and retrieving results.
 
-        .. deprecated:: 19.1.0 Deprecated the ``"ttl"`` option in the ``meta`` parameter. Use the policy parameter in a
-            :py:obj:`~aerospike_helpers.batch.records.Write` BatchRecord to set the ``"ttl"`` instead.
-
         Attributes:
             key (:obj:`tuple`): The aerospike key to send the command to.
             record (:obj:`tuple`): The record corresponding to the requested key.
@@ -132,7 +127,7 @@ class Read(BatchRecord):
             to the server.
             ops (:ref:`aerospike_operation_helpers.operations`): list of aerospike operation dictionaries to perform on
                 the record at key.
-            meta (dict): the metadata to set for this command
+            meta (dict): the expected generation for this record
             read_all_bins (:obj:`bool`, optional): An optional bool, if True, read all bins in the record.
             policy (:ref:`aerospike_batch_read_policies`, optional): An optional dictionary of batch read policy flags.
     """

doc/client.rst

@@ -152,11 +152,9 @@ Record Commands
 
         Create a new record, or remove / add bins to a record.
 
-        .. include:: ./deprecate_meta_ttl.rst
-
         :param tuple key: a :ref:`aerospike_key_tuple` associated with the record.
         :param dict bins: contains bin name-value pairs of the record.
-        :param dict meta: record metadata to be set. see :ref:`metadata_dict`.
+        :param dict meta: record generation to compare. see :ref:`metadata_dict`.
         :param dict policy: see :ref:`aerospike_write_policies`.
 
         :param serializer: override the serialization mode of the client \
@@ -317,11 +315,9 @@ Record Commands
         (In Aerospike server versions prior to 3.6.0, non-existent bins being read will have a \
         :py:obj:`None` value. )
 
-        .. include:: ./deprecate_meta_ttl.rst
-
         :param tuple key: a :ref:`aerospike_key_tuple` associated with the record.
         :param list list: See :ref:`aerospike_operation_helpers.operations`.
-        :param dict meta: record metadata to be set. See :ref:`metadata_dict`.
+        :param dict meta: record generation to compare. See :ref:`metadata_dict`.
         :param dict policy: optional :ref:`aerospike_operate_policies`.
         :return: a :ref:`aerospike_record_tuple`.
         :raises: a subclass of :exc:`~aerospike.exception.AerospikeError`.
@@ -372,11 +368,9 @@ Record Commands
 
         Write operations or read operations that fail will not return a ``(bin-name, result)`` tuple.
 
-        .. include:: ./deprecate_meta_ttl.rst
-
         :param tuple key: a :ref:`aerospike_key_tuple` associated with the record.
         :param list list: See :ref:`aerospike_operation_helpers.operations`.
-        :param dict meta: record metadata to be set. See :ref:`metadata_dict`.
+        :param dict meta: record generation to compare. See :ref:`metadata_dict`.
         :param dict policy: optional :ref:`aerospike_operate_policies`.
 
         :return: a :ref:`aerospike_record_tuple`.
@@ -414,13 +408,9 @@ Record Commands
 
         Touch the given record, setting its time-to-live and incrementing its generation.
 
-        .. versionchanged:: 19.1.0
-
-            Deprecated the ``meta["ttl"]`` parameter. Use the ``val`` parameter instead.
-
         :param tuple key: a :ref:`aerospike_key_tuple` associated with the record.
         :param int val: ttl in seconds, with ``0`` resolving to the default value in the server config.
-        :param dict meta: record metadata to be set. see :ref:`metadata_dict`
+        :param dict meta: record generation to compare. see :ref:`metadata_dict`
         :param dict policy: see :ref:`aerospike_operate_policies`.
 
         :raises: a subclass of :exc:`~aerospike.exception.AerospikeError`.
@@ -446,16 +436,11 @@ Record Commands
             {'ttl': 2592000, 'gen': 1}
             {'ttl': 120, 'gen': 2}
 
-    .. method:: remove(key[meta: dict[, policy: dict]])
+    .. method:: remove(key[, policy: dict])
 
         Remove a record matching the *key* from the cluster.
 
-        .. versionchanged:: 19.1.0
-
-            Deprecated the ``meta`` parameter. Use the policy parameter to set ``gen`` instead.
-
         :param tuple key: a :ref:`aerospike_key_tuple` associated with the record.
-        :param dict meta: contains the expected generation of the record in a key called ``"gen"``.
         :param dict policy: see :ref:`aerospike_remove_policies`. May be passed as a keyword argument.
 
         :raises: a subclass of :exc:`~aerospike.exception.AerospikeError`.
@@ -468,7 +453,7 @@ Record Commands
 
             # Try to remove it with the wrong generation
             try:
-                client.remove(keyTuple, meta={'gen': 5}, policy={'gen': aerospike.POLICY_GEN_EQ})
+                client.remove(keyTuple, policy={'gen': aerospike.POLICY_GEN_EQ, 'generation': 5})
             except ex.AerospikeError as e:
                 print("Error: {0} [{1}]".format(e.msg, e.code))
 
@@ -484,11 +469,9 @@ Record Commands
         Remove a list of bins from a record with a given *key*. Equivalent to \
         setting those bins to :meth:`aerospike.null` with a :meth:`~aerospike.Client.put`.
 
-        .. include:: ./deprecate_meta_ttl.rst
-
         :param tuple key: a :ref:`aerospike_key_tuple` associated with the record.
         :param list list: the bins names to be removed from the record.
-        :param dict meta: record metadata to be set. See :ref:`metadata_dict`.
+        :param dict meta: record generation to compare. See :ref:`metadata_dict`.
         :param dict policy: optional :ref:`aerospike_write_policies`.
 
         :raises: a subclass of :exc:`~aerospike.exception.AerospikeError`.
@@ -817,12 +800,10 @@ String Operations
 
         Append a string to the string value in bin.
 
-        .. include:: ./deprecate_meta_ttl.rst
-
         :param tuple key: a :ref:`aerospike_key_tuple` tuple associated with the record.
         :param str bin: the name of the bin.
         :param str val: the string to append to the bin value.
-        :param dict meta: record metadata to be set. See :ref:`metadata_dict`.
+        :param dict meta: record generation to compare. See :ref:`metadata_dict`.
         :param dict policy: optional :ref:`aerospike_operate_policies`.
 
         :raises: a subclass of :exc:`~aerospike.exception.AerospikeError`.
@@ -844,12 +825,10 @@ String Operations
 
         Prepend the string value in *bin* with the string *val*.
 
-        .. include:: ./deprecate_meta_ttl.rst
-
         :param tuple key: a :ref:`aerospike_key_tuple` tuple associated with the record.
         :param str bin: the name of the bin.
         :param str val: the string to prepend to the bin value.
-        :param dict meta: record metadata to be set. See :ref:`metadata_dict`.
+        :param dict meta: record generation to compare. See :ref:`metadata_dict`.
         :param dict policy: optional :ref:`aerospike_operate_policies`.
 
         :raises: a subclass of :exc:`~aerospike.exception.AerospikeError`.
@@ -880,13 +859,11 @@ Numeric Operations
 
         Increment the integer value in *bin* by the integer *val*.
 
-        .. include:: ./deprecate_meta_ttl.rst
-
         :param tuple key: a :ref:`aerospike_key_tuple` tuple associated with the record.
         :param str bin: the name of the bin.
         :param int offset: the value by which to increment the value in *bin*.
         :type offset: :py:class:`int` or :py:class:`float`
-        :param dict meta: record metadata to be set. See :ref:`metadata_dict`.
+        :param dict meta: record generation to compare. See :ref:`metadata_dict`.
         :param dict policy: optional :ref:`aerospike_operate_policies`. Note: the ``exists`` policy option may not be: :py:data:`aerospike.POLICY_EXISTS_CREATE_OR_REPLACE` nor :py:data:`aerospike.POLICY_EXISTS_REPLACE`
         :raises: a subclass of :exc:`~aerospike.exception.AerospikeError`.
 
@@ -1519,24 +1496,6 @@ Index Operations
 
             client.index_geo2dsphere_create('test', 'pads', 'loc', 'pads_loc_geo')
 
-    .. method:: index_cdt_create(ns: str, set: str, bin: str, index_type, index_datatype, index_name: str, ctx: list[, policy: dict])
-
-        .. deprecated:: 19.1.0 Use the other non-deprecated index methods to create an index with a list of contexts.
-
-        Create an collection data type (CDT) index named *index_name* for a scalar, list values, map keys, or map values (as defined by *index_type*) and for
-        numeric, string, or GeoJSON values (as defined by *index_datatype*)
-        on records of the specified *ns*, *set* whose bin is a list or map.
-
-        :param str ns: the namespace in the aerospike cluster.
-        :param str set: the set name.
-        :param str bin: the name of bin the secondary index is built on.
-        :param index_type: whether we are querying a single scalar value or specific values of a CDT type. See :ref:`aerospike_index_types`.
-        :param index_datatype: the type of value being queried on. See :ref:`aerospike_index_datatypes`.
-        :param str index_name: the name of the index.
-        :param dict ctx: a :class:`list` of contexts produced by :mod:`aerospike_helpers.cdt_ctx` methods.
-        :param dict policy: optional :ref:`aerospike_info_policies`.
-        :raises: a subclass of :exc:`~aerospike.exception.AerospikeError`.
-
     .. index::
         single: Admin Operations
 
@@ -2032,8 +1991,9 @@ Metadata Dictionary
 
 The metadata dictionary has the following key-value pairs:
 
-    * ``"ttl"`` (:class:`int`): record time to live in seconds. See :ref:`TTL_CONSTANTS` for possible special values.
-    * ``"gen"`` (:class:`int`): record generation
+    * ``"ttl"`` (:class:`int`): record time to live in seconds. This field is read only.
+    * ``"gen"`` (:class:`int`): record generation. If passing as input, this is the expected record generation.
+        If returned as an output, this is the current record generation.
 
 .. _aerospike_policies:
 

doc/deprecate_meta_ttl.rst

@@ -157,7 +157,7 @@ PyObject *AerospikeClient_Remove(AerospikeClient *self, PyObject *args,
                                  PyObject *kwds);
 
 PyObject *AerospikeClient_Remove_Invoke(AerospikeClient *self, PyObject *py_key,
-                                        PyObject *py_meta, PyObject *py_policy);
+                                        PyObject *py_policy);
 
 /**
  * Remove bin from the database.
@@ -374,15 +374,6 @@ PyObject *AerospikeClient_Index_Blob_Create(AerospikeClient *self,
 PyObject *AerospikeClient_Index_Expr_Create(AerospikeClient *self,
                                             PyObject *args, PyObject *kwds);
 
-/**
- * Create secondary cdt index
- *
- *		client.index_cdt_create(namespace, set, bin, index_type, index_datatype, index_name, ctx, policy)
- *
- */
-PyObject *AerospikeClient_Index_Cdt_Create(AerospikeClient *self,
-                                           PyObject *args, PyObject *kwds);
-
 /**
  * Create secondary geospatial index
  *

src/include/client.h

@@ -155,11 +155,10 @@ void initialize_bin_for_strictypes(AerospikeClient *self, as_error *err,
                                    PyObject *py_value, as_binop *binop,
                                    char *bin, as_dynamic_pool *dynamic_pool);
 
-// Both as_operations and as_record have ttl and gen fields,
-// so we have ttl and gen as separate parameters instead of accepting either as_operations or as_record
-as_status check_and_set_meta(PyObject *py_meta, uint32_t *ttl_ref,
-                             uint16_t *gen_ref, as_error *err,
-                             bool validate_keys);
+// Both as_operations and as_record have gen fields,
+// so we have gen as a separate parameter instead of accepting either as_operations or as_record
+as_status check_and_set_meta(PyObject *py_meta, uint16_t *gen_ref,
+                             as_error *err, bool validate_keys);
 
 as_status string_and_pyuni_from_pystring(PyObject *py_string,
                                          PyObject **pyuni_r, char **c_str_ptr,

src/include/conversions.h

@@ -951,7 +951,7 @@ DEFINE_SET_OF_VALID_KEYS(hll_policy, "flags", NULL)
 
 DEFINE_SET_OF_VALID_KEYS(admin_policy, "timeout", NULL)
 
-DEFINE_SET_OF_VALID_KEYS(record_metadata, "gen", "ttl", NULL)
+DEFINE_SET_OF_VALID_KEYS(record_metadata, "gen", NULL)
 
 // Use a struct to create pairs of pyobjects and list of strings defined above
 // When we initialize the module, we create sets for the valid keys that the client can use later

src/main/aerospike.c

@@ -297,8 +297,10 @@ static PyObject *AerospikeClient_BatchWriteInvoke(AerospikeClient *self,
 
             ops = as_operations_new(py_ops_size);
             garb->ops_to_free = ops;
+            // as_operations_new defaults ttl to 0 (namespace default). Use the batch write policy ttl instead.
+            ops->ttl = AS_RECORD_CLIENT_DEFAULT_TTL;
 
-            if (check_and_set_meta(py_meta, &ops->ttl, &ops->gen, err,
+            if (check_and_set_meta(py_meta, &ops->gen, err,
                                    self->validate_keys) != AEROSPIKE_OK) {
                 goto CLEANUP_ON_ERROR;
             }

src/main/client/batch_write.c

@@ -261,7 +261,7 @@ as_status get_enum_from_py_dict(
     bool *int_was_found)
 {
     return get_bound_int_from_py_dict(err, py_dict, key, int_pointer, min_bound,
-                                      max_bound, is_optional, true, int_was_found);
+                                      max_bound, is_optional, false, int_was_found);
 }
 
 as_status get_int_from_py_dict(as_error *err, PyObject *py_dict, const char *key, int *int_pointer, bool is_optional, bool *int_was_found)

src/main/client/cdt_operation_utils.c

@@ -487,75 +487,3 @@ PyObject *AerospikeClient_Index_2dsphere_Create(AerospikeClient *self,
     return AerospikeClient_Index_Create_Deprecated_Helper(
         self, args, kwds, "index_geo2dsphere_create", AS_INDEX_GEO2DSPHERE);
 }
-
-PyObject *AerospikeClient_Index_Cdt_Create(AerospikeClient *self,
-                                           PyObject *args, PyObject *kwds)
-{
-    int retval =
-        PyErr_WarnEx(PyExc_DeprecationWarning,
-                     "index_cdt_create() is deprecated. Please use one of the "
-                     "other non-deprecated index_*_create() methods instead",
-                     STACK_LEVEL);
-    if (retval == -1) {
-        return NULL;
-    }
-
-    // Initialize error
-    as_error err;
-    as_error_init(&err);
-
-    // Python Function Arguments
-    PyObject *py_policy = NULL;
-    PyObject *py_ns = NULL;
-    PyObject *py_set = NULL;
-    PyObject *py_bin = NULL;
-    PyObject *py_indextype = NULL;
-    PyObject *py_datatype = NULL;
-    PyObject *py_name = NULL;
-
-    PyObject *py_ctx = NULL;
-
-    as_index_datatype data_type;
-    as_index_type index_type;
-
-    // Python Function Keyword Arguments
-    static char *kwlist[] = {
-        "ns",   "set", "bin",    "index_type", "index_datatype",
-        "name", "ctx", "policy", NULL};
-
-    // Python Function Argument Parsing
-    if (PyArg_ParseTupleAndKeywords(args, kwds, "OOOOOOO|O:index_list_create",
-                                    kwlist, &py_ns, &py_set, &py_bin,
-                                    &py_indextype, &py_datatype, &py_name,
-                                    &py_ctx, &py_policy) == false) {
-        return NULL;
-    }
-
-    if (get_int_from_py_int(&err, py_indextype, (int *)&index_type,
-                            "index_type") != AEROSPIKE_OK) {
-        goto CLEANUP_ON_ERROR;
-    }
-
-    if (get_int_from_py_int(&err, py_datatype, (int *)&data_type,
-                            "index_datatype") != AEROSPIKE_OK) {
-        goto CLEANUP_ON_ERROR;
-    }
-
-    // convert_python_args_to_c_and_create_index, which is called by the new index create method API's,
-    // accepts an optional value of None for ctx
-    // This API call is the only exception where a list of ctx's is required
-    if (Py_IsNone(py_ctx)) {
-        as_error_update(&err, AEROSPIKE_ERR_PARAM, "ctx cannot be None");
-        goto CLEANUP_ON_ERROR;
-    }
-
-    // Even if this call fails, it will raise its own exception
-    // and the err object here will not be set. We don't raise an exception twice
-    return convert_python_args_to_c_and_create_index(
-        self, py_policy, py_ns, py_set, py_bin, py_name, index_type, data_type,
-        py_ctx, NULL);
-
-CLEANUP_ON_ERROR:
-    raise_exception_base(&err, Py_None, Py_None, Py_None, Py_None, py_name);
-    return NULL;
-}