Skip to content

Commit

Permalink
Change 'colum'/'field' into 'expressions'
Browse files Browse the repository at this point in the history
  • Loading branch information
abdonpijpelink committed Jan 25, 2024
1 parent 14453b0 commit 3750c87
Show file tree
Hide file tree
Showing 12 changed files with 38 additions and 36 deletions.
4 changes: 2 additions & 2 deletions docs/reference/esql/functions/auto_bucket.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@

[source,esql]
----
AUTO_BUCKET(field, buckets, from, to)
AUTO_BUCKET(expression, buckets, from, to)
----

*Parameters*

`field`::
Numeric or date column from which to derive buckets.
Numeric or date expression from which to derive buckets.

`buckets`::
Target number of buckets.
Expand Down
8 changes: 4 additions & 4 deletions docs/reference/esql/functions/avg.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@

[source,esql]
----
AVG(column)
AVG(expression)
----

`column`::
Numeric column. If `null`, the function returns `null`.
`expression`::
Numeric expression. If `null`, the function returns `null`.

*Description*

The average of a numeric field.
The average of a numeric expression.

*Supported types*

Expand Down
10 changes: 5 additions & 5 deletions docs/reference/esql/functions/mv_avg.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,18 @@

[source,esql]
----
MV_AVG(field)
MV_AVG(expression)
----

*Parameters*

`field`::
Column to convert from multiple values to single value.
`expression`::
Multivalue expression.

*Description*

Converts a multivalued column into a single valued column containing the average
of all of the values.
Converts a multivalued expression into a single valued column containing the
average of all of the values.

*Supported types*

Expand Down
6 changes: 3 additions & 3 deletions docs/reference/esql/functions/mv_concat.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ image::esql/functions/signature/mv_concat.svg[Embedded,opts=inline]
*Parameters*

`v`::
Column to convert from multiple values to single value.
Multivalue expression.

`delim`::
Delimiter.

*Description*

Converts a multivalued string column into a single valued column containing the
concatenation of all values separated by a delimiter.
Converts a multivalued string expression into a single valued column containing
the concatenation of all values separated by a delimiter.

*Supported types*

Expand Down
6 changes: 3 additions & 3 deletions docs/reference/esql/functions/mv_count.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ image::esql/functions/signature/mv_count.svg[Embedded,opts=inline]
*Parameters*

`v`::
Column to convert from multiple values to single value.
Multivalue expression.

*Description*

Converts a multivalued column into a single valued column containing a count of
the number of values.
Converts a multivalued expression into a single valued column containing a count
of the number of values.

*Supported types*

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/esql/functions/mv_dedupe.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ image::esql/functions/signature/mv_dedupe.svg[Embedded,opts=inline]
*Parameters*

`v`::
Column to deduplicate.
Multivalue expression.

*Description*

Removes duplicates from a multivalued column.
Removes duplicates from a multivalue expression.

NOTE: `MV_DEDUPE` may, but won't always, sort the values in the column.

Expand Down
18 changes: 10 additions & 8 deletions docs/reference/esql/functions/mv_first.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,20 @@ image::esql/functions/signature/mv_first.svg[Embedded,opts=inline]
*Parameters*

`v`::
Multivalue from which to return the first value.
Multivalue expression.

*Description*

Converts a multivalued field into a single valued field containing the first value. This is most
useful when reading from a function that emits multivalued fields in a known order like <<esql-split>>:
Converts a multivalued expression into a single valued column containing the
first value. This is most useful when reading from a function that emits
multivalued columns in a known order like <<esql-split>>:

The order that <<esql-multivalued-fields, multivalued fields>> are read from underlying storage is not
guaranteed. It is *frequently* ascending, but don't rely on that. If you need the minimum field value
use <<esql-mv_min>> instead of `MV_FIRST`. `MV_MIN` has optimizations for sorted values so there isn't
a performance benefit to `MV_FIRST`. `MV_FIRST` is mostly useful with functions that create multivalued
fields like `SPLIT`.
The order that <<esql-multivalued-fields, multivalued fields>> are read from
underlying storage is not guaranteed. It is *frequently* ascending, but don't
rely on that. If you need the minimum value use <<esql-mv_min>> instead of
`MV_FIRST`. `MV_MIN` has optimizations for sorted values so there isn't a
performance benefit to `MV_FIRST`. `MV_FIRST` is mostly useful with functions
that create multivalued columns like `SPLIT`.

*Supported types*

Expand Down
6 changes: 3 additions & 3 deletions docs/reference/esql/functions/mv_last.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,18 @@ image::esql/functions/signature/mv_last.svg[Embedded,opts=inline]
*Parameters*

`v`::
Multivalue from which to return the last value.
Multivalue expression.

*Description*

Converts a multivalued field into a single valued field containing the last value. This is most
Converts a multivalue expression into a single valued column containing the last value. This is most
useful when reading from a function that emits multivalued fields in a known order like <<esql-split>>:

The order that <<esql-multivalued-fields, multivalued fields>> are read from underlying storage is not
guaranteed. It is *frequently* ascending, but don't rely on that. If you need the maximum field value
use <<esql-mv_max>> instead of `MV_LAST`. `MV_MAX` has optimizations for sorted values so there isn't
a performance benefit to `MV_LAST`. `MV_LAST` is mostly useful with functions that create multivalued
fields like `SPLIT`.
columns like `SPLIT`.

*Supported types*

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/esql/functions/mv_max.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ image::esql/functions/signature/mv_max.svg[Embedded,opts=inline]
*Parameters*

`v`::
Column to convert from multiple values to single value.
Multivalue expression.

*Description*

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/esql/functions/mv_median.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ MV_MEDIAN(v)
*Parameters*

`v`::
Column to convert from multiple values to single value.
Multivalue expression.

*Description*

Expand Down
6 changes: 3 additions & 3 deletions docs/reference/esql/functions/mv_min.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ image::esql/functions/signature/mv_min.svg[Embedded,opts=inline]
*Parameters*

`v`::
Column to convert from multiple values to single value.
Multivalue expression.

*Description*

Converts a multivalued column into a single valued column containing the minimum
value.
Converts a multivalued expression into a single valued column containing the
minimum value.

*Supported types*

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/esql/functions/mv_sum.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ MV_SUM(v)
*Parameters*

`v`::
Column to convert from multiple values to single value.
Multivalue expression.

*Description*

Expand Down

0 comments on commit 3750c87

Please sign in to comment.