[CLIENT-2219] Remove deprecated client.scan_info()

Author: juliannguyen4

aerospike-stubs/aerospike.pyi

@@ -281,10 +281,6 @@ REGEX_ICASE: int
 REGEX_NEWLINE: int
 REGEX_NONE: int
 REGEX_NOSUB: int
-SCAN_STATUS_ABORTED: int
-SCAN_STATUS_COMPLETED: int
-SCAN_STATUS_INPROGRESS: int
-SCAN_STATUS_UNDEF: int
 SERIALIZER_JSON: int
 SERIALIZER_NONE: int
 SERIALIZER_PYTHON: int
@@ -411,7 +407,6 @@ class Client:
     def remove_bin(self, key: tuple, list: list, meta: dict = ..., policy: dict = ...) -> None: ...
     def scan(self, namespace: str, set: str = ...) -> Scan: ...
     def scan_apply(self, ns: str, set: str, module: str, function: str, args: list = ..., policy: dict = ..., options: dict = ...) -> int: ...
-    def scan_info(self, scan_id: int) -> dict: ...
     def select(self, *args, **kwargs) -> tuple: ...
     def select_many(self, keys: list, bins: list, policy: dict = ...) -> list: ...
     def set_xdr_filter(self, data_center: str, namespace: str, expression_filter, policy: dict = ...) -> str: ...

doc/aerospike.rst

@@ -897,33 +897,6 @@ Specifies the type of authentication to be used when communicating with the serv
     .. warning::
         This mode should only be used for testing purposes because it is not secure authentication.
 
-.. _aerospike_scan_constants:
-
-Scan Constants
---------------
-
-.. data:: SCAN_STATUS_ABORTED
-
-    .. deprecated:: 1.0.50
-        used by :meth:`Client.scan_info`
-
-.. data:: SCAN_STATUS_COMPLETED
-
-    .. deprecated:: 1.0.50
-        used by :meth:`Client.scan_info`
-
-.. data:: SCAN_STATUS_INPROGRESS
-
-    .. deprecated:: 1.0.50
-        used by :meth:`Client.scan_info`
-
-.. data:: SCAN_STATUS_UNDEF
-
-    .. deprecated:: 1.0.50
-        used by :meth:`Client.scan_info`
-
-.. versionadded:: 1.0.39
-
 .. _aerospike_job_constants:
 
 Job Constants

doc/client.rst

@@ -693,24 +693,6 @@ User Defined Functions
         :returns: :class:`dict`
         :raises: a subclass of :exc:`~aerospike.exception.AerospikeError`.
 
-    .. method:: scan_info(scan_id) -> dict
-
-        .. deprecated:: 1.0.50
-            Use :meth:`job_info` instead.
-
-        Return the status of a scan running in the background.
-
-
-        The returned :class:`dict` contains these keys:
-
-            * ``"status"``: see :ref:`aerospike_scan_constants` for possible values.
-            * ``"records_scanned"``: number of scanned records.
-            * ``"progress_pct"``: progress percentage of the job
-
-        :param int scan_id: the scan ID returned by :meth:`scan_apply`.
-        :returns: :class:`dict`
-        :raises: a subclass of :exc:`~aerospike.exception.AerospikeError`.
-
     .. index::
         single: Info Operations
 

examples/client/scan_info.py

@@ -250,8 +250,6 @@ AerospikeScan *AerospikeClient_Scan(AerospikeClient *self, PyObject *args,
                                     PyObject *kwds);
 PyObject *AerospikeClient_ScanApply(AerospikeClient *self, PyObject *args,
                                     PyObject *kwds);
-PyObject *AerospikeClient_ScanInfo(AerospikeClient *self, PyObject *args,
-                                   PyObject *kwds);
 
 /*******************************************************************************
  * QUERY OPERATIONS

src/include/client.h

@@ -283,91 +283,3 @@ PyObject *AerospikeClient_ScanApply(AerospikeClient *self, PyObject *args,
                                             py_function, py_args, py_policy,
                                             py_options, true);
 }
-
-/**
- *******************************************************************************************************
- * Gets the status of a background scan triggered by scanApply()
- *
- * @param self                  AerospikeClient object
- * @param args                  The args is a tuple object containing an argument
- *                              list passed from Python to a C function
- * @param kwds                  Dictionary of keywords
- *
- * Returns status of the background scan returned as a tuple containing
- * progress_pct, records_scanned, status.
- *******************************************************************************************************
- */
-PyObject *AerospikeClient_ScanInfo(AerospikeClient *self, PyObject *args,
-                                   PyObject *kwds)
-{
-    // Initialize error
-    as_error err;
-    as_error_init(&err);
-
-    // Python Function Arguments
-    PyObject *py_policy = NULL;
-    PyObject *retObj = PyDict_New();
-
-    long lscanId = 0;
-
-    as_policy_info info_policy;
-    as_policy_info *info_policy_p = NULL;
-    as_scan_info scan_info;
-
-    // Python Function Keyword Arguments
-    static char *kwlist[] = {"scanid", "policy", NULL};
-
-    // Python Function Argument Parsing
-    if (PyArg_ParseTupleAndKeywords(args, kwds, "l|O:scan_info", kwlist,
-                                    &lscanId, &py_policy) == false) {
-        return NULL;
-    }
-
-    if (!self || !self->as) {
-        as_error_update(&err, AEROSPIKE_ERR_PARAM, "Invalid aerospike object");
-        goto CLEANUP;
-    }
-
-    if (!self->is_conn_16) {
-        as_error_update(&err, AEROSPIKE_ERR_CLUSTER,
-                        "No connection to aerospike cluster");
-        goto CLEANUP;
-    }
-
-    // Convert python object to policy_info
-    pyobject_to_policy_info(&err, py_policy, &info_policy, &info_policy_p,
-                            &self->as->config.policies.info);
-    if (err.code != AEROSPIKE_OK) {
-        goto CLEANUP;
-    }
-
-    Py_BEGIN_ALLOW_THREADS
-    aerospike_scan_info(self->as, &err, info_policy_p, lscanId, &scan_info);
-    Py_END_ALLOW_THREADS
-
-    if (err.code != AEROSPIKE_OK) {
-        goto CLEANUP;
-    }
-
-    if (retObj) {
-        PyObject *py_longobject = NULL;
-        py_longobject = PyLong_FromLong(scan_info.progress_pct);
-        PyDict_SetItemString(retObj, PROGRESS_PCT, py_longobject);
-        Py_DECREF(py_longobject);
-        py_longobject = PyLong_FromLong(scan_info.records_scanned);
-        PyDict_SetItemString(retObj, RECORDS_SCANNED, py_longobject);
-        Py_DECREF(py_longobject);
-        py_longobject = PyLong_FromLong(scan_info.status);
-        PyDict_SetItemString(retObj, STATUS, py_longobject);
-        Py_DECREF(py_longobject);
-    }
-
-CLEANUP:
-
-    if (err.code != AEROSPIKE_OK) {
-        raise_exception(&err);
-        return NULL;
-    }
-
-    return retObj;
-}

src/main/client/scan.c

@@ -163,10 +163,6 @@ PyDoc_STRVAR(
 \n\
 Initiate a background scan and apply a record UDF to each record matched by the scan.");
 
-PyDoc_STRVAR(scan_info_doc, "scan_info(scan_id) -> dict\n\
-\n\
-Return the status of a scan running in the background.");
-
 PyDoc_STRVAR(info_doc, "info(command[, hosts[, policy]]) -> {}\n\
 \n\
 Send an info command to multiple nodes specified in a hosts list.");
@@ -460,9 +456,6 @@ static PyMethodDef AerospikeClient_Type_Methods[] = {
     {"scan_apply", (PyCFunction)AerospikeClient_ScanApply,
      METH_VARARGS | METH_KEYWORDS, scan_apply_doc},
 
-    {"scan_info", (PyCFunction)AerospikeClient_ScanInfo,
-     METH_VARARGS | METH_KEYWORDS, scan_info_doc},
-
     // INFO OPERATIONS
 
     {"info", (PyCFunction)AerospikeClient_Info, METH_VARARGS | METH_KEYWORDS,

src/main/client/type.c

@@ -138,10 +138,6 @@ static AerospikeConstants aerospike_constants[] = {
     {AS_POLICY_GEN_IGNORE, "POLICY_GEN_IGNORE"},
     {AS_POLICY_GEN_EQ, "POLICY_GEN_EQ"},
     {AS_POLICY_GEN_GT, "POLICY_GEN_GT"},
-    {AS_SCAN_STATUS_COMPLETED, "SCAN_STATUS_COMPLETED"},
-    {AS_SCAN_STATUS_ABORTED, "SCAN_STATUS_ABORTED"},
-    {AS_SCAN_STATUS_UNDEF, "SCAN_STATUS_UNDEF"},
-    {AS_SCAN_STATUS_INPROGRESS, "SCAN_STATUS_INPROGRESS"},
     {AS_JOB_STATUS_COMPLETED, "JOB_STATUS_COMPLETED"},
     {AS_JOB_STATUS_UNDEF, "JOB_STATUS_UNDEF"},
     {AS_JOB_STATUS_INPROGRESS, "JOB_STATUS_INPROGRESS"},