SQL: [docs] Add documentation for COALESCE #35740
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
Collaborator
|
Pinging @elastic/es-search-aggs |
astefan
reviewed
Nov 20, 2018
| ---- | ||
| COALESCE ( expression<1>, expression<2>, ... ) | ||
| ---- | ||
|
|
Contributor
There was a problem hiding this comment.
Enumerating the parameters should happen in a section called Input. Also, there has to be an Output section. Something like:
==== `COALESCE`
.Synopsis:
[source, sql]
--------------------------------------------------
COALESCE ( expression<1>, expression<2>, ... )
--------------------------------------------------
*Input*:
<1> 1st expression
<2> 2nd expression
....
*Output*: one expression or `null`
.Description:
Returns the first of its arguments that is not null.
If all arguments are null, then it returns `null`.
Contributor
There was a problem hiding this comment.
Also, I would add in the description (to enforce the ... in the parameters list), that the function can take an arbitrary number of arguments.
Contributor
There was a problem hiding this comment.
The statement about arbitrary number of arguments is there. Please, ignore my comment.
Contributor
Author
|
@astefan Thank you! pushed fixup. |
Contributor
Author
|
Backported to |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 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.
Follows: #35253