[ES|QL] Add MATCH_PHRASE #127661

kderusso · 2025-05-02T19:50:40Z

Adds MATCH_PHRASE support to ES|QL.

Some examples of how to use MATCH_PHRASE:

POST _query?format=txt { "query": """ FROM books METADATA _score | WHERE MATCH_PHRASE(title, "return of the king") | KEEP title, _score | SORT _score | LIMIT 5 """ } POST _query?format=txt { "query": """ FROM books METADATA _score | WHERE MATCH_PHRASE(title, "return of king", {"slop": 5}) | KEEP title, _score | SORT _score | LIMIT 5 """ } POST _query?format=txt { "query": """ FROM books METADATA _score | WHERE MATCH_PHRASE(title, "return of king", {"analyzer": "whitespace"}) | KEEP title, _score | SORT _score | LIMIT 5 """ } POST _query?format=txt { "query": """ FROM books METADATA _score | WHERE MATCH_PHRASE(title, "", {"zero_terms_query": "all"}) | KEEP title, _score | SORT _score | LIMIT 5 """ }

elasticsearchmachine · 2025-05-07T18:16:42Z

Hi @kderusso, I've created a changelog YAML for you.

…t only

carlosdelest

It's important that we register the match_phrase as snapshot and get some tests ready for release builds.

Besides that, some small nits.

...sql/src/main/java/org/elasticsearch/xpack/esql/expression/function/EsqlFunctionRegistry.java

...sql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/MatchPhrase.java

carlosdelest · 2025-06-02T07:28:10Z

x-pack/plugin/src/yamlRestTest/resources/rest-api-spec/test/esql/60_usage.yml

 - match: {esql.functions.coalesce: $functions_coalesce}
 - gt: {esql.functions.categorize: $functions_categorize}
- - length: {esql.functions: 134} # check the "sister" test above for a likely update to the same esql.functions length check
+ - length: {esql.functions: 135} # check the "sister" test above for a likely update to the same esql.functions length check


Hopefully those errors get corrected when registering the function under snapshot functions 🤞

carlosdelest · 2025-06-02T07:30:04Z

x-pack/plugin/src/yamlRestTest/resources/rest-api-spec/test/esql/60_usage.yml

 - match: {esql.functions.coalesce: $functions_coalesce}
 - gt: {esql.functions.categorize: $functions_categorize}
- - length: {esql.functions: 134} # check the "sister" test above for a likely update to the same esql.functions length check
+ - length: {esql.functions: 135} # check the "sister" test above for a likely update to the same esql.functions length check


I think you'll need to add match_phrase capability to these tests, otherwise they will fail for release as the function will not be registered

ioanatia · 2025-06-04T07:36:52Z

@elasticmachine test this please

ioanatia · 2025-06-04T07:38:43Z

I checked the release tests failures - there is nothing pertaining to match_phrase - I removed the test-release label since all the match_phrase failures for release tests were fixed.

carlosdelest

LGTM, great work! 💯

There are other tests that can be added to VerifierTests - look for EsqlCapabilities.Cap.MULTI_MATCH_FUNCTION.isEnabled() and you'll be able to add an equivalent one for match_phrase

elasticsearchmachine · 2025-06-04T16:34:20Z

💔 Backport failed

Status	Branch	Result
❌	8.19	Commit could not be cherrypicked due to conflicts

You can use sqren/backport to manually backport by running backport --upstream elastic/elasticsearch --pr 127661

* Initial commit of match_phrase * Add MatchPhraseQueryTests * First pass at CSV specs * Update docs/changelog/127661.yaml * Refactor so MatchPhrase doesn't use all fulltext test cases, just text only * Fix tests * Add some CSV test cases * Fix test * Update changelog * Update tests * Comment out MATCH_PHRASE in search-functions Markdown * Minor PR feedback * PR feedback - refactor/consolidate code * Add some more tests * Fix some tests * [CI] Auto commit changes from spotless * Fix tests * PR feedback - add tests, support boost and numeric data * Revert "PR feedback - add tests, support boost and numeric data" This reverts commit 4e7a699. * Apply testing/PR feedback outside numeric support only * Regenerate docs * Add negative test * Update x-pack/plugin/esql/qa/testFixtures/src/main/resources/match-phrase-function.csv-spec Co-authored-by: Carlos Delgado <6339205+carlosdelest@users.noreply.github.com> * Update x-pack/plugin/esql/qa/testFixtures/src/main/resources/match-phrase-function.csv-spec Co-authored-by: Carlos Delgado <6339205+carlosdelest@users.noreply.github.com> * Update x-pack/plugin/esql/qa/testFixtures/src/main/resources/match-phrase-function.csv-spec Co-authored-by: Carlos Delgado <6339205+carlosdelest@users.noreply.github.com> * PR feedback * Fix auto-commit error * Regenerate docs * Update x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/MatchPhrase.java Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com> * Remove non text field types * Fake test data * Remove tests that no longer should pass without ip/date/version support * Put real data in score tests now that I was able to engineer a failure * Realized the scoring test might be flakey because how it was written, updated * PR feedback * PR feedback * [CI] Auto commit changes from spotless * Add check to MatchPhrase tests * Fix merge errors * [CI] Auto commit changes from spotless * Test generated docs * Add additional verifier tests --------- Co-authored-by: elasticsearchmachine <infra-root+elasticsearchmachine@elastic.co> Co-authored-by: Carlos Delgado <6339205+carlosdelest@users.noreply.github.com> Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com> (cherry picked from commit eee423a) # Conflicts: # docs/reference/esql/functions/description/match_phrase.md # docs/reference/esql/functions/examples/match_phrase.md # docs/reference/esql/functions/kibana/definition/match_phrase.json # docs/reference/esql/functions/kibana/docs/match_phrase.md # docs/reference/query-languages/esql/_snippets/lists/search-functions.md # docs/reference/query-languages/esql/functions-operators/search-functions.md # x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/action/EsqlCapabilities.java # x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/EsqlFunctionRegistry.java # x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/FullTextFunction.java # x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/Match.java # x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/QueryString.java # x-pack/plugin/esql/src/test/java/org/elasticsearch/xpack/esql/analysis/VerifierTests.java

kderusso · 2025-06-10T17:41:36Z

💚 All backports created successfully

Status	Branch	Result
✅	8.19

Questions ?

Please refer to the Backport tool documentation

kderusso · 2025-06-10T19:28:29Z

Backport PR: #129215

* [ES|QL] Add MATCH_PHRASE (#127661) * Initial commit of match_phrase * Add MatchPhraseQueryTests * First pass at CSV specs * Update docs/changelog/127661.yaml * Refactor so MatchPhrase doesn't use all fulltext test cases, just text only * Fix tests * Add some CSV test cases * Fix test * Update changelog * Update tests * Comment out MATCH_PHRASE in search-functions Markdown * Minor PR feedback * PR feedback - refactor/consolidate code * Add some more tests * Fix some tests * [CI] Auto commit changes from spotless * Fix tests * PR feedback - add tests, support boost and numeric data * Revert "PR feedback - add tests, support boost and numeric data" This reverts commit 4e7a699. * Apply testing/PR feedback outside numeric support only * Regenerate docs * Add negative test * Update x-pack/plugin/esql/qa/testFixtures/src/main/resources/match-phrase-function.csv-spec Co-authored-by: Carlos Delgado <6339205+carlosdelest@users.noreply.github.com> * Update x-pack/plugin/esql/qa/testFixtures/src/main/resources/match-phrase-function.csv-spec Co-authored-by: Carlos Delgado <6339205+carlosdelest@users.noreply.github.com> * Update x-pack/plugin/esql/qa/testFixtures/src/main/resources/match-phrase-function.csv-spec Co-authored-by: Carlos Delgado <6339205+carlosdelest@users.noreply.github.com> * PR feedback * Fix auto-commit error * Regenerate docs * Update x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/MatchPhrase.java Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com> * Remove non text field types * Fake test data * Remove tests that no longer should pass without ip/date/version support * Put real data in score tests now that I was able to engineer a failure * Realized the scoring test might be flakey because how it was written, updated * PR feedback * PR feedback * [CI] Auto commit changes from spotless * Add check to MatchPhrase tests * Fix merge errors * [CI] Auto commit changes from spotless * Test generated docs * Add additional verifier tests --------- Co-authored-by: elasticsearchmachine <infra-root+elasticsearchmachine@elastic.co> Co-authored-by: Carlos Delgado <6339205+carlosdelest@users.noreply.github.com> Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com> (cherry picked from commit eee423a) # Conflicts: # docs/reference/esql/functions/description/match_phrase.md # docs/reference/esql/functions/examples/match_phrase.md # docs/reference/esql/functions/kibana/definition/match_phrase.json # docs/reference/esql/functions/kibana/docs/match_phrase.md # docs/reference/query-languages/esql/_snippets/lists/search-functions.md # docs/reference/query-languages/esql/functions-operators/search-functions.md # x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/action/EsqlCapabilities.java # x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/EsqlFunctionRegistry.java # x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/FullTextFunction.java # x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/Match.java # x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/QueryString.java # x-pack/plugin/esql/src/test/java/org/elasticsearch/xpack/esql/analysis/VerifierTests.java * Take match_phrase out of snapshot and make tech preview (#128925) * Take match_phrase out of snapshot and make tech preview * Update docs/changelog/128925.yaml * PR feedback * Adding regenerated test data * Update docs/changelog/128925.yaml Co-authored-by: Carlos Delgado <6339205+carlosdelest@users.noreply.github.com> * [CI] Auto commit changes from spotless * Checkstyle * Correct docs * Hopefully fix docs build * Found one more bad docs link - here's hoping this now fixes the doc build * OMG bitten by - vs _ --------- Co-authored-by: Carlos Delgado <6339205+carlosdelest@users.noreply.github.com> Co-authored-by: elasticsearchmachine <infra-root+elasticsearchmachine@elastic.co> Co-authored-by: Aurélien FOUCRET <aurelien.foucret@gmail.com> * Remove null example for match_phrase (#129173) * Fix errors from merge * Fix more errors from merge * [CI] Auto commit changes from spotless * Fix compile errors introduced through cherry-pick * Fix test compilation * Generate docs * Register match_phrase as a function not a snapshot function (#129255) * Register match_phrase as a function not a snapshot function * Update usage * Fix usage --------- Co-authored-by: Carlos Delgado <6339205+carlosdelest@users.noreply.github.com> Co-authored-by: elasticsearchmachine <infra-root+elasticsearchmachine@elastic.co> Co-authored-by: Aurélien FOUCRET <aurelien.foucret@gmail.com> Co-authored-by: Ioana Tagirta <ioanatia@users.noreply.github.com>

elasticsearchmachine added the v9.1.0 label May 2, 2025

github-actions bot deployed to docs-preview May 6, 2025 17:55 View deployment

kderusso added 3 commits May 6, 2025 15:31

Initial commit of match_phrase

3bcc654

Add MatchPhraseQueryTests

baee81b

First pass at CSV specs

13ccda7

kderusso force-pushed the kderusso/esql-match-phrase branch from dabef06 to 13ccda7 Compare May 6, 2025 19:32

github-actions bot deployed to docs-preview May 6, 2025 19:32 View deployment

kderusso added :SearchOrg/Relevance Label for the Search (solution/org) Relevance team >enhancement labels May 7, 2025

Update docs/changelog/127661.yaml

c8e6770

kderusso removed the :SearchOrg/Relevance Label for the Search (solution/org) Relevance team label May 7, 2025

github-actions bot deployed to docs-preview May 7, 2025 18:17 View deployment

kderusso added :Search Relevance/Search Catch all for Search Relevance :SearchOrg/Relevance Label for the Search (solution/org) Relevance team and removed :Search Relevance/Search Catch all for Search Relevance labels May 7, 2025

github-actions bot deployed to docs-preview May 8, 2025 17:24 View deployment

github-actions bot deployed to docs-preview May 8, 2025 17:32 View deployment

github-actions bot deployed to docs-preview May 8, 2025 18:16 View deployment

Refactor so MatchPhrase doesn't use all fulltext test cases, just tex…

d02864e

…t only

kderusso force-pushed the kderusso/esql-match-phrase branch from 8f01955 to d02864e Compare May 8, 2025 20:11

github-actions bot deployed to docs-preview May 8, 2025 20:12 View deployment

Fix tests

49ae77f

github-actions bot deployed to docs-preview May 8, 2025 21:01 View deployment

Merge main

9769fca

github-actions bot deployed to docs-preview May 8, 2025 21:03 View deployment

kderusso added 3 commits May 9, 2025 15:18

Add some CSV test cases

5f14d2e

Fix test

8095a28

Merge branch 'main' into kderusso/esql-match-phrase

6ff795b

github-actions bot deployed to docs-preview May 9, 2025 19:21 View deployment

carlosdelest reviewed Jun 2, 2025

View reviewed changes

kderusso and others added 3 commits June 2, 2025 09:47

PR feedback

1cc6eba

PR feedback

77c9fbf

[CI] Auto commit changes from spotless

6983392

ioanatia mentioned this pull request Jun 3, 2025

ESQL - full text functions verifier tests refactor #128775

Merged

kderusso and others added 5 commits June 3, 2025 11:34

Add check to MatchPhrase tests

f94faeb

Merge from main and resolve merge conflicts

553fb02

Fix merge errors

373c8eb

[CI] Auto commit changes from spotless

b9410f4

Test generated docs

7db150f

ioanatia removed the test-release Trigger CI checks against release build label Jun 4, 2025

Merge branch 'main' into kderusso/esql-match-phrase

1051aed

kderusso requested a review from carlosdelest June 4, 2025 13:57

ioanatia approved these changes Jun 4, 2025

View reviewed changes

carlosdelest approved these changes Jun 4, 2025

View reviewed changes

kderusso added 2 commits June 4, 2025 11:00

Add additional verifier tests

e680538

Merge from main

39839e4

kderusso merged commit eee423a into elastic:main Jun 4, 2025
18 checks passed

elasticsearchmachine added the backport pending label Jun 4, 2025

kderusso mentioned this pull request Jun 10, 2025

[8.19] [ES|QL] Add MATCH_PHRASE (#127661) #129215

Merged

kderusso removed the backport pending label Jun 12, 2025

dnhatn mentioned this pull request Jun 13, 2025

[CI] EsqlClientYamlIT class failing #129299

Closed

carlosdelest mentioned this pull request Jun 16, 2025

ES|QL: Add support for match_phrase #125012

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[ES|QL] Add MATCH_PHRASE #127661

[ES|QL] Add MATCH_PHRASE #127661

Uh oh!

kderusso commented May 2, 2025 •

edited

Loading

elasticsearchmachine commented May 7, 2025

carlosdelest left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

carlosdelest Jun 2, 2025

carlosdelest Jun 2, 2025

ioanatia commented Jun 4, 2025

ioanatia commented Jun 4, 2025

carlosdelest left a comment

Uh oh!

elasticsearchmachine commented Jun 4, 2025

kderusso commented Jun 10, 2025

kderusso commented Jun 10, 2025

Labels

5 participants

[ES|QL] Add MATCH_PHRASE #127661

[ES|QL] Add MATCH_PHRASE #127661

Uh oh!

Conversation

kderusso commented May 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

elasticsearchmachine commented May 7, 2025

carlosdelest left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

carlosdelest Jun 2, 2025

Choose a reason for hiding this comment

carlosdelest Jun 2, 2025

Choose a reason for hiding this comment

ioanatia commented Jun 4, 2025

ioanatia commented Jun 4, 2025

carlosdelest left a comment

Choose a reason for hiding this comment

Uh oh!

elasticsearchmachine commented Jun 4, 2025

💔 Backport failed

kderusso commented Jun 10, 2025

💚 All backports created successfully

Questions ?

kderusso commented Jun 10, 2025

Labels

5 participants

kderusso commented May 2, 2025 •

edited

Loading