Skip to content

ES|QL: Add default values for match function options #125282

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 6 commits into from
Mar 21, 2025
Merged

ES|QL: Add default values for match function options #125282

merged 6 commits into from
Mar 21, 2025

Conversation

carlosdelest
Copy link
Member

This PR adds documentation for MATCH default values

@carlosdelest carlosdelest added >docs General docs changes Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo) auto-backport Automatically create backport pull requests when merged :Analytics/ES|QL AKA ESQL v9.0.0 v8.18.0 v8.19.0 v9.1.0 labels Mar 20, 2025
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@elasticsearchmachine elasticsearchmachine added the Team:Docs Meta label for docs team label Mar 20, 2025
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-analytical-engine (Team:Analytics)

ioanatia
ioanatia reviewed Mar 20, 2025
View reviewed changes
...ugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/Match.java Outdated
type = "keyword",
valueHint = { "none", "all" },
description = "Number of beginning characters left unchanged for fuzzy matching."
description = "Number of beginning characters left unchanged for fuzzy matching. Defaults to none."
Copy link
Contributor

@ioanatia ioanatia Mar 20, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

this is not the right doc string for zero_terms_query - it seems to be a copy of the one we have for prefix_length.

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks for the catch! Fixed in a6bb85d

@carlosdelest
Copy link
Member Author

@elasticmachine update branch

@leemthompo
Copy link
Contributor

@carlosdelest The annoying thing about the docs migration is that we can't backport docs changes from main/9.0 to 8.x anymore and will have to make those changes in a separate PR, because it's asciidoc all the way down on 8.x

@leemthompo
Copy link
Contributor

But maybe can backport manually, delete the .md files and use the updated java code to generate the asciidoc changes? @craigtaverner would that work?

@craigtaverner
Copy link
Contributor

But maybe can backport manually, delete the .md files and use the updated java code to generate the asciidoc changes? @craigtaverner would that work?

Yes. The manual backport to 8.x should start with only the changes to Match.java and then re-run MatchTests to re-generate the asciidoc versions of the documentation, and then commit those.

Just to confirm, automatic backporting any PR between main and 8.x will fail (or should fail) if it includes any documentation changes.

@carlosdelest
Copy link
Member Author

@craigtaverner @leemthompo Yes, the plan was to do a manual regeneration of the docs on the 8.x branches 👍

@carlosdelest carlosdelest merged commit 160ac69 into elastic:main Mar 21, 2025
16 checks passed
@carlosdelest carlosdelest mentioned this pull request Mar 21, 2025
Merged
carlosdelest added a commit to carlosdelest/elasticsearch that referenced this pull request Mar 21, 2025
@carlosdelest
ES|QL: Add default values for match function options (elastic#125282)
4ddbe0c
@elasticsearchmachine
Copy link
Collaborator

💔 Backport failed

Status Branch Result
✅ 9.0
❌ 8.18 Commit could not be cherrypicked due to conflicts
❌ 8.x Commit could not be cherrypicked due to conflicts

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

elasticsearchmachine pushed a commit that referenced this pull request Mar 21, 2025
@carlosdelest
ES|QL: Add default values for match function options (#125282) (#125371)
b08a6c0
afoucret pushed a commit to afoucret/elasticsearch that referenced this pull request Mar 21, 2025
@carlosdelest @afoucret
ES|QL: Add default values for match function options (elastic#125282)
cd7927b
@carlosdelest carlosdelest mentioned this pull request Mar 21, 2025
Merged
carlosdelest added a commit to carlosdelest/elasticsearch that referenced this pull request Mar 21, 2025
@carlosdelest
ES|QL: Add default values for match function options (elastic#125282)
248165e 
(cherry picked from commit 160ac69)

# Conflicts:
#	docs/reference/query-languages/esql/_snippets/functions/functionNamedParams/match.md
@carlosdelest
Copy link
Member Author

💔 Some backports could not be created

Status Branch Result
✅ 8.x
❌ 8.18 An unhandled error occurred. Please see the logs for details

Manual backport

To create the backport manually run:

backport --pr 125282

Questions ?

Please refer to the Backport tool documentation

@carlosdelest carlosdelest mentioned this pull request Mar 21, 2025
Merged
@carlosdelest
Copy link
Member Author

💚 All backports created successfully

Status Branch Result
✅ 8.18

Questions ?

Please refer to the Backport tool documentation

carlosdelest added a commit to carlosdelest/elasticsearch that referenced this pull request Mar 21, 2025
@carlosdelest
ES|QL: Add default values for match function options (elastic#125282)
6c935e8 
(cherry picked from commit 160ac69)

# Conflicts:
#	docs/reference/query-languages/esql/_snippets/functions/functionNamedParams/match.md
elasticsearchmachine pushed a commit that referenced this pull request Mar 21, 2025
@carlosdelest
ES|QL: Add default values for match function options (#125282) (#125411)
a259503 
(cherry picked from commit 160ac69)

# Conflicts:
#	docs/reference/query-languages/esql/_snippets/functions/functionNamedParams/match.md
elasticsearchmachine pushed a commit that referenced this pull request Mar 21, 2025
@carlosdelest
ES|QL: Add default values for match function options (#125282) (#125405)
4dbed7e 
(cherry picked from commit 160ac69)

# Conflicts:
#	docs/reference/query-languages/esql/_snippets/functions/functionNamedParams/match.md
smalyshev pushed a commit to smalyshev/elasticsearch that referenced this pull request Mar 21, 2025
@carlosdelest @smalyshev
ES|QL: Add default values for match function options (elastic#125282)
877e1ed
omricohenn pushed a commit to omricohenn/elasticsearch that referenced this pull request Mar 28, 2025
@carlosdelest @omricohenn
ES|QL: Add default values for match function options (elastic#125282)
1f2e253
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ioanatia ioanatia ioanatia approved these changes

@tteofili tteofili Awaiting requested review from tteofili

@afoucret afoucret Awaiting requested review from afoucret

@ChrisHegarty ChrisHegarty Awaiting requested review from ChrisHegarty

@svilen-mihaylov-elastic svilen-mihaylov-elastic Awaiting requested review from svilen-mihaylov-elastic

@fang-xing-esql fang-xing-esql Awaiting requested review from fang-xing-esql

Assignees

No one assigned

Labels

:Analytics/ES|QL AKA ESQL auto-backport Automatically create backport pull requests when merged backport pending >docs General docs changes Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo) Team:Docs Meta label for docs team v8.18.0 v8.19.0 v9.0.0 v9.1.0

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@carlosdelest @elasticsearchmachine @leemthompo @craigtaverner @ioanatia @elasticmachine