Skip to content
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.

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

ESQL: Generate more docs #106367

Merged
merged 7 commits into from
Mar 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
4 changes: 1 addition & 3 deletions docs/reference/esql/functions/abs.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@ Numeric expression. If `null`, the function returns `null`.

Returns the absolute value.

*Supported types*

include::types/abs.asciidoc[]

*Examples*
Expand All @@ -38,4 +36,4 @@ include::{esql-specs}/math.csv-spec[tag=docsAbsEmployees]
[%header.monospaced.styled,format=dsv,separator=|]
|===
include::{esql-specs}/math.csv-spec[tag=docsAbsEmployees-result]
|===
|===
2 changes: 0 additions & 2 deletions docs/reference/esql/functions/acos.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@ Numeric expression. If `null`, the function returns `null`.
Returns the {wikipedia}/Inverse_trigonometric_functions[arccosine] of `n` as an
angle, expressed in radians.

*Supported types*

include::types/acos.asciidoc[]

*Example*
Expand Down
2 changes: 0 additions & 2 deletions docs/reference/esql/functions/asin.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@ Numeric expression. If `null`, the function returns `null`.
Returns the {wikipedia}/Inverse_trigonometric_functions[arcsine] of the input
numeric expression as an angle, expressed in radians.

*Supported types*

include::types/asin.asciidoc[]

*Example*
Expand Down
4 changes: 1 addition & 3 deletions docs/reference/esql/functions/atan.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@ Numeric expression. If `null`, the function returns `null`.
Returns the {wikipedia}/Inverse_trigonometric_functions[arctangent] of the input
numeric expression as an angle, expressed in radians.

*Supported types*

include::types/atan.asciidoc[]

*Example*
Expand All @@ -30,4 +28,4 @@ include::{esql-specs}/floats.csv-spec[tag=atan]
[%header.monospaced.styled,format=dsv,separator=|]
|===
include::{esql-specs}/floats.csv-spec[tag=atan-result]
|===
|===
2 changes: 0 additions & 2 deletions docs/reference/esql/functions/atan2.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,6 @@ Numeric expression. If `null`, the function returns `null`.
The {wikipedia}/Atan2[angle] between the positive x-axis and the ray from the
origin to the point (x , y) in the Cartesian plane, expressed in radians.

*Supported types*

include::types/atan2.asciidoc[]

*Example*
Expand Down
18 changes: 0 additions & 18 deletions docs/reference/esql/functions/binary.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,70 +23,52 @@ include::types/not_equals.asciidoc[]
[.text-center]
image::esql/functions/signature/less_than.svg[Embedded,opts=inline]

Supported types:

include::types/less_than.asciidoc[]

==== Less than or equal to `<=`
[.text-center]
image::esql/functions/signature/less_than_or_equal.svg[Embedded,opts=inline]

Supported types:

include::types/less_than_or_equal.asciidoc[]

==== Greater than `>`
[.text-center]
image::esql/functions/signature/greater_than.svg[Embedded,opts=inline]

Supported types:

include::types/greater_than.asciidoc[]

==== Greater than or equal to `>=`
[.text-center]
image::esql/functions/signature/greater_than_or_equal.svg[Embedded,opts=inline]

Supported types:

include::types/greater_than_or_equal.asciidoc[]

==== Add `+`
[.text-center]
image::esql/functions/signature/add.svg[Embedded,opts=inline]

Supported types:

include::types/add.asciidoc[]

==== Subtract `-`
[.text-center]
image::esql/functions/signature/sub.svg[Embedded,opts=inline]

Supported types:

include::types/sub.asciidoc[]

==== Multiply `*`
[.text-center]
image::esql/functions/signature/mul.svg[Embedded,opts=inline]

Supported types:

include::types/mul.asciidoc[]

==== Divide `/`
[.text-center]
image::esql/functions/signature/div.svg[Embedded,opts=inline]

Supported types:

include::types/div.asciidoc[]

==== Modulus `%`
[.text-center]
image::esql/functions/signature/mod.svg[Embedded,opts=inline]

Supported types:

include::types/mod.asciidoc[]
4 changes: 1 addition & 3 deletions docs/reference/esql/functions/ceil.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,9 @@ Numeric expression. If `null`, the function returns `null`.
Round a number up to the nearest integer.

NOTE: This is a noop for `long` (including unsigned) and `integer`.
For `double` this picks the closest `double` value to the integer
For `double` this picks the closest `double` value to the integer
similar to {javadoc}/java.base/java/lang/Math.html#ceil(double)[Math.ceil].

*Supported types*

include::types/ceil.asciidoc[]


Expand Down
24 changes: 3 additions & 21 deletions docs/reference/esql/functions/coalesce.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,24 +8,6 @@
----
COALESCE(expression1 [, ..., expressionN])
----

*Parameters*

`expressionX`::
Expression to evaluate.

*Description*

Returns the first of its arguments that is not null. If all arguments are null,
it returns `null`.

*Example*

[source.merge.styled,esql]
----
include::{esql-specs}/null.csv-spec[tag=coalesce]
----
[%header.monospaced.styled,format=dsv,separator=|]
|===
include::{esql-specs}/null.csv-spec[tag=coalesce-result]
|===
include::parameters/coalesce.asciidoc[]
include::description/coalesce.asciidoc[]
include::examples/coalesce.asciidoc[]
2 changes: 0 additions & 2 deletions docs/reference/esql/functions/cos.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@ Numeric expression. If `null`, the function returns `null`.
Returns the {wikipedia}/Sine_and_cosine[cosine] of `n`. Input expected in
radians.

*Supported types*

include::types/cos.asciidoc[]

*Example*
Expand Down
2 changes: 0 additions & 2 deletions docs/reference/esql/functions/cosh.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@ Numeric expression. If `null`, the function returns `null`.

Returns the {wikipedia}/Hyperbolic_functions[hyperbolic cosine].

*Supported types*

include::types/cosh.asciidoc[]

*Example*
Expand Down
2 changes: 0 additions & 2 deletions docs/reference/esql/functions/date_diff.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,6 @@ s|abbreviations
| nanosecond | nanoseconds, ns
|===

*Supported types*

include::types/date_diff.asciidoc[]

*Example*
Expand Down
5 changes: 5 additions & 0 deletions docs/reference/esql/functions/description/abs.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// This is generated by ESQL's AbstractFunctionTestCase. Do no edit it.

*Description*

Returns the absolute value.
5 changes: 5 additions & 0 deletions docs/reference/esql/functions/description/acos.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// This is generated by ESQL's AbstractFunctionTestCase. Do no edit it.

*Description*

The arccosine of an angle, expressed in radians.
5 changes: 5 additions & 0 deletions docs/reference/esql/functions/description/asin.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// This is generated by ESQL's AbstractFunctionTestCase. Do no edit it.

*Description*

Inverse sine trigonometric function.
5 changes: 5 additions & 0 deletions docs/reference/esql/functions/description/atan.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// This is generated by ESQL's AbstractFunctionTestCase. Do no edit it.

*Description*

Inverse tangent trigonometric function.
5 changes: 5 additions & 0 deletions docs/reference/esql/functions/description/atan2.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// This is generated by ESQL's AbstractFunctionTestCase. Do no edit it.

*Description*

The angle between the positive x-axis and the ray from the origin to the point (x , y) in the Cartesian plane.
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// This is generated by ESQL's AbstractFunctionTestCase. Do no edit it.

*Description*

Creates human-friendly buckets and returns a datetime value for each row that corresponds to the resulting bucket the row falls into.
5 changes: 5 additions & 0 deletions docs/reference/esql/functions/description/case.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// This is generated by ESQL's AbstractFunctionTestCase. Do no edit it.

*Description*

Accepts pairs of conditions and values. The function returns the value that belongs to the first condition that evaluates to true.
5 changes: 5 additions & 0 deletions docs/reference/esql/functions/description/ceil.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// This is generated by ESQL's AbstractFunctionTestCase. Do no edit it.

*Description*

Round a number up to the nearest integer.
5 changes: 5 additions & 0 deletions docs/reference/esql/functions/description/coalesce.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// This is generated by ESQL's AbstractFunctionTestCase. Do no edit it.

*Description*

Returns the first of its arguments that is not null. If all arguments are null, it returns `null`.
5 changes: 5 additions & 0 deletions docs/reference/esql/functions/description/concat.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// This is generated by ESQL's AbstractFunctionTestCase. Do no edit it.

*Description*

Concatenates two or more strings.
5 changes: 5 additions & 0 deletions docs/reference/esql/functions/description/cos.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// This is generated by ESQL's AbstractFunctionTestCase. Do no edit it.

*Description*

Returns the trigonometric cosine of an angle
5 changes: 5 additions & 0 deletions docs/reference/esql/functions/description/cosh.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// This is generated by ESQL's AbstractFunctionTestCase. Do no edit it.

*Description*

Returns the hyperbolic cosine of a number
5 changes: 5 additions & 0 deletions docs/reference/esql/functions/description/date_diff.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// This is generated by ESQL's AbstractFunctionTestCase. Do no edit it.

*Description*

Subtract 2 dates and return their difference in multiples of a unit specified in the 1st argument
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// This is generated by ESQL's AbstractFunctionTestCase. Do no edit it.

*Description*

Extracts parts of a date, like year, month, day, hour.
5 changes: 5 additions & 0 deletions docs/reference/esql/functions/description/date_parse.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// This is generated by ESQL's AbstractFunctionTestCase. Do no edit it.

*Description*

Parses a string into a date value
5 changes: 5 additions & 0 deletions docs/reference/esql/functions/description/e.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// This is generated by ESQL's AbstractFunctionTestCase. Do no edit it.

*Description*

Euler’s number.
5 changes: 5 additions & 0 deletions docs/reference/esql/functions/description/ends_with.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// This is generated by ESQL's AbstractFunctionTestCase. Do no edit it.

*Description*

Returns a boolean that indicates whether a keyword string ends with another string
5 changes: 5 additions & 0 deletions docs/reference/esql/functions/description/floor.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// This is generated by ESQL's AbstractFunctionTestCase. Do no edit it.

*Description*

Round a number down to the nearest integer.
5 changes: 5 additions & 0 deletions docs/reference/esql/functions/description/greatest.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// This is generated by ESQL's AbstractFunctionTestCase. Do no edit it.

*Description*

Returns the maximum value from many columns.
5 changes: 5 additions & 0 deletions docs/reference/esql/functions/description/least.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// This is generated by ESQL's AbstractFunctionTestCase. Do no edit it.

*Description*

Returns the minimum value from many columns.
5 changes: 5 additions & 0 deletions docs/reference/esql/functions/description/left.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// This is generated by ESQL's AbstractFunctionTestCase. Do no edit it.

*Description*

Returns the substring that extracts 'length' chars from 'str' starting from the left.
5 changes: 5 additions & 0 deletions docs/reference/esql/functions/description/length.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// This is generated by ESQL's AbstractFunctionTestCase. Do no edit it.

*Description*

Returns the character length of a string.
5 changes: 5 additions & 0 deletions docs/reference/esql/functions/description/log.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// This is generated by ESQL's AbstractFunctionTestCase. Do no edit it.

*Description*

Returns the logarithm of a value to a base.
5 changes: 5 additions & 0 deletions docs/reference/esql/functions/description/log10.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// This is generated by ESQL's AbstractFunctionTestCase. Do no edit it.

*Description*

Returns the log base 10.
5 changes: 5 additions & 0 deletions docs/reference/esql/functions/description/ltrim.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// This is generated by ESQL's AbstractFunctionTestCase. Do no edit it.

*Description*

Removes leading whitespaces from a string.
5 changes: 5 additions & 0 deletions docs/reference/esql/functions/description/mv_avg.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// This is generated by ESQL's AbstractFunctionTestCase. Do no edit it.

*Description*

Converts a multivalued field into a single valued field containing the average of all of the values.
5 changes: 5 additions & 0 deletions docs/reference/esql/functions/description/mv_concat.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// This is generated by ESQL's AbstractFunctionTestCase. Do no edit it.

*Description*

Reduce a multivalued string field to a single valued field by concatenating all values.
5 changes: 5 additions & 0 deletions docs/reference/esql/functions/description/mv_count.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// This is generated by ESQL's AbstractFunctionTestCase. Do no edit it.

*Description*

Reduce a multivalued field to a single valued field containing the count of values.
5 changes: 5 additions & 0 deletions docs/reference/esql/functions/description/mv_dedupe.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// This is generated by ESQL's AbstractFunctionTestCase. Do no edit it.

*Description*

Remove duplicate values from a multivalued field.
5 changes: 5 additions & 0 deletions docs/reference/esql/functions/description/mv_first.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// This is generated by ESQL's AbstractFunctionTestCase. Do no edit it.

*Description*

Reduce a multivalued field to a single valued field containing the first value.
5 changes: 5 additions & 0 deletions docs/reference/esql/functions/description/mv_last.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// This is generated by ESQL's AbstractFunctionTestCase. Do no edit it.

*Description*

Reduce a multivalued field to a single valued field containing the last value.
5 changes: 5 additions & 0 deletions docs/reference/esql/functions/description/mv_max.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// This is generated by ESQL's AbstractFunctionTestCase. Do no edit it.

*Description*

Reduce a multivalued field to a single valued field containing the maximum value.
5 changes: 5 additions & 0 deletions docs/reference/esql/functions/description/mv_median.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// This is generated by ESQL's AbstractFunctionTestCase. Do no edit it.

*Description*

Converts a multivalued field into a single valued field containing the median value.
Loading