mod function

Applies to: Databricks SQL Databricks Runtime

Returns the remainder after dividend / divisor. This function is equivalent to the % (percent sign) operator.

Syntax

mod(dividend, divisor)

Arguments

• dividend: An expression that evaluates to a numeric.
• divisor: An expression that evaluates to a numeric.

Returns

If both dividend and divisor are of DECIMAL, the result matches the divisor's type. In all other cases, a DOUBLE.

If divisor is 0, the function raises a REMAINDER_BY_ZERO error. To return NULL instead, use the try_mod() function.

Common error conditions

• REMAINDER_BY_ZERO

Examples

> SELECT mod(2, 1.8);
 0.2

> SELECT mod(2, 0);
 Error: REMAINDER_BY_ZERO

Related functions

• % (percent sign) operator
• / (slash sign) operator
• pmod function
• try_mod function