Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] EQL: Document Unicode escape sequences #70694

Merged
merged 6 commits into from
Mar 23, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion docs/reference/eql/syntax.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -410,6 +410,14 @@ double quote (`"`), must be escaped with a preceding backslash (`\`).
|`\"` | Double quote (`"`)
|====

You can escape Unicode characters using a hexadecimal `\u{XXXXXXXX}` escape
sequence. The hexadecimal value can be 2-8 characters and is case-insensitive.
Values shorter than 8 characters are zero-padded. You can use these escape
sequences to include non-printable or right-to-left (RTL) characters in your
strings. For example, you can escape a
{wikipedia}/Right-to-left_mark[right-to-left mark (RLM)] as `\u{200f}`,
`\u{200F}`, or `\u{0000200f}`.

IMPORTANT: The single quote (`'`) character is reserved for future use. You
cannot use an escaped single quote (`\'`) for literal strings. Use an escaped
double quote (`\"`) instead.
Expand Down Expand Up @@ -827,7 +835,7 @@ sub-fields of a `nested` field. However, data streams and indices containing
follows:

* In {es} EQL, most operators are case-sensitive. For example,
`process_name == "cmd.exe"` is not equivalent to
`process_name == "cmd.exe"` is not equivalent to
`process_name == "Cmd.exe"`.

* In {es} EQL, functions are case-sensitive. To make a function
Expand Down