split tests for native array and BinaryVector

introduce internal search field abstraction
remove methods on DefaultSearchIndexOperations

Author: christophstrobl

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/index/DefaultSearchIndexOperations.java

@@ -47,6 +47,7 @@ public DefaultSearchIndexOperations(MongoOperations mongoOperations, Class<?> ty
 	}
 
 	public DefaultSearchIndexOperations(MongoOperations mongoOperations, String collectionName, @Nullable Class<?> type) {
+
 		this.collectionName = collectionName;
 
 		if (type != null) {
@@ -68,89 +69,52 @@ public String ensureIndex(SearchIndexDefinition indexDefinition) {
 				mongoOperations.getConverter().getMappingContext());
 
 		mongoOperations.getCollection(collectionName)
-				.createSearchIndexes(List.of(new SearchIndexModel(indexDefinition.getName(), index.get("definition", Document.class),
-						SearchIndexType.of(new BsonString(indexDefinition.getType())))));
+				.createSearchIndexes(List.of(new SearchIndexModel(indexDefinition.getName(),
+						index.get("definition", Document.class), SearchIndexType.of(new BsonString(indexDefinition.getType())))));
 
 		return indexDefinition.getName();
 	}
 
 	@Override
-	public void updateIndex(SearchIndexDefinition index) {
-
-		if (index instanceof VectorIndex) {
-			throw new UnsupportedOperationException("Vector Index definitions cannot be updated");
-		}
+	public void updateIndex(SearchIndexDefinition indexDefinition) {
 
-		Document indexDocument = index.getIndexDocument(entityTypeInformation,
+		Document indexDocument = indexDefinition.getIndexDocument(entityTypeInformation,
 				mongoOperations.getConverter().getMappingContext());
 
-		mongoOperations.getCollection(collectionName).updateSearchIndex(index.getName(), indexDocument);
+		mongoOperations.getCollection(collectionName).updateSearchIndex(indexDefinition.getName(), indexDocument);
 	}
 
 	@Override
 	public boolean exists(String indexName) {
-
-		List<Document> indexes = getSearchIndexes(indexName);
-
-		for (Document index : indexes) {
-			if (index.getString("name").equals(indexName)) {
-				return true;
-			}
-		}
-
-		return false;
+		return getSearchIndex(indexName) != null;
 	}
 
 	@Override
-	public SearchIndexStatus status(String name) {
-
-		List<Document> indexes = getSearchIndexes(name);
+	public SearchIndexStatus status(String indexName) {
 
-		if (indexes.isEmpty()) {
-			return SearchIndexStatus.DOES_NOT_EXIST;
-		}
-
-		for (Document index : indexes) {
-			if (index.getString("name").equals(name)) {
-				return SearchIndexStatus.valueOf(index.getString("status"));
-			}
-		}
-		return SearchIndexStatus.DOES_NOT_EXIST;
+		Document searchIndex = getSearchIndex(indexName);
+		return searchIndex != null ? SearchIndexStatus.valueOf(searchIndex.getString("status"))
+				: SearchIndexStatus.DOES_NOT_EXIST;
 	}
 
 	@Override
-	public List<IndexInfo> getIndexInfo() {
-
-		List<Document> aggregate = getSearchIndexes(null);
-
-		ArrayList<IndexInfo> result = new ArrayList<>();
-		for (Document doc : aggregate) {
-
-			List<IndexField> indexFields = new ArrayList<>();
-			String name = doc.getString("name");
-			for (Object field : doc.get("latestDefinition", Document.class).get("fields", List.class)) {
-
-				if (field instanceof Document fieldInfo) {
-					indexFields.add(IndexField.vector(fieldInfo.getString("path")));
-				}
-			}
-
-			result.add(new IndexInfo(indexFields, name, false, false, null, false));
-		}
-		return result;
+	public void dropAllIndexes() {
+		getSearchIndexes(null).forEach(indexInfo -> dropIndex(indexInfo.getString("name")));
 	}
 
 	@Override
-	public void dropAllIndexes() {
-		getIndexInfo().forEach(indexInfo -> dropIndex(indexInfo.getName()));
+	public void dropIndex(String indexName) {
+		mongoOperations.getCollection(collectionName).dropSearchIndex(indexName);
 	}
 
-	@Override
-	public void dropIndex(String name) {
-		mongoOperations.getCollection(collectionName).dropSearchIndex(name);
+	@Nullable
+	private Document getSearchIndex(String indexName) {
+
+		List<Document> indexes = getSearchIndexes(indexName);
+		return indexes.isEmpty() ? null : indexes.iterator().next();
 	}
 
-	private List<Document> getSearchIndexes(String indexName) {
+	private List<Document> getSearchIndexes(@Nullable String indexName) {
 
 		Document filter = StringUtils.hasText(indexName) ? new Document("name", indexName) : new Document();
 

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/index/SearchIndexDefinition.java

@@ -16,7 +16,6 @@
 package org.springframework.data.mongodb.core.index;
 
 import org.bson.Document;
-
 import org.springframework.data.mapping.context.MappingContext;
 import org.springframework.data.mongodb.core.mapping.MongoPersistentEntity;
 import org.springframework.data.mongodb.core.mapping.MongoPersistentProperty;
@@ -47,9 +46,9 @@ public interface SearchIndexDefinition {
 	 * resulting document contains the index name, type and {@link #getDefinition(TypeInformation, MappingContext)
 	 * definition}.
 	 *
-	 * @param entity
+	 * @param entity can be {@literal null}.
 	 * @param mappingContext
-	 * @return
+	 * @return never {@literal null}.
 	 */
 	default Document getIndexDocument(@Nullable TypeInformation<?> entity,
 			MappingContext<? extends MongoPersistentEntity<?>, MongoPersistentProperty> mappingContext) {
@@ -66,13 +65,11 @@ default Document getIndexDocument(@Nullable TypeInformation<?> entity,
 	 * Returns the actual index definition for this index in the context of a potential entity to resolve field name
 	 * mappings.
 	 *
-	 * @param entity
+	 * @param entity can be {@literal null}.
 	 * @param mappingContext
-	 * @return
+	 * @return never {@literal null}.
 	 */
 	Document getDefinition(@Nullable TypeInformation<?> entity,
 			MappingContext<? extends MongoPersistentEntity<?>, MongoPersistentProperty> mappingContext);
 
-
-
 }

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/index/SearchIndexOperations.java

@@ -15,69 +15,61 @@
  */
 package org.springframework.data.mongodb.core.index;
 
-import java.util.List;
+import org.springframework.dao.DataAccessException;
 
 /**
  * Search Index operations on a collection for Atlas Search.
  *
  * @author Christoph Strobl
  * @author Mark Paluch
  * @since 4.5
+ * @see VectorIndex
  */
 public interface SearchIndexOperations {
 
 	/**
-	 * Ensure that an index for the provided {@link SearchIndexDefinition} exists for the collection indicated by the
-	 * entity class. If not it will be created.
+	 * Create the index for the given {@link SearchIndexDefinition} in the collection indicated by the entity class.
 	 *
 	 * @param indexDefinition must not be {@literal null}.
 	 * @return the index name.
 	 */
 	String ensureIndex(SearchIndexDefinition indexDefinition);
 
 	/**
-	 * Alters the search {@code index}.
+	 * Alters the search index matching the index {@link SearchIndexDefinition#getName() name}.
 	 * <p>
-	 * Note that Atlas Search does not support updating Vector Search Indices resulting in
-	 * {@link UnsupportedOperationException}.
+	 * Atlas Search might not support updating indices which raises a {@link DataAccessException}.
 	 *
-	 * @param index the index definition.
+	 * @param indexDefinition the index definition.
 	 */
-	void updateIndex(SearchIndexDefinition index);
+	void updateIndex(SearchIndexDefinition indexDefinition);
 
 	/**
-	 * Check whether an index with the {@code name} exists. To ensure an existing index is queryable it is recommended to
-	 * check its {@link #status(String) status}.
+	 * Check whether an index with the given {@code indexName} exists for the collection indicated by the entity class. To
+	 * ensure an existing index is queryable it is recommended to check its {@link #status(String) status}.
 	 *
-	 * @param name name of index to check for presence.
+	 * @param indexName name of index to check for presence.
 	 * @return {@literal true} if the index exists; {@literal false} otherwise.
 	 */
-	boolean exists(String name);
+	boolean exists(String indexName);
 
 	/**
-	 * Check the actual {@link SearchIndexStatus} of an index.
+	 * Check the actual {@link SearchIndexStatus status} of an index.
 	 *
-	 * @param name name of index to check for presence.
-	 * @return {@literal true} if the index exists; {@literal false} otherwise.
+	 * @param indexName name of index to get the status for.
+	 * @return the current status of the index or {@link SearchIndexStatus#DOES_NOT_EXIST} if the index cannot be found.
 	 */
-	SearchIndexStatus status(String name);
+	SearchIndexStatus status(String indexName);
 
 	/**
-	 * Drops an index from this collection.
+	 * Drops an index from the collection indicated by the entity class.
 	 *
-	 * @param name name of index to drop.
+	 * @param indexName name of index to drop.
 	 */
-	void dropIndex(String name);
+	void dropIndex(String indexName);
 
 	/**
-	 * Drops all search indices from this collection.
+	 * Drops all search indices from the collection indicated by the entity class.
 	 */
 	void dropAllIndexes();
-
-	/**
-	 * Returns the index information on the collection.
-	 *
-	 * @return index information on the collection
-	 */
-	List<IndexInfo> getIndexInfo();
 }