[DOCS] EQL: Document substring function
#53867
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
Adds documentation for the EQL `substring` function. Supporting changes: * Creates a new "EQL function reference" page * Updates the title of the "EQL syntax reference" page for consistency * Adds a brief "Functions" section to the EQL syntax docs * Updates EQL limitations docs to state that only array functions are unsupported
|
Pinging @elastic/es-docs (>docs) |
|
Pinging @elastic/es-search (:Search/EQL) |
jrodewig
commented
Mar 20, 2020
|
@costin Cool. I thought that might the case. I'll just keep this PR as a draft until those are fixed up. Thanks! |
|
See #53935 |
jrodewig
changed the title
substring functionsubstring function
|
@elasticmachine update branch |
|
@costin This is ready for review at your convenience. Thanks again! |
costin
approved these changes
Mar 25, 2020
| End position for extraction. If this position is not provided, the function | ||
| returns the remaining string. | ||
| + | ||
| Positions are zero-indexed. Negative offsets are supported. |
There was a problem hiding this comment.
I would add that if the start is higher than the length of the string or end, an empty string is returned.
There was a problem hiding this comment.
Good note. Added with 9d38109.
rw-access
approved these changes
Mar 25, 2020
There was a problem hiding this comment.
LGTM. thanks @jrodewig.
those examples are perfect.
only things that may be worth adding
- https://github.com/elastic/elasticsearch/pull/53867/files#r397951533
- it's implied that the end index is exclusive, and you can tell from the examples. but it could be worthwhile to make this explicit
|
Thanks very much @costin and @rw-access. |
jrodewig
added a commit
that referenced
this pull request
Mar 25, 2020
Adds documentation for the EQL `substring` function. Supporting changes: * Creates a new "EQL function reference" page * Updates the title of the "EQL syntax reference" page for consistency * Adds a brief "Functions" section to the EQL syntax docs * Updates EQL limitations docs to state that only array functions are unsupported
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.
Adds documentation for the EQL
substringfunction.Supporting changes:
unsupported