DATAES-826 - Add method to IndexOperations to write an index mapping from an entity class.

Original PR: spring-projects#455

Author: sothawo

src/main/java/org/springframework/data/elasticsearch/core/ElasticsearchOperations.java

@@ -186,7 +186,7 @@ default boolean indexExists(Class<?> clazz) {
 	@Deprecated
 	default boolean putMapping(Class<?> clazz) {
 		IndexOperations indexOps = indexOps(clazz);
-		return indexOps.putMapping(indexOps.createMapping(clazz));
+		return indexOps.putMapping(clazz);
 	}
 
 	/**
@@ -202,7 +202,7 @@ default boolean putMapping(Class<?> clazz) {
 	@Deprecated
 	default boolean putMapping(IndexCoordinates index, Class<?> clazz) {
 		IndexOperations indexOps = indexOps(index);
-		return indexOps.putMapping(indexOps.createMapping(clazz));
+		return indexOps.putMapping(clazz);
 	}
 
 	/**

src/main/java/org/springframework/data/elasticsearch/core/IndexOperations.java

@@ -93,6 +93,16 @@ public interface IndexOperations {
 	 */
 	boolean putMapping(Document mapping);
 
+	/**
+	 * Creates the index mapping for the given class and writes it to the index.
+	 * @param clazz the clazz to create a mapping for
+	 * @return {@literal true} if the mapping could be stored
+	 * @since 4.1
+	 */
+	default boolean putMapping(Class<?> clazz) {
+		return putMapping(createMapping(clazz));
+	}
+
 	/**
 	 * Get mapping for an index defined by a class.
 	 *

src/main/java/org/springframework/data/elasticsearch/repository/support/AbstractElasticsearchRepository.java

@@ -102,7 +102,7 @@ private void createIndex() {
 	}
 
 	private void putMapping() {
-		indexOperations.putMapping(indexOperations.createMapping(entityClass));
+		indexOperations.putMapping(entityClass);
 	}
 
 	private boolean createIndexAndMapping() {

src/test/java/org/springframework/data/elasticsearch/core/ElasticsearchTemplateTests.java

@@ -123,15 +123,15 @@ public void before() {
 		deleteIndices();
 
 		indexOperations.create();
-		indexOperations.putMapping(indexOperations.createMapping(SampleEntity.class));
+		indexOperations.putMapping(SampleEntity.class);
 
 		IndexOperations indexOpsSampleEntityUUIDKeyed = operations.indexOps(SampleEntityUUIDKeyed.class);
 		indexOpsSampleEntityUUIDKeyed.create();
-		indexOpsSampleEntityUUIDKeyed.putMapping(indexOpsSampleEntityUUIDKeyed.createMapping(SampleEntityUUIDKeyed.class));
+		indexOpsSampleEntityUUIDKeyed.putMapping(SampleEntityUUIDKeyed.class);
 
 		IndexOperations indexOpsSearchHitsEntity = operations.indexOps(SearchHitsEntity.class);
 		indexOpsSearchHitsEntity.create();
-		indexOpsSearchHitsEntity.putMapping(indexOpsSearchHitsEntity.createMapping(SearchHitsEntity.class));
+		indexOpsSearchHitsEntity.putMapping(SearchHitsEntity.class);
 	}
 
 	@AfterEach
@@ -1419,7 +1419,7 @@ public void shouldPutMappingForGivenEntity() {
 		// when
 
 		// then
-		assertThat(indexOperations.putMapping(indexOperations.createMapping(entityClass))).isTrue();
+		assertThat(indexOperations.putMapping(entityClass)).isTrue();
 	}
 
 	@Test // DATAES-305
@@ -1432,7 +1432,7 @@ public void shouldPutMappingWithCustomIndexName() {
 		indexOperations1.create();
 
 		// when
-		indexOperations1.putMapping(indexOperations1.createMapping(entity));
+		indexOperations1.putMapping(entity);
 
 		// then
 		Map<String, Object> mapping = indexOperations.getMapping();
@@ -1622,7 +1622,7 @@ public void shouldReturnDifferentEntityForMultiSearch() {
 		IndexOperations bookIndexOperations = operations.indexOps(Book.class);
 		bookIndexOperations.delete();
 		bookIndexOperations.create();
-		indexOperations.putMapping(indexOperations.createMapping(clazz));
+		indexOperations.putMapping(clazz);
 		bookIndexOperations.refresh();
 
 		IndexCoordinates bookIndex = IndexCoordinates.of("test-index-book-core-template").withTypes("book");
@@ -2263,7 +2263,7 @@ public void shouldCreateIndexWithGivenClassAndSettings() {
 		// when
 		indexOperations.delete();
 		indexOperations.create(parse(settings));
-		indexOperations.putMapping(indexOperations.createMapping(SampleEntity.class));
+		indexOperations.putMapping(SampleEntity.class);
 		indexOperations.refresh();
 
 		// then

src/test/java/org/springframework/data/elasticsearch/core/ReactiveElasticsearchTemplateTests.java

@@ -108,7 +108,7 @@ public void setUp() {
 		deleteIndices();
 
 		indexOperations.create();
-		indexOperations.putMapping(indexOperations.createMapping(SampleEntity.class));
+		indexOperations.putMapping(SampleEntity.class);
 		indexOperations.refresh();
 
 		template = new ReactiveElasticsearchTemplate(TestUtils.reactiveClient(), restTemplate.getElasticsearchConverter());

src/test/java/org/springframework/data/elasticsearch/core/event/ElasticsearchOperationsCallbackTest.java

@@ -55,7 +55,7 @@ void setUp() {
 		IndexOperations indexOps = operations.indexOps(SampleEntity.class);
 		indexOps.delete();
 		indexOps.create();
-		indexOps.putMapping(indexOps.createMapping(SampleEntity.class));
+		indexOps.putMapping(SampleEntity.class);
 	}
 
 	@AfterEach

src/test/java/org/springframework/data/elasticsearch/core/event/ReactiveElasticsearchOperationsCallbackTest.java

@@ -67,7 +67,7 @@ public Mono<SampleEntity> onBeforeConvert(SampleEntity entity, IndexCoordinates
 	void setUp() {
 		IndexOperations indexOps = nonreactiveOperations.indexOps(SampleEntity.class);
 		indexOps.create();
-		indexOps.putMapping(indexOps.createMapping(SampleEntity.class));
+		indexOps.putMapping(SampleEntity.class);
 	}
 
 	@AfterEach

src/test/java/org/springframework/data/elasticsearch/core/index/MappingBuilderTests.java

@@ -108,7 +108,7 @@ public void before() {
 	public void shouldNotFailOnCircularReference() {
 
 		operations.indexOps(SimpleRecursiveEntity.class).create();
-		indexOperations.putMapping(indexOperations.createMapping(SimpleRecursiveEntity.class));
+		indexOperations.putMapping(SimpleRecursiveEntity.class);
 		indexOperations.refresh();
 	}
 
@@ -144,7 +144,7 @@ public void shouldAddStockPriceDocumentToIndex() {
 
 		// When
 		indexOps.create();
-		indexOps.putMapping(indexOps.createMapping(StockPrice.class));
+		indexOps.putMapping(StockPrice.class);
 		String symbol = "AU";
 		double price = 2.34;
 		String id = "abc";
@@ -197,7 +197,7 @@ public void shouldAddSampleInheritedEntityDocumentToIndex() {
 
 		// when
 		indexOps.create();
-		indexOps.putMapping(indexOps.createMapping(SampleInheritedEntity.class));
+		indexOps.putMapping(SampleInheritedEntity.class);
 		Date createdDate = new Date();
 		String message = "msg";
 		String id = "abc";
@@ -238,11 +238,11 @@ public void shouldHandleReverseRelationship() {
 		// given
 		IndexOperations indexOpsUser = operations.indexOps(User.class);
 		indexOpsUser.create();
-		indexOpsUser.putMapping(indexOpsUser.createMapping(User.class));
+		indexOpsUser.putMapping(User.class);
 
 		IndexOperations indexOpsGroup = operations.indexOps(Group.class);
 		indexOpsGroup.create();
-		indexOpsGroup.putMapping(indexOpsGroup.createMapping(Group.class));
+		indexOpsGroup.putMapping(Group.class);
 
 		// when
 
@@ -255,7 +255,7 @@ public void shouldMapBooks() {
 		// given
 		IndexOperations indexOps = operations.indexOps(Book.class);
 		indexOps.create();
-		indexOps.putMapping(indexOps.createMapping(Book.class));
+		indexOps.putMapping(Book.class);
 
 		// when
 
@@ -268,7 +268,7 @@ public void shouldUseBothAnalyzer() {
 		// given
 		IndexOperations indexOps = this.operations.indexOps(Book.class);
 		indexOps.create();
-		indexOps.putMapping(indexOps.createMapping(Book.class));
+		indexOps.putMapping(Book.class);
 
 		// when
 		Map mapping = indexOps.getMapping();
@@ -310,7 +310,7 @@ public void shouldUseCopyTo() {
 		// given
 		IndexOperations indexOps = operations.indexOps(CopyToEntity.class);
 		indexOps.create();
-		indexOps.putMapping(indexOps.createMapping(CopyToEntity.class));
+		indexOps.putMapping(CopyToEntity.class);
 
 		// when
 		Map mapping = indexOps.getMapping();

src/test/java/org/springframework/data/elasticsearch/core/query/CriteriaQueryTests.java

@@ -74,7 +74,7 @@ public void before() {
 		indexOperations = operations.indexOps(SampleEntity.class);
 		indexOperations.delete();
 		indexOperations.create();
-		indexOperations.putMapping(indexOperations.createMapping(SampleEntity.class));
+		indexOperations.putMapping(SampleEntity.class);
 		indexOperations.refresh();
 	}