elasticsearch/docs/reference/esql/functions/floor.asciidoc
Abdon Pijpelink e87c49cb4b
[DOCS] Improve ES|QL functions reference for functions E-Z (#104623)
* Functions E-Z

* Incorporate changes from #103686

* More functions

* More functions

* Update docs/reference/esql/functions/floor.asciidoc

Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com>

* Update docs/reference/esql/functions/left.asciidoc

Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Alexander Spies <alexander.spies@elastic.co>

* Review feedback

* Fix geo_shape description

* Change 'colum'/'field' into 'expressions'

* Review feedback

* One more

---------

Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com>
Co-authored-by: Alexander Spies <alexander.spies@elastic.co>
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2024-01-25 16:32:24 +01:00

36 lines
759 B
Text

[discrete]
[[esql-floor]]
=== `FLOOR`
*Syntax*
[.text-center]
image::esql/functions/signature/floor.svg[Embedded,opts=inline]
*Parameters*
`n`::
Numeric expression. If `null`, the function returns `null`.
*Description*
Rounds a number down 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
similar to {javadoc}/java.base/java/lang/Math.html#floor(double)[Math.floor].
*Supported types*
include::types/floor.asciidoc[]
*Example*
[source.merge.styled,esql]
----
include::{esql-specs}/math.csv-spec[tag=floor]
----
[%header.monospaced.styled,format=dsv,separator=|]
|===
include::{esql-specs}/math.csv-spec[tag=floor-result]
|===