Skip to content

[DOCS] Update ES|QL applies to's #131805

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Jul 28, 2025
Merged

[DOCS] Update ES|QL applies to's #131805

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
1b4a458
Add applies to to ScalB function in https://github.com/elastic/elasti…
leemthompo Jul 23, 2025
4adffb9
Add applies_to to categorize, follow up to https://github.com/elastic…
leemthompo Jul 23, 2025
7c3dc70
Add version info, following https://github.com/elastic/elasticsearch/…
leemthompo Jul 23, 2025
49783f1
SAMPLE is new + GA in 9.1 https://github.com/elastic/elasticsearch/pu…
leemthompo Jul 24, 2025
c7e87d4
[CI] Auto commit changes from spotless
Jul 24, 2025
310bf86
add applies to for 9.2 option
leemthompo Jul 24, 2025
dedccc1
Merge branch 'esql-applies-tos' of https://github.com/leemthompo/elas…
leemthompo Jul 24, 2025
a36cd8f
fix it
leemthompo Jul 24, 2025
541f764
Merge branch 'main' into esql-applies-tos
leemthompo Jul 24, 2025
df358e0
Merge branch 'main' into esql-applies-tos
leemthompo Jul 24, 2025
f1ca06e
fix checkstyle violations
leemthompo Jul 24, 2025
6131ecc
Merge branch 'main' into esql-applies-tos
leemthompo Jul 24, 2025
3519ce5
Merge branch 'main' into esql-applies-tos
leemthompo Jul 25, 2025
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/reference/query-languages/esql/_snippets/functions/layout/categorize.md
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions docs/reference/query-languages/esql/_snippets/functions/layout/sample.md
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions docs/reference/query-languages/esql/_snippets/functions/layout/scalb.md
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/query-languages/esql/_snippets/functions/parameters/categorize.md
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 5 additions & 1 deletion ...esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/aggregate/Sample.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@
import org.elasticsearch.xpack.esql.core.tree.Source;
import org.elasticsearch.xpack.esql.core.type.DataType;
import org.elasticsearch.xpack.esql.expression.function.Example;
import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesTo;
import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesToLifecycle;
import org.elasticsearch.xpack.esql.expression.function.FunctionInfo;
import org.elasticsearch.xpack.esql.expression.function.FunctionType;
import org.elasticsearch.xpack.esql.expression.function.FunctionUtils;
Expand Down Expand Up @@ -63,7 +65,9 @@ public class Sample extends AggregateFunction implements ToAggregator, PostOptim
"version" },
description = "Collects sample values for a field.",
type = FunctionType.AGGREGATE,
examples = @Example(file = "stats_sample", tag = "doc")
examples = @Example(file = "stats_sample", tag = "doc"),
appliesTo = { @FunctionAppliesTo(lifeCycle = FunctionAppliesToLifecycle.GA, version = "9.1.0") }

)
public Sample(
Source source,
Expand Down
11 changes: 9 additions & 2 deletions ...l/src/main/java/org/elasticsearch/xpack/esql/expression/function/grouping/Categorize.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@
import org.elasticsearch.xpack.esql.core.tree.Source;
import org.elasticsearch.xpack.esql.core.type.DataType;
import org.elasticsearch.xpack.esql.expression.function.Example;
import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesTo;
import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesToLifecycle;
import org.elasticsearch.xpack.esql.expression.function.FunctionInfo;
import org.elasticsearch.xpack.esql.expression.function.FunctionType;
import org.elasticsearch.xpack.esql.expression.function.MapParam;
Expand Down Expand Up @@ -93,14 +95,19 @@ public class Categorize extends GroupingFunction.NonEvaluatableGroupingFunction
tag = "docsCategorize",
description = "This example categorizes server logs messages into categories and aggregates their counts. "
) },
type = FunctionType.GROUPING
type = FunctionType.GROUPING,
appliesTo = {
@FunctionAppliesTo(lifeCycle = FunctionAppliesToLifecycle.PREVIEW, version = "9.0"),
@FunctionAppliesTo(lifeCycle = FunctionAppliesToLifecycle.GA, version = "9.1") }
)
public Categorize(
Source source,
@Param(name = "field", type = { "text", "keyword" }, description = "Expression to categorize") Expression field,
@MapParam(
name = "options",
description = "(Optional) Categorize additional options as <<esql-function-named-params,function named parameters>>.",
description = "(Optional) Categorize additional options as "
+ "<<esql-function-named-params,function named parameters>>. "
+ "{applies_to}`stack: ga 9.2`}",
params = {
@MapParam.MapParamEntry(
name = ANALYZER,
Expand Down
17 changes: 12 additions & 5 deletions ...sql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/math/Scalb.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
import org.elasticsearch.xpack.esql.core.type.DataType;
import org.elasticsearch.xpack.esql.core.util.NumericUtils;
import org.elasticsearch.xpack.esql.expression.function.Example;
import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesTo;
import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesToLifecycle;
import org.elasticsearch.xpack.esql.expression.function.FunctionInfo;
import org.elasticsearch.xpack.esql.expression.function.Param;
import org.elasticsearch.xpack.esql.expression.function.scalar.EsqlScalarFunction;
Expand All @@ -40,11 +42,16 @@ public class Scalb extends EsqlScalarFunction {
private final Expression d;
private final Expression scaleFactor;

@FunctionInfo(returnType = "double", description = """
Returns the result of `d * 2 ^ scaleFactor`,
Similar to Java's `scalb` function. Result is rounded as if
performed by a single correctly rounded floating-point multiply
to a member of the double value set.""", examples = @Example(file = "floats", tag = "scalb"))
@FunctionInfo(
returnType = "double",
description = """
Returns the result of `d * 2 ^ scaleFactor`,
Similar to Java's `scalb` function. Result is rounded as if
performed by a single correctly rounded floating-point multiply
to a member of the double value set.""",
examples = @Example(file = "floats", tag = "scalb"),
appliesTo = { @FunctionAppliesTo(lifeCycle = FunctionAppliesToLifecycle.GA, version = "9.1.0") }
)

public Scalb(
Source source,
Expand Down
Loading