Skip to content

Adding WithFieldName interface for QueryBuilders with fieldName#15705

Merged
jainankitk merged 3 commits intoopensearch-project:mainfrom
dzane17:qb-field-name
Sep 5, 2024
Merged

Adding WithFieldName interface for QueryBuilders with fieldName#15705
jainankitk merged 3 commits intoopensearch-project:mainfrom
dzane17:qb-field-name

Conversation

@dzane17
Copy link
Copy Markdown
Member

@dzane17 dzane17 commented Sep 4, 2024 •
edited
Loading

Description

Adding WithFieldName interface and update QueryBuilder classes that conform - have a fieldName() implementation.

In the Query-Insights plugin, we would like to append fieldName and fieldType data during query shape construction. Some *QueryBuilder classes already provide a fieldName() method, but not all query types necessarily operate on a single field. Adding the WithFieldName interface provides a uniform way to type-check any *QueryBuilder instance and get a singular fieldName when possible. Also once fieldName is known, we can lookup fieldType via index mappings.

Related Issues

Related RFC opensearch-project/query-insights#69

Check List

  • Functionality includes testing.
  • API changes companion pull request created, if applicable.
  • Public documentation issue/PR created, if applicable.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Sep 4, 2024

❌ Gradle check result for 089eede: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

@dzane17 dzane17 force-pushed the qb-field-name branch 2 times, most recently from 71d1cb1 to 9b6f465 Compare September 4, 2024 23:28
@dzane17 dzane17 changed the title Update QueryBuilders that implement MultiTermQueryBuilder interface Add WithFieldName interface Sep 4, 2024
@dzane17 dzane17 marked this pull request as ready for review September 4, 2024 23:36
jainankitk
jainankitk approved these changes Sep 4, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@jainankitk jainankitk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@msfroh - Can you also provide your feedback on this PR?

@jainankitk
Copy link
Copy Markdown
Contributor

jainankitk commented Sep 4, 2024

@dzane17 - Can you add CHANGELOG.md for this change?

dzane17 added a commit to dzane17/OpenSearch that referenced this pull request Sep 5, 2024
@dzane17 @jainankitk
Adding WithFieldName interface for QueryBuilders with fieldName (open…
46e9f55 
…search-project#15705)

Signed-off-by: David Zane <davizane@amazon.com>
Signed-off-by: Ankit Jain <akjain@amazon.com>
Co-authored-by: Ankit Jain <akjain@amazon.com>
(cherry picked from commit f5c897c)
dzane17 added a commit to dzane17/OpenSearch that referenced this pull request Sep 5, 2024
@dzane17 @jainankitk
Adding WithFieldName interface for QueryBuilders with fieldName (open…
990f6bc 
…search-project#15705)

Signed-off-by: David Zane <davizane@amazon.com>
Signed-off-by: Ankit Jain <akjain@amazon.com>
Co-authored-by: Ankit Jain <akjain@amazon.com>
(cherry picked from commit f5c897c)
dzane17 added a commit to dzane17/OpenSearch that referenced this pull request Sep 5, 2024
@dzane17 @jainankitk
Adding WithFieldName interface for QueryBuilders with fieldName (open…
7a7cb09 
…search-project#15705)

Signed-off-by: David Zane <davizane@amazon.com>
Signed-off-by: Ankit Jain <akjain@amazon.com>
Co-authored-by: Ankit Jain <akjain@amazon.com>
(cherry picked from commit f5c897c)
@dzane17 dzane17 mentioned this pull request Sep 5, 2024
Merged
3 tasks
dzane17 added a commit to dzane17/OpenSearch that referenced this pull request Sep 5, 2024
@dzane17 @jainankitk
Adding WithFieldName interface for QueryBuilders with fieldName (open…
2038b45 
…search-project#15705)

Signed-off-by: David Zane <davizane@amazon.com>
Signed-off-by: Ankit Jain <akjain@amazon.com>
Co-authored-by: Ankit Jain <akjain@amazon.com>
(cherry picked from commit f5c897c)
@dzane17 dzane17 mentioned this pull request Sep 5, 2024
Merged
3 tasks
jainankitk added a commit that referenced this pull request Sep 5, 2024
@dzane17 @jainankitk
[Backport 2.17] Adding WithFieldName interface for QueryBuilders with…
9b38044 
… fieldName (#15765)

* Adding WithFieldName interface for QueryBuilders with fieldName (#15705)

Signed-off-by: David Zane <davizane@amazon.com>
Signed-off-by: Ankit Jain <akjain@amazon.com>
Co-authored-by: Ankit Jain <akjain@amazon.com>
(cherry picked from commit f5c897c)

* Update CHANGELOG.md

Signed-off-by: Ankit Jain <akjain@amazon.com>

---------

Signed-off-by: Ankit Jain <akjain@amazon.com>
Co-authored-by: Ankit Jain <akjain@amazon.com>
dzane17 added a commit to dzane17/OpenSearch that referenced this pull request Sep 5, 2024
@dzane17 @jainankitk
Adding WithFieldName interface for QueryBuilders with fieldName (open…
b6a787a 
…search-project#15705)

Signed-off-by: David Zane <davizane@amazon.com>
Signed-off-by: Ankit Jain <akjain@amazon.com>
Co-authored-by: Ankit Jain <akjain@amazon.com>
(cherry picked from commit f5c897c)
dzane17 added a commit to dzane17/OpenSearch that referenced this pull request Sep 6, 2024
@dzane17 @jainankitk
Adding WithFieldName interface for QueryBuilders with fieldName (open…
a844b6f 
…search-project#15705)

Signed-off-by: David Zane <davizane@amazon.com>
Signed-off-by: Ankit Jain <akjain@amazon.com>
Co-authored-by: Ankit Jain <akjain@amazon.com>
(cherry picked from commit f5c897c)
This was referenced Sep 6, 2024
Closed
Closed
Closed
Open
Closed
dzane17 added a commit to dzane17/OpenSearch that referenced this pull request Sep 9, 2024
@dzane17 @jainankitk
Adding WithFieldName interface for QueryBuilders with fieldName (open…
c643cfa 
…search-project#15705)

Signed-off-by: David Zane <davizane@amazon.com>
Signed-off-by: Ankit Jain <akjain@amazon.com>
Co-authored-by: Ankit Jain <akjain@amazon.com>
(cherry picked from commit f5c897c)
dzane17 added a commit to dzane17/OpenSearch that referenced this pull request Sep 9, 2024
@dzane17 @jainankitk
Adding WithFieldName interface for QueryBuilders with fieldName (open…
f919bca 
…search-project#15705)

Signed-off-by: David Zane <davizane@amazon.com>
Signed-off-by: Ankit Jain <akjain@amazon.com>
Co-authored-by: Ankit Jain <akjain@amazon.com>
(cherry picked from commit f5c897c)
jainankitk added a commit that referenced this pull request Sep 9, 2024
@dzane17 @jainankitk
Adding WithFieldName interface for QueryBuilders with fieldName (#15705…
4742400 
…) (#15763)

Signed-off-by: David Zane <davizane@amazon.com>
Signed-off-by: Ankit Jain <akjain@amazon.com>
Co-authored-by: Ankit Jain <akjain@amazon.com>
(cherry picked from commit f5c897c)
@dzane17 dzane17 mentioned this pull request Sep 9, 2024
Merged
akolarkunnu pushed a commit to akolarkunnu/OpenSearch that referenced this pull request Sep 10, 2024
@dzane17 @jainankitk @akolarkunnu
Adding WithFieldName interface for QueryBuilders with fieldName (open…
8678fdc 
…search-project#15705)

Signed-off-by: David Zane <davizane@amazon.com>
Signed-off-by: Ankit Jain <akjain@amazon.com>
Co-authored-by: Ankit Jain <akjain@amazon.com>
This was referenced Sep 11, 2024
Open
Open
Open
@dzane17 dzane17 mentioned this pull request Sep 12, 2024
Merged
3 tasks
@BrewTestBot BrewTestBot mentioned this pull request Sep 18, 2024
Merged
@prudhvigodithi prudhvigodithi mentioned this pull request Oct 16, 2024
Open
dk2k pushed a commit to dk2k/OpenSearch that referenced this pull request Oct 16, 2024
@dzane17 @jainankitk @dk2k
Adding WithFieldName interface for QueryBuilders with fieldName (open…
7fb44a7 
…search-project#15705)

Signed-off-by: David Zane <davizane@amazon.com>
Signed-off-by: Ankit Jain <akjain@amazon.com>
Co-authored-by: Ankit Jain <akjain@amazon.com>
dk2k pushed a commit to dk2k/OpenSearch that referenced this pull request Oct 17, 2024
@dzane17 @jainankitk @dk2k
Adding WithFieldName interface for QueryBuilders with fieldName (open…
03bd186 
…search-project#15705)

Signed-off-by: David Zane <davizane@amazon.com>
Signed-off-by: Ankit Jain <akjain@amazon.com>
Co-authored-by: Ankit Jain <akjain@amazon.com>
dk2k pushed a commit to dk2k/OpenSearch that referenced this pull request Oct 21, 2024
@dzane17 @jainankitk @dk2k
Adding WithFieldName interface for QueryBuilders with fieldName (open…
92d5286 
…search-project#15705)

Signed-off-by: David Zane <davizane@amazon.com>
Signed-off-by: Ankit Jain <akjain@amazon.com>
Co-authored-by: Ankit Jain <akjain@amazon.com>
@markwu-sde markwu-sde mentioned this pull request Jan 16, 2025
Merged
3 tasks
@tkykenmt tkykenmt mentioned this pull request Jan 10, 2026
Closed
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@msfroh msfroh msfroh approved these changes

@jainankitk jainankitk jainankitk approved these changes

@anasalkouz anasalkouz Awaiting requested review from anasalkouz anasalkouz is a code owner

@andrross andrross Awaiting requested review from andrross andrross is a code owner

@ashking94 ashking94 Awaiting requested review from ashking94 ashking94 is a code owner

@Bukhtawar Bukhtawar Awaiting requested review from Bukhtawar Bukhtawar is a code owner

@CEHENKLE CEHENKLE Awaiting requested review from CEHENKLE CEHENKLE is a code owner

@dblock dblock Awaiting requested review from dblock

@dbwiddis dbwiddis Awaiting requested review from dbwiddis dbwiddis is a code owner

@gbbafna gbbafna Awaiting requested review from gbbafna gbbafna is a code owner

@jed326 jed326 Awaiting requested review from jed326 jed326 is a code owner

@kotwanikunal kotwanikunal Awaiting requested review from kotwanikunal kotwanikunal is a code owner

@mch2 mch2 Awaiting requested review from mch2 mch2 is a code owner

@nknize nknize Awaiting requested review from nknize

@owaiskazi19 owaiskazi19 Awaiting requested review from owaiskazi19 owaiskazi19 is a code owner

@reta reta Awaiting requested review from reta reta is a code owner

@Rishikesh1159 Rishikesh1159 Awaiting requested review from Rishikesh1159 Rishikesh1159 is a code owner

@sachinpkale sachinpkale Awaiting requested review from sachinpkale sachinpkale is a code owner

@saratvemulapalli saratvemulapalli Awaiting requested review from saratvemulapalli saratvemulapalli is a code owner

@shwetathareja shwetathareja Awaiting requested review from shwetathareja shwetathareja is a code owner

@sohami sohami Awaiting requested review from sohami sohami is a code owner

@VachaShah VachaShah Awaiting requested review from VachaShah

@linuxpi linuxpi Awaiting requested review from linuxpi

Assignees

No one assigned

Labels

backport 2.x Backport to 2.x branch backport 2.17 backport-failed

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@dzane17 @jainankitk @msfroh