elasticsearch/docs/reference/query-languages/esql/_snippets/functions/locate.md
Colleen McGinnis b7e3a1e14b
[docs] Migrate docs from AsciiDoc to Markdown (#123507)
* delete asciidoc files

* add migrated files

* fix errors

* Disable docs tests

* Clarify release notes page titles

* Revert "Clarify release notes page titles"

This reverts commit 8be688648d.

* Comment out edternal URI images

* Clean up query languages landing pages, link to conceptual docs

* Add .md to url

* Fixes inference processor nesting.

---------

Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com>
Co-authored-by: Liam Thompson <leemthompo@gmail.com>
Co-authored-by: Martijn Laarman <Mpdreamz@gmail.com>
Co-authored-by: István Zoltán Szabó <szabosteve@gmail.com>
2025-02-27 17:56:14 +01:00

960 B

LOCATE [esql-locate]

Syntax

:::{image} ../../../../../images/locate.svg :alt: Embedded :class: text-center :::

Parameters

string
An input string
substring
A substring to locate in the input string
start
The start index

Description

Returns an integer that indicates the position of a keyword substring within another string. Returns 0 if the substring cannot be found. Note that string positions start from 1.

Supported types

string substring start result
keyword keyword integer integer
keyword keyword integer
keyword text integer integer
keyword text integer
text keyword integer integer
text keyword integer
text text integer integer
text text integer

Example

row a = "hello"
| eval a_ll = locate(a, "ll")
a:keyword a_ll:integer
hello 3