ESQL: Add reference entry for LOOKUP JOIN (#210201)

I couldn't verify if this builds correctly, as I couldn't quickly whip
up a dev environment locally that could build this. Is there a preview
built by the CI?

---------

Co-authored-by: Stratoula Kalafateli <efstratia.kalafateli@elastic.co>
This commit is contained in:
Alexander Spies 2025-02-07 21:39:10 +01:00 committed by GitHub
parent 8ce4eefad5
commit 3915d3310c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 54 additions and 3 deletions

View file

@ -397,10 +397,61 @@ FROM employees
/>
),
},
{
label: i18n.translate('languageDocumentation.documentationESQL.lookupJoin', {
defaultMessage: 'LOOKUP JOIN',
}),
preview: true,
description: (
<Markdown
openLinksInNewTab={true}
markdownContent={i18n.translate(
'languageDocumentation.documentationESQL.lookupJoin.markdown',
{
defaultMessage: `### LOOKUP JOIN
You can use \`LOOKUP JOIN\` to add data from an existing index to incoming rows. While this is similar to \`ENRICH\`, it does not require an enrich policy to be executed beforehand. Additionally, if multiple matching documents are found in the lookup index, they will generate multiple output rows.
\`\`\`
ROW language_code = 1
| LOOKUP JOIN languages ON language_code
\`\`\`
An index that is used in \`LOOKUP JOIN\` needs to be in lookup mode. To create a lookup index, set the index mode to lookup.
\`\`\`
PUT languages
'{
"settings": {
"index":{
"mode":"lookup"
}
}
}'
\`\`\`
The join key field must have a compatible type and match the name of the field in the lookup index to find matching documents. You can use \`RENAME\` or \`EVAL\` to rename columns as needed.
\`\`\`
FROM employees
| EVAL language_code = languages
| LOOKUP JOIN languages ON language_code
\`\`\`
In case of name collisions, the fields from the lookup index will override the existing fields.
`,
ignoreTag: true,
description:
'Text is in markdown. Do not translate function names, special characters, or field names like sum(bytes)',
}
)}
/>
),
},
{
label: i18n.translate('languageDocumentation.documentationESQL.mvExpand', {
defaultMessage: 'MV_EXPAND',
}),
preview: true,
description: (
<Markdown
markdownContent={i18n.translate(

View file

@ -46812,4 +46812,4 @@
"xpack.watcher.watchEdit.thresholdWatchExpression.aggType.fieldIsRequiredValidationMessage": "Ce champ est requis.",
"xpack.watcher.watcherDescription": "Détectez les modifications survenant dans vos données en créant, gérant et monitorant des alertes."
}
}
}

View file

@ -46663,4 +46663,4 @@
"xpack.watcher.watchEdit.thresholdWatchExpression.aggType.fieldIsRequiredValidationMessage": "フィールドを選択してください。",
"xpack.watcher.watcherDescription": "アラートの作成、管理、監視によりデータへの変更を検知します。"
}
}
}

View file

@ -45966,4 +45966,4 @@
"xpack.watcher.watchEdit.thresholdWatchExpression.aggType.fieldIsRequiredValidationMessage": "此字段必填。",
"xpack.watcher.watcherDescription": "通过创建、管理和监测警报来检测数据中的更改。"
}
}
}