[CLIENT-3947] feat!: remove ability to set a record's ttl using the "meta" dictionary parameter and have users pass ttl using policy instead

aerospike-stubs/aerospike.pyi

@@ -478,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`.
 
@@ -2014,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:
 

src/include/client.h

@@ -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.

src/include/conversions.h

@@ -155,11 +155,10 @@ void initialize_bin_for_strictypes(AerospikeClient *self, as_error *err,
                                    PyObject *py_value, as_binop *binop,
                                    char *bin, as_static_pool *static_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/main/aerospike.c

@@ -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/client/batch_write.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/operate.c

@@ -944,6 +944,8 @@ static PyObject *AerospikeClient_Operate_Invoke(AerospikeClient *self,
     as_operations ops;
     Py_ssize_t size = PyList_Size(py_list);
     as_operations_inita(&ops, size);
+    // as_operations_inita defaults ttl to 0 (namespace default). Use the operate policy ttl instead.
+    ops.ttl = AS_RECORD_CLIENT_DEFAULT_TTL;
 
     if (py_policy) {
         if (pyobject_to_policy_operate(self, err, py_policy, &operate_policy,
@@ -958,8 +960,8 @@ static PyObject *AerospikeClient_Operate_Invoke(AerospikeClient *self,
     memset(&static_pool, 0, sizeof(static_pool));
     CHECK_CONNECTED(err);
 
-    if (check_and_set_meta(py_meta, &ops.ttl, &ops.gen, err,
-                           self->validate_keys) != AEROSPIKE_OK) {
+    if (check_and_set_meta(py_meta, &ops.gen, err, self->validate_keys) !=
+        AEROSPIKE_OK) {
         goto CLEANUP;
     }
 
@@ -1109,6 +1111,8 @@ AerospikeClient_OperateOrdered_Invoke(AerospikeClient *self, as_error *err,
     as_operations ops;
     Py_ssize_t ops_list_size = PyList_Size(py_list);
     as_operations_inita(&ops, ops_list_size);
+    // as_operations_inita defaults ttl to 0 (namespace default). Use the operate policy ttl instead.
+    ops.ttl = AS_RECORD_CLIENT_DEFAULT_TTL;
 
     // For expressions conversion.
     as_exp *exp_list_p = NULL;
@@ -1129,8 +1133,8 @@ AerospikeClient_OperateOrdered_Invoke(AerospikeClient *self, as_error *err,
         }
     }
 
-    if (check_and_set_meta(py_meta, &ops.ttl, &ops.gen, err,
-                           self->validate_keys) != AEROSPIKE_OK) {
+    if (check_and_set_meta(py_meta, &ops.gen, err, self->validate_keys) !=
+        AEROSPIKE_OK) {
         goto CLEANUP;
     }
 

src/main/client/remove.c

@@ -41,7 +41,7 @@
  *******************************************************************************************************
  */
 PyObject *AerospikeClient_Remove_Invoke(AerospikeClient *self, PyObject *py_key,
-                                        PyObject *py_meta, PyObject *py_policy)
+                                        PyObject *py_policy)
 {
 
     // Aerospike Client Arguments
@@ -86,33 +86,6 @@ PyObject *AerospikeClient_Remove_Invoke(AerospikeClient *self, PyObject *py_key,
         if (err.code != AEROSPIKE_OK) {
             goto CLEANUP;
         }
-        else {
-            if (py_meta && PyDict_Check(py_meta)) {
-                PyObject *py_gen = PyDict_GetItemString(py_meta, "gen");
-
-                if (py_gen) {
-                    if (PyLong_Check(py_gen)) {
-                        remove_policy_p->generation =
-                            (uint16_t)PyLong_AsLong(py_gen);
-                    }
-                    else if (PyLong_Check(py_gen)) {
-                        remove_policy_p->generation =
-                            (uint16_t)PyLong_AsLongLong(py_gen);
-                        if ((uint16_t)-1 == remove_policy_p->generation &&
-                            PyErr_Occurred()) {
-                            as_error_update(
-                                &err, AEROSPIKE_ERR_PARAM,
-                                "integer value for gen exceeds sys.maxsize");
-                            goto CLEANUP;
-                        }
-                    }
-                    else {
-                        as_error_update(&err, AEROSPIKE_ERR_PARAM,
-                                        "Generation should be an int or long");
-                    }
-                }
-            }
-        }
     }
 
     // Invoke operation
@@ -158,28 +131,16 @@ PyObject *AerospikeClient_Remove(AerospikeClient *self, PyObject *args,
     // Python Function Arguments
     PyObject *py_key = NULL;
     PyObject *py_policy = NULL;
-    PyObject *py_meta = NULL;
 
     // Python Function Keyword Arguments
-    static char *kwlist[] = {"key", "meta", "policy", NULL};
+    static char *kwlist[] = {"key", "policy", NULL};
 
     // Python Function Argument Parsing
-    if (PyArg_ParseTupleAndKeywords(args, kwds, "O|OO:remove", kwlist, &py_key,
-                                    &py_meta, &py_policy) == false) {
+    if (PyArg_ParseTupleAndKeywords(args, kwds, "O|O:remove", kwlist, &py_key,
+                                    &py_policy) == false) {
         return NULL;
     }
 
-    if (py_meta) {
-        int retval = PyErr_WarnEx(
-            PyExc_DeprecationWarning,
-            "meta parameter is deprecated and will be removed in the "
-            "next client major release",
-            STACK_LEVEL);
-        if (retval == -1) {
-            return NULL;
-        }
-    }
-
     // Invoke Operation
-    return AerospikeClient_Remove_Invoke(self, py_key, py_meta, py_policy);
+    return AerospikeClient_Remove_Invoke(self, py_key, py_policy);
 }

src/main/client/remove_bin.c

@@ -98,6 +98,8 @@ AerospikeClient_RemoveBin_Invoke(AerospikeClient *self, PyObject *py_key,
     Py_ssize_t size = PyList_Size(py_binList);
     // Initialize record
     as_record_inita(&rec, size);
+    // as_record_inita defaults ttl to 0 (namespace default). Use the write policy ttl instead.
+    rec.ttl = AS_RECORD_CLIENT_DEFAULT_TTL;
 
     // Convert python key object to as_key
     pyobject_to_key(err, py_key, &key);
@@ -142,7 +144,7 @@ AerospikeClient_RemoveBin_Invoke(AerospikeClient *self, PyObject *py_key,
         }
     }
 
-    check_and_set_meta(py_meta, &rec.ttl, &rec.gen, err, self->validate_keys);
+    check_and_set_meta(py_meta, &rec.gen, err, self->validate_keys);
     if (err->code != AEROSPIKE_OK) {
         goto CLEANUP;
     }