mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-06-30 18:33:26 -04:00
1256a49c3a
This copies the first line of the description of each command to just under the syntax so that it's "in order", before the `Parameters` section. That way if you are reading from top to bottom you see: ``` syntax short description parameter names and descriptions long description examples ``` I've also removed the `Description` section entirely if the description was just one sentence. So in some cases that just isn't `long description`.
108 lines
3.3 KiB
Text
108 lines
3.3 KiB
Text
[discrete]
|
|
[[esql-enrich]]
|
|
=== `ENRICH`
|
|
|
|
`ENRICH` enables you to add data from existing indices as new columns using an
|
|
enrich policy.
|
|
|
|
**Syntax**
|
|
|
|
[source,esql]
|
|
----
|
|
ENRICH policy [ON match_field] [WITH [new_name1 = ]field1, [new_name2 = ]field2, ...]
|
|
----
|
|
|
|
*Parameters*
|
|
|
|
`policy`::
|
|
The name of the enrich policy. You need to <<esql-set-up-enrich-policy,create>>
|
|
and <<esql-execute-enrich-policy,execute>> the enrich policy first.
|
|
|
|
`mode`::
|
|
The mode of the enrich command in cross cluster {esql}.
|
|
See <<ccq-enrich, enrich across clusters>>.
|
|
|
|
`match_field`::
|
|
The match field. `ENRICH` uses its value to look for records in the enrich
|
|
index. If not specified, the match will be performed on the column with the same
|
|
name as the `match_field` defined in the <<esql-enrich-policy,enrich policy>>.
|
|
|
|
`fieldX`::
|
|
The enrich fields from the enrich index that are added to the result as new
|
|
columns. If a column with the same name as the enrich field already exists, the
|
|
existing column will be replaced by the new column. If not specified, each of
|
|
the enrich fields defined in the policy is added
|
|
|
|
`new_nameX`::
|
|
Enables you to change the name of the column that's added for each of the enrich
|
|
fields. Defaults to the enrich field name.
|
|
|
|
*Description*
|
|
|
|
`ENRICH` enables you to add data from existing indices as new columns using an
|
|
enrich policy. Refer to <<esql-enrich-data>> for information about setting up a
|
|
policy.
|
|
|
|
image::images/esql/esql-enrich.png[align="center"]
|
|
|
|
TIP: Before you can use `ENRICH`, you need to <<esql-set-up-enrich-policy,create
|
|
and execute an enrich policy>>.
|
|
|
|
*Examples*
|
|
|
|
// tag::examples[]
|
|
The following example uses the `languages_policy` enrich policy to add a new
|
|
column for each enrich field defined in the policy. The match is performed using
|
|
the `match_field` defined in the <<esql-enrich-policy,enrich policy>> and
|
|
requires that the input table has a column with the same name (`language_code`
|
|
in this example). `ENRICH` will look for records in the
|
|
<<esql-enrich-index,enrich index>> based on the match field value.
|
|
|
|
[source.merge.styled,esql]
|
|
----
|
|
include::{esql-specs}/enrich.csv-spec[tag=enrich]
|
|
----
|
|
[%header.monospaced.styled,format=dsv,separator=|]
|
|
|===
|
|
include::{esql-specs}/enrich.csv-spec[tag=enrich-result]
|
|
|===
|
|
|
|
To use a column with a different name than the `match_field` defined in the
|
|
policy as the match field, use `ON <column-name>`:
|
|
|
|
[source.merge.styled,esql]
|
|
----
|
|
include::{esql-specs}/enrich.csv-spec[tag=enrich_on]
|
|
----
|
|
[%header.monospaced.styled,format=dsv,separator=|]
|
|
|===
|
|
include::{esql-specs}/enrich.csv-spec[tag=enrich_on-result]
|
|
|===
|
|
|
|
By default, each of the enrich fields defined in the policy is added as a
|
|
column. To explicitly select the enrich fields that are added, use
|
|
`WITH <field1>, <field2>, ...`:
|
|
|
|
[source.merge.styled,esql]
|
|
----
|
|
include::{esql-specs}/enrich.csv-spec[tag=enrich_with]
|
|
----
|
|
[%header.monospaced.styled,format=dsv,separator=|]
|
|
|===
|
|
include::{esql-specs}/enrich.csv-spec[tag=enrich_with-result]
|
|
|===
|
|
|
|
You can rename the columns that are added using `WITH new_name=<field1>`:
|
|
|
|
[source.merge.styled,esql]
|
|
----
|
|
include::{esql-specs}/enrich.csv-spec[tag=enrich_rename]
|
|
----
|
|
[%header.monospaced.styled,format=dsv,separator=|]
|
|
|===
|
|
include::{esql-specs}/enrich.csv-spec[tag=enrich_rename-result]
|
|
|===
|
|
|
|
In case of name collisions, the newly created columns will override existing
|
|
columns.
|
|
// end::examples[]
|