Skip to content

Set trackTotalHits in searchMsearchRequest #550

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.

Sign up for GitHub

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
reta merged 1 commit into from
Sep 23, 2025
Merged

Set trackTotalHits in searchMsearchRequest #550

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions spring-data-opensearch/src/main/java/org/opensearch/data/client/osc/RequestConverter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1394,6 +1394,12 @@ public MsearchRequest searchMsearchRequest(
query.getScriptedFields().forEach(scriptedField -> bb.scriptFields(scriptedField.getFieldName(),
sf -> sf.script(getScript(scriptedField.getScriptData()))));

if (query.getTrackTotalHits() != null) {
bb.trackTotalHits(th -> th.enabled(query.getTrackTotalHits()));
} else if (query.getTrackTotalHitsUpTo() != null) {
bb.trackTotalHits(th -> th.count(query.getTrackTotalHitsUpTo()));
}

if (query instanceof NativeQuery nativeQuery) {
prepareNativeSearch(nativeQuery, bb);
}
Expand Down
74 changes: 74 additions & 0 deletions ...ng-data-opensearch/src/test/java/org/opensearch/data/client/osc/RequestConverterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,14 @@

import static org.assertj.core.api.Assertions.*;

import java.util.ArrayList;
import java.util.List;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.opensearch.client.json.jackson.JacksonJsonpMapper;
import org.opensearch.client.opensearch._types.Refresh;
import org.opensearch.client.opensearch.core.msearch.RequestItem;
import org.opensearch.client.opensearch.core.search.TrackHits;
import org.springframework.data.annotation.Id;
import org.springframework.data.elasticsearch.annotations.Document;
import org.springframework.data.elasticsearch.annotations.Field;
Expand Down Expand Up @@ -86,6 +89,77 @@ void refreshSetByDeleteRequest() {
assertThat(deleteByQueryRequest.refresh()).isEqualTo(Refresh.True);
}


@Test // #542
@DisplayName("should set track_total_hits to true on searchMsearchRequest")
void shouldSetTrackTotalTrueOnMultiSearch() {
var query = new NativeQueryBuilder()
.withQuery(Queries.matchAllQuery().toQuery())
.withTrackTotalHits(true)
.build();

var multiSearchQueryParameters = new ArrayList<OpenSearchTemplate.MultiSearchQueryParameter>();
multiSearchQueryParameters.add(new OpenSearchTemplate.MultiSearchQueryParameter(query, SampleEntity.class, IndexCoordinates.of("foo")));

var searchRequest = requestConverter.searchMsearchRequest(multiSearchQueryParameters, null);

List<RequestItem> searches = searchRequest.searches();
assertThat(searches).hasSize(1);

TrackHits trackTotalHits = searches.getFirst().body().trackTotalHits();
assertThat(trackTotalHits).isNotNull();
assertThat(trackTotalHits.isCount()).isFalse();
assertThat(trackTotalHits.isEnabled()).isTrue();
assertThat(trackTotalHits.enabled()).isTrue();
}

@Test // #542
@DisplayName("should set track_total_hits to false on searchMsearchRequest")
void shouldSetTrackTotalFalseOnMultiSearch() {
var query = new NativeQueryBuilder()
.withQuery(Queries.matchAllQuery().toQuery())
.withTrackTotalHits(false)
.build();

var multiSearchQueryParameters = new ArrayList<OpenSearchTemplate.MultiSearchQueryParameter>();
multiSearchQueryParameters.add(new OpenSearchTemplate.MultiSearchQueryParameter(query, SampleEntity.class, IndexCoordinates.of("foo")));

var searchRequest = requestConverter.searchMsearchRequest(multiSearchQueryParameters, null);

List<RequestItem> searches = searchRequest.searches();
assertThat(searches).hasSize(1);

TrackHits trackTotalHits = searches.getFirst().body().trackTotalHits();
assertThat(trackTotalHits).isNotNull();
assertThat(trackTotalHits.isCount()).isFalse();
assertThat(trackTotalHits.isEnabled()).isTrue();
assertThat(trackTotalHits.enabled()).isFalse();
}

@Test // #542
@DisplayName("should set track_total_hits to count value on searchMsearchRequest")
void shouldSetTrackTotalCountValueOnMultiSearch() {
int countValue = 5000;
var query = new NativeQueryBuilder()
.withQuery(Queries.matchAllQuery().toQuery())
.withTrackTotalHitsUpTo(countValue)
.build();

var multiSearchQueryParameters = new ArrayList<OpenSearchTemplate.MultiSearchQueryParameter>();
multiSearchQueryParameters.add(new OpenSearchTemplate.MultiSearchQueryParameter(query, SampleEntity.class, IndexCoordinates.of("foo")));

var searchRequest = requestConverter.searchMsearchRequest(multiSearchQueryParameters, null);

List<RequestItem> searches = searchRequest.searches();
assertThat(searches).hasSize(1);

TrackHits trackTotalHits = searches.getFirst().body().trackTotalHits();
assertThat(trackTotalHits).isNotNull();
assertThat(trackTotalHits.isEnabled()).isFalse();
assertThat(trackTotalHits.isCount()).isTrue();
assertThat(trackTotalHits.count()).isEqualTo(countValue);
}

@Document(indexName = "does-not-matter")
static class SampleEntity {
@Nullable
Expand Down
Loading