refactor: scope reindex type names to inverted indexes (#2098)

Renames the unreleased public types PropertyIndexType/State/Status/
Task/TaskStatus to InvertedIndexType/State/Status/Task/TaskStatus and
PropertyIndexes/CollectionPropertyIndexes to PropertyInvertedIndexes/
CollectionInvertedIndexes, incl. private counterparts and parser names.
The runtime reindex API only ever touches inverted indexes; a future
vector reindex must not collide with these names. Method names, the
released IndexName alias and the deliberately generic Reindex*Error
exceptions are unchanged.

Author: g-despot

integration/test_collection_config.py

@@ -41,8 +41,8 @@
     _NamedVectorConfigCreate,
     _VectorizerConfigCreate,
     IndexName,
-    PropertyIndexState,
-    PropertyIndexTaskStatus,
+    InvertedIndexState,
+    InvertedIndexTaskStatus,
 )
 from weaviate.collections.classes.tenants import Tenant
 from weaviate.exceptions import (
@@ -2706,14 +2706,14 @@ def test_property_reindex_searchable_lifecycle(collection_factory: CollectionFac
         "name", "searchable", tokenization=Tokenization.WORD, wait_for_completion=True
     )
     assert status.type == "searchable"
-    assert status.status == PropertyIndexState.READY
+    assert status.status == InvertedIndexState.READY
     assert status.tokenization == Tokenization.WORD
 
     # re-putting the matching configuration is a no-op
     task = collection.config.update_property_index(
         "name", "searchable", tokenization=Tokenization.WORD
     )
-    assert task.status == PropertyIndexTaskStatus.NO_OP
+    assert task.status == InvertedIndexTaskStatus.NO_OP
     assert task.task_id is None
 
     # the status endpoint reports the index as ready
@@ -2726,18 +2726,18 @@ def test_property_reindex_searchable_lifecycle(collection_factory: CollectionFac
         for index in prop.indexes
         if index.type == "searchable"
     )
-    assert entry.status == PropertyIndexState.READY
+    assert entry.status == InvertedIndexState.READY
 
     # rebuild the index from scratch
     status = collection.config.rebuild_property_index(
         "name", "searchable", wait_for_completion=True
     )
     assert status.type == "searchable"
-    assert status.status == PropertyIndexState.READY
+    assert status.status == InvertedIndexState.READY
 
     # cancelling when no task is live is an idempotent no-op
     task = collection.config.cancel_property_index_task("name", "searchable")
-    assert task.status == PropertyIndexTaskStatus.NO_OP
+    assert task.status == InvertedIndexTaskStatus.NO_OP
 
     # the pre-existing delete API removes the index again
     assert collection.config.delete_property_index("name", "searchable") is True
@@ -2765,7 +2765,7 @@ def test_property_reindex_range_filters(collection_factory: CollectionFactory) -
         "age", "rangeFilters", wait_for_completion=True
     )
     assert status.type == "rangeFilters"
-    assert status.status == PropertyIndexState.READY
+    assert status.status == InvertedIndexState.READY
 
     entry = next(
         index
@@ -2774,7 +2774,7 @@ def test_property_reindex_range_filters(collection_factory: CollectionFactory) -
         for index in prop.indexes
         if index.type == "rangeFilters"
     )
-    assert entry.status == PropertyIndexState.READY
+    assert entry.status == InvertedIndexState.READY
 
 
 def test_property_reindex_coupled_tokenization_change(
@@ -2801,7 +2801,7 @@ def test_property_reindex_coupled_tokenization_change(
     task = collection.config.update_property_index(
         "name", "searchable", tokenization=Tokenization.FIELD
     )
-    assert task.status == PropertyIndexTaskStatus.STARTED
+    assert task.status == InvertedIndexTaskStatus.STARTED
     assert task.task_id is not None
 
     prop = next(p for p in collection.config.get_property_indexes().properties if p.name == "name")
@@ -2821,12 +2821,12 @@ def test_property_reindex_coupled_tokenization_change(
     status = collection.config.update_property_index(
         "name", "searchable", tokenization=Tokenization.FIELD, wait_for_completion=True
     )
-    assert status.status == PropertyIndexState.READY
+    assert status.status == InvertedIndexState.READY
     assert status.tokenization == Tokenization.FIELD
 
     prop = next(p for p in collection.config.get_property_indexes().properties if p.name == "name")
     filterable = next(i for i in prop.indexes if i.type == "filterable")
-    assert filterable.status == PropertyIndexState.READY
+    assert filterable.status == InvertedIndexState.READY
     assert filterable.tokenization == Tokenization.FIELD
 
 
@@ -2854,13 +2854,13 @@ def test_property_reindex_multi_tenant(collection_factory: CollectionFactory) ->
         "age", "rangeFilters", tenants=["tenant1", "tenant2"], wait_for_completion=True
     )
     assert status.type == "rangeFilters"
-    assert status.status == PropertyIndexState.READY
+    assert status.status == InvertedIndexState.READY
 
     status = collection.config.rebuild_property_index(
         "age", "rangeFilters", tenants=["tenant1"], wait_for_completion=True
     )
     assert status.type == "rangeFilters"
-    assert status.status == PropertyIndexState.READY
+    assert status.status == InvertedIndexState.READY
 
 
 @pytest.mark.asyncio
@@ -2885,20 +2885,20 @@ async def test_property_reindex_async(async_collection_factory: AsyncCollectionF
         "name", "searchable", tokenization=Tokenization.WORD, wait_for_completion=True
     )
     assert status.type == "searchable"
-    assert status.status == PropertyIndexState.READY
+    assert status.status == InvertedIndexState.READY
 
     task = await collection.config.update_property_index(
         "name", "searchable", tokenization=Tokenization.WORD
     )
-    assert task.status == PropertyIndexTaskStatus.NO_OP
+    assert task.status == InvertedIndexTaskStatus.NO_OP
 
     indexes = await collection.config.get_property_indexes()
     assert indexes.collection == collection.name
 
     status = await collection.config.rebuild_property_index(
         "name", "searchable", wait_for_completion=True
     )
-    assert status.status == PropertyIndexState.READY
+    assert status.status == InvertedIndexState.READY
 
     task = await collection.config.cancel_property_index_task("name", "searchable")
-    assert task.status == PropertyIndexTaskStatus.NO_OP
+    assert task.status == InvertedIndexTaskStatus.NO_OP

mock_tests/test_property_reindex.py

@@ -10,9 +10,9 @@
 from mock_tests.conftest import MOCK_IP, MOCK_PORT, MOCK_PORT_GRPC
 from weaviate.collections.classes.config import (
     DataType,
-    PropertyIndexState,
-    PropertyIndexTaskStatus,
-    PropertyIndexType,
+    InvertedIndexState,
+    InvertedIndexTaskStatus,
+    InvertedIndexType,
     Tokenization,
 )
 from weaviate.exceptions import (
@@ -64,7 +64,7 @@ def test_update_property_index_started(
         algorithm="blockmax",
     )
     assert task.task_id == TASK_ID
-    assert task.status == PropertyIndexTaskStatus.STARTED
+    assert task.status == InvertedIndexTaskStatus.STARTED
     weaviate_139_mock.check_assertions()
 
 
@@ -81,7 +81,7 @@ def test_update_property_index_no_op(
         "name", "searchable", tokenization=Tokenization.WORD
     )
     assert task.task_id is None
-    assert task.status == PropertyIndexTaskStatus.NO_OP
+    assert task.status == InvertedIndexTaskStatus.NO_OP
     weaviate_139_mock.check_assertions()
 
 
@@ -100,7 +100,7 @@ def test_update_property_index_range_filters_with_tenants(
         "age", "rangeFilters", tenants=["tenant1", "tenant2"]
     )
     assert task.task_id == TASK_ID
-    assert task.status == PropertyIndexTaskStatus.STARTED
+    assert task.status == InvertedIndexTaskStatus.STARTED
     weaviate_139_mock.check_assertions()
 
 
@@ -129,7 +129,7 @@ def test_update_property_index_wait_for_completion(
         "name", "searchable", tokenization=Tokenization.WORD, wait_for_completion=True
     )
     assert status.type == "searchable"
-    assert status.status == PropertyIndexState.READY
+    assert status.status == InvertedIndexState.READY
     assert status.tokenization == Tokenization.WORD
     weaviate_139_mock.check_assertions()
 
@@ -148,7 +148,7 @@ def test_update_property_index_bare_str_tenant(
     task = client_139.collections.use(COLLECTION).config.update_property_index(
         "age", "rangeFilters", tenants="tenant1"
     )
-    assert task.status == PropertyIndexTaskStatus.STARTED
+    assert task.status == InvertedIndexTaskStatus.STARTED
     weaviate_139_mock.check_assertions()
 
 
@@ -251,7 +251,7 @@ def test_rebuild_property_index(
         "name", "searchable"
     )
     assert task.task_id == TASK_ID
-    assert task.status == PropertyIndexTaskStatus.STARTED
+    assert task.status == InvertedIndexTaskStatus.STARTED
     weaviate_139_mock.check_assertions()
 
 
@@ -269,7 +269,7 @@ def test_rebuild_property_index_with_tenants(
         "age", "rangeFilters", tenants=["tenant1", "tenant2"]
     )
     assert task.task_id == TASK_ID
-    assert task.status == PropertyIndexTaskStatus.STARTED
+    assert task.status == InvertedIndexTaskStatus.STARTED
     weaviate_139_mock.check_assertions()
 
 
@@ -286,7 +286,7 @@ def test_cancel_property_index_task_cancelled(
         "name", "searchable"
     )
     assert task.task_id == TASK_ID
-    assert task.status == PropertyIndexTaskStatus.CANCELLED
+    assert task.status == InvertedIndexTaskStatus.CANCELLED
     weaviate_139_mock.check_assertions()
 
 
@@ -303,7 +303,7 @@ def test_cancel_property_index_task_no_op(
         "name", "searchable"
     )
     assert task.task_id is None
-    assert task.status == PropertyIndexTaskStatus.NO_OP
+    assert task.status == InvertedIndexTaskStatus.NO_OP
     weaviate_139_mock.check_assertions()
 
 
@@ -360,7 +360,7 @@ def test_get_property_indexes(
     assert len(name.indexes) == 2
     searchable, filterable = name.indexes
     assert searchable.type == "searchable"
-    assert searchable.status == PropertyIndexState.INDEXING
+    assert searchable.status == InvertedIndexState.INDEXING
     assert searchable.progress == 0.5
     assert searchable.task_id == TASK_ID
     assert searchable.tokenization == Tokenization.WORD
@@ -379,7 +379,7 @@ def test_get_property_indexes(
     assert age.description is None
     assert len(age.indexes) == 1
     assert age.indexes[0].type == "rangeFilters"
-    assert age.indexes[0].status == PropertyIndexState.READY
+    assert age.indexes[0].status == InvertedIndexState.READY
     assert age.indexes[0].progress is None
     assert age.indexes[0].task_id is None
     assert age.indexes[0].tokenization is None
@@ -398,18 +398,18 @@ def test_get_property_indexes(
 @pytest.mark.parametrize(
     "index_name,wire",
     [
-        (PropertyIndexType.SEARCHABLE, "searchable"),
+        (InvertedIndexType.SEARCHABLE, "searchable"),
         ("searchable", "searchable"),
-        (PropertyIndexType.FILTERABLE, "filterable"),
+        (InvertedIndexType.FILTERABLE, "filterable"),
         ("filterable", "filterable"),
-        (PropertyIndexType.RANGE_FILTERS, "rangeFilters"),
+        (InvertedIndexType.RANGE_FILTERS, "rangeFilters"),
         ("rangeFilters", "rangeFilters"),
     ],
 )
 def test_update_property_index_enum_and_literal_hit_same_route(
     weaviate_139_mock: HTTPServer,
     client_139: weaviate.WeaviateClient,
-    index_name: Union[PropertyIndexType, str],
+    index_name: Union[InvertedIndexType, str],
     wire: str,
 ) -> None:
     """The enum and literal forms of index_name hit the exact same wire route."""
@@ -423,25 +423,25 @@ def test_update_property_index_enum_and_literal_hit_same_route(
         "name",
         index_name,  # type: ignore
     )
-    assert task.status == PropertyIndexTaskStatus.STARTED
+    assert task.status == InvertedIndexTaskStatus.STARTED
     weaviate_139_mock.check_assertions()
 
 
 @pytest.mark.parametrize(
     "index_name,wire",
     [
-        (PropertyIndexType.SEARCHABLE, "searchable"),
+        (InvertedIndexType.SEARCHABLE, "searchable"),
         ("searchable", "searchable"),
-        (PropertyIndexType.FILTERABLE, "filterable"),
+        (InvertedIndexType.FILTERABLE, "filterable"),
         ("filterable", "filterable"),
-        (PropertyIndexType.RANGE_FILTERS, "rangeFilters"),
+        (InvertedIndexType.RANGE_FILTERS, "rangeFilters"),
         ("rangeFilters", "rangeFilters"),
     ],
 )
 def test_delete_property_index_enum_and_literal_hit_same_route(
     weaviate_139_mock: HTTPServer,
     client_139: weaviate.WeaviateClient,
-    index_name: Union[PropertyIndexType, str],
+    index_name: Union[InvertedIndexType, str],
     wire: str,
 ) -> None:
     """The enum and literal forms of index_name hit the exact same wire route."""
@@ -462,12 +462,12 @@ def test_delete_property_index_enum_and_literal_hit_same_route(
 
 @pytest.mark.parametrize(
     "index_name",
-    [PropertyIndexType.RANGE_FILTERS, "rangeFilters"],
+    [InvertedIndexType.RANGE_FILTERS, "rangeFilters"],
 )
 def test_rebuild_property_index_enum_and_literal_hit_same_route(
     weaviate_139_mock: HTTPServer,
     client_139: weaviate.WeaviateClient,
-    index_name: Union[PropertyIndexType, str],
+    index_name: Union[InvertedIndexType, str],
 ) -> None:
     """The enum and literal forms of index_name hit the exact same rebuild route."""
     weaviate_139_mock.expect_request(
@@ -480,18 +480,18 @@ def test_rebuild_property_index_enum_and_literal_hit_same_route(
         "age",
         index_name,  # type: ignore
     )
-    assert task.status == PropertyIndexTaskStatus.STARTED
+    assert task.status == InvertedIndexTaskStatus.STARTED
     weaviate_139_mock.check_assertions()
 
 
 @pytest.mark.parametrize(
     "index_name",
-    [PropertyIndexType.RANGE_FILTERS, "rangeFilters"],
+    [InvertedIndexType.RANGE_FILTERS, "rangeFilters"],
 )
 def test_cancel_property_index_task_enum_and_literal_hit_same_route(
     weaviate_139_mock: HTTPServer,
     client_139: weaviate.WeaviateClient,
-    index_name: Union[PropertyIndexType, str],
+    index_name: Union[InvertedIndexType, str],
 ) -> None:
     """The enum and literal forms of index_name hit the exact same cancel route."""
     weaviate_139_mock.expect_request(
@@ -504,7 +504,7 @@ def test_cancel_property_index_task_enum_and_literal_hit_same_route(
         "age",
         index_name,  # type: ignore
     )
-    assert task.status == PropertyIndexTaskStatus.CANCELLED
+    assert task.status == InvertedIndexTaskStatus.CANCELLED
     weaviate_139_mock.check_assertions()
 
 

weaviate/classes/config.py

@@ -4,10 +4,10 @@
     DataType,
     GenerativeSearches,
     IndexName,
+    InvertedIndexType,
     PQEncoderDistribution,
     PQEncoderType,
     Property,
-    PropertyIndexType,
     Reconfigure,
     ReferenceProperty,
     ReplicationDeletionStrategy,
@@ -38,7 +38,7 @@
     "MultiVectorAggregation",
     "ReplicationDeletionStrategy",
     "Property",
-    "PropertyIndexType",
+    "InvertedIndexType",
     "PQEncoderDistribution",
     "PQEncoderType",
     "ReferenceProperty",