Skip to content

update document partially by specified entity(polish) #2310

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 25, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ In order to run the tests locally with `./mvnw test` you need to have docker run

== Class names of the test classes

Tset classes that do depend on the client have either `ERHLC` (when using the deprecated Elasticsearch `RestHighLevelClient`) or `ELC` (the new `ElasticsearchClient`) in their name.
Test classes that do depend on the client have either `ERHLC` (when using the deprecated Elasticsearch `RestHighLevelClient`) or `ELC` (the new `ElasticsearchClient`) in their name.
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
import org.springframework.data.elasticsearch.core.query.Query;
import org.springframework.data.elasticsearch.core.query.SeqNoPrimaryTerm;
import org.springframework.data.elasticsearch.core.query.UpdateQuery;
import org.springframework.data.elasticsearch.core.query.UpdateResponse;
import org.springframework.data.elasticsearch.core.routing.DefaultRoutingResolver;
import org.springframework.data.elasticsearch.core.routing.RoutingResolver;
import org.springframework.data.elasticsearch.support.VersionInfo;
Expand All @@ -75,6 +76,7 @@
* @author Subhobrata Dey
* @author Steven Pearce
* @author Anton Naydenov
* @author Haibo Liu
*/
public abstract class AbstractElasticsearchTemplate implements ElasticsearchOperations, ApplicationContextAware {

Expand Down Expand Up @@ -305,7 +307,7 @@ public String delete(Object entity) {
@Override
public String delete(Object entity, IndexCoordinates index) {
String entityId = getEntityId(entity);
Assert.notNull(entityId, "entity must have an if that is notnull");
Assert.notNull(entityId, "entity must have an id that is notnull");
return this.delete(entityId, index);
}

Expand Down Expand Up @@ -460,6 +462,27 @@ public IndexCoordinates getIndexCoordinatesFor(Class<?> clazz) {
return getRequiredPersistentEntity(clazz).getIndexCoordinates();
}

@Override
public <T> UpdateResponse update(T entity) {
return update(buildUpdateQueryByEntity(entity), getIndexCoordinatesFor(entity.getClass()));
}

protected <T> UpdateQuery buildUpdateQueryByEntity(T entity) {
Assert.notNull(entity, "entity must not be null");

String id = getEntityId(entity);
Assert.notNull(entity, "entity must have an id that is notnull");

UpdateQuery.Builder updateQueryBuilder = UpdateQuery.builder(id)
.withDocument(elasticsearchConverter.mapObject(entity));

String routing = getEntityRouting(entity);
if (Objects.nonNull(routing)) {
updateQueryBuilder.withRouting(routing);
}
return updateQueryBuilder.build();
}

protected <T> T updateIndexedObject(T entity, IndexedObjectInformation indexedObjectInformation) {

ElasticsearchPersistentEntity<?> persistentEntity = elasticsearchConverter.getMappingContext()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
* @author Peter-Josef Meisch
* @author Farid Faoudi
* @author Sijia Liu
* @author Haibo Liu
* @since 4.0
*/
public interface DocumentOperations {
Expand Down Expand Up @@ -293,6 +294,15 @@ default void bulkUpdate(List<UpdateQuery> queries, IndexCoordinates index) {
*/
ByQueryResponse delete(Query query, Class<?> clazz, IndexCoordinates index);

/**
* Partially update a document by the given entity.
*
* @param entity the entity to update partially
* @return the update response
* @param <T> the entity type
*/
<T> UpdateResponse update(T entity);

/**
* Partial update of the document.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,7 @@
* @author Farid Faoudi
* @author Peer Mueller
* @author Sijia Liu
* @author Haibo Liu
*/
@SpringIntegrationTest
public abstract class ElasticsearchIntegrationTests {
Expand Down Expand Up @@ -186,6 +187,20 @@ protected abstract Query getMatchAllQueryWithIncludesAndInlineExpressionScript(@

protected abstract Query getQueryWithRescorer();

@Test // #2304
public void shouldThrowDataAccessExceptionIfDocumentDoesNotExistWhileDoingPartialUpdateByEntity() {

// given
String documentId = nextIdAsString();
String messageBeforeUpdate = "some test message";

SampleEntity sampleEntity = SampleEntity.builder().id(documentId).message(messageBeforeUpdate)
.version(System.currentTimeMillis()).build();

assertThatThrownBy(() -> operations.update(sampleEntity))
.isInstanceOf(DataAccessException.class);
}

@Test
public void shouldThrowDataAccessExceptionIfDocumentDoesNotExistWhileDoingPartialUpdate() {

Expand Down Expand Up @@ -1505,6 +1520,32 @@ public void shouldDeleteIndexForGivenEntity() {
assertThat(indexOperations.exists()).isFalse();
}

@Test // #2304
public void shouldDoPartialUpdateBySuppliedEntityForExistingDocument() {

// given
String documentId = nextIdAsString();
String messageBeforeUpdate = "some test message";
String messageAfterUpdate = "test message";
String originalTypeInfo = "some type";

SampleEntity sampleEntity = SampleEntity.builder().id(documentId).message(messageBeforeUpdate).type(originalTypeInfo)
.version(System.currentTimeMillis()).build();
operations.save(sampleEntity);

// modify the entity
sampleEntity.setMessage(messageAfterUpdate);
sampleEntity.setType(null);

// when
operations.update(sampleEntity);

// then
SampleEntity indexedEntity = operations.get(documentId, SampleEntity.class);
assertThat(indexedEntity.getType()).isEqualTo(originalTypeInfo);
assertThat(indexedEntity.getMessage()).isEqualTo(messageAfterUpdate);
}

@Test
public void shouldDoPartialUpdateForExistingDocument() {

Expand Down