Skip to content

[DOCS] Update esql-lookup-join.md to mention index mode requirement #126901

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 8 commits into from
Apr 16, 2025
Merged

[DOCS] Update esql-lookup-join.md to mention index mode requirement #126901

Changes from 4 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
6f0362d
[DOCS] Update esql-lookup-join.md to mention index mode requirement
leemthompo Apr 16, 2025
de3aeeb
Update docs/reference/query-languages/esql/esql-lookup-join.md
leemthompo Apr 16, 2025
6073827
Fix typos
leemthompo Apr 16, 2025
e6a5579
fix url
leemthompo Apr 16, 2025
8aa2b54
so many typos
leemthompo Apr 16, 2025
ef1b357
fix url
leemthompo Apr 16, 2025
4a6afda
I shouldn't have done this PR in the UI
leemthompo Apr 16, 2025
08e307a
fix 8.x page mapping metadata
leemthompo Apr 16, 2025
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/query-languages/esql/esql-lookup-join.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The `LOOKUP JOIN` command adds new columns to a table, with data from {{es}} ind
:::

`<lookup_index>`
: The name of the lookup index. This must be a specific index name - wildcards, aliases, and remote cluster references are not supported.
: The name of the lookup index. This must be a specific index name - wildcards, aliases, and remote cluster references are not supported. Indices used for lookups must be configured with the [`lookup` index mode](/reference/elasticsearch/index-settings/index-modules.md#index-mode-setting).

`<field_name>`
: The field to join on. This field must exist in both your current query results and in the lookup index. If the field contains multi-valued entries, those entries will not match anything (the added fields will contain `null` for those rows).
Expand Down Expand Up @@ -107,6 +107,8 @@ FROM employees

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


* Indices used for lookups must be configured with the [`lookup` index mode](https://claude.ai/reference/elasticsearch/index-settings/index-modules.md#index-mode-setting)
* **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 as the same type in {{esql}}
* Numeric types follow these compatibility rules:
Expand All @@ -122,7 +124,7 @@ For a complete list of supported data types and their internal representations,

The following are the current limitations with `LOOKUP JOIN`

* Indices in [lookup](/reference/elasticsearch/index-settings/index-modules.md#index-mode-setting) mode are always single-sharded.
* Indices in [`lookup` mode](/reference/elasticsearch/index-settings/index-modules.md#index-mode-setting) 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.
* `LOOKUP JOIN` can only use a single match field and a single index. Wildcards, aliases, datemath, and datastreams are not supported.
Expand Down
Loading