Update key prefix and access method (#66)

Adds an explicit `key` method help function that combines the index
key prefix + in addition to the records identifier to create the key
name.

Author: tylerhutcherson

redisvl/index.py

@@ -151,7 +151,24 @@ def disconnect(self):
         """Disconnect from the Redis instance"""
         self._redis_conn = None
 
-    def _get_key(self, record: Dict[str, Any], key_field: Optional[str] = None) -> str:
+    def key(self, key_value: str) -> str:
+        """
+        Create a redis key as a combination of an index key prefix (optional) and specified key value.
+        The key value is typically a unique identifier, created at random, or derived from
+        some specified metadata.
+
+        Args:
+            key_value (str): The specified unique identifier for a particular document
+                             indexed in Redis.
+
+        Returns:
+            str: The full Redis key including key prefix and value as a string.
+        """
+        return f"{self._prefix}:{key_value}" if self._prefix else key_value
+
+    def _create_key(
+        self, record: Dict[str, Any], key_field: Optional[str] = None
+    ) -> str:
         """Construct the Redis HASH top level key.
 
         Args:
@@ -166,13 +183,13 @@ def _get_key(self, record: Dict[str, Any], key_field: Optional[str] = None) -> s
             ValueError: If the key field is not found in the record.
         """
         if key_field is None:
-            key = uuid4().hex
+            key_value = uuid4().hex
         else:
             try:
-                key = record[key_field]  # type: ignore
+                key_value = record[key_field]  # type: ignore
             except KeyError:
                 raise ValueError(f"Key field {key_field} not found in record {record}")
-        return f"{self._prefix}:{key}" if self._prefix else key
+        return self.key(key_value)
 
     @check_connected("_redis_conn")
     def info(self) -> Dict[str, Any]:
@@ -363,7 +380,7 @@ def load(
             ttl = kwargs.get("ttl")
             with self._redis_conn.pipeline(transaction=False) as pipe:  # type: ignore
                 for record in data:
-                    key = self._get_key(record, key_field)
+                    key = self._create_key(record, key_field)
                     pipe.hset(key, mapping=record)  # type: ignore
                     if ttl:
                         pipe.expire(key, ttl)
@@ -516,7 +533,7 @@ async def load(
 
         async def _load(record: dict):
             async with semaphore:
-                key = self._get_key(record, key_field)
+                key = self._create_key(record, key_field)
                 await self._redis_conn.hset(key, mapping=record)  # type: ignore
                 if ttl:
                     await self._redis_conn.expire(key, ttl)  # type: ignore

tests/test_index.py

@@ -10,14 +10,22 @@
 
 def test_search_index_get_key():
     si = SearchIndex("my_index", fields=fields)
-    key = si._get_key({"id": "foo"}, "id")
+    key = si.key("foo")
     assert key.startswith(si._prefix)
     assert "foo" in key
-    key = si._get_key({"id": "foo"})
+    key = si._create_key({"id": "foo"})
     assert key.startswith(si._prefix)
     assert "foo" not in key
 
 
+def test_search_index_no_prefix():
+    # specify None as the prefix...
+    si = SearchIndex("my_index", prefix=None, fields=fields)
+    key = si.key("foo")
+    assert not si._prefix
+    assert key == "foo"
+
+
 def test_search_index_client(client):
     si = SearchIndex("my_index", fields=fields)
     si.set_client(client)
@@ -29,6 +37,7 @@ def test_search_index_create(client, redis_url):
     si = SearchIndex("my_index", fields=fields)
     si.set_client(client)
     si.create(overwrite=True)
+    assert si.exists()
     assert "my_index" in convert_bytes(si.client.execute_command("FT._LIST"))
 
     s1_2 = SearchIndex.from_existing("my_index", url=redis_url)
@@ -40,7 +49,6 @@ def test_search_index_delete(client):
     si.set_client(client)
     si.create(overwrite=True)
     si.delete()
-
     assert "my_index" not in convert_bytes(si.client.execute_command("FT._LIST"))