Skip to content

Commit eed0aac

Browse files
docs: update stream docs (#31768)
1 parent 2984bd4 commit eed0aac

File tree

1 file changed

+62
-32
lines changed

1 file changed

+62
-32
lines changed

docs/zh/14-reference/03-taos-sql/14-stream.md

Lines changed: 62 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ trigger_type: {
3131
| COUNT_WINDOW(count_val[, sliding_val][, col1[, ...]])
3232
}
3333

34-
stream_option: {WATERMARK(duration_time) | EXPIRED_TIME(exp_time) | IGNORE_DISORDER | DELETE_RECALC | DELETE_OUTPUT_TABLE | FILL_HISTORY[(start_time)] | FILL_HISTORY_FIRST[(start_time)] | CALC_NOTIFY_ONLY | LOW_LATENCY_CALC | PRE_FILTER(expr) | FORCE_OUTPUT | MAX_DELAY(delay_time) | EVENT_TYPE(event_types)}
34+
stream_option: {WATERMARK(duration_time) | EXPIRED_TIME(exp_time) | IGNORE_DISORDER | DELETE_RECALC | DELETE_OUTPUT_TABLE | FILL_HISTORY[(start_time)] | FILL_HISTORY_FIRST[(start_time)] | CALC_NOTIFY_ONLY | LOW_LATENCY_CALC | PRE_FILTER(expr) | FORCE_OUTPUT | MAX_DELAY(delay_time) | EVENT_TYPE(event_types) | IGNORE_NODATA_TRIGGER}
3535

3636
notification_definition:
3737
NOTIFY(url [, ...]) [ON (event_types)] [WHERE condition] [NOTIFY_OPTIONS(notify_option[|notify_option])]
@@ -49,22 +49,19 @@ tag_definition:
4949

5050
### 流式计算的触发方式
5151

52-
流式计算支持事件触发和定时触发两种触发方式,触发对象与计算对象彼此分离。
53-
54-
- 事件触发:通过与触发表关联的事件时间驱动,可以灵活的定义和使用各种窗口来产生触发事件,支持在开窗、关窗以及开关窗同时进行触发,支持对触发数据进行预先过滤处理,只有符合条件的数据才会进入触发。
55-
- 定时触发:与事件时间无关,按照系统时间定时触发。
52+
事件触发是流计算的驱动方式,事件触发产生的来源可能多种多样,可以来自于某个表的数据写入,也可以来自于对某个表的计算分析结果,甚至可以不来自于任何表。当流计算引擎检测到符合用户定义的触发条件时,就会触发计算,条件符合次数和计算触发次数是相同的,触发对象与计算对象彼此分离。用户可以灵活的定义和使用各种窗口来产生触发事件,支持在开窗、关窗以及开关窗同时进行触发,支持分组触发,支持对触发数据进行预先过滤处理。
5653

5754
#### 触发类型
5855

59-
触发类型通过 `trigger_type` 指定,支持定时触发、滑动触发、会话窗口触发、状态窗口触发、事件窗口触发、计数窗口触发。其中,会话窗口、状态窗口、事件窗口和计数窗口搭配超级表时,必须与 `partition by tbname` 一起使用。
56+
触发类型通过 `trigger_type` 指定,包括定时触发、滑动触发、滑动窗口触发、会话窗口触发、状态窗口触发、事件窗口触发、计数窗口触发。其中,状态窗口、事件窗口和计数窗口搭配超级表时,必须与 `partition by tbname` 一起使用。
6057

6158
##### 定时触发
6259

6360
```sql
6461
PERIOD(period_time[, offset_time])
6562
```
6663

67-
定时触发通过系统时间的固定间隔来驱动,以建流当天系统时间的零点作为基准时间点,然后根据间隔来确定下次触发的时间点,可以通过指定时间偏移来改变基准时间点。各参数含义如下:
64+
定时触发通过系统时间的固定间隔来驱动,以建流当天系统时间的零点作为基准时间点,然后根据间隔来确定下次触发的时间点,可以通过指定时间偏移来改变基准时间点。定时触发本质上就是我们常说的定时任务,定时触发不属于窗口触发。各参数含义如下:
6865

6966
- period_time:定时触发的系统时间间隔,支持的时间单位包括:毫秒 (a)、秒 (s)、分 (m)、小时 (h)、天 (d),支持的时间范围为 `[10a, 3650d]`
7067
- offset_time:可选,指定定时触发的时间偏移,支持的时间单位包括:毫秒 (a)、秒 (s)、分 (m)、小时 (h)。
@@ -84,28 +81,44 @@ PERIOD(period_time[, offset_time])
8481
##### 滑动触发
8582

8683
```sql
87-
[INTERVAL(interval_val[, interval_offset])] SLIDING(sliding_val[, offset_time])
84+
SLIDING(sliding_val[, offset_time])
8885
```
8986

90-
滑动触发是指对触发表的写入数据按照事件时间的固定间隔来驱动的触发。可以有 INTERVAL 窗口,也可以没有。
91-
92-
- 存在 `INTERVAL` 窗口时,滑动触发的起始时间点是窗口的起始点,可以指定窗口的时间偏移,此时滑动的时间偏移不起作用。
93-
- 不存在 `INTERVAL` 窗口时,滑动触发的触发时刻、时间偏移规则同定时触发相同,唯一的区别是系统时间变更为事件时间。
87+
滑动触发是指对触发表的写入数据按照事件时间的固定间隔来驱动的触发。不可以指定 INTERVAL 窗口,不属于窗口触发,必须指定触发表。滑动触发的触发时刻、时间偏移规则和定时触发相同,唯一的区别是系统时间变更为事件时间。
9488

9589
各参数含义如下:
9690

97-
- interval_val:可选,滑动窗口的时长。
98-
- interval_offset:可选,滑动窗口的时间偏移。
9991
- sliding_val:必选,事件时间的滑动时长。
10092
- offset_time:可选,指定滑动触发的时间偏移,支持的时间单位包括:毫秒 (a)、秒 (s)、分 (m)、小时 (h)。
10193

10294
使用说明:
10395

10496
- 必须指定触发表,触发表为超级表时支持按标签、子表分组,支持不分组。
105-
- 支持对写入数据进行处理过滤后(有条件)的窗口触发
97+
- 支持对写入数据进行处理过滤后(有条件)的滑动触发
10698

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

101+
##### 滑动窗口触发
102+
103+
```sql
104+
[INTERVAL(interval_val[, interval_offset])] SLIDING(sliding_val)
105+
```
106+
107+
滑动窗口触发是指对触发表的写入数据按照事件时间和固定窗口大小滑动而形成的触发,必须指定 INTERVAL 窗口,属于窗口触发,必须指定触发表。
108+
109+
滑动窗口触发的起始时间点是窗口的起始点,窗口默认是从 Unix time 0(1970-01-01 00:00:00 UTC)开始划分,可以通过指定窗口时间偏移的方式来改变窗口的划分起始点。各参数含义如下:
110+
111+
- interval_val:可选,滑动窗口的时长。
112+
- interval_offset:可选,滑动窗口的时间偏移。
113+
- sliding_val:必选,事件时间的滑动时长。
114+
115+
使用说明:
116+
117+
- 必须指定触发表,触发表为超级表时支持按标签、子表分组,支持不分组。
118+
- 支持对写入数据进行处理过滤后(有条件)的滑动窗口触发。
119+
120+
适用场景:需要按照事件时间定时窗口计算的场景,例如每小时计算生成该小时内的统计数据,每隔 1 小时计算最后 5 分钟窗口内的数据等场景。
121+
109122
##### 会话窗口触发
110123

111124
```sql
@@ -120,7 +133,6 @@ SESSION(ts_col, session_val)
120133
使用说明:
121134

122135
- 必须指定触发表,触发表为超级表时支持按标签、子表分组,支持不分组。
123-
- 搭配超级表时,必须与 `partition by tbname` 一起使用。
124136
- 支持对写入数据进行处理过滤后(有条件)的窗口触发。
125137

126138
适用场景:需要通过会话窗口驱动计算和(或)通知的场景。
@@ -172,7 +184,7 @@ COUNT_WINDOW(count_val[, sliding_val][, col1[, ...]])
172184

173185
计数窗口触发是指对触发表的写入数据按照计数窗口的方式进行窗口划分,当窗口启动和(或)关闭时进行的触发。支持列的触发,只有当指定的列有数据写入时才触发。各参数含义如下:
174186

175-
- count_val:计数条数,当写入数据条目数达到 `count_val` 时触发。
187+
- count_val:计数条数,当写入数据条目数达到 `count_val` 时触发,最小值为 1
176188
- sliding_val:可选,窗口滑动的条数。
177189
- col1 [, ...]:可选,按列触发模式时的数据列列表,列表中任一列有非空数据写入时才为有效条目,NULL 值视为无效值。
178190

@@ -218,7 +230,9 @@ COUNT_WINDOW(count_val[, sliding_val][, col1[, ...]])
218230
[PARTITION BY col1 [, ...]]
219231
```
220232

221-
### 流式计算的输出结果
233+
### 流式计算的结果输出
234+
235+
流计算的计算结果默认会保存到输出表中,每个输出表中的计算结果是截至当前时刻已经触发和计算完成的输出。可以指定输出表的结构定义,如果存在分组还可以指定子表的标签值。
222236

223237
```sql
224238
[INTO [db_name.]table_name] [OUTPUT_SUBTABLE(tbname_expr)] [(column_name1, column_name2 [COMPOSITE KEY][, ...])] [TAGS (tag_definition [, ...])]
@@ -227,7 +241,7 @@ tag_definition:
227241
tag_name type_name [COMMENT 'string_value'] AS expr
228242
```
229243

230-
指定输出表的结构定义,如果存在分组还可以指定子表的标签值。说明如下:
244+
说明如下:
231245

232246
- INTO [db_name.]table_name:可选,指定输出表的表名为 `table_name` 和所在数据库名 `db_name`
233247
- 存在触发分组时该表为超级表。
@@ -276,15 +290,15 @@ tag_definition:
276290
使用限制:
277291

278292
- %%trows:只能用于 FROM 子句,推荐在小数据量场景下使用。
279-
- %%tbname:只能用于 FROM、SELECT 和 WHERE 子句。
293+
- %%tbname:可以用于 FROM、SELECT 和 WHERE 子句。
280294
- 其他占位符:只能用于 SELECT 和 WHERE 子句。
281295

282296
### 流式计算的控制选项
283297

284298
```sql
285299
[OPTIONS(stream_option [|...])]
286300

287-
stream_option: {WATERMARK(duration_time) | EXPIRED_TIME(exp_time) | IGNORE_DISORDER | DELETE_RECALC | DELETE_OUTPUT_TABLE | FILL_HISTORY[(start_time)] | FILL_HISTORY_FIRST[(start_time)] | CALC_NOTIFY_ONLY | LOW_LATENCY_CALC | PRE_FILTER(expr) | FORCE_OUTPUT | MAX_DELAY(delay_time) | EVENT_TYPE(event_types)}
301+
stream_option: {WATERMARK(duration_time) | EXPIRED_TIME(exp_time) | IGNORE_DISORDER | DELETE_RECALC | DELETE_OUTPUT_TABLE | FILL_HISTORY[(start_time)] | FILL_HISTORY_FIRST[(start_time)] | CALC_NOTIFY_ONLY | LOW_LATENCY_CALC | PRE_FILTER(expr) | FORCE_OUTPUT | MAX_DELAY(delay_time) | EVENT_TYPE(event_types) | IGNORE_NODATA_TRIGGER}
288302
```
289303

290304
控制选项用于控制触发和计算行为,可以多选,同一个选项不可以多次指定。包括:
@@ -304,6 +318,10 @@ stream_option: {WATERMARK(duration_time) | EXPIRED_TIME(exp_time) | IGNORE_DISOR
304318
- EVENT_TYPE(event_types):指定窗口触发的事件类型,可以多选,未指定时默认值为 `WINDOW_CLOSE`。SLIDING 触发(不带 INTERVAL)和 PERIOD 触发不适用(自动忽略)。各选项含义如下:
305319
- WINDOW_OPEN:窗口启动事件。
306320
- WINDOW_CLOSE:窗口关闭事件。
321+
- IGNORE_NODATA_TRIGGER:指定忽略触发表无输入数据时的触发,适用于滑动触发(SLIDING)、滑动窗口触发(INTERVAL)、定时触发(PERIOD)。
322+
- 滑动触发与定时触发:如果两次触发时刻中间触发表没有数据则忽略该次触发。
323+
- 滑动窗口触发:如果窗口内触发表没有数据则忽略该次触发。
324+
- 没有未指定时:不忽略无输入数据时的触发。
307325

308326
### 流式计算的通知机制
309327

@@ -501,6 +519,7 @@ event_type: {WINDOW_OPEN | WINDOW_CLOSE}
501519
- conditionIndex:整型,表示满足的触发窗口关闭的条件的索引,从 0 开始编号。
502520
- fieldValue:键值对形式,包含条件列列名及其对应的值。
503521
- result:计算结果,为键值对形式,包含窗口计算的结果列列名及其对应的值。
522+
504523
###### 计数窗口相关字段
505524

506525
这部分是 windowType 为 Count 时 event 对象才有的字段。
@@ -532,7 +551,7 @@ DROP STREAM [IF EXISTS] [db_name.]stream_name;
532551

533552
##### 查看流计算信息
534553

535-
显示当前数据库或指定数据库所属的流计算
554+
显示当前数据库或指定数据库的流计算
536555

537556
```sql
538557
SHOW [db_name.]STREAMS;
@@ -639,7 +658,7 @@ TDengine 的窗口类型大多与主键列相关联,比如事件窗口要根
639658

640659
支持使用 `WATERMARK` 来解决一定程度的乱序、更新、删除场景带来的问题。`WATERMARK` 是用户可以指定的基于事件时间的时长,它代表的是事件时间在流计算中的进展,体现了用户对于乱序数据的容忍程度。`当前处理的最新事件时间 - WATERMARK 指定的固定间隔` 即为当前水位线,只有写入数据的事件时间早于当前水位线才会进入触发判断,只有窗口或其他触发的时间条件早于当前水位线才会启动触发。`WATERMARK` 对于定时触发(PERIOD)不生效,定时触发模式下不会有重新计算。
641660

642-
对于超出 `WATERMARK` 的乱序、更新、删除场景,使用重新计算的方式来保证最终结果的正确性,重新计算意味着对于乱序、更新和删除的数据覆盖区间重新进行触发和运算。为了保证这种方式的有效性,用户需要确保其计算语句和数据源表是与处理时间无关的,也就是说同一个触发即使执行多次其结果依然是有效的。
661+
对于超出 `WATERMARK` 的乱序、更新、删除场景,使用重新计算的方式来保证最终结果的正确性,重新计算意味着对于乱序、更新和删除的数据覆盖区间重新进行触发和运算。重算时输出表中已经产生的计算结果不会被删除,会重新写入新的结果,为保证这种方式的有效性,用户需要确保其计算语句和数据源表是与处理时间无关的,也就是说同一个触发即使执行多次其结果依然是有效的。
643662

644663
重新计算可以分为自动重新计算与手动重新计算,如果用户不需要自动重新计算,可以通过选项关闭。
645664

@@ -654,7 +673,7 @@ RECALCULATE STREAM [db_name.]stream_name FROM start_time [TO end_time];
654673
说明:
655674

656675
- 可以根据需要来指定需要重算流的一段时间区间(事件时间)内的数据。
657-
- 不适用于定时触发,适用于其他所有触发类型。
676+
- 不适用于定时触发(PERIOD),适用于其他所有触发类型。
658677

659678
### 非典型数据写入场景
660679

@@ -664,8 +683,9 @@ RECALCULATE STREAM [db_name.]stream_name FROM start_time [TO end_time];
664683

665684
| 触发方式 | 影响和处理 |
666685
| --------------| ----------|
667-
| 计数窗口触发 | 无影响,当做正常写入数据进行触发 |
668-
| 定时触发 | 无影响 |
686+
| 计数窗口触发 | 忽略,不处理 |
687+
| 定时触发触发 | 忽略,不处理 |
688+
| 滑动触发触发 | 忽略,不处理 |
669689
| 其他窗口触发 | 默认处理:通过重算进行处理 <br/> 可选处理:忽略,不处理 |
670690

671691
#### 数据更新
@@ -675,18 +695,20 @@ RECALCULATE STREAM [db_name.]stream_name FROM start_time [TO end_time];
675695

676696
| 触发方式 | 影响和处理 |
677697
| --------------| ----------|
678-
| 计数窗口触发 | 无影响,当做正常写入数据进行触发 |
679-
| 定时触发 | 无影响 |
680-
| 其他窗口触发 | 当做乱序数据处理(重算) |
698+
| 计数窗口触发 | 忽略,不处理 |
699+
| 定时触发触发 | 忽略,不处理 |
700+
| 滑动触发触发 | 忽略,不处理 |
701+
| 其他窗口触发 | 当做乱序数据处理(重算)|
681702

682703
#### 数据删除
683704

684705
数据删除也只针对触发表和触发操作有影响,对计算过程本身无影响。根据触发方式的不同,数据删除的影响和处理也不相同。
685706

686707
| 触发方式 | 影响和处理 |
687708
| --------------| ----------|
688-
| 计数窗口触发 | 忽略,不处理 |
689-
| 定时触发 | 无影响 |
709+
| 计数窗口触发 | 忽略,不处理 |
710+
| 定时触发触发 | 忽略,不处理 |
711+
| 滑动触发触发 | 忽略,不处理 |
690712
| 其他窗口触发 | 默认处理:忽略,不处理 <br/> 可选处理:当做乱序数据处理(重算)|
691713

692714
#### 过期数据
@@ -744,13 +766,20 @@ RECALCULATE STREAM [db_name.]stream_name FROM start_time [TO end_time];
744766
- 流计算可以嵌套使用,也就是说可以基于一个流的输出表再创建一个新的流计算。
745767
- 计数窗口触发不支持乱序、更新、删除的自动处理(采取忽略处理的方式),在非 `FILL_HISTORY_FIRST` 模式下历史与实时窗口可能不对齐。
746768
- 对于超级表的窗口触发方式,只有 `interval``session` 窗口支持按照标签、子表分组和不分组,其他窗口只支持按子表分组。
769+
770+
短期使用限制
771+
747772
- 暂不支持按普通数据列分组的场景。
773+
- 暂不支持 `Geometry` 数据类型。
774+
- 暂不支持 `interp``percentile` 函数。
775+
- 暂不支持 windows 平台。
748776

749777
### 兼容性说明
750778

751779
相比于 `3.3.6.0` 版本,流计算进行了全新设计。老版本升级之前要做如下动作后,在新的流计算版本上进行重建。
752780

753781
- 删除所有的流计算任务
782+
- 删除所有的 TSMA
754783
- 删除所有的 snode
755784
- 删除 snode 存储目录
756785
- 删除所有的结果表
@@ -832,10 +861,11 @@ CREATE stream sm2 count_window(10, 1, col1) FROM tb1
832861

833862
##### 滑动触发
834863

835-
- 超级表 stb1 的每个子表在每 5 分钟的时间窗口结束后,计算这 5 分钟的 col1 的平均值,每个子表的计算结果分别写入超级表 stb2 的不同子表中。
864+
- 超级表 stb1 的每个子表在每 5 分钟的时间窗口结束后,计算这 5 分钟的 col1 的平均值(如果没有数据则忽略),每个子表的计算结果分别写入超级表 stb2 的不同子表中。
836865

837866
```SQL
838867
CREATE stream sm1 INTERVAL(5m) SLIDING(5m) FROM stb1 PARTITION BY tbname
868+
OPTIONS(FILL_HISTORY_FIRST)
839869
INTO stb2 AS
840870
SELECT _twstart, avg(col1) FROM %%tbname
841871
WHERE _c0 >= _twstart AND _c0 <= _twend;

0 commit comments

Comments
 (0)