Understanding SearchHits in Elasticsearch with Java

X (Twitter) Facebook Pinterest LinkedIn

Elasticsearch, a powerful open-source search and analytics engine, has become an essential tool for complex queries, full-text search capabilities, and analytics on large volumes of data. When using Elasticsearch in Java applications, one of the core classes you’ll interact with is SearchHits. This article delves into understanding and effectively utilizing the SearchHits class within the Elasticsearch Java API, facilitating the efficient handling and analysis of search results.

Table of Contents

Introduction to SearchHits

In Elasticsearch, a search operation returns a SearchResponse object, containing detailed information about the query execution and the results. The SearchHits class, part of this SearchResponse, encapsulates the collection of search hits (or matched documents) and provides methods to navigate and process these results.

Understanding how to work with SearchHits is crucial for developers looking to extract detailed information from their Elasticsearch queries, such as retrieving documents, understanding the relevance score, or implementing pagination.

Accessing SearchHits

To perform a search operation and access the SearchHits, you’ll typically use the Elasticsearch Java High-Level REST Client. Here’s a basic example of executing a search query and retrieving the SearchHits:

RestHighLevelClient client = new RestHighLevelClient(
        RestClient.builder(new HttpHost("localhost", 9200, "http")));

SearchRequest searchRequest = new SearchRequest("your_index_name");
SearchSourceBuilder searchSourceBuilder = new SearchSourceBuilder();
searchSourceBuilder.query(QueryBuilders.matchAllQuery());
searchRequest.source(searchSourceBuilder);

SearchResponse searchResponse = client.search(searchRequest, RequestOptions.DEFAULT);
SearchHits hits = searchResponse.getHits();

In this example, a SearchRequest is created for a specific index, and a query is defined using SearchSourceBuilder. The search operation is executed with the search method of the RestHighLevelClient, returning a SearchResponse object from which we retrieve the SearchHits.

Working with SearchHits

The SearchHits class offers several methods to work with the search results:

getTotalHits: Returns the total number of hits that matched the search query. This can be useful for implementing pagination or displaying result counts to users.
getHits: Provides access to the individual search hits (SearchHit objects) within the SearchHits. Each SearchHit contains the document’s data, its metadata (like the document ID and index), and the relevance score.
getMaxScore: Returns the highest relevance score among all the hits.

Here’s how you might iterate over the search hits to extract and process each document:

for (SearchHit hit : hits.getHits()) {
    String index = hit.getIndex();
    String id = hit.getId();
    float score = hit.getScore();
    String sourceAsString = hit.getSourceAsString(); // The document's source as JSON string
    Map<String, Object> sourceAsMap = hit.getSourceAsMap(); // The document's source as a Map
    // Process the document's data...
}

Advanced Usage

Highlighting

Elasticsearch allows you to highlight specific parts of the documents that match the search query. This feature is especially useful for full-text search applications. You can specify highlighting options in your SearchSourceBuilder and then access the highlighted fields from each SearchHit:

searchSourceBuilder.highlighter(new HighlightBuilder().field("your_field_name"));
// Execute search and process hits...
SearchHit hit = hits.getHits()[0];
String highlightString = hit.getHighlightFields().get("your_field_name").fragments()[0].string();

Pagination

Implementing pagination with SearchHits involves using the from and size parameters in your SearchSourceBuilder to control the slice of results returned by a query:

searchSourceBuilder.from(0); // Starting offset
searchSourceBuilder.size(10); // Number of search hits to return

Sorting

You can also sort the search results by specifying sort options in your SearchSourceBuilder:

searchSourceBuilder.sort(new FieldSortBuilder("your_field_name").order(SortOrder.ASC));

Conclusion

The SearchHits class is a fundamental component of the Elasticsearch Java API, offering powerful capabilities to access and manipulate search results in Java applications. By mastering SearchHits, developers can implement detailed search result analysis, highlighting, pagination, and sorting, unlocking the full potential of Elasticsearch to meet their application’s search and data exploration needs.

Author
Recent Posts

Follow me

Anastasios Antoniadis

Anastasios Antoniadis is the founder and editor-in-chief of BORDERPOLAR... He is a software engineer, blogger, and avid gamer covering tech, gaming, and coding guides for over 4 years. He is a 2014 graduate of the Department of Informatics and Telecommunications of the University of Athens, an M.Sc. holder in Computer Science, and a Ph.D. student in Program Analysis.