elastic/elasticsearch

Add a checkCancelled public method to ContextIndexSearcher

Open

#121,349 opened on 2025年1月30日

GitHub で見る
 (5 comments) (0 reactions) (0 assignees)Java (76,700 stars) (25,882 forks)batch import
:Search Foundations/Search>enhancementTeam:Search Foundationshelp wanted

説明

Description

The ContextIndexSearcher has some API to deal with cancelled tasks, see for example hasCancellations() below. Acting on cancelled tasks can be useful in ValueFetchers (which can be implemented by plugins via custom runtime fields), where resources can be released in such a case. Although the method hasCancellations() is public and accessible to plugins, there is however no access point to its counterpart checkCancelled() (see below): that method would be needed to check if the search's task got cancelled (and act upon it).

  • Would it be possible to add a public access method to checkCancelled(), in order to allow plugins to handle cancellations in custom runtime fields ?
  • Related question: are IndexSearchers used in Elasticsearch all ContextIndexSearcher instances ?

https://github.com/elastic/elasticsearch/blob/0d2db063ec4d8e95941e3b92dc150e294e5f0689/server/src/main/java/org/elasticsearch/search/internal/ContextIndexSearcher.java#L193

https://github.com/elastic/elasticsearch/blob/0d2db063ec4d8e95941e3b92dc150e294e5f0689/server/src/main/java/org/elasticsearch/index/mapper/MappedFieldType.java#L118

https://github.com/elastic/elasticsearch/blob/0d2db063ec4d8e95941e3b92dc150e294e5f0689/server/src/main/java/org/elasticsearch/search/internal/ContextIndexSearcher.java#L594

コントリビューターガイド

技術スタック
java
領域
backend
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
fresh
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
JavaElasticsearch search internals
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
60
調査方針
Examine ContextIndexSearcher.java (lines 193 and 594) to understand the existing private checkCancelled method and its relationship to hasCancellations. Check the linked MappedFieldType.java to understand how ValueFetchers use cancellation. Review comments in the issue #121349 for maintainer feedback on whether all IndexSearcher instances are ContextIndexSearcher, and whether a public method is acceptable. The change may involve adding a simple public wrapper that delegates to the private checkCancelled, following existing patterns.