ES|QL mathematical functions

ES|QL supports these mathematical functions:

• ABS
• ACOS
• ASIN
• ATAN
• ATAN2
• CBRT
• CEIL
• COS
• COSH
• E
• EXP
• FLOOR
• HYPOT
• LOG
• LOG10
• PI
• POW
• ROUND
• SIGNUM
• SIN
• SINH
• SQRT
• TAN
• TANH
• TAU

Syntax

×

Parameters

number

Numeric expression. If null, the function returns null.

Description

Returns the absolute value.

Supported types

Examples

ROW number = -1.0
| EVAL abs_number = ABS(number)

FROM employees
| KEEP first_name, last_name, height
| EVAL abs_height = ABS(0.0 - height)

Syntax

×

Parameters

number

Number between -1 and 1. If null, the function returns null.

Description

Returns the arccosine of n as an angle, expressed in radians.

Supported types

Example

ROW a=.9
| EVAL acos=ACOS(a)

Syntax

×

Parameters

number

Number between -1 and 1. If null, the function returns null.

Description

Returns the arcsine of the input numeric expression as an angle, expressed in radians.

Supported types

Example

ROW a=.9
| EVAL asin=ASIN(a)

Syntax

×

Parameters

number

Numeric expression. If null, the function returns null.

Description

Returns the arctangent of the input numeric expression as an angle, expressed in radians.

Supported types

Example

ROW a=12.9
| EVAL atan=ATAN(a)

Syntax

×

Parameters

y_coordinate

y coordinate. If null, the function returns null.

x_coordinate

x coordinate. If null, the function returns null.

Description

The 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

Example

ROW y=12.9, x=.6
| EVAL atan2=ATAN2(y, x)

Syntax

×

Parameters

number

Numeric expression. If null, the function returns null.

Description

Returns the cube root of a number. The input can be any numeric value, the return value is always a double. Cube roots of infinities are null.

Supported types

Example

ROW d = 1000.0
| EVAL c = CBRT(d)

Syntax

×

Parameters

number

Numeric expression. If null, the function returns null.

Description

Round a number up to the nearest integer.

Supported types

Example

ROW a=1.8
| EVAL a=CEIL(a)

Syntax

×

Parameters

angle

An angle, in radians. If null, the function returns null.

Description

Returns the cosine of an angle.

Supported types

Example

ROW a=1.8
| EVAL cos=COS(a)

Syntax

×

Parameters

number

Numeric expression. If null, the function returns null.

Description

Returns the hyperbolic cosine of a number.

Supported types

Example

ROW a=1.8
| EVAL cosh=COSH(a)

Syntax

×

Parameters

Description

Returns Euler’s number.

Supported types

Example

ROW E()

Syntax

×

Parameters

number

Numeric expression. If null, the function returns null.

Description

Returns the value of e raised to the power of the given number.

Supported types

Example

ROW d = 5.0
| EVAL s = EXP(d)

Syntax

×

Parameters

number

Numeric expression. If null, the function returns null.

Description

Round a number down to the nearest integer.

Supported types

Example

ROW a=1.8
| EVAL a=FLOOR(a)

Syntax

×

Parameters

number1

Numeric expression. If null, the function returns null.

number2

Numeric expression. If null, the function returns null.

Description

Returns the hypotenuse of two numbers. The input can be any numeric values, the return value is always a double. Hypotenuses of infinities are null.

Supported types

Example

ROW a = 3.0, b = 4.0
| EVAL c = HYPOT(a, b)

Syntax

×

Parameters

base

Base of logarithm. If null, the function returns null. If not provided, this function returns the natural logarithm (base e) of a value.

number

Numeric expression. If null, the function returns null.

Description

Returns the logarithm of a value to a base. The input can be any numeric value, the return value is always a double. Logs of zero, negative numbers, and base of one return null as well as a warning.

Supported types

Examples

ROW base = 2.0, value = 8.0
| EVAL s = LOG(base, value)

ROW value = 100
| EVAL s = LOG(value);

Syntax

×

Parameters

number

Numeric expression. If null, the function returns null.

Description

Returns the logarithm of a value to base 10. The input can be any numeric value, the return value is always a double. Logs of 0 and negative numbers return null as well as a warning.

Supported types

Example

ROW d = 1000.0
| EVAL s = LOG10(d)

Syntax

×

Parameters

Description

Returns Pi, the ratio of a circle’s circumference to its diameter.

Supported types

Example

ROW PI()

Syntax

×

Parameters

base

Numeric expression for the base. If null, the function returns null.

exponent

Numeric expression for the exponent. If null, the function returns null.

Description

Returns the value of base raised to the power of exponent.

Supported types

Examples

ROW base = 2.0, exponent = 2
| EVAL result = POW(base, exponent)

The exponent can be a fraction, which is similar to performing a root. For example, the exponent of 0.5 will give the square root of the base:

ROW base = 4, exponent = 0.5
| EVAL s = POW(base, exponent)

Syntax

×

Parameters

number

The numeric value to round. If null, the function returns null.

decimals

The number of decimal places to round to. Defaults to 0. If null, the function returns null.

Description

Rounds a number to the specified number of decimal places. Defaults to 0, which returns the nearest integer. If the precision is a negative number, rounds to the number of digits left of the decimal point.

Supported types

Example

FROM employees
| KEEP first_name, last_name, height
| EVAL height_ft = ROUND(height * 3.281, 1)

Syntax

×

Parameters

number

Numeric expression. If null, the function returns null.

Description

Returns the sign of the given number. It returns -1 for negative numbers, 0 for 0 and 1 for positive numbers.

Supported types

Example

ROW d = 100.0
| EVAL s = SIGNUM(d)

Syntax

×

Parameters

angle

An angle, in radians. If null, the function returns null.

Description

Returns the sine of an angle.

Supported types

Example

ROW a=1.8
| EVAL sin=SIN(a)

Syntax

×

Parameters

number

Numeric expression. If null, the function returns null.

Description

Returns the hyperbolic sine of a number.

Supported types

Example

ROW a=1.8
| EVAL sinh=SINH(a)

Syntax

×

Parameters

number

Numeric expression. If null, the function returns null.

Description

Returns the square root of a number. The input can be any numeric value, the return value is always a double. Square roots of negative numbers and infinities are null.

Supported types

Example

ROW d = 100.0
| EVAL s = SQRT(d)

Syntax

×

Parameters

angle

An angle, in radians. If null, the function returns null.

Description

Returns the tangent of an angle.

Supported types

Example

ROW a=1.8
| EVAL tan=TAN(a)

Syntax

×

Parameters

number

Numeric expression. If null, the function returns null.

Description

Returns the hyperbolic tangent of a number.

Supported types

Example

ROW a=1.8
| EVAL tanh=TANH(a)

Syntax

×

Parameters

Description

Returns the ratio of a circle’s circumference to its radius.

Supported types

Example

ROW TAU()