diff --git a/docs/reference/eql/functions.asciidoc b/docs/reference/eql/functions.asciidoc index a586dd3ccf0..6664f228145 100644 --- a/docs/reference/eql/functions.asciidoc +++ b/docs/reference/eql/functions.asciidoc @@ -12,6 +12,7 @@ experimental::[] * <> * <> * <> +* <> * <> * <> @@ -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() +---- + +*Parameters* + +``:: +(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 +<> field datatype. + +*Returns:* string or `null` +==== + [discrete] [[eql-fn-substring]] === `substring`