Skip to content

Commit ed86d57

Browse files
committed
updates
1 parent 5015be2 commit ed86d57

File tree

2 files changed

+20
-4
lines changed

2 files changed

+20
-4
lines changed

docs/reference/query-languages/esql/esql-commands.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -665,10 +665,19 @@ FROM employees
665665

666666
## `LOOKUP JOIN` [esql-lookup-join]
667667

668-
`LOOKUP JOIN` is useful for any scenario where you need to pull in information from a lookup index to streamline data enrichment and analysis.
668+
::::{warning}
669+
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
670+
::::
671+
672+
`LOOKUP JOIN` enables you to add data from another index, AKA a 'lookup' index, to your {esql} query results, simplifying data enrichment and analysis workflows.
669673

670674
**Syntax**
671675

676+
```
677+
FROM <source_index>
678+
| LOOKUP JOIN <lookup_index> ON <field_name>
679+
```
680+
672681
```esql
673682
FROM firewall_logs
674683
| LOOKUP JOIN threat_list ON source.IP
@@ -677,11 +686,18 @@ FROM firewall_logs
677686

678687
**Parameters**
679688

680-
TBD
689+
`<lookup_index>`
690+
: The name of the lookup index. This must be a specific index name - wildcards, aliases, and remote cluster references are not supported.
691+
`<field_name>`
692+
: 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).
681693

682694
**Description**
683695

684-
TBD
696+
The `LOOKUP JOIN` command adds new columns to your {esql} query results table by finding documents in a lookup index that share the same join field value as your result rows.
697+
698+
For each row in your results table that matches a document in the lookup index based on the join field, all fields from the matching document are added as new columns to that row.
699+
700+
If multiple documents in the lookup index match a single row in your results, the output will contain one row for each matching combination.
685701

686702
**Examples**
687703

docs/reference/query-languages/esql/esql-lookup-join.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ FROM employees
102102

103103
::::
104104

105-
## Prerequisites for LOOKUP JOIN
105+
## Prerequisites [esql-lookup-join-prereqs]
106106

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

0 commit comments

Comments
 (0)