Match, Like and RLike operators improved docs #120504
Merged
Conversation
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
carlosdelest
added
>docs
|
Documentation preview: |
carlosdelest
changed the title
…ed-docs' into docs/match-operator-improved-docs
|
Pinging @elastic/es-docs (Team:Docs) |
|
Pinging @elastic/es-analytical-engine (Team:Analytics) |
|
Pinging @elastic/kibana-esql (ES|QL-ui) |
...ugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/Match.java
Outdated
Show resolved
Hide resolved
...l/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/MatchOperator.java
Outdated
Show resolved
Hide resolved
| * Unlike other ESQL functions, Match is both a function and an operator. This class provides implementation for both, | ||
| * but the operator documentation is generated in {@link MatchOperator}. | ||
| */ | ||
| public class Match extends FullTextFunction implements PostOptimizationVerificationAware { |
There was a problem hiding this comment.
I do wonder if Match should be abstract, with a MatchFunction and MatchOperator subclasses? Which would make the distinction between them more obvious.
There was a problem hiding this comment.
That's something we didn't do back in the day, mostly because there were fewer differences. I think it makes sense now.
I implemented that separation in ed10886. @fang-xing-esql @ChrisHegarty , do you think it makes sense?
…an focus on the differences
9 tasks
carlosdelest
requested review from
afoucret,
fang-xing-esql,
ioanatia and
tteofili
carlosdelest
added a commit
to carlosdelest/elasticsearch
that referenced
this pull request
Jan 24, 2025
💔 Backport failed
You can use sqren/backport to manually backport by running |
elasticsearchmachine
pushed a commit
that referenced
this pull request
Jan 24, 2025
carlosdelest
added a commit
to carlosdelest/elasticsearch
that referenced
this pull request
Jan 24, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Match is both a function and an operator. This caused some problems rendering docs as functions are not expected to be both.
This PR creates a new
MatchOperatorclass that contains the updatedFunctionInfoannotation for the operator, thus separating the Match function and the operator.MatchOperatorTestshave been modified so the newMatchOperatorclass is used to generate the docs.LIKEandRLIKEoperators are marked as such as well in this PR