Skip to content

docs: update stream doc #32374

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
guanshengliang merged 2 commits into from
Jul 30, 2025
Merged

docs: update stream doc #32374

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1d9f750
docs: update stream doc
guanshengliang Jul 30, 2025
8c9e368
fix: typo
guanshengliang Jul 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions docs/zh/14-reference/03-taos-sql/14-stream.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,11 +72,11 @@ PERIOD(period_time[, offset_time])

- 定时间隔小于 1 天时，基准时间点为每日零点加定时偏移，根据定时间隔来确定下次触发的时间点。基准时间点在每日零点重置。每日最后一次触发的时间点与下一日的基准时间点之间的间隔可能小于定时间隔。例如：
- 定时间隔为 5 小时 30 分钟，那么当天的触发时刻为 `[00:00, 05:30, 11:00, 16:30, 22:00]`，后续每一天的触发时刻都是相同的。
- 同样的定时间隔，如果指定时间偏移为 1 秒，那么当天的触发时刻为 `[00:01, 05:31, 11:01, 16:31, 22:01]`，后续每一天的触发时刻都是相同的。
- 同样的定时间隔，如果指定时间偏移为 1 分钟，那么当天的触发时刻为 `[00:01, 05:31, 11:01, 16:31, 22:01]`，后续每一天的触发时刻都是相同的。
- 同样条件下，如果建流时当前系统时间为 `12:00`，那么当天的触发时刻为 `[16:31, 22:01]`，后续每一天内的触发时刻为 `[00:01, 05:31, 11:01, 16:31, 22:01]`。
- 定时间隔大于等于 1 天时，基准时间点为当日的零点加定时偏移，后续不会重置。例如：
- 定时间隔为 1 天 1 小时，建流时当前系统时间为 `05-01 12:00`，那么在当天及随后几天的触发时刻为 `[05-02 01:00, 05-03 02:00, 05-04 03:00, 05-05 04:00, ……]`。
- 同样条件下，如果指定时间偏移为 1 秒，那么当天及随后几天的触发时刻为 `[05-02 01:01, 05-03 02:02, 05-04 03:03, 05-05 04:04, ……]`。
- 同样条件下，如果指定时间偏移为 1 分钟，那么当天及随后几天的触发时刻为 `[05-02 01:01, 05-03 02:02, 05-04 03:03, 05-05 04:04, ……]`。

适用场景：需要按照系统时间连续定时驱动计算的场景，例如每小时计算生成一次当天的统计数据，每天定时发送统计报告等。

Expand Down Expand Up @@ -474,7 +474,6 @@ event_type: {WINDOW_OPEN | WINDOW_CLOSE | ON_TIME}
- triggerType：字符串类型，表示触发类型，支持 Period、SLIDING 两种非窗口触发类型以及 INTERVAL、State、Session、Event、Count 五种窗口类型。
- groupId: 字符串类型，是对应分组的唯一标识符，如果是按子表分组，则与对应表的 uid 一致。


###### 定时触发相关字段

这部分是 triggerType 为 Period 时 event 对象的关键字段。
Expand All @@ -489,7 +488,7 @@ event_type: {WINDOW_OPEN | WINDOW_CLOSE | ON_TIME}
- eventType 固定为 ON_TIME，包含如下字段：
- result：计算结果，为键值对形式，包含窗口计算的结果列列名及其对应的值。

###### 滑动触发（Interval）相关字段
###### 时间窗口（Interval）相关字段

这部分是 triggerType 为 Interval 时 event 对象的关键字段。

Expand Down
Loading