{
  "comment" : "This is generated by ESQL's AbstractFunctionTestCase. Do not edit it. See ../README.md for how to regenerate it.",
  "type" : "scalar",
  "name" : "replace",
  "description" : "The function substitutes in the string `str` any match of the regular expression `regex`\nwith the replacement string `newStr`.",
  "signatures" : [
    {
      "params" : [
        {
          "name" : "string",
          "type" : "keyword",
          "optional" : false,
          "description" : "String expression."
        },
        {
          "name" : "regex",
          "type" : "keyword",
          "optional" : false,
          "description" : "Regular expression."
        },
        {
          "name" : "newString",
          "type" : "keyword",
          "optional" : false,
          "description" : "Replacement string."
        }
      ],
      "variadic" : false,
      "returnType" : "keyword"
    },
    {
      "params" : [
        {
          "name" : "string",
          "type" : "keyword",
          "optional" : false,
          "description" : "String expression."
        },
        {
          "name" : "regex",
          "type" : "keyword",
          "optional" : false,
          "description" : "Regular expression."
        },
        {
          "name" : "newString",
          "type" : "text",
          "optional" : false,
          "description" : "Replacement string."
        }
      ],
      "variadic" : false,
      "returnType" : "keyword"
    },
    {
      "params" : [
        {
          "name" : "string",
          "type" : "keyword",
          "optional" : false,
          "description" : "String expression."
        },
        {
          "name" : "regex",
          "type" : "text",
          "optional" : false,
          "description" : "Regular expression."
        },
        {
          "name" : "newString",
          "type" : "keyword",
          "optional" : false,
          "description" : "Replacement string."
        }
      ],
      "variadic" : false,
      "returnType" : "keyword"
    },
    {
      "params" : [
        {
          "name" : "string",
          "type" : "keyword",
          "optional" : false,
          "description" : "String expression."
        },
        {
          "name" : "regex",
          "type" : "text",
          "optional" : false,
          "description" : "Regular expression."
        },
        {
          "name" : "newString",
          "type" : "text",
          "optional" : false,
          "description" : "Replacement string."
        }
      ],
      "variadic" : false,
      "returnType" : "keyword"
    },
    {
      "params" : [
        {
          "name" : "string",
          "type" : "text",
          "optional" : false,
          "description" : "String expression."
        },
        {
          "name" : "regex",
          "type" : "keyword",
          "optional" : false,
          "description" : "Regular expression."
        },
        {
          "name" : "newString",
          "type" : "keyword",
          "optional" : false,
          "description" : "Replacement string."
        }
      ],
      "variadic" : false,
      "returnType" : "keyword"
    },
    {
      "params" : [
        {
          "name" : "string",
          "type" : "text",
          "optional" : false,
          "description" : "String expression."
        },
        {
          "name" : "regex",
          "type" : "keyword",
          "optional" : false,
          "description" : "Regular expression."
        },
        {
          "name" : "newString",
          "type" : "text",
          "optional" : false,
          "description" : "Replacement string."
        }
      ],
      "variadic" : false,
      "returnType" : "keyword"
    },
    {
      "params" : [
        {
          "name" : "string",
          "type" : "text",
          "optional" : false,
          "description" : "String expression."
        },
        {
          "name" : "regex",
          "type" : "text",
          "optional" : false,
          "description" : "Regular expression."
        },
        {
          "name" : "newString",
          "type" : "keyword",
          "optional" : false,
          "description" : "Replacement string."
        }
      ],
      "variadic" : false,
      "returnType" : "keyword"
    },
    {
      "params" : [
        {
          "name" : "string",
          "type" : "text",
          "optional" : false,
          "description" : "String expression."
        },
        {
          "name" : "regex",
          "type" : "text",
          "optional" : false,
          "description" : "Regular expression."
        },
        {
          "name" : "newString",
          "type" : "text",
          "optional" : false,
          "description" : "Replacement string."
        }
      ],
      "variadic" : false,
      "returnType" : "keyword"
    }
  ],
  "examples" : [
    "ROW str = \"Hello World\"\n| EVAL str = REPLACE(str, \"World\", \"Universe\")\n| KEEP str"
  ],
  "preview" : false,
  "snapshot_only" : false
}