Document ES|QL categorize limitations

elastic · Dec 3, 2024 · 146a76b · 146a76b
1 parent ed1e366
commit 146a76b
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/docs/reference/esql/functions/description/categorize.asciidoc b/docs/reference/esql/functions/description/categorize.asciidoc
diff --git a/...l/src/main/java/org/elasticsearch/xpack/esql/expression/function/grouping/Categorize.java b/...l/src/main/java/org/elasticsearch/xpack/esql/expression/function/grouping/Categorize.java
@@ -48,6 +48,12 @@ public class Categorize extends GroupingFunction implements Validatable {
     @FunctionInfo(
         returnType = "keyword",
         description = "Groups text messages into categories of similarly formatted text values.",
+        detailedDescription = """
+            `CATEGORIZE` has the following limitations:
+
+            * can't be used within other expressions
+            * can't be used with multiple groupings
+            * can't be used or referenced within aggregations""",
         examples = {
             @Example(
                 file = "docs",