elasticsearch/docs/reference/query-languages/esql/_snippets/functions/categorize.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

51 lines
1.2 KiB
Markdown
Raw Normal View History

## `CATEGORIZE` [esql-categorize]
::::{warning}
Do not use on production environments. 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.
::::
**Syntax**
:::{image} ../../../../../images/categorize.svg
:alt: Embedded
:class: text-center
:::
**Parameters**
`field`
: Expression to categorize
**Description**
Groups text messages into categories of similarly formatted text values.
`CATEGORIZE` has the following limitations:
* cant be used within other expressions
* cant be used with multiple groupings
* cant be used or referenced within aggregate functions
**Supported types**
| field | result |
| --- | --- |
| keyword | keyword |
| text | keyword |
**Example**
This example categorizes server logs messages into categories and aggregates their counts.
```esql
FROM sample_data
| STATS count=COUNT() BY category=CATEGORIZE(message)
```
| count:long | category:keyword |
| --- | --- |
| 3 | .**?Connected.+?to.**? |
| 3 | .**?Connection.+?error.**? |
| 1 | .**?Disconnected.**? |