-
Notifications
You must be signed in to change notification settings - Fork 2.3k
Inject QueryCollectorSpecFactory from Plugins to create QueryCollectorContext in QueryPhase #18637
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
owaiskazi19
merged 19 commits into
opensearch-project:main
from
vibrantvarun:POC_on_collector_context
Jul 1, 2025
Merged
Changes from 10 commits
Commits
Show all changes
19 commits
Select commit
Hold shift + click to select a range
ad91bee
Initial Commit
vibrantvarun 1b192d6
Merge branch 'main' into POC_on_collector_context
vibrantvarun 5618ee1
Javadocs
vibrantvarun 1784819
Factory design pattern for QueryCollectorContextSpec
vibrantvarun a2bcea0
Rebase
vibrantvarun 54de680
Merge branch 'main' into POC_on_collector_context
vibrantvarun 6ab43b7
Fixing Concurrent Segment Search
vibrantvarun 9d77eb2
Remove spec
vibrantvarun a63a4c8
Renaming method
vibrantvarun 11ef45b
Javadoc
vibrantvarun 172b0ba
Removing support method from QueryCollectorContextSpecFactory
vibrantvarun 1cc3243
Adding javadoc
vibrantvarun c66f365
Add changelog
vibrantvarun f4f559b
Add experimentalAPI annotation
vibrantvarun 068f4ca
remove redundant check from getQueryCollectorContextSpec method
vibrantvarun 517a7c5
Add unit tests
vibrantvarun 8499eb6
Remove Test annotation
vibrantvarun d28fb56
Reformatting
vibrantvarun e215ef0
Merge branch 'main' into POC_on_collector_context
vibrantvarun File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
27 changes: 27 additions & 0 deletions
27
server/src/main/java/org/opensearch/search/query/QueryCollectorContextSpec.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| /* | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * | ||
| * The OpenSearch Contributors require contributions made to | ||
| * this file be licensed under the Apache-2.0 license or a | ||
| * compatible open source license. | ||
| */ | ||
|
|
||
| package org.opensearch.search.query; | ||
|
|
||
| import org.apache.lucene.search.Collector; | ||
| import org.apache.lucene.search.CollectorManager; | ||
|
|
||
| import java.io.IOException; | ||
|
|
||
| /** | ||
| * interface of QueryCollectorContextSpec | ||
| */ | ||
| public interface QueryCollectorContextSpec { | ||
vibrantvarun marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| String getProfileName(); | ||
reta marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| Collector create(Collector in) throws IOException; | ||
|
|
||
| CollectorManager<?, ReduceableSearchResult> createManager(CollectorManager<?, ReduceableSearchResult> in) throws IOException; | ||
|
|
||
| void postProcess(QuerySearchResult result) throws IOException; | ||
| } | ||
35 changes: 35 additions & 0 deletions
35
server/src/main/java/org/opensearch/search/query/QueryCollectorContextSpecFactory.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| /* | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * | ||
| * The OpenSearch Contributors require contributions made to | ||
| * this file be licensed under the Apache-2.0 license or a | ||
| * compatible open source license. | ||
| */ | ||
|
|
||
| package org.opensearch.search.query; | ||
|
|
||
| import org.apache.lucene.search.Query; | ||
| import org.opensearch.search.internal.SearchContext; | ||
|
|
||
| import java.io.IOException; | ||
|
|
||
| /** | ||
| * interface of QueryCollectorContext spec factory | ||
| */ | ||
| public interface QueryCollectorContextSpecFactory { | ||
vibrantvarun marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| /** | ||
| * check if query is supported to initialize the factory | ||
| * @param query sent in the search request | ||
| * @return true if query satisfies the factory initialization criteria | ||
| */ | ||
| boolean supports(Query query); | ||
reta marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| /** | ||
| * | ||
| * @param searchContext context needed to create collector context spec | ||
| * @param hasFilterCollector flag true if filter collector there | ||
| * @return QueryCollectorContextSpec | ||
| * @throws IOException | ||
| */ | ||
| QueryCollectorContextSpec createQueryCollectorContextSpec(SearchContext searchContext, boolean hasFilterCollector) throws IOException; | ||
reta marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| } | ||
35 changes: 35 additions & 0 deletions
35
server/src/main/java/org/opensearch/search/query/QueryCollectorContextSpecRegistry.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| /* | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * | ||
| * The OpenSearch Contributors require contributions made to | ||
| * this file be licensed under the Apache-2.0 license or a | ||
| * compatible open source license. | ||
| */ | ||
|
|
||
| package org.opensearch.search.query; | ||
|
|
||
| import org.apache.lucene.search.Query; | ||
|
|
||
| import java.util.List; | ||
| import java.util.concurrent.CopyOnWriteArrayList; | ||
|
|
||
| /** | ||
| * Registry class to load all collector context spec factories during cluster bootstrapping | ||
| */ | ||
| public class QueryCollectorContextSpecRegistry { | ||
vibrantvarun marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| private static final List<QueryCollectorContextSpecFactory> registry = new CopyOnWriteArrayList<>(); | ||
|
|
||
| static QueryCollectorContextSpecFactory getFactory(Query query) { | ||
|
|
||
| return registry.stream().filter(entry -> entry.supports(query)).findFirst().orElse(null); | ||
| } | ||
|
|
||
| /** | ||
| * Register factory | ||
| * @param factory collector context spec factory defined in plugin | ||
| */ | ||
| public static void registerFactory(QueryCollectorContextSpecFactory factory) { | ||
| registry.add(factory); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.