Skip to content

[DOCS] EQL: Document startsWith function#54518

Merged
jrodewig merged 7 commits intoelastic:masterfrom
jrodewig:docs__eql-fn-startswith
Apr 1, 2020
Merged

[DOCS] EQL: Document startsWith function#54518
jrodewig merged 7 commits intoelastic:masterfrom
jrodewig:docs__eql-fn-startswith

Conversation

@jrodewig
Copy link
Copy Markdown
Contributor

Adds documentation for the EQL startsWith function.

Relates to #54400

@jrodewig jrodewig added >docs General docs changes :Analytics/EQL EQL querying labels Mar 31, 2020
@jrodewig jrodewig requested a review from astefan March 31, 2020 16:03
@elasticmachine
Copy link
Copy Markdown
Collaborator

Pinging @elastic/es-ql (:Query Languages/EQL)

@elasticmachine
Copy link
Copy Markdown
Collaborator

Pinging @elastic/es-docs (>docs)

Copy link
Copy Markdown
Contributor

@astefan astefan left a comment

Choose a reason for hiding this comment

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

LGTM. Left one comment. Thank you @jrodewig

[[eql-fn-startswith]]
=== `startsWith`

Returns `true` if a source string begins with a provided substring.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

One important bit to mention is that the function is case insensitive. Not sure if it will always be like this but, for the moment, it's ignoring case sensitivity.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Good catch @astefan. I noted this and added an example with b7d36ca.

@jrodewig
Copy link
Copy Markdown
Contributor Author

jrodewig commented Apr 1, 2020

Thanks @astefan.

@astefan
Copy link
Copy Markdown
Contributor

astefan commented Apr 1, 2020

@jrodewig please, also, see #54521 (comment). Apologies, I noticed this aspect when I reviewed endsWith function and haven't gotten back to others.

@jrodewig
Copy link
Copy Markdown
Contributor Author

jrodewig commented Apr 1, 2020

Thanks @astefan. I'll update to address support for text fields with a keyword sub-field. Thanks for raising!

@jrodewig jrodewig merged commit d614b7f into elastic:master Apr 1, 2020
@jrodewig jrodewig deleted the docs__eql-fn-startswith branch April 1, 2020 13:15
@jrodewig
Copy link
Copy Markdown
Contributor Author

jrodewig commented Apr 1, 2020

Backport commits

master d614b7f
7.x 95622d8

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

:Analytics/EQL EQL querying >docs General docs changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants