Skip to content

[8.x] [DOCS] [8.x] Update esql-lookup-join.md to mention index mode requirement (#126905) #126907

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 16, 2025
Merged

[8.x] [DOCS] [8.x] Update esql-lookup-join.md to mention index mode requirement (#126905) #126907

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/reference/esql/esql-lookup-join.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,8 @@ image::images/esql/esql-lookup-join.png[align="center"]
lookup_index::
The name of the lookup index. This must
be a specific index name - wildcards, aliases, and remote cluster
references are not supported.
references are not supported. Indices used for lookups must be configured with the <<index-mode-setting,`lookup` mode>>.


[[esql-lookup-join-field-name]]
field_name::
Expand Down Expand Up @@ -142,6 +143,7 @@ any particular order. If a certain order is required, users should use a

To use `LOOKUP JOIN`, the following requirements must be met:

* Indices used for lookups must be configured with the <<index-mode-setting,`lookup` mode>>
* *Compatible data types*: The join key and join field in the lookup
index must have compatible data types. This means:
** The data types must either be identical or be internally represented
Expand All @@ -166,7 +168,7 @@ representations, see the <<esql-supported-types,Supported Field Types documentat

The following are the current limitations with `LOOKUP JOIN`

* Indices in <<index-mode-setting,lookup>> mode are always single-sharded.
* Indices in <<index-mode-setting,`lookup`>> mode are always single-sharded.
* Cross cluster search is unsupported initially. Both source and lookup indices
must be local.
* Currently, only matching on equality is supported.
Expand Down