ESQL: Begin documenting MV behaviors on non-aggs #123917
Open
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
Most functions turn multivalue fields into `null`, but a few "obvious" ones do the "obvious" things. This starts to document these behaviors.
elasticsearchmachine
added
Team:Docs
|
Pinging @elastic/es-docs (Team:Docs) |
|
Pinging @elastic/es-analytical-engine (Team:Analytics) |
nik9000
commented
Mar 3, 2025
| @@ -164,7 +164,9 @@ public static Part resolve(String dateTimeUnit) { | |||
| examples = { @Example(file = "date", tag = "docsDateDiff"), @Example(description = """ | |||
| When subtracting in calendar units - like year, month a.s.o. - only the fully elapsed units are counted. | |||
| To avoid this and obtain also remainders, simply switch to the next smaller unit and do the date math accordingly. | |||
| """, file = "date", tag = "evalDateDiffYearForDocs") } | |||
| """, file = "date", tag = "evalDateDiffYearForDocs"), @Example(description = """ | |||
| If any column is multivalued, this will return a `null` result. | |||
There was a problem hiding this comment.
We'd been considering this behavior to be "undefined" but the null-and-warning behavior as something we may change in the future. I'm not sure that that's really true though - folks may be relying on it even though it's a warning.
nik9000
commented
Mar 3, 2025
ivancea
approved these changes
Mar 5, 2025
| @@ -35,7 +35,8 @@ | |||
| import static org.elasticsearch.xpack.esql.core.type.DataType.NULL; | |||
|
|
|||
| /** | |||
| * Returns the minimum value of multiple columns. | |||
| * Returns the minimum value of multiple columns. This will correctly return the | |||
There was a problem hiding this comment.
Should this doc change be reflected in the FunctionInfo.description instead? Same for Greatest
| @@ -54,7 +54,7 @@ public class DateFormat extends EsqlConfigurationFunction implements OptionalArg | |||
| @FunctionInfo( | |||
| returnType = "keyword", | |||
| description = "Returns a string representation of a date, in the provided format.", | |||
| examples = @Example(file = "date", tag = "docsDateFormat") | |||
| examples = { @Example(file = "date", tag = "docsDateFormat"), @Example(file = "date", tag = "docsDateFormat"), } | |||
There was a problem hiding this comment.
Both examples are identical. Wrong tag?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Most functions turn multivalue fields into
null, but a few "obvious" ones do the "obvious" things. This starts to document these behaviors.