setTrackTotalHits (Java transport client) default in docs is wrong

e-orz · May 13, 2019, 11:42am

Hi,
according to the docs:
"Indicates if the total hit count for the query should be tracked. Defaults to true".

When I use client.prepareSearch(...) and don't set setTrackTotalHits I still get the result with "gte" totals. Setting setTrackTotalHits to true solves the issue.

Either the default is false, or am I doing something wrong?

Thanks,
Eli

dadoonet · May 13, 2019, 12:20pm

Could you share the link to the documentation and the version you are using?

e-orz · May 13, 2019, 1:13pm

The javadoc. I am using 7.0.0 but it's also in master. see:

github.com

elastic/elasticsearch/blob/45e1e59371b4c8159d6a11999458537db414a7c2/server/src/main/java/org/elasticsearch/action/search/SearchRequestBuilder.java#L381




/**
 * Applies when sorting, and controls if scores will be tracked as well. Defaults to {@code false}.
 */
public SearchRequestBuilder setTrackScores(boolean trackScores) {
    sourceBuilder().trackScores(trackScores);
    return this;
}


/**
 * Indicates if the total hit count for the query should be tracked. Defaults to {@code true}
 */
public SearchRequestBuilder setTrackTotalHits(boolean trackTotalHits) {
    sourceBuilder().trackTotalHits(trackTotalHits);
    return this;
}


/**
 * Indicates if the total hit count for the query should be tracked. Defaults to {@code true}
 */
public SearchRequestBuilder setTrackTotalHitsUpTo(int trackTotalHitsUpTo) {

dadoonet · May 20, 2019, 10:04am

Hmmm. Looks like a Javadoc issue. @jimczi WDYT?

jimczi · May 20, 2019, 10:46am

Thanks @dadoonet and @e-orz this is a leftover. I opened https://github.com/elastic/elasticsearch/pull/42219 to fix the docs.

system · June 17, 2019, 10:46am

This topic was automatically closed 28 days after the last reply. New replies are no longer allowed.

Topic		Replies	Views
Unable to set trackTotalHits to true in Java RestHighLevelClient Elasticsearch language-clients	2	783	August 8, 2022
How to enable track_total_hits=true by default for all queries? Elasticsearch	2	2421	October 11, 2019
Elasticsearch java API client trackTotalHits Elasticsearch language-clients	3	978	September 27, 2023
Search.totalhits breaking change in ES 7: Java rest client 6.7 Elasticsearch	1	344	September 17, 2020
Missing result using scroll in java API Elasticsearch	10	1281	May 4, 2018

setTrackTotalHits (Java transport client) default in docs is wrong

Related topics