elasticsearch/docs/reference/esql/functions/case.asciidoc
Abdon Pijpelink 8e0d4e1846
[DOCS] Improve ES|QL functions reference for functions A-D (#103447)
* Functions starting with A

* Functions starting with 'C'

* More 'C' functions

* Fix tests

* Fix missing snippet

* DATE_* functions

* Apply suggestions from code review

Co-authored-by: Bogdan Pintea <pintea@mailbox.org>

---------

Co-authored-by: Bogdan Pintea <pintea@mailbox.org>
2023-12-19 15:59:02 +01:00

70 lines
1.7 KiB
Text

[discrete]
[[esql-case]]
=== `CASE`
*Syntax*
[source,esql]
----
CASE(condition1, value1[, ..., conditionN, valueN][, default_value])
----
*Parameters*
`conditionX`::
A condition.
`valueX`::
The value that's returned when the corresponding condition is the first to
evaluate to `true`.
`default_value`::
The default value that's is returned when no condition matches.
*Description*
Accepts pairs of conditions and values. The function returns the value that
belongs to the first condition that evaluates to `true`.
If the number of arguments is odd, the last argument is the default value which
is returned when no condition matches. If the number of arguments is even, and
no condition matches, the function returns `null`.
*Example*
Determine whether employees are monolingual, bilingual, or polyglot:
[source,esql]
[source.merge.styled,esql]
----
include::{esql-specs}/docs.csv-spec[tag=case]
----
[%header.monospaced.styled,format=dsv,separator=|]
|===
include::{esql-specs}/docs.csv-spec[tag=case-result]
|===
Calculate the total connection success rate based on log messages:
[source,esql]
[source.merge.styled,esql]
----
include::{esql-specs}/conditional.csv-spec[tag=docsCaseSuccessRate]
----
[%header.monospaced.styled,format=dsv,separator=|]
|===
include::{esql-specs}/conditional.csv-spec[tag=docsCaseSuccessRate-result]
|===
Calculate an hourly error rate as a percentage of the total number of log
messages:
[source,esql]
[source.merge.styled,esql]
----
include::{esql-specs}/conditional.csv-spec[tag=docsCaseHourlyErrorRate]
----
[%header.monospaced.styled,format=dsv,separator=|]
|===
include::{esql-specs}/conditional.csv-spec[tag=docsCaseHourlyErrorRate-result]
|===