算术函数

概述

算术函数适用于任何两个类型为 UInt8、UInt16、UInt32、UInt64、Int8、Int16、Int32、Int64、Float32 或 Float64 的操作数。

在执行操作之前，两个操作数都会被转换为结果类型。结果类型由以下规则确定（除非在下面的函数文档中另有说明）

如果两个操作数最多为 32 位宽，则结果类型的宽度将是两个操作数中较大者之后下一个更大的类型的大小（整数大小提升）。例如，UInt8 + UInt16 = UInt32 或 Float32 * Float32 = Float64。
如果其中一个操作数有 64 位或更多位，则结果类型的宽度将与两个操作数中较大的操作数相同。例如，UInt32 + UInt128 = UInt128 或 Float32 * Float64 = Float64。
如果其中一个操作数是有符号的，则结果类型也将是有符号的，否则将是无符号的。例如，UInt32 * Int32 = Int64 或 UInt32 * UInt32 = UInt64。

这些规则确保结果类型将是能够表示所有可能结果的最小类型。虽然这会引入在值范围边界附近溢出的风险，但它确保了使用最大 64 位本机整数宽度进行快速计算。这种行为也保证了与许多其他数据库的兼容性，这些数据库提供 64 位整数 (BIGINT) 作为最大的整数类型。

示例

SELECT toTypeName(0), toTypeName(0 + 0), toTypeName(0 + 0 + 0), toTypeName(0 + 0 + 0 + 0)

┌─toTypeName(0)─┬─toTypeName(plus(0, 0))─┬─toTypeName(plus(plus(0, 0), 0))─┬─toTypeName(plus(plus(plus(0, 0), 0), 0))─┐
│ UInt8         │ UInt16                 │ UInt32                          │ UInt64                                   │
└───────────────┴────────────────────────┴─────────────────────────────────┴──────────────────────────────────────────┘

溢出与 C++ 中的方式相同。

abs

引入于：v1.1

计算 x 的绝对值。如果 x 是无符号类型，则没有效果。如果 x 是有符号类型，则返回一个无符号数字。

语法

abs(x)

参数

x — 要获取绝对值的数值

返回值

x 的绝对值

示例

使用示例

SELECT abs(-0.5)

0.5

avg2

引入于：v25.11

计算并返回所提供参数的平均值。支持数值和时间类型。

语法

avg2(x1, x2])

参数

x1, x2] — 接受两个用于求平均的值。

返回值

返回所提供参数的平均值，提升到最大的兼容类型。

示例

数值类型

SELECT avg2(toUInt8(3), 1.0) AS result, toTypeName(result) AS type;
-- The type returned is a Float64 as the UInt8 must be promoted to 64 bit for the comparison.

┌─result─┬─type────┐
│      2 │ Float64 │
└────────┴─────────┘

十进制类型

SELECT avg2(toDecimal32(1, 2), 2) AS result, toTypeName(result) AS type;

┌─result─┬─type──────────┐
│    1.5 │ Decimal(9, 2) │
└────────┴───────────────┘

日期类型

SELECT avg2(toDate('2025-01-01'), toDate('2025-01-05')) AS result, toTypeName(result) AS type;

┌─────result─┬─type─┐
│ 2025-01-03 │ Date │
└────────────┴──────┘

日期时间类型

SELECT avg2(toDateTime('2025-01-01 00:00:00'), toDateTime('2025-01-03 12:00:00')) AS result, toTypeName(result) AS type;

┌──────────────result─┬─type─────┐
│ 2025-01-02 06:00:00 │ DateTime │
└─────────────────────┴──────────┘

Time64 类型

SELECT avg2(toTime64('12:00:00', 0), toTime64('14:00:00', 0)) AS result, toTypeName(result) AS type;

┌───result─┬─type──────┐
│ 13:00:00 │ Time64(0) │
└──────────┴───────────┘

byteSwap

引入于：v23.10

反转整数的字节，即改变其字节序。

以下示例可以按以下方式计算

将十进制整数转换为大端格式的等效十六进制格式，即 3351772109 -> C7 C7 FB CD（4 个字节）
反转字节，即 C7 C7 FB CD -> CD FB C7 C7
假设大端，将结果转换回整数，即 CD FB C7 C7 -> 3455829959 此函数的一个用例是反转 IPv4 地址

┌─toIPv4(byteSwap(toUInt32(toIPv4('205.251.199.199'))))─┐
│ 199.199.251.205                                       │
└───────────────────────────────────────────────────────┘

语法

byteSwap(x)

参数

x — 一个整数值。 (U)Int*

返回值

返回字节反转后的 x。 (U)Int*

示例

使用示例

SELECT byteSwap(3351772109)

3455829959

8 位

SELECT byteSwap(54)

16 位

SELECT byteSwap(4135)

32 位

SELECT byteSwap(3351772109)

3455829959

64 位

SELECT byteSwap(123294967295)

18439412204227788800

divide

引入于：v1.1

计算两个值 a 和 b 的商。结果类型始终为 Float64。整数除法由 intDiv 函数提供。

注意

除以 0 将返回 inf、-inf 或 nan。

语法

divide(x, y)

参数

x — 被除数 - y — 除数

返回值

x 和 y 的商

示例

除以两个数字

SELECT divide(25,5) AS quotient, toTypeName(quotient)

5 Float64

除以零

SELECT divide(25,0)

inf

divideDecimal

引入于：v22.12

对两个十进制数执行除法。结果值将为类型 Decimal256。可以通过 result_scale 参数（范围为 [0, 76] 的常量整数）显式指定结果比例。如果未指定，则结果比例为给定参数的最大比例。

注意

这些函数比通常的 divide 慢得多。如果您实际上不需要受控精度和/或需要快速计算，请考虑使用 divide。

语法

divideDecimal(x, y[, result_scale])

参数

x — 第一个值：Decimal。 - y — 第二个值：Decimal。 - result_scale — 结果的比例。类型 Int/UInt。

返回值

具有给定比例的除法结果。 Decimal256

示例

示例 1

divideDecimal(toDecimal256(-12, 0), toDecimal32(2.1, 1), 10)

┌─divideDecimal(toDecimal256(-12, 0), toDecimal32(2.1, 1), 10)─┐
│                                                -5.7142857142 │
└──────────────────────────────────────────────────────────────┘

示例 2

SELECT toDecimal64(-12, 1) / toDecimal32(2.1, 1);
SELECT toDecimal64(-12, 1) as a, toDecimal32(2.1, 1) as b, divideDecimal(a, b, 1), divideDecimal(a, b, 5);

┌─divide(toDecimal64(-12, 1), toDecimal32(2.1, 1))─┐
│                                             -5.7 │
└──────────────────────────────────────────────────┘
┌───a─┬───b─┬─divideDecimal(toDecimal64(-12, 1), toDecimal32(2.1, 1), 1)─┬─divideDecimal(toDecimal64(-12, 1), toDecimal32(2.1, 1), 5)─┐
│ -12 │ 2.1 │                                                       -5.7 │                                                   -5.71428 │
└─────┴─────┴────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────┘

divideOrNull

引入于：v25.5

与 divide 相同，但除以零时返回 NULL。

语法

divideOrNull(x, y)

参数

x — 被除数 - y — 除数

返回值

x 和 y 的商，或 NULL。

示例

除以零

SELECT divideOrNull(25, 0)

\N

gcd

引入于：v1.1

返回两个值 a 和 b 的最大公约数。

除以零或将最小负数除以负一时会抛出异常。

语法

gcd(x, y)

参数

x — 第一个整数 - y — 第二个整数

返回值

x 和 y 的最大公约数。

示例

使用示例

SELECT gcd(12, 18)

ifNotFinite

引入于：v20.3

检查浮点值是否有限。

您可以使用三元运算符获得类似的结果：isFinite(x) ? x : y。

语法

ifNotFinite(x,y)

参数

x — 要检查是否无限的值。 Float*
y — 备用值。 Float*

返回值

如果 x 是有限的，则为 x。
如果 x 不是有限的，则为 y。

示例

使用示例

SELECT 1/0 AS infimum, ifNotFinite(infimum,42)

inf  42

intDiv

引入于：v1.1

执行两个值 x 除以 y 的整数除法。换句话说，它计算向下舍入到下一个最小整数的商。

结果与被除数（第一个参数）的宽度相同。

除以零、商不适合被除数的范围或将最小负数除以负一时会抛出异常。

语法

intDiv(x, y)

参数

x — 左操作数。 - y — 右操作数。

返回值

x 和 y 的整数除法结果

示例

两个浮点数的整数除法

SELECT intDiv(toFloat64(1), 0.001) AS res, toTypeName(res)

┌──res─┬─toTypeName(intDiv(toFloat64(1), 0.001))─┐
│ 1000 │ Int64                                   │
└──────┴─────────────────────────────────────────┘

商不适合被除数的范围

SELECT
intDiv(1, 0.001) AS res,
toTypeName(res)

Received exception from server (version 23.2.1):
Code: 153. DB::Exception: Received from localhost:9000. DB::Exception:
Cannot perform integer division, because it will produce infinite or too
large number: While processing intDiv(1, 0.001) AS res, toTypeName(res).
(ILLEGAL_DIVISION)

intDivOrNull

引入于：v25.5

与 intDiv 相同，但除以零或将最小负数除以负一时返回 NULL。

语法

intDivOrNull(x, y)

参数

x — 左操作数。 (U)Int*
y — 右操作数。 (U)Int*

返回值

x 和 y 的整数除法结果，或 NULL。

示例

除以零

SELECT intDivOrNull(1, 0)

\N

将最小负数除以 -1

SELECT intDivOrNull(-9223372036854775808, -1)

\N

intDivOrZero

引入于：v1.1

与 intDiv 相同，但除以零或将最小负数除以负一时返回零。

语法

intDivOrZero(a, b)

参数

a — 左操作数。 (U)Int*
b — 右操作数。 (U)Int*

返回值

a 和 b 的整数除法结果，或零。

示例

除以零

SELECT intDivOrZero(1, 0)

将最小负数除以 -1

SELECT intDivOrZero(0.05, -1)

isFinite

引入于：v1.1

如果 Float32 或 Float64 参数不是无限大且不是 NaN，则返回 1，否则此函数返回 0。

语法

isFinite(x)

参数

x — 要检查有限性的数字。 Float*

返回值

如果 x 不是无限大且不是 NaN，则为 1，否则为 0。

示例

测试一个数字是否有限

SELECT isFinite(inf)

isInfinite

引入于：v1.1

如果 Float32 或 Float64 参数是无限大，则返回 1，否则此函数返回 0。请注意，对于 NaN，返回 0。

语法

isInfinite(x)

参数

x — 要检查无限性的数字。 Float*

返回值

如果 x 是无限大，则为 1，否则为 0（包括 NaN）。

示例

测试一个数字是否无限

SELECT isInfinite(inf), isInfinite(NaN), isInfinite(10))

1 0 0

isNaN

引入于：v1.1

如果 Float32 和 Float64 参数是 NaN，则返回 1，否则返回 0。

语法

isNaN(x)

参数

x — 要评估是否为 NaN 的参数。 Float*

返回值

如果为 NaN，则为 1，否则为 0

示例

使用示例

SELECT isNaN(NaN)

lcm

引入于：v1.1

返回两个值 x 和 y 的最小公倍数。

除以零或将最小负数除以负一时会抛出异常。

语法

lcm(x, y)

参数

x — 第一个整数。 (U)Int*
y — 第二个整数。 (U)Int*

返回值

返回 x 和 y 的最小公倍数。 (U)Int*

示例

使用示例

SELECT lcm(6, 8)

max2

引入于：v21.11

返回两个数值 x 和 y 中较大的一个。

语法

max2(x, y)

参数

x — 第一个值 (U)Int8/16/32/64 或 Float* 或 Decimal
y — 第二个值 (U)Int8/16/32/64 或 Float* 或 Decimal

返回值

返回 x 和 y 中较大的值。 Float64

示例

使用示例

SELECT max2(-1, 2)

midpoint

引入于：v25.11

计算并返回所提供参数的平均值。支持数值和时间类型。

语法

midpoint(x1[, x2, ...])

参数

x1[, x2, ...] — 接受单个值或多个值进行平均。

返回值

返回所提供参数的平均值，提升到最大的兼容类型。

示例

数值类型

SELECT midpoint(1, toUInt8(3), 0.5) AS result, toTypeName(result) AS type;
-- The type returned is a Float64 as the UInt8 must be promoted to 64 bit for the comparison.

┌─result─┬─type────┐
│    1.5 │ Float64 │
└────────┴─────────┘

十进制类型

SELECT midpoint(toDecimal32(1.5, 2), toDecimal32(1, 1), 2) AS result, toTypeName(result) AS type;

┌─result─┬─type──────────┐
│    1.5 │ Decimal(9, 2) │
└────────┴───────────────┘

日期类型

SELECT midpoint(toDate('2025-01-01'), toDate('2025-01-05')) AS result, toTypeName(result) AS type;

┌─────result─┬─type─┐
│ 2025-01-03 │ Date │
└────────────┴──────┘

日期时间类型

SELECT midpoint(toDateTime('2025-01-01 00:00:00'), toDateTime('2025-01-03 12:00:00')) AS result, toTypeName(result) AS type;

┌──────────────result─┬─type─────┐
│ 2025-01-02 06:00:00 │ DateTime │
└─────────────────────┴──────────┘

Time64 类型

SELECT midpoint(toTime64('12:00:00', 0), toTime64('14:00:00', 0)) AS result, toTypeName(result) AS type;

┌───result─┬─type──────┐
│ 13:00:00 │ Time64(0) │
└──────────┴───────────┘

min2

引入于：v21.11

返回两个数值 x 和 y 中较小的一个。

语法

min2(x, y)

参数

x — 第一个值 (U)Int8/16/32/64 或 Float* 或 Decimal
y — 第二个值 (U)Int8/16/32/64 或 Float* 或 Decimal

返回值

返回 x 和 y 中较小的值。 Float64

示例

使用示例

SELECT min2(-1, 2)

-1

minus

引入于：v1.1

计算两个值 a 和 b 的差。结果始终是有符号的。与 plus 类似，可以将整数从日期或日期与时间中减去。此外，还支持日期与时间之间的减法，从而得到它们之间的时间差。

语法

minus(x, y)

参数

x — 被减数。 - y — 减数。

返回值

x 减 y

示例

减去两个数字

SELECT minus(10, 5)

减去一个整数和一个日期

SELECT minus(toDate('2025-01-01'),5)

2024-12-27

modulo

引入于：v1.1

计算 a 除以 b 的余数。

如果两个输入都是整数，则结果类型为整数。如果其中一个输入是浮点数，则结果类型为 Float64。

余数计算方式与 C++ 相同。对于负数使用截断除法。

除以零或将最小负数除以负一时会抛出异常。

语法

modulo(a, b)

别名：mod

参数

a — 被除数 - b — 除数（模数）

返回值

a % b 的余数

示例

使用示例

SELECT modulo(5, 2)

moduloOrNull

引入于：v25.5

计算 a 除以 b 的余数。类似于函数 modulo，但如果右侧参数为 0，则 moduloOrNull 将返回 NULL。

语法

moduloOrNull(x, y)

别名：modOrNull

参数

x — 被除数。 (U)Int* 或 Float*
y — 除数（模数）。 (U)Int* 或 Float*

返回值

返回 x 除以 y 的余数，或者当除数为零时返回 null。

示例

moduloOrNull 除以零

SELECT moduloOrNull(5, 0)

\N

moduloOrZero

引入于：v20.3

类似于 modulo，但当除数为零时返回零，而不是像 modulo 函数那样抛出异常。

语法

moduloOrZero(a, b)

参数

a — 被除数。 (U)Int* 或 Float*
b — 除数（模数）。 (U)Int* 或 Float*

返回值

返回 a % b 的余数，或者当除数为 0 时返回 0。

示例

使用示例

SELECT moduloOrZero(5, 0)

multiply

引入于：v1.1

计算两个值 x 和 y 的乘积。

语法

multiply(x, y)

参数

x — 因子。 (U)Int* 或 Float* 或 Decimal
y — 因子。 (U)Int* 或 Float* 或 Decimal

返回值

返回 x 和 y 的乘积

示例

乘两个数

SELECT multiply(5,5)

multiplyDecimal

引入于：v22.12

对两个十进制数执行乘法运算。结果值的类型为 Decimal256。可以通过 result_scale 参数（范围为 [0, 76] 的整数）显式指定结果刻度。如果未指定，则结果刻度为给定参数的最大刻度。

注意

这些函数比通常的 multiply 慢得多。如果您实际上不需要受控精度和/或需要快速计算，请考虑使用 multiply

语法

multiplyDecimal(a, b[, result_scale])

参数

a — 第一个值。 Decimal
b — 第二个值。 Decimal
result_scale — 结果的刻度。 (U)Int*

返回值

具有给定刻度的乘法结果。类型：Decimal256

示例

使用示例

SELECT multiplyDecimal(toDecimal256(-12, 0), toDecimal32(-2.1, 1), 1)

25.2

与常规乘法的区别

SELECT multiplyDecimal(toDecimal256(-12, 0), toDecimal32(-2.1, 1), 1)

┌─multiply(toDecimal64(-12.647, 3), toDecimal32(2.1239, 4))─┐
│                                               -26.8609633 │
└───────────────────────────────────────────────────────────┘
┌─multiplyDecimal(toDecimal64(-12.647, 3), toDecimal32(2.1239, 4))─┐
│                                                         -26.8609 │
└──────────────────────────────────────────────────────────────────┘

十进制溢出

SELECT
    toDecimal64(-12.647987876, 9) AS a,
    toDecimal64(123.967645643, 9) AS b,
    multiplyDecimal(a, b);
SELECT
    toDecimal64(-12.647987876, 9) AS a,
    toDecimal64(123.967645643, 9) AS b,
    a * b;

┌─────────────a─┬─────────────b─┬─multiplyDecimal(toDecimal64(-12.647987876, 9), toDecimal64(123.967645643, 9))─┐
│ -12.647987876 │ 123.967645643 │                                                               -1567.941279108 │
└───────────────┴───────────────┴───────────────────────────────────────────────────────────────────────────────┘
Received exception from server (version 22.11.1):
Code: 407. DB::Exception: Received from localhost:9000. DB::Exception: Decimal math overflow:
While processing toDecimal64(-12.647987876, 9) AS a, toDecimal64(123.967645643, 9) AS b, a * b. (DECIMAL_OVERFLOW)

negate

引入于：v1.1

否定参数 x。结果始终是有符号的。

语法

negate(x)

参数

x — 要否定的值。

返回值

返回 x 的 -x

示例

使用示例

SELECT negate(10)

-10

plus

引入于：v1.1

计算两个值 x 和 y 的和。别名：x + y（运算符）。可以添加整数和日期或日期与时间。前一种操作会增加日期中的天数，后一种操作会增加日期与时间中的秒数。

语法

plus(x, y)

参数

x — 左操作数。 - y — 右操作数。

返回值

返回 x 和 y 的和

示例

加两个数

SELECT plus(5,5)

将整数和日期相加

SELECT plus(toDate('2025-01-01'),5)

2025-01-06

positiveModulo

引入于：v22.11

计算 x 除以 y 的余数。类似于函数 modulo，但 positiveModulo 始终返回非负数。

语法

positiveModulo(x, y)

别名：positive_modulo, pmod

参数

x — 被除数。 (U)Int* 或 Float* 或 Decimal
y — 除数（模数）。 (U)Int* 或 Float* 或 Decimal

返回值

返回 x 与小于或等于 x 且可被 y 整除的最近整数之间的差。

示例

使用示例

SELECT positiveModulo(-1, 10)

positiveModuloOrNull

引入于：v25.5

计算 a 除以 b 的余数。类似于函数 positiveModulo，但如果右侧参数为 0，则 positiveModuloOrNull 将返回 NULL。

语法

positiveModuloOrNull(x, y)

别名：positive_modulo_or_null, pmodOrNull

参数

x — 被除数。 (U)Int*/Float32/64. - x — 除数（模数）。 (U)Int*/Float32/64。

返回值

返回 x 与小于或等于 x 且可被 y 整除的最近整数之间的差，当除数为零时返回 null。

示例

positiveModuloOrNull

SELECT positiveModuloOrNull(5, 0)

\N

概述​

abs​

avg2​

byteSwap​

divide​

divideDecimal​

divideOrNull​

gcd​

ifNotFinite​

intDiv​

intDivOrNull​

intDivOrZero​

isFinite​

isInfinite​

isNaN​

lcm​

max2​

midpoint​

min2​

minus​

modulo​

moduloOrNull​

moduloOrZero​

multiply​

multiplyDecimal​

negate​

plus​

positiveModulo​

positiveModuloOrNull​

概述

abs

avg2

byteSwap

divide

divideDecimal

divideOrNull

gcd

ifNotFinite

intDiv

intDivOrNull

intDivOrZero

isFinite

isInfinite

isNaN

lcm

max2

midpoint

min2

minus

modulo

moduloOrNull

moduloOrZero

multiply

multiplyDecimal

negate

plus

positiveModulo

positiveModuloOrNull