Functions executing mathematical calculations.
Returns the absolute value of numeric_expression. Returns NULL if numeric_expression evaluates to NULL.
abs(expression)
| Parameter | Type | Description | Required |
|---|---|---|---|
expression | double, long, duration | The numeric expression for which to calculate the absolute value. | Required |
The data type of the returned value is double, long, or duration.
data record(x = -42.13),record(x = 0),record(x = 6.8545)| fieldsAdd abs(x)
Query result:
| x | abs(x) |
|---|---|
|
|
|
|
|
|
Computes arc cosine of expression. The returned angle is in the range 0.0 through pi. Returns null if expression evaluates to NULL.
acos(expression)
| Parameter | Type | Description | Required |
|---|---|---|---|
expression | double, long | The numeric expression, angle in radians for which to calculate the acos. | Required |
The data type of the returned value is double.
data record(x = -1),record(x = 0),record(x = 1)| fieldsAdd acos(x)
Query result:
| x | acos(x) |
|---|---|
|
|
|
|
|
|
Computes arc sine of expression. The returned angle is in the range -pi/2 through pi/2. Returns null if <expression> evaluates to NULL.
asin(expression)
| Parameter | Type | Description | Required |
|---|---|---|---|
expression | double, long | The numeric expression, angle in radians for which to calculate the asin. | Required |
The data type of the returned value is double.
data record(x = -1),record(x = 0),record(x = 1)| fieldsAdd asin(x)
Query result:
| x | asin(x) |
|---|---|
|
|
|
|
|
|
Computes the arc tangent of expression. The returned angle is in the range -p/2 through pi/2. Returns null if expression evaluates to NULL.
atan(expression)
| Parameter | Type | Description | Required |
|---|---|---|---|
expression | double, long | The numeric expression, angle in radians for which to calculate the atan. | Required |
The data type of the returned value is double.
data record(x = -1),record(x = 0),record(x = 1)| fieldsAdd atan(x)
Query result:
| x | atan(x) |
|---|---|
|
|
|
|
|
|
Computes the angle theta from the conversion of rectangular coordinates (x, y) to polar coordinates (r, theta). Returns null if either of the expressions evaluates to NULL.
atan2(ordinate, abscissa)
| Parameter | Type | Description | Required |
|---|---|---|---|
ordinate | double, long | The ordinate coordinate. | Required |
abscissa | double, long | The abscissa coordinate. | Required |
The data type of the returned value is double.
data record(x = 1, y = 1),record(x = 2, y = 3),record(x = 4, y = 5)| fieldsAdd atan2(x, y)
Query result:
| x | y | atan2(x, y) |
|---|---|---|
|
|
|
|
|
|
|
|
|
Rounds values down to a multiple of a given numeric bin size.
Used frequently in combination with summarize , by: ..... If it encounters a scattered set of values, they will be grouped into a smaller set of specific values.
bin(expression, interval)
| Parameter | Type | Description | Required |
|---|---|---|---|
expression | timestamp, long, double, duration | The expression that should be aligned. | Required |
interval | duration, double, long | The interval by which to align the expression. Constraints: statically evaluated. | Required |
at | timestamp, number, duration | The offset to which each interval should be shifted. Default: 0. Constraints: The offset to which each interval should be shifted. | Optional |
The data type of the returned value is double, long, duration, or timestamp.
data record(x = -42.13),record(x = 0),record(x = 6.8545),record(x = 27)| fieldsAdd bin(x, 10), bin(x, 10, at:5)
Query result:
| x | bin(x, 10) | bin(x, 10, at:5) |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
data record(timestamp = toTimestamp("2019-08-01T09:30:00.000-0400")),record(timestamp = toTimestamp("2022-12-24T18:13:23.672-0400")),record(timestamp = toTimestamp("2023-01-27T23:21:11.459-0400"))| fieldsAdd bin(timestamp, 1m), bin(timestamp, 1d)
Query result:
| timestamp | bin(timestamp, 1m) | bin(timestamp, 1d) |
|---|---|---|
|
|
|
|
|
|
|
|
|
In this example, we align the timestamp to noon.
data record(timestamp = toTimestamp("2019-08-01T09:30:00.000-0400"))| fieldsAdd bin(timestamp, 1d, at: 12h)
Query result:
| timestamp | bin(timestamp, 1d, at:12h) |
|---|---|
|
|
Calculates the smallest (closest to negative infinity) double value greater than or equal to the numeric_expression; is equal to a mathematical integer. Returns null if numeric_expression evaluates to NULL. The return type is of the same type as the input parameter.
ceil(expression)
| Parameter | Type | Description | Required |
|---|---|---|---|
expression | double, long | The numeric expression to be rounded up. | Required |
The data type of the returned value is double or long.
data record(x = -0.5),record(x = 0),record(x = 0.5)| fieldsAdd ceil(x)
Query result:
| x | ceil(x) |
|---|---|
|
|
|
|
|
|
Computes the trigonometric cosine of an angle expression (in radians). Returns null if expression evaluates to NULL.
cos(expression)
| Parameter | Type | Description | Required |
|---|---|---|---|
expression | double, long | The numeric expression, angle in radians for which to calculate the sin. | Required |
The data type of the returned value is double.
data record(x = -pi()),record(x = 0),record(x = pi())| fieldsAdd cos(x)
Query result:
| x | cos(x) |
|---|---|
|
|
|
|
|
|
Computes the hyperbolic cosine of an angle <expression>. Returns null if <expression> evaluates to NULL.
cosh(expression)
| Parameter | Type | Description | Required |
|---|---|---|---|
expression | double, long | The numeric expression, angle in radians for which to calculate the cosh. | Required |
The data type of the returned value is double.
data record(x = -1),record(x = 0),record(x = 1)| fieldsAdd cosh(x)
Query result:
| x | cosh(x) |
|---|---|
|
|
|
|
|
|
Calculates the real cubic root of a numeric expression.
cbrt (numeric_expression)
| Parameter | Type | Description | Required |
|---|---|---|---|
expression | double, long | The numeric expression for which to calculate the real cubic root. | Required |
The data type of the returned value is double.
data record(x = -8),record(x = -42.13),record(x = 0),record(x = 6.8545)| fieldsAdd cbrt(x)
Query result:
| x | cbrt(x) |
|---|---|
|
|
|
|
|
|
|
|
Converts the numeric expression of an angle in degrees to an approximately equivalent angle as expressed in radians. Returns null if numeric_expr evaluates to NULL.
degreeToRadian(expression)
| Parameter | Type | Description | Required |
|---|---|---|---|
expression | double, long | The angle to be converted from radians to degrees. | Required |
The data type of the returned value is double.
data record(degree = 90),record(degree = 180)| fieldsAdd degreeToRadian(degree)
Query result:
| degree | degreeToRadian(degree) |
|---|---|
|
|
|
|
Returns Euler’s number.
e()
The data type of the returned value is double.
data record()| fieldsAdd e()
Query result:
| e() |
|---|
|
Calculates the exponential function e^x, where e is the Euler's number and x is a numeric expression.
exp(expression)
| Parameter | Type | Description | Required |
|---|---|---|---|
expression | double, duration, long | The numeric expression for which to calculate the exponential function. | Required |
The data type of the returned value is double.
data record(x = 1),record(x = 4)| fieldsAdd exp(x)
Query result:
| x | exp(x) |
|---|---|
|
|
|
|
Calculates the largest (closest to positive infinity) double value less than or equal to the numeric_expression; and is equal to a mathematical integer. Returns NULL if numeric_expression evaluates to NULL. The return type is of the same type as the input parameter.
floor(expression)
| Parameter | Type | Description | Required |
|---|---|---|---|
expression | double, long | The numeric expression to be rounded down. | Required |
The data type of the returned value is double orlong.
data record(x = -0.5),record(x = 0),record(x = 0.5)| fieldsAdd floor(x)
Query result:
| x | floor(x) |
|---|---|
|
|
|
|
|
|
Returns sqrt(x^2 + y^2). Returns null if expression evaluates to NULL.
hypotenuse(x, y)
| Parameter | Type | Description | Required |
|---|---|---|---|
x | double, long | Length of the first of the catheti. | Required |
The data type of the returned value is double.
data record(x = 1, y = 2),record(x = 3, y = 4),record(x = 5, y = 6)| fieldsAdd hypotenuse(x, y)
Query result:
| x | y | hypotenuse(x, y) |
|---|---|---|
|
|
|
|
|
|
|
|
|
Calculates the natural logarithm (the base is e, the Euler's number) of a numeric expression.
log(expression)
| Parameter | Type | Description | Required |
|---|---|---|---|
expression | double, long | The numeric expression for which to calculate the natural logarithm (base e). | Required |
The data type of the returned value is double.
data record(x = e()),record(x = 0),record(x = 1),record(x = 6.8545)| fieldsAdd log(x)
Query result:
| x | log(x) |
|---|---|
|
|
| null |
|
|
|
|
Calculates log(1+x), where log is the natural logarithm and x is a numeric expression.
log1p(expression)
| Parameter | Type | Description | Required |
|---|---|---|---|
expression | double, long | The numeric expression for which to add one and calculate the natural logarithm (base e). | Required |
The data type of the returned value is double.
data record(x = 0),record(x = 6.8545)| fieldsAdd log1p(x)
Query result:
| x | log1p(x) |
|---|---|
|
|
|
|
Calculates the decadic (common) logarithm (the base is 10) of a numeric expression.
log10(expression)
| Parameter | Type | Description | Required |
|---|---|---|---|
expression | double, long | The numeric expression for which to calculate the decadic logarithm (base 10). | Required |
The data type of the returned value is double.
data record(x = 6.8545),record(x = 100)| fieldsAdd log10(x)
Query result:
| x | log10(x) |
|---|---|
|
|
|
|
Returns the constant value of PI (Archimedes’ number).
pi()
The data type of the returned value is double.
data record()| fieldsAdd pi()
Query result:
| pi() |
|---|
|
Raises a numeric expression to a given power.
power(base, exponent)
| Parameter | Type | Description | Required |
|---|---|---|---|
base | double, long | The numeric expression acting as the base of the power calculation. | Required |
exponent | double, long | The numeric expression acting as the exponent of the power calculation. | Required |
The data type of the returned value is double.
data record(base = 2, exponent = 4),record(base = 3, exponent = 5)| fieldsAdd power(base, exponent)
Query result:
| base | exponent | power(base, exponent) |
|---|---|---|
|
|
|
|
|
|
Converts the numeric expression of an angle in radians to an approximately equivalent angle as expressed in degrees. Returns null if numeric_expr evaluates to NULL.
radianToDegree(numeric_expr)
| Parameter | Type | Description | Required |
|---|---|---|---|
expression | double, long | The angle to be converted from radians to degrees. | Required |
The data type of the returned value is double.
data record(radian = pi() / 2),record(radian = pi())| fieldsAdd radianToDegree(radian)
Query result:
| radian | radianToDegree(radian) |
|---|---|
|
|
|
|
Creates a random double value. Generated values aren't deterministic. The value range of the generated double value is between 0.0 (inclusive) and 1.0 (exclusive).
random()
The data type of the returned value is double.
data record()| fieldsAdd random()
Query result:
| random() |
|---|
|
Aligns the given value/timestamp to value range based on the provided alignment parameter. The range function is similar to the bin function, but produces a range instead, then provides information about the start and the end of the bin the value is aligned to.
range(expression, interval [, at])
| Parameter | Type | Description | Required |
|---|---|---|---|
expressions | expressions | The numeric, timestamp or duration expression that should be aligned into bins. | Required |
interval | expression | The size of bins produced and the values that are aligned to it. Constraints: numeric_expression, duration_expression. | Required |
at | expression | The starting value for the first bin that is produced. Default: 0, EPOCH. | Optional |
The data type of the returned value is record.
data record(x = -42.13),record(x = 0),record(x = 6.8545),record(x = 27)| fieldsAdd range(x, 10),range(x, 10, at: 5)
Query result:
| x | range(x, 10) | range(x, 10, at:5) |
|---|---|---|
| start: | start: |
| start: | start: |
| start: | start: |
| start: | start: |
data record(timestamp = toTimestamp("2019-08-01T09:30:00.000-0400")),record(timestamp = toTimestamp("2022-12-24T18:13:23.672-0400")),record(timestamp = toTimestamp("2023-01-27T23:21:11.459-0400"))| fieldsAdd range(timestamp, 1m),range(timestamp, 1d)
Query result:
| timestamp | range(timestamp, 1m) | range(timestamp, 1d) |
|---|---|---|
| start: | start: |
| start: | start: |
| start: | start: |
data record(timestamp = toTimestamp("2019-08-01T09:30:00.000-0400"))| fieldsAdd bin(timestamp, 1d, at: 12h)
Query result:
| timestamp | bin(timestamp, 1d, at:12h) |
|---|---|
|
|
Rounds any numeric value to the specified number of decimal places. If you don't specify the number of decimal places, it rounds to the nearest integer. The return type is of the same type as the input parameter.
round(expression [, decimals])
| Parameter | Type | Description | Required |
|---|---|---|---|
expression | double, long | Numeric expression to be rounded. | Required |
decimals | long | Number of places after the decimal point. | Optional |
The data type of the returned value is double or long.
data record(x = -0.5),record(x = 0),record(x = 0.5),record(x = 0.55)| fieldsAdd round(x),round(x, decimals: 1)
Query result:
| x | round(x) | round(x, decimals:1) |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
Returns the signum (sign) result of an argument. It returns one of four possible values: -1 (if numeric_expression evaluates to a value less than 0), 0 (if numeric_expression evaluates to 0), 1 (if numeric_expression evaluates to a value greater than 0), or null (if numeric_expression evaluates to NULL).
The return type is of the same type as the input parameter.
signum(expression)
| Parameter | Type | Description | Required |
|---|---|---|---|
expression | double, long | The numeric expression for which to calculate the signum. | Required |
The data type of the returned value is double or long.
data record(x = -42.13),record(x = 0),record(x = 6.8545)| fieldsAdd signum(x)
Query result:
| x | signum(x) |
|---|---|
|
|
|
|
|
|
Computes the trigonometric sine of angle <expression> (in radians). Returns null if <expression> evaluates to NULL.
sin(expression)
| Parameter | Type | Description | Required |
|---|---|---|---|
expression | double, long | The numeric expression, angle in radians for which to calculate the sin. | Required |
The data type of the returned value is double.
data record(x = -pi() / 2),record(x = 0),record(x = pi() / 2)| fieldsAdd sin(x)
Query result:
| x | sin(x) |
|---|---|
|
|
|
|
|
|
Computes the hyperbolic sine of <expression>. Returns null if <expression> evaluates to NULL.
sinh(expression)
| Parameter | Type | Description | Required |
|---|---|---|---|
expression | double, long | The numeric expression, angle in radians for which to calculate the sinh. | Required |
The data type of the returned value is double.
data record(x = -1),record(x = 0),record(x = 1)| fieldsAdd sinh(x)
Query result:
| x | sinh(x) |
|---|---|
|
|
|
|
|
|
Computes the positive square root of a numeric expression.
sqrt(expression)
| Parameter | Type | Description | Required |
|---|---|---|---|
expression | double, long | The numeric expression for which to calculate the square root. | Required |
The data type of the returned value is double.
data record(x = 4),record(x = 81),record(x = -14)| fieldsAdd sqrt(x)
Query result:
| x | sqrt(x) |
|---|---|
|
|
|
|
| null |
Computes the trigonometric tangent of angle expression (in radians). Returns null if expression evaluates to NULL.
tan(expression)
| Parameter | Type | Description | Required |
|---|---|---|---|
expression | double, long | The numeric expression, angle in radians for which to calculate the tan. | Required |
The data type of the returned value is double.
data record(x = -pi() / 4),record(x = 0),record(x = pi() / 4)| fieldsAdd tan(x)
Query result:
| x | tan(x) |
|---|---|
|
|
|
|
|
|
Computes the hyperbolic tangent of expression. Returns null if expression evaluates to NULL.
tanh(expression)
| Parameter | Type | Description | Required |
|---|---|---|---|
expression | double, long | The numeric expression, angle in radians for which to calculate the tanh. | Required |
The data type of the returned value is double.
data record(x = -1),record(x = 0),record(x = 1)| fieldsAdd tanh(x)
Query result:
| x | tanh(x) |
|---|---|
|
|
|
|
|
|