From 1954663c143c5564b562f92cbed3ce59480ab150 Mon Sep 17 00:00:00 2001 From: Liam Thompson Date: Mon, 29 Sep 2025 13:09:27 +0200 Subject: [PATCH] [ESQL] Docs clarify counts are approximate in count_distinct docs (#135600) need to make this visible in Kibana inline docs --- .../esql/_snippets/functions/description/count_distinct.md | 5 +++++ .../esql/kibana/definition/functions/count_distinct.json | 1 + .../esql/kibana/docs/functions/count_distinct.md | 2 ++ .../esql/expression/function/aggregate/CountDistinct.java | 2 ++ 4 files changed, 10 insertions(+) diff --git a/docs/reference/query-languages/esql/_snippets/functions/description/count_distinct.md b/docs/reference/query-languages/esql/_snippets/functions/description/count_distinct.md index 9fbe109fa55bb..a4005b3f295ee 100644 --- a/docs/reference/query-languages/esql/_snippets/functions/description/count_distinct.md +++ b/docs/reference/query-languages/esql/_snippets/functions/description/count_distinct.md @@ -4,3 +4,8 @@ Returns the approximate number of distinct values. +::::{note} +[Counts are approximate](/reference/query-languages/esql/functions-operators/aggregation-functions.md#esql-agg-count-distinct-approximate). +:::: + + diff --git a/docs/reference/query-languages/esql/kibana/definition/functions/count_distinct.json b/docs/reference/query-languages/esql/kibana/definition/functions/count_distinct.json index 894049ac826fb..d3add63ab353e 100644 --- a/docs/reference/query-languages/esql/kibana/definition/functions/count_distinct.json +++ b/docs/reference/query-languages/esql/kibana/definition/functions/count_distinct.json @@ -3,6 +3,7 @@ "type" : "agg", "name" : "count_distinct", "description" : "Returns the approximate number of distinct values.", + "note" : "Counts are approximate.", "signatures" : [ { "params" : [ diff --git a/docs/reference/query-languages/esql/kibana/docs/functions/count_distinct.md b/docs/reference/query-languages/esql/kibana/docs/functions/count_distinct.md index 0e608b19377b1..67d45b6664830 100644 --- a/docs/reference/query-languages/esql/kibana/docs/functions/count_distinct.md +++ b/docs/reference/query-languages/esql/kibana/docs/functions/count_distinct.md @@ -3,6 +3,8 @@ ### COUNT DISTINCT Returns the approximate number of distinct values. +Note: [Counts are approximate](https://www.elastic.co/docs/reference/query-languages/esql/functions-operators/aggregation-functions#esql-agg-count-distinct-approximate). + ```esql FROM hosts | STATS COUNT_DISTINCT(ip0), COUNT_DISTINCT(ip1) diff --git a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/aggregate/CountDistinct.java b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/aggregate/CountDistinct.java index 2dd3acc600d26..871c45952067a 100644 --- a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/aggregate/CountDistinct.java +++ b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/aggregate/CountDistinct.java @@ -77,6 +77,8 @@ public class CountDistinct extends AggregateFunction implements OptionalArgument @FunctionInfo( returnType = "long", description = "Returns the approximate number of distinct values.", + note = "[Counts are approximate](/reference/query-languages/esql/functions-operators/" + + "aggregation-functions.md#esql-agg-count-distinct-approximate).", appendix = """ ### Counts are approximate [esql-agg-count-distinct-approximate]