时区

Doris 支持自定义时区设置

基本概念

Doris 内部存在以下两个时区相关参数：

• system_time_zone : 当服务器启动时，会根据机器设置时区自动设置，设置后不可修改。

• time_zone : 集群当前时区，可以修改。

具体操作

1. show variables like '%time_zone%'

   查看当前时区相关配置

2. SET [global] time_zone = 'Asia/Shanghai'

   该命令可以设置 session 级别的时区，如使用global关键字，则 Doris FE 会将参数持久化，之后对所有新 session 生效。

数据来源

时区数据包含时区名、对应时间偏移量、夏令时变化情况等。在 BE 所在机器上，其数据来源依次为：

1. TZDIR 命令返回的目录，如不支持该命令，则为 /usr/share/zoneinfo 目录

2. Doris BE 部署目录下生成的 zoneinfo 目录。产生自 Doris Repository 下的 resource/zoneinfo.tar.gz

按顺序查找以上数据源，如果找到则使用当前项。如果 BE 配置项 use_doris_tzfile 为 true，则跳过对第一项的查找。如均未找到，则 Doris BE 将启动失败，请重新正确构建 BE 或获取发行版。

时区的影响

1. 函数

包括NOW()或CURTIME()等时间函数显示的值，也包括show load, show backends中的时间值。

但不会影响 create table 中时间类型分区列的 less than 值，也不会影响存储为 date/datetime 类型的值的显示。

受时区影响的函数：

• FROM_UNIXTIME：给定一个 UTC 时间戳，返回其在 Doris session time_zone 指定时区的日期时间，如time_zone为CST时FROM_UNIXTIME(0)返回1970-01-01 08:00:00。

• UNIX_TIMESTAMP：给定一个日期时间，返回其在 Doris session time_zone 指定时区下的 UTC 时间戳，如time_zone为CST时UNIX_TIMESTAMP('1970-01-01 08:00:00')返回0。

• CURTIME：返回当前 Doris session time_zone 指定时区的时间。

• NOW：返回当前 Doris session time_zone 指定时区的日期时间。

• CONVERT_TZ：将一个日期时间从一个指定时区转换到另一个指定时区。

2. 时间类型的值

对于DATE、DATETIME类型，我们支持导入数据时对时区进行转换。

• 如果数据带有时区，如 "2020-12-12 12:12:12+08:00"，而当前 Doris time_zone = +00:00 或者 Stream Load 指定的 header timezone 为 +00:00 ，则数据导入 Doris 得到实际值为 "2020-12-12 04:12:12"。

• 如果数据不带有时区，如 "2020-12-12 12:12:12"，则认为该时间为绝对时间，不发生任何转换。

3. 夏令时

夏令时的本质是具名时区的实际时间偏移量，在一定日期内发生改变。

例如，America/Los_Angeles时区包含一次夏令时调整，起止时间为约为每年 3 月至 11 月。即，三月份夏令时开始时，America/Los_Angeles实际时区偏移由-08:00变为-07:00，11 月夏令时结束时，又从-07:00变为-08:00。 如果不希望开启夏令时，则应设定 time_zone 为 -08:00 而非 America/Los_Angeles。

使用方式

时区值可以使用多种格式给出，以下是 Doris 中完善支持的标准格式：

1. 标准具名时区格式，如 "Asia/Shanghai", "America/Los_Angeles"

2. 标准偏移格式，如 "+02:30", "-10:00"

3. 缩写时区格式，当前仅支持：

   1. "GMT", "UTC"，等同于 "+00:00" 时区

   2. "CST", 等同于 "Asia/Shanghai" 时区

4. 单字母 Z，代表 Zulu 时区，等同于 "+00:00" 时区

注意：由于实现方式的不同，当前 Doris 存在部分其他格式在部分导入方式中得到了支持。生产环境不应当依赖这些未列于此的格式，它们的行为随时可能发生变化，请关注版本更新时的相关 changelog。

最佳实践

时区敏感数据

时区问题主要涉及三个影响因素：

1. session variable time_zone —— 集群时区

2. Stream Load、Broker Load 等导入时指定的 header timezone —— 导入时区

3. 时区类型字面量 "2023-12-12 08:00:00+08:00" 中的 "+08:00" —— 数据时区

我们可以做如下理解：

Doris 目前兼容各时区下的数据向 Doris 中进行导入。而由于 Doris 自身 DATETIME 等各个时间类型本身不内含时区信息，且数据在导入后不会随时区变化而变更，因此时间数据导入 Doris 时，可分为如下两类：

1. 绝对时间

   绝对时间是指，它所关联的数据场景与时区无关。对于这类数据，在导入时应该不带有任何时区后缀，它们将被原样存储。

2. 特定时区下的时间

   某个特定时区下的时间是指，它所关联的数据场景与时区有关。对于这类数据，在导入时应该带有具体时区后缀，导入时它们将被转化至 Doris 集群 time_zone 时区或 Stream Load/Broker Load 中指定的 header timezone。

   这类数据在导入后即被转化至导入时指定时区下的绝对时间存储，故后续导入和查询应当保持此时区，以免数据意义发生紊乱。

• 对于 Insert 语句，我们可以通过以下例子来说明：

  Doris > select @@time_zone;
  +---------------+
  | @@time_zone   |
  +---------------+
  | Asia/Shanghai |
  +---------------+
   
  Doris > insert into dt values('2020-12-12 12:12:12+02:00'); --- 导入的数据中指定了时区为 +02:00
   
  Doris > select * from dt;
  +---------------------+
  | dt                  |
  +---------------------+
  | 2020-12-12 18:12:12 | --- 被转换为 Doris 集群时区 Asia/Shanghai，后续导入和查询应当保持此时区。
  +---------------------+
   
  Doris > set time_zone = 'America/Los_Angeles';
   
  Doris > select * from dt;
  +---------------------+
  | dt                  |
  +---------------------+
  | 2020-12-12 18:12:12 | --- 如果修改 time_zone，时间值不会随之改变，其查询时的意义发生紊乱。
  +---------------------+

• 对于 Stream Load、Broker Load 等导入方式，我们可以通过指定 header timezone 来实现。例如，对于 Stream Load，我们可以通过以下例子来说明：

   cat dt.csv
   2020-12-12 12:12:12+02:00
    
   curl --location-trusted -u root: \
    -H "Expect:100-continue" \
    -H "strict_mode: true" \
    -H "timezone: Asia/Shanghai" \
    -T dt.csv -XPUT \
    http://127.0.0.1:8030/api/test/dt/_stream_load

  Doris > select @@time_zone;
  +---------------+
  | @@time_zone   |
  +---------------+
  | Asia/Shanghai |
  +---------------+
   
  Doris > select * from dt;
  +---------------------+
  | dt                  |
  +---------------------+
  | 2020-12-12 18:12:12 | --- 被转换为 Doris 集群时区 Asia/Shanghai，后续导入和查询应当保持此时区。
  +---------------------+
  提示

  • Stream Load、Broker Load 等导入方式中，header timezone 会覆盖 Doris 集群 time_zone，因此在导入时应当保持一致。
  • Stream Load、Broker Load 等导入方式中，header timezone 会影响导入转换中使用的函数。
  • 如果导入时未指定 header timezone，则默认使用东八区。

综上所述，处理时区问题最佳的实践是：

最佳实践

1. 在使用前确认该集群所表征的时区并设置 time_zone，在此之后不再更改。

2. 在导入时设定 header timezone 同集群 time_zone 一致。

3. 对于绝对时间，导入时不带时区后缀；对于有时区的时间，导入时带具体时区后缀，导入后将被转化至 Doris time_zone 时区。

夏令时

夏令时的起讫时间来自当前时区数据源，不一定与当年度时区所在地官方实际确认时间完全一致。该数据由 ICANN 进行维护。如果需要确保夏令时表现与当年度实际规定一致，请保证 Doris 所选择的数据源为最新的 ICANN 所公布时区数据，下载途径见下文。

信息更新

真实世界中的时区与夏令时相关数据，将会因各种原因而不定期发生变化。IANA 会定期记录这些变化并更新相应时区文件。如果希望 Doris 中的时区信息与最新的IANA 数据保持一致，请采取下列方式进行更新：

1. 使用包管理器更新

根据当前操作系统使用的包管理器，用户可以使用对应的命令直接更新时区数据：

# yum
> sudo yum update tzdata
# apt
> sudo apt update tzdata

该方式更新的数据位于系统 $TZDIR 下（一般为 usr/share/zoneinfo）。如果 use_doris_tzfile = true，则用户应当将其覆盖至 BE 部署目录下的 zoneinfo 目录。

2. 直接拉取 IANA 时区数据库（推荐）

大多数 Linux 发行版的包管理器，tzdata 的同步并不及时。如果对时区数据准确性要求较高，可以直接拉取 IANA 定期公布的数据：

wget https://www.iana.org/time-zones/repository/tzdb-latest.tar.lz

然后根据解压后文件夹中的 README 文件，生成具体的 zoneinfo 数据。生成的数据应当拷贝至 $TZDIR 还是 BE 部署目录，取决于 BE config use_doris_tzfile 的值。

请注意，以上所有操作在 BE 所在机器上完成后，都必须重启对应 BE 才能生效。

拓展阅读

• 时区格式列表：List of tz database time zones

• IANA 时区数据库：IANA Time Zone Database

• ICANN 时区数据库：The tz-announce Archives