版本：0.9

概述

Datafusion 函数

由于 GreptimeDB 的查询引擎是基于 Apache Arrow DataFusion 构建的，GreptimeDB 继承了 DataFusion 中所有内置的函数。这些函数包括：

聚合函数: 如 COUNT、SUM、MIN、MAX 等。详细列表请参阅聚合函数
标量函数: 如 ABS、COS、FLOOR 等。详细列表请参阅标量函数
窗口函数: 对相关的一组行记录执行计算。详细列表请参阅窗口函数

要查看所有 DataFusion 函数，请参阅 DataFusion 函数。

`arrow_cast`

arrow_cast 函数来自 DataFusion 的 arrow_cast。其用法如下：

arrow_cast(expression, datatype)

其中 datatype 可以是此列表中的任何有效 Arrow 数据类型。四种时间戳类型是：

Timestamp(Second, None)
Timestamp(Millisecond, None)
Timestamp(Microsecond, None)
Timestamp(Nanosecond, None)

（注意 None 表示时间戳不考虑时区）

GreptimeDB 函数

字符串函数

DataFusion 字符串函数。GreptimeDB 提供：

matches(expression, pattern) 用于全文检索。

TODO：链接到全文检索用户指南。

数学函数

DataFusion 数学函数。GreptimeDB 额外提供：

clamp(value, lower, upper) 将给定值限制在上下界之间：

SELECT CLAMP(10, 0, 1);

+------------------------------------+
| clamp(Int64(10),Int64(0),Int64(1)) |
+------------------------------------+
|                                  1 |
+------------------------------------+

SELECT CLAMP(0.5, 0, 1);

+---------------------------------------+
| clamp(Float64(0.5),Int64(0),Int64(1)) |
+---------------------------------------+
|                                   0.5 |
+---------------------------------------+

mod(x, y) 获取一个数除以另一个数的余数：

SELECT mod(18, 4);

+-------------------------+
| mod(Int64(18),Int64(4)) |
+-------------------------+
|                       2 |
+-------------------------+

pow(x, y) 获取一个数的幂值：

SELECT pow(2, 10);

+-------------------------+
| pow(Int64(2),Int64(10)) |
+-------------------------+
|                    1024 |
+-------------------------+

日期和时间函数

DataFusion 时间和日期函数。GreptimeDB 额外提供：

date_add(expression, interval) 向 Timestamp、Date 或 DateTime 添加一个间隔值：

SELECT date_add('2023-12-06'::DATE, '3 month 5 day');

+----------------------------------------------------+
| date_add(Utf8("2023-12-06"),Utf8("3 month 5 day")) |
+----------------------------------------------------+
| 2024-03-11                                         |
+----------------------------------------------------+

date_sub(expression, interval) 从 Timestamp、Date 或 DateTime 减去一个间隔值：

SELECT date_sub('2023-12-06 07:39:46.222'::TIMESTAMP_MS, INTERVAL '5 day');

+-----------------------------------------------------------------------------------------------------------------------------------------+
| date_sub(arrow_cast(Utf8("2023-12-06 07:39:46.222"),Utf8("Timestamp(Millisecond, None)")),IntervalMonthDayNano("92233720368547758080")) |
+-----------------------------------------------------------------------------------------------------------------------------------------+
| 2023-12-01 07:39:46.222000                                                                                                              |
+-----------------------------------------------------------------------------------------------------------------------------------------+

date_format(expression, fmt) 将 Timestamp、Date 或 DateTime格式化：

SELECT date_format('2023-12-06 07:39:46.222'::TIMESTAMP, '%Y-%m-%d %H:%M:%S:%3f');

+-----------------------------------------------------------------------------------------------------------------------------+
| date_format(arrow_cast(Utf8("2023-12-06 07:39:46.222"),Utf8("Timestamp(Millisecond, None)")),Utf8("%Y-%m-%d %H:%M:%S:%3f")) |
+-----------------------------------------------------------------------------------------------------------------------------+
| 2023-12-06 07:39:46:222                                                                                                     |
+-----------------------------------------------------------------------------------------------------------------------------+

支持的格式化符号请参阅 chrono::format::strftime 模块。

to_unixtime(expression) 将表达式转换为 Unix 时间戳（秒）。参数可以是整数（毫秒 Unix 时间戳）、Timestamp、Date、DateTime 或字符串类型。如果参数是字符串类型，函数将首先尝试将其转换为 DateTime、Timestamp 或 Date。

select to_unixtime('2023-03-01T06:35:02Z');

+-------------------------------------------+
| to_unixtime(Utf8("2023-03-01T06:35:02Z")) |
+-------------------------------------------+
|                                1677652502 |
+-------------------------------------------+

select to_unixtime('2023-03-01'::date);

+---------------------------------+
| to_unixtime(Utf8("2023-03-01")) |
+---------------------------------+
|                      1677628800 |
+---------------------------------+

to_timezone(expression, timezone) 根据时区转换表达式。参数可以是整数（毫秒 Unix 时间戳）、Timestamp 或字符串类型。如果参数是字符串类型，函数将首先尝试将其转换为 Timestamp。

SELECT to_timezone('2022-09-20T14:16:43.012345+08:00', 'Europe/Berlin');

+-----------------------------------------------------------------------------+
| to_timezone(Utf8("2022-09-20T14:16:43.012345+08:00"),Utf8("Europe/Berlin")) |
+-----------------------------------------------------------------------------+
| 2022-09-20 08:16:43.012345                                                  |
+-----------------------------------------------------------------------------+

SELECT to_timezone(1709992225000, 'Asia/Shanghai');

+---------------------------------------------------------+
| to_timezone(Int64(1709992225000),Utf8("Asia/Shanghai")) |
+---------------------------------------------------------+
| 2024-03-09 21:50:25                                     |
+---------------------------------------------------------+

timezone() 查询当前会话时区：

select timezone();

+------------+
| timezone() |
+------------+
| UTC        |
+------------+

系统函数

isnull(expression) 检查表达式是否为 NULL：

 SELECT isnull(1);
 
 +------------------+
| isnull(Int64(1)) |
+------------------+
|                0 |
+------------------+

SELECT isnull(NULL);

+--------------+
| isnull(NULL) |
+--------------+
|            1 |
+--------------+

build() 查询 GreptimeDB 构建信息。
version() 查询 GreptimeDB 版本信息。
database() 查询当前会话数据库：

select database();

+------------+
| database() |
+------------+
| public     |
+------------+

管理函数

GreptimeDB 提供一些管理数据库和数据的函数：

flush_table(table_name) 通过表名将表的内存表刷写到 SST 文件。
flush_region(region_id) 通过 Region Id 将 Region 的内存表刷写到 SST 文件。可以通过 PARTITIONS 表查找一张表的所有 Region Id。
compact_table(table_name) 通过表名为表发起compaction 任务。
compact_region(region_id) 通过 Region Id 为 Region 发起 compaction 任务。
migrate_region(region_id, from_peer, to_peer, [timeout]) 在 Datanode 之间迁移 Region，请阅读 Region迁移。
procedure_state(procedure_id) 通过 Procedure Id 查询 Procedure 状态。
flush_flow(flow_name) 通过 Flow 名称将 Flow 的输出刷写到结果表。

例如：

-- 刷新表 test --
admin flush_table("test");

-- 为表 test 安排压缩任务 --
admin compact_table("test".md);

概述

Datafusion 函数​

arrow_cast​

GreptimeDB 函数​

字符串函数​

数学函数​

日期和时间函数​

系统函数​

管理函数​