drop_keys returns number of records removed from Redis

Author: justin-cechmanek

redisvl/index/index.py

@@ -497,15 +497,19 @@ def clear(self) -> int:
 
         return total_records_deleted
 
-    def drop_keys(self, keys: Union[str, List[str]]) -> None:
+    def drop_keys(self, keys: Union[str, List[str]]) -> int:
         """Remove a specific entry or entries from the index by it's key ID.
+
         Args:
             keys (Union[str, List[str]]): The document ID or IDs to remove from the index.
+
+        Returns:
+            int: Count of records deleted from Redis.
         """
         if isinstance(keys, List):
-            self._redis_client.delete(*keys)  # type: ignore
+            return self._redis_client.delete(*keys)  # type: ignore
         else:
-            self._redis_client.delete(keys)  # type: ignore
+            return self._redis_client.delete(keys)  # type: ignore
 
     def load(
         self,
@@ -945,15 +949,19 @@ async def clear(self) -> int:
 
         return total_records_deleted
 
-    async def drop_keys(self, keys: Union[str, List[str]]) -> None:
+    async def drop_keys(self, keys: Union[str, List[str]]) -> int:
         """Remove a specific entry or entries from the index by it's key ID.
+
         Args:
             keys (Union[str, List[str]]): The document ID or IDs to remove from the index.
+
+        Returns:
+            int: Count of records deleted from Redis.
         """
         if isinstance(keys, List):
-            await self._redis_client.delete(*keys)  # type: ignore
+            return await self._redis_client.delete(*keys)  # type: ignore
         else:
-            await self._redis_client.delete(keys)  # type: ignore
+            return await self._redis_client.delete(keys)  # type: ignore
 
     async def load(
         self,

tests/integration/test_async_search_index.py

@@ -191,7 +191,8 @@ async def test_search_index_drop_key(async_client, async_index):
     data = [{"id": "1", "test": "foo"}, {"id": "2", "test": "bar"}]
     keys = await async_index.load(data, id_field="id")
 
-    await async_index.drop_keys(keys[0])
+    dropped = await async_index.drop_keys(keys[0])
+    assert dropped == 1
     assert not await async_index.fetch(keys[0])
     assert await async_index.fetch(keys[1]) is not None
 
@@ -207,7 +208,8 @@ async def test_search_index_drop_keys(async_client, async_index):
     ]
     keys = await async_index.load(data, id_field="id")
 
-    await async_index.drop_keys(keys[0:2])
+    dropped = await async_index.drop_keys(keys[0:2])
+    assert dropped == 2
     assert not await async_index.fetch(keys[0])
     assert not await async_index.fetch(keys[1])
     assert await async_index.fetch(keys[2]) is not None

tests/integration/test_search_index.py

@@ -177,7 +177,8 @@ def test_search_index_drop_key(client, index):
     keys = index.load(data, id_field="id")
 
     # test passing a single string key removes only that key
-    index.drop_keys(keys[0])
+    dropped = index.drop_keys(keys[0])
+    assert dropped == 1
     assert not index.fetch(keys[0])
     assert index.fetch(keys[1]) is not None  # still have all other entries
 
@@ -193,7 +194,8 @@ def test_search_index_drop_keys(client, index):
     keys = index.load(data, id_field="id")
 
     # test passing a list of keys selectively removes only those keys
-    index.drop_keys(keys[0:2])
+    dropped = index.drop_keys(keys[0:2])
+    assert dropped == 2
     assert not index.fetch(keys[0])
     assert not index.fetch(keys[1])
     assert index.fetch(keys[2]) is not None