mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-25 23:57:20 -04:00
1541da5e65
This modifies the ESQL test infrastructure to generate more of the documentation for functions. It generates the *Description* section, the *Examples* section, and the *Parameters* section as separate files so we can use them as needed. It also generates a `layout` file that's just a guess as to how to render the whole thing. In some cases it'll work and we can use that instead of hand maintaining a "top level" description file for the function. Most newly generated files are unused. We have to chose to pick them up by replacing the sections we were manually maintaining with an include of the generated section. Or by replacing the entire hand maintained file with the generated top level file. Relates to #104247
42 lines
786 B
Text
42 lines
786 B
Text
[discrete]
|
|
[[esql-replace]]
|
|
=== `REPLACE`
|
|
|
|
*Syntax*
|
|
|
|
[.text-center]
|
|
image::esql/functions/signature/replace.svg[Embedded,opts=inline]
|
|
|
|
*Parameters*
|
|
|
|
`str`::
|
|
String expression.
|
|
|
|
`regex`::
|
|
Regular expression.
|
|
|
|
`newStr`::
|
|
Replacement string.
|
|
|
|
*Description*
|
|
|
|
The function substitutes in the string `str` any match of the regular expression
|
|
`regex` with the replacement string `newStr`.
|
|
|
|
If any of the arguments is `null`, the result is `null`.
|
|
|
|
include::types/replace.asciidoc[]
|
|
|
|
*Example*
|
|
|
|
This example replaces any occurrence of the word "World" with the word
|
|
"Universe":
|
|
|
|
[source.merge.styled,esql]
|
|
----
|
|
include::{esql-specs}/docs.csv-spec[tag=replaceString]
|
|
----
|
|
[%header.monospaced.styled,format=dsv,separator=|]
|
|
|===
|
|
include::{esql-specs}/docs.csv-spec[tag=replaceString-result]
|
|
|===
|