Skip to content

Commit

Permalink
[DOCS] EQL: Document string function (#55086)
Browse files Browse the repository at this point in the history
  • Loading branch information
jrodewig committed Apr 13, 2020
1 parent f0b6cf4 commit 57d6493
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions docs/reference/eql/functions.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ experimental::[]
* <<eql-fn-endswith>>
* <<eql-fn-length>>
* <<eql-fn-startswith>>
* <<eql-fn-string>>
* <<eql-fn-substring>>
* <<eql-fn-wildcard>>

Expand Down Expand Up @@ -337,6 +338,44 @@ field datatypes:
*Returns:* boolean or `null`
====

[discrete]
[[eql-fn-string]]
=== `string`

Converts a value to a string.

[%collapsible]
====
*Example*
[source,eql]
----
string(42) // returns "42"
string(42.5) // returns "42.5"
string("regsvr32.exe") // returns "regsvr32.exe"
string(true) // returns "true"
// null handling
string(null) // returns null
----
*Syntax*
[source,txt]
----
string(<value>)
----
*Parameters*
`<value>`::
(Required)
Value to convert to a string. If `null`, the function returns `null`.
+
If using a field as the argument, this parameter does not support the
<<text,`text`>> field datatype.
*Returns:* string or `null`
====

[discrete]
[[eql-fn-substring]]
=== `substring`
Expand Down

0 comments on commit 57d6493

Please sign in to comment.