07-function.md 39.8 KB
Newer Older
1
---
2 3
sidebar_label: 函数
title: 函数
4
toc_max_heading_level: 4
5 6
---

7
## 单行函数
8

9
单行函数为查询结果中的每一行返回一个结果行。
10

11
### 数学函数
12

13
#### ABS
14

15 16 17
```sql
  SELECT ABS(field_name) FROM { tb_name | stb_name } [WHERE clause]
```
18

19
**功能说明**:获得指定列的绝对值
20

21
**返回结果类型**:如果输入值为整数,输出值是 UBIGINT 类型。如果输入值是 FLOAT/DOUBLE 数据类型,输出值是 DOUBLE 数据类型。
22

G
gccgdb1234 已提交
23
**适用数据类型**:数值类型。
24

25
**嵌套子查询支持**:适用于内层查询和外层查询。
26

27
**适用于**: 表和超级表
28

29
**使用说明**:只能与普通列,选择(Selection)、投影(Projection)函数一起使用,不能与聚合(Aggregation)函数一起使用。
30

31
#### ACOS
32

33 34
```sql
  SELECT ACOS(field_name) FROM { tb_name | stb_name } [WHERE clause]
35 36
```

37
**功能说明**:获得指定列的反余弦结果
38

39
**返回结果类型**:DOUBLE。如果输入值为 NULL,输出值也为 NULL
40

G
gccgdb1234 已提交
41
**适用数据类型**:数值类型。
42

43
**嵌套子查询支持**:适用于内层查询和外层查询。
44

45
**适用于**: 表和超级表
46

47
**使用说明**:只能与普通列,选择(Selection)、投影(Projection)函数一起使用,不能与聚合(Aggregation)函数一起使用。
48

49
#### ASIN
50

51 52
```sql
  SELECT ASIN(field_name) FROM { tb_name | stb_name } [WHERE clause]
53 54
```

55
**功能说明**:获得指定列的反正弦结果
56

57
**返回结果类型**:DOUBLE。如果输入值为 NULL,输出值也为 NULL
58

G
gccgdb1234 已提交
59
**适用数据类型**:数值类型。
60

61
**嵌套子查询支持**:适用于内层查询和外层查询。
62

63
**适用于**: 表和超级表
64

65
**使用说明**:只能与普通列,选择(Selection)、投影(Projection)函数一起使用,不能与聚合(Aggregation)函数一起使用。
66 67


68
#### ATAN
69

70 71
```sql
  SELECT ATAN(field_name) FROM { tb_name | stb_name } [WHERE clause]
72 73
```

74
**功能说明**:获得指定列的反正切结果
75

76
**返回结果类型**:DOUBLE。如果输入值为 NULL,输出值也为 NULL
77

G
gccgdb1234 已提交
78
**适用数据类型**:数值类型。
79

80
**嵌套子查询支持**:适用于内层查询和外层查询。
81

82
**适用于**: 表和超级表
83

84
**使用说明**:只能与普通列,选择(Selection)、投影(Projection)函数一起使用,不能与聚合(Aggregation)函数一起使用。
85

86 87

#### CEIL
88 89

```
90
SELECT CEIL(field_name) FROM { tb_name | stb_name } [WHERE clause];
91 92
```

93
**功能说明**:获得指定列的向上取整数的结果。
94

95
**返回结果类型**:与指定列的原始数据类型一致。例如,如果指定列的原始数据类型为 Float,那么返回的数据类型也为 Float;如果指定列的原始数据类型为 Double,那么返回的数据类型也为 Double。
96

G
gccgdb1234 已提交
97
**适用数据类型**:数值类型。
98

99
**适用于**: 普通表、超级表。
100

101
**嵌套子查询支持**:适用于内层查询和外层查询。
102

103
**使用说明**:
104

105 106
- 支持 +、-、\*、/ 运算,如 ceil(col1) + ceil(col2)。
- 只能与普通列,选择(Selection)、投影(Projection)函数一起使用,不能与聚合(Aggregation)函数一起使用。
107

108
#### COS
109

110 111
```sql
  SELECT COS(field_name) FROM { tb_name | stb_name } [WHERE clause]
112 113
```

114
**功能说明**:获得指定列的余弦结果
115

116 117
**返回结果类型**:DOUBLE。如果输入值为 NULL,输出值也为 NULL

G
gccgdb1234 已提交
118
**适用数据类型**:数值类型。
119 120

**嵌套子查询支持**:适用于内层查询和外层查询。
121

122
**适用于**: 表和超级表
123

124
**使用说明**:只能与普通列,选择(Selection)、投影(Projection)函数一起使用,不能与聚合(Aggregation)函数一起使用。
125

126
#### FLOOR
127 128

```
129
SELECT FLOOR(field_name) FROM { tb_name | stb_name } [WHERE clause];
130 131
```

132 133
**功能说明**:获得指定列的向下取整数的结果。  
 其他使用说明参见 CEIL 函数描述。
134

135 136 137 138
#### LOG

```sql
  SELECT LOG(field_name, base) FROM { tb_name | stb_name } [WHERE clause]
139 140
```

141
**功能说明**:获得指定列对于底数 base 的对数
142

143
**返回结果类型**:DOUBLE。如果输入值为 NULL,输出值也为 NULL
144

G
gccgdb1234 已提交
145
**适用数据类型**:数值类型。
146

147
**嵌套子查询支持**:适用于内层查询和外层查询。
148

149
**适用于**: 表和超级表
150

151
**使用说明**:只能与普通列,选择(Selection)、投影(Projection)函数一起使用,不能与聚合(Aggregation)函数一起使用。
152 153


154
#### POW
155

156 157 158
```sql
  SELECT POW(field_name, power) FROM { tb_name | stb_name } [WHERE clause]
```
159

160
**功能说明**:获得指定列的指数为 power 的幂
161

162
**返回结果类型**:DOUBLE。如果输入值为 NULL,输出值也为 NULL
163

G
gccgdb1234 已提交
164
**适用数据类型**:数值类型。
165

166
**嵌套子查询支持**:适用于内层查询和外层查询。
167

168
**适用于**: 表和超级表
169

170
**使用说明**:只能与普通列,选择(Selection)、投影(Projection)函数一起使用,不能与聚合(Aggregation)函数一起使用。
171 172


173
#### ROUND
174 175

```
176
SELECT ROUND(field_name) FROM { tb_name | stb_name } [WHERE clause];
177 178
```

179 180
**功能说明**:获得指定列的四舍五入的结果。  
 其他使用说明参见 CEIL 函数描述。
181 182


183
#### SIN
184

185 186 187
```sql
  SELECT SIN(field_name) FROM { tb_name | stb_name } [WHERE clause]
```
188

189
**功能说明**:获得指定列的正弦结果
190

191
**返回结果类型**:DOUBLE。如果输入值为 NULL,输出值也为 NULL
192

G
gccgdb1234 已提交
193
**适用数据类型**:数值类型。
194

195
**嵌套子查询支持**:适用于内层查询和外层查询。
196

197
**适用于**: 表和超级表
198

199
**使用说明**:只能与普通列,选择(Selection)、投影(Projection)函数一起使用,不能与聚合(Aggregation)函数一起使用。
200

201
#### SQRT
202

203 204 205
```sql
  SELECT SQRT(field_name) FROM { tb_name | stb_name } [WHERE clause]
```
206

207
**功能说明**:获得指定列的平方根
208

209
**返回结果类型**:DOUBLE。如果输入值为 NULL,输出值也为 NULL
210

G
gccgdb1234 已提交
211
**适用数据类型**:数值类型。
212

213
**嵌套子查询支持**:适用于内层查询和外层查询。
214

215
**适用于**: 表和超级表
216

217
**使用说明**:只能与普通列,选择(Selection)、投影(Projection)函数一起使用,不能与聚合(Aggregation)函数一起使用。
G
gccgdb1234 已提交
218

219 220 221 222
#### TAN

```sql
  SELECT TAN(field_name) FROM { tb_name | stb_name } [WHERE clause]
G
gccgdb1234 已提交
223 224
```

225
**功能说明**:获得指定列的正切结果
G
gccgdb1234 已提交
226

227
**返回结果类型**:DOUBLE。如果输入值为 NULL,输出值也为 NULL
G
gccgdb1234 已提交
228

G
gccgdb1234 已提交
229
**适用数据类型**:数值类型。
G
gccgdb1234 已提交
230

231
**嵌套子查询支持**:适用于内层查询和外层查询。
G
gccgdb1234 已提交
232

233
**适用于**: 表和超级表
G
gccgdb1234 已提交
234

235
**使用说明**:只能与普通列,选择(Selection)、投影(Projection)函数一起使用,不能与聚合(Aggregation)函数一起使用。
G
gccgdb1234 已提交
236

237
### 字符串函数
238

239
字符串函数的输入参数为字符串类型,返回结果为数值类型或字符串类型。
240

241
#### CHAR_LENGTH
242 243

```
244
  SELECT CHAR_LENGTH(str|column) FROM { tb_name | stb_name } [WHERE clause]
245 246
```

247
**功能说明**:以字符计数的字符串长度。
248

249
**返回结果类型**:INT。如果输入值为NULL,输出值为NULL。
250

G
gccgdb1234 已提交
251
**适用数据类型**:VARCHAR, NCHAR
252

253
**嵌套子查询支持**:适用于内层查询和外层查询。
254

255
**适用于**: 表和超级表
256

257
#### CONCAT
258

259 260
```sql
  SELECT CONCAT(str1|column1, str2|column2, ...) FROM { tb_name | stb_name } [WHERE clause]
261 262
```

263
**功能说明**:字符串连接函数。
264

G
gccgdb1234 已提交
265
**返回结果类型**:如果所有参数均为 VARCHAR 类型,则结果类型为 VARCHAR。如果参数包含NCHAR类型,则结果类型为NCHAR。如果输入值为NULL,输出值为NULL。
266

G
gccgdb1234 已提交
267
**适用数据类型**:VARCHAR, NCHAR。 该函数最小参数个数为2个,最大参数个数为8个。
268

269
**嵌套子查询支持**:适用于内层查询和外层查询。
270

271
**适用于**: 表和超级表
272 273


274
#### CONCAT_WS
275 276

```
277
  SELECT CONCAT_WS(separator, str1|column1, str2|column2, ...) FROM { tb_name | stb_name } [WHERE clause]
278 279
```

280 281
**功能说明**:带分隔符的字符串连接函数。

G
gccgdb1234 已提交
282
**返回结果类型**:如果所有参数均为VARCHAR类型,则结果类型为VARCHAR。如果参数包含NCHAR类型,则结果类型为NCHAR。如果输入值为NULL,输出值为NULL。如果separator值不为NULL,其他输入为NULL,输出为空串。
283

G
gccgdb1234 已提交
284
**适用数据类型**:VARCHAR, NCHAR。 该函数最小参数个数为3个,最大参数个数为9个。
285 286 287 288 289 290 291

**嵌套子查询支持**:适用于内层查询和外层查询。

**适用于**: 表和超级表


#### LENGTH
292 293

```
294
  SELECT LENGTH(str|column) FROM { tb_name | stb_name } [WHERE clause]
295 296
```

297
**功能说明**:以字节计数的字符串长度。
298

299
**返回结果类型**:INT。
300

G
gccgdb1234 已提交
301
**适用数据类型**:输入参数是 VARCHAR 类型或者 NCHAR 类型的字符串或者列。
302

303
**嵌套子查询支持**:适用于内层查询和外层查询。
304

305
**适用于**: 表和超级表
306 307


308
#### LOWER
309 310

```
311
  SELECT LOWER(str|column) FROM { tb_name | stb_name } [WHERE clause]
312 313
```

314
**功能说明**:将字符串参数值转换为全小写字母。
315

316
**返回结果类型**:同输入类型。如果输入值为NULL,输出值为NULL。
317

G
gccgdb1234 已提交
318
**适用数据类型**:输入参数是 VARCHAR 类型或者 NCHAR 类型的字符串或者列。
319

320
**嵌套子查询支持**:适用于内层查询和外层查询。
321

322
**适用于**: 表和超级表
323 324


325
#### LTRIM
326 327

```
328
  SELECT LTRIM(str|column) FROM { tb_name | stb_name } [WHERE clause]
329 330
```

331
**功能说明**:返回清除左边空格后的字符串。
332

333
**返回结果类型**:同输入类型。如果输入值为NULL,输出值为NULL。
334

G
gccgdb1234 已提交
335
**适用数据类型**:输入参数是 VARCHAR 类型或者 NCHAR 类型的字符串或者列。
336

337
**嵌套子查询支持**:适用于内层查询和外层查询。
338

339
**适用于**: 表和超级表
340 341


342
#### RTRIM
343 344

```
345
  SELECT LTRIM(str|column) FROM { tb_name | stb_name } [WHERE clause]
346 347
```

348
**功能说明**:返回清除右边空格后的字符串。
349

350
**返回结果类型**:同输入类型。如果输入值为NULL,输出值为NULL。
351

G
gccgdb1234 已提交
352
**适用数据类型**:输入参数是 VARCHAR 类型或者 NCHAR 类型的字符串或者列。
353

354
**嵌套子查询支持**:适用于内层查询和外层查询。
355

356
**适用于**: 表和超级表
357 358


359
#### SUBSTR
360 361

```
362
  SELECT SUBSTR(str,pos[,len]) FROM { tb_name | stb_name } [WHERE clause]
363 364
```

365
**功能说明**:从源字符串 str 中的指定位置 pos 开始取一个长度为 len 的子串并返回。
366

367
**返回结果类型**:同输入类型。如果输入值为NULL,输出值为NULL。
368

G
gccgdb1234 已提交
369
**适用数据类型**:输入参数是 VARCHAR 类型或者 NCHAR 类型的字符串或者列。输入参数pos可以为正数,也可以为负数。如果pos是正数,表示开始位置从字符串开头正数计算。如果pos为负数,表示开始位置从字符串结尾倒数计算。如果输入参数len被忽略,返回的子串包含从pos开始的整个字串。
370

371
**嵌套子查询支持**:适用于内层查询和外层查询。
372

373
**适用于**: 表和超级表
374 375


376
#### UPPER
377 378

```
379
  SELECT UPPER(str|column) FROM { tb_name | stb_name } [WHERE clause]
380 381
```

382
**功能说明**:将字符串参数值转换为全大写字母。
383

384
**返回结果类型**:同输入类型。如果输入值为NULL,输出值为NULL。
385

G
gccgdb1234 已提交
386
**适用数据类型**:输入参数是 VARCHAR 类型或者 NCHAR 类型的字符串或者列。
387

388
**嵌套子查询支持**:适用于内层查询和外层查询。
389

390
**适用于**: 表和超级表
391 392


393
### 转换函数
394

395
转换函数将值从一种数据类型转换为另一种数据类型。
396

397
#### CAST
398

399 400
```sql
  SELECT CAST(expression AS type_name) FROM { tb_name | stb_name } [WHERE clause]
401 402
```

G
gccgdb1234 已提交
403
**功能说明**:数据类型转换函数,输入参数 expression 支持普通列、常量、标量函数及它们之间的四则运算,只适用于 select 子句中。
404

405
**返回结果类型**:CAST 中指定的类型(type_name),可以是 BIGINT、BIGINT UNSIGNED、BINARY、VARCHAR、NCHAR和TIMESTAMP。
406

407
**适用数据类型**:输入参数 expression 的类型可以是BLOB、MEDIUMBLOB和JSON外的所有类型 
408

409 410 411 412 413 414 415 416 417 418 419 420 421
**使用说明**

- 对于不能支持的类型转换会直接报错。
- 如果输入值为NULL则输出值也为NULL。
- 对于类型支持但某些值无法正确转换的情况对应的转换后的值以转换函数输出为准。目前可能遇到的几种情况:
        1)字符串类型转换数值类型时可能出现的无效字符情况,例如"a"可能转为0,但不会报错。
        2)转换到数值类型时,数值大于type_name可表示的范围时,则会溢出,但不会报错。
        3)转换到字符串类型时,如果转换后长度超过type_name的长度,则会截断,但不会报错。

#### TO_ISO8601

```sql
SELECT TO_ISO8601(ts_val | ts_col) FROM { tb_name | stb_name } [WHERE clause];
422 423
```

424
**功能说明**:将 UNIX 时间戳转换成为 ISO8601 标准的日期时间格式,并附加客户端时区信息。
425

G
gccgdb1234 已提交
426
**返回结果数据类型**:VARCHAR 类型。
427

428
**适用数据类型**:UNIX 时间戳常量或是 TIMESTAMP 类型的列
429 430 431 432 433

**适用于**:表、超级表。

**使用说明**

434 435
- 如果输入是 UNIX 时间戳常量,返回格式精度由时间戳的位数决定; 
- 如果输入是 TIMSTAMP 类型的列,返回格式的时间戳精度与当前 DATABASE 设置的时间精度一致。
436 437


438
#### TO_JSON
439

440 441
```sql
SELECT TO_JSON(str_literal) FROM { tb_name | stb_name } [WHERE clause];
442 443
```

444
**功能说明**: 将字符串常量转换为 JSON 类型。
445

446
**返回结果数据类型**: JSON
447

448
**适用数据类型**: JSON 字符串,形如 '{ "literal" : literal }'。'{}'表示空值。键必须为字符串字面量,值可以为数值字面量、字符串字面量、布尔字面量或空值字面量。str_literal中不支持转义符。
449

450
**适用于**: 表和超级表
451

452
**嵌套子查询支持**:适用于内层查询和外层查询。
453 454


455
#### TO_UNIXTIMESTAMP
456

457 458 459
```sql
SELECT TO_UNIXTIMESTAMP(datetime_string | ts_col) FROM { tb_name | stb_name } [WHERE clause];
```
460

461
**功能说明**:将日期时间格式的字符串转换成为 UNIX 时间戳。
462

463
**返回结果数据类型**:长整型 INT64。
464

G
gccgdb1234 已提交
465
**应用字段**:字符串常量或是 VARCHAR/NCHAR 类型的列。
466

467
**适用于**:表、超级表。
468

469
**使用说明**
470

471 472
- 输入的日期时间字符串须符合 ISO8601/RFC3339 标准,无法转换的字符串格式将返回 0。
- 返回的时间戳精度与当前 DATABASE 设置的时间精度一致。
473 474


475
### 时间和日期函数
476

477
时间和日期函数对时间戳类型进行操作。
478

479
所有返回当前时间的函数,如NOW、TODAY和TIMEZONE,在一条SQL语句中不论出现多少次都只会被计算一次。
480

481
#### NOW
482

483 484 485 486
```sql
SELECT NOW() FROM { tb_name | stb_name } [WHERE clause];
SELECT select_expr FROM { tb_name | stb_name } WHERE ts_col cond_operatior NOW();
INSERT INTO tb_name VALUES (NOW(), ...);
487 488
```

489
**功能说明**:返回客户端当前系统时间。
490

491
**返回结果数据类型**:TIMESTAMP 时间戳类型。
492

493
**应用字段**:在 WHERE 或 INSERT 语句中使用时只能作用于 TIMESTAMP 类型的字段。
494 495 496

**适用于**:表、超级表。

497
**使用说明**
498

499 500 501
- 支持时间加减操作,如 NOW() + 1s, 支持的时间单位如下:
        b(纳秒)、u(微秒)、a(毫秒)、s(秒)、m(分)、h(小时)、d(天)、w(周)。
- 返回的时间戳精度与当前 DATABASE 设置的时间精度一致。
502 503


504
#### TIMEDIFF
505

506 507
```sql
SELECT TIMEDIFF(ts_val1 | datetime_string1 | ts_col1, ts_val2 | datetime_string2 | ts_col2 [, time_unit]) FROM { tb_name | stb_name } [WHERE clause];
508 509
```

510
**功能说明**:计算两个时间戳之间的差值,并近似到时间单位 time_unit 指定的精度。
511

512
**返回结果数据类型**:长整型 INT64。
513

514
**应用字段**:UNIX 时间戳,日期时间格式的字符串,或者 TIMESTAMP 类型的列。
515

516
**适用于**:表、超级表。
517

518 519 520 521
**使用说明**
- 支持的时间单位 time_unit 如下:
          1u(微秒),1a(毫秒),1s(秒),1m(分),1h(小时),1d(天)。
- 如果时间单位 time_unit 未指定, 返回的时间差值精度与当前 DATABASE 设置的时间精度一致。
522 523


524
#### TIMETRUNCATE
525

526 527 528
```sql
SELECT TIMETRUNCATE(ts_val | datetime_string | ts_col, time_unit) FROM { tb_name | stb_name } [WHERE clause];
```
529

530
**功能说明**:将时间戳按照指定时间单位 time_unit 进行截断。
531

532
**返回结果数据类型**:TIMESTAMP 时间戳类型。
533

534
**应用字段**:UNIX 时间戳,日期时间格式的字符串,或者 TIMESTAMP 类型的列。
535

536
**适用于**:表、超级表。
537

538 539 540 541
**使用说明**
- 支持的时间单位 time_unit 如下:
          1u(微秒),1a(毫秒),1s(秒),1m(分),1h(小时),1d(天)。
- 返回的时间戳精度与当前 DATABASE 设置的时间精度一致。
542 543


544
#### TIMEZONE
545

546 547 548
```sql
SELECT TIMEZONE() FROM { tb_name | stb_name } [WHERE clause];
```
549

550
**功能说明**:返回客户端当前时区信息。
551

G
gccgdb1234 已提交
552
**返回结果数据类型**:VARCHAR 类型。
553

554
**应用字段**:无
555

556
**适用于**:表、超级表。
557 558


559
#### TODAY
560

561 562 563 564
```sql
SELECT TODAY() FROM { tb_name | stb_name } [WHERE clause];
SELECT select_expr FROM { tb_name | stb_name } WHERE ts_col cond_operatior TODAY()];
INSERT INTO tb_name VALUES (TODAY(), ...);
565 566
```

567
**功能说明**:返回客户端当日零时的系统时间。
568

569
**返回结果数据类型**:TIMESTAMP 时间戳类型。
570

571
**应用字段**:在 WHERE 或 INSERT 语句中使用时只能作用于 TIMESTAMP 类型的字段。
572

573
**适用于**:表、超级表。
574

575
**使用说明**
576

577 578 579
- 支持时间加减操作,如 TODAY() + 1s, 支持的时间单位如下:
                b(纳秒),u(微秒),a(毫秒),s(秒),m(分),h(小时),d(天),w(周)。
- 返回的时间戳精度与当前 DATABASE 设置的时间精度一致。
580 581


582
## 聚合函数
583

584
聚合函数为查询结果集的每一个分组返回单个结果行。可以由 GROUP BY 或窗口切分子句指定分组,如果没有,则整个查询结果集视为一个分组。
585

586
TDengine 支持针对数据的聚合查询。提供如下聚合函数。
587

588
### AVG
589 590

```
591
SELECT AVG(field_name) FROM tb_name [WHERE clause];
592 593
```

594
**功能说明**:统计表/超级表中某列的平均值。
595

596
**返回数据类型**:双精度浮点数 Double。
597

598
**适用数据类型**:数值类型。
599

600
**适用于**:表、超级表。
601 602


603
### COUNT
604 605

```
606
SELECT COUNT([*|field_name]) FROM tb_name [WHERE clause];
607 608
```

609
**功能说明**:统计表/超级表中记录行数或某列的非空值个数。
610

611
**返回数据类型**:长整型 INT64。
612

613
**适用数据类型**:应用全部字段。
614

615
**适用于**:表、超级表。
616

617
**使用说明**:
618

619 620 621
- 可以使用星号(\*)来替代具体的字段,使用星号(\*)返回全部记录数量。
- 针对同一表的(不包含 NULL 值)字段查询结果均相同。
- 如果统计对象是具体的列,则返回该列中非 NULL 值的记录数量。
622 623


624
### ELAPSED
625

626 627
```mysql
SELECT ELAPSED(ts_primary_key [, time_unit]) FROM { tb_name | stb_name } [WHERE clause] [INTERVAL(interval [, offset]) [SLIDING sliding]];
628 629
```

630
**功能说明**:elapsed函数表达了统计周期内连续的时间长度,和twa函数配合使用可以计算统计曲线下的面积。在通过INTERVAL子句指定窗口的情况下,统计在给定时间范围内的每个窗口内有数据覆盖的时间范围;如果没有INTERVAL子句,则返回整个给定时间范围内的有数据覆盖的时间范围。注意,ELAPSED返回的并不是时间范围的绝对值,而是绝对值除以time_unit所得到的单位个数。
631

632
**返回结果类型**:Double
633

634
**适用数据类型**:Timestamp类型
635

636
**支持的版本**:2.6.0.0 及以后的版本。
637

638
**适用于**: 表,超级表,嵌套查询的外层查询
639

640 641 642 643 644 645 646 647 648
**说明**
- field_name参数只能是表的第一列,即timestamp主键列。
- 按time_unit参数指定的时间单位返回,最小是数据库的时间分辨率。time_unit参数未指定时,以数据库的时间分辨率为时间单位。
- 可以和interval组合使用,返回每个时间窗口的时间戳差值。需要特别注意的是,除第一个时间窗口和最后一个时间窗口外,中间窗口的时间戳差值均为窗口长度。
- order by asc/desc不影响差值的计算结果。
- 对于超级表,需要和group by tbname子句组合使用,不可以直接使用。
- 对于普通表,不支持和group by子句组合使用。
- 对于嵌套查询,仅当内层查询会输出隐式时间戳列时有效。例如select elapsed(ts) from (select diff(value) from sub1)语句,diff函数会让内层查询输出隐式时间戳列,此为主键列,可以用于elapsed函数的第一个参数。相反,例如select elapsed(ts) from (select * from sub1) 语句,ts列输出到外层时已经没有了主键列的含义,无法使用elapsed函数。此外,elapsed函数作为一个与时间线强依赖的函数,形如select elapsed(ts) from (select diff(value) from st group by tbname)尽管会返回一条计算结果,但并无实际意义,这种用法后续也将被限制。
- 不支持与leastsquares、diff、derivative、top、bottom、last_row、interp等函数混合使用。
649

650
### LEASTSQUARES
651 652

```
653
SELECT LEASTSQUARES(field_name, start_val, step_val) FROM tb_name [WHERE clause];
654 655
```

656
**功能说明**:统计表中某列的值是主键(时间戳)的拟合直线方程。start_val 是自变量初始值,step_val 是自变量的步长值。
657

658
**返回数据类型**:字符串表达式(斜率, 截距)。
659

660
**适用数据类型**:field_name 必须是数值类型。
661

662
**适用于**:表。
663 664


665
### MODE
666 667

```
668
SELECT MODE(field_name) FROM tb_name [WHERE clause];
669 670
```

G
gccgdb1234 已提交
671
**功能说明**:返回出现频率最高的值,若存在多个频率相同的最高值,输出空。
672

673
**返回数据类型**:同应用的字段。
674

675
**适用数据类型**: 数值类型。
676

677
**适用于**:表和超级表。
678 679


680
### SPREAD
681 682

```
683
SELECT SPREAD(field_name) FROM { tb_name | stb_name } [WHERE clause];
684 685
```

686
**功能说明**:统计表/超级表中某列的最大值和最小值之差。
687

688
**返回数据类型**:双精度浮点数。
689

690
**适用数据类型**:数值类型或TIMESTAMP类型。
691

692
**适用于**:表和超级表。
693 694


695
### STDDEV
696 697

```
698
SELECT STDDEV(field_name) FROM tb_name [WHERE clause];
699 700
```

701
**功能说明**:统计表中某列的均方差。
702

703
**返回数据类型**:双精度浮点数 Double。
704

705
**适用数据类型**:数值类型。
706

707
**适用于**:表和超级表。
708 709


710
### SUM
711 712

```
713
SELECT SUM(field_name) FROM tb_name [WHERE clause];
714 715
```

716
**功能说明**:统计表/超级表中某列的和。
717

718
**返回数据类型**:双精度浮点数 Double 和长整型 INT64。
719

720
**适用数据类型**:数值类型。
721

722
**适用于**:表和超级表。
723 724


725
### HYPERLOGLOG
726 727

```
728
SELECT HYPERLOGLOG(field_name) FROM { tb_name | stb_name } [WHERE clause];
729 730
```

731 732 733
**功能说明**
  - 采用 hyperloglog 算法,返回某列的基数。该算法在数据量很大的情况下,可以明显降低内存的占用,但是求出来的基数是个估算值,标准误差(标准误差是多次实验,每次的平均数的标准差,不是与真实结果的误差)为 0.81%。
  - 在数据量较少的时候该算法不是很准确,可以使用 select count(data) from (select unique(col) as data from table) 的方法。
734

735
**返回结果类型**:整形。
736

737
**适用数据类型**:任何类型。
738

739
**适用于**:表和超级表。
740 741


742
### HISTOGRAM
743

744 745
```
SELECT HISTOGRAM(field_name,bin_type, bin_description, normalized) FROM tb_name [WHERE clause];
746 747
```

748
**功能说明**:统计数据按照用户指定区间的分布。
749

750
**返回结果类型**:如归一化参数 normalized 设置为 1,返回结果为双精度浮点类型 DOUBLE,否则为长整形 INT64。
751

752
**适用数据类型**:数值型字段。
753

754
**适用于**: 表和超级表。
755

756 757 758 759 760 761 762 763 764 765 766 767 768 769
**详细说明**
1. bin_type 用户指定的分桶类型, 有效输入类型为"user_input“, ”linear_bin", "log_bin"。
2. bin_description 描述如何生成分桶区间,针对三种桶类型,分别为以下描述格式(均为 JSON 格式字符串):       
    - "user_input": "[1, 3, 5, 7]" 
       用户指定 bin 的具体数值。
       
    - "linear_bin": "{"start": 0.0, "width": 5.0, "count": 5, "infinity": true}"
       "start" 表示数据起始点,"width" 表示每次 bin 偏移量, "count" 为 bin 的总数,"infinity" 表示是否添加(-inf, inf)作为区间起点跟终点,
       生成区间为[-inf, 0.0, 5.0, 10.0, 15.0, 20.0, +inf]。
 
    - "log_bin": "{"start":1.0, "factor": 2.0, "count": 5, "infinity": true}"
       "start" 表示数据起始点,"factor" 表示按指数递增的因子,"count" 为 bin 的总数,"infinity" 表示是否添加(-inf, inf)作为区间起点跟终点,
       生成区间为[-inf, 1.0, 2.0, 4.0, 8.0, 16.0, +inf]。
3. normalized 是否将返回结果归一化到 0~1 之间 。有效输入为 0 和 1。
770 771


772
## 选择函数
773

774
选择函数根据语义在查询结果集中选择一行或多行结果返回。用户可以同时指定输出 ts 列或其他列(包括 tbname 和标签列),这样就可以方便地知道被选出的值是源于哪个数据行的。
775

776
### APERCENTILE
777

778 779 780
```
SELECT APERCENTILE(field_name, P[, algo_type])
FROM { tb_name | stb_name } [WHERE clause]
781 782
```

783
**功能说明**:统计表/超级表中指定列的值的近似百分比分位数,与 PERCENTILE 函数相似,但是返回近似结果。
784

785
**返回数据类型**: 双精度浮点数 Double。
786

787
**适用数据类型**:数值类型。P值范围是[0,100],当为0时等同于MIN,为100时等同于MAX。如果不指定 algo_type 则使用默认算法 。
788

789
**适用于**:表、超级表。
790

791
### BOTTOM
792

793 794 795
```
SELECT BOTTOM(field_name, K) FROM { tb_name | stb_name } [WHERE clause];
```
796

797
**功能说明**:统计表/超级表中某列的值最小 _k_ 个非 NULL 值。如果多条数据取值一样,全部取用又会超出 k 条限制时,系统会从相同值中随机选取符合要求的数量返回。
798

799
**返回数据类型**:同应用的字段。
800

801
**适用数据类型**:数值类型。
802

803
**适用于**:表和超级表。
804

805
**使用说明**:
806

807 808 809
- *k*值取值范围 1≤*k*≤100;
- 系统同时返回该记录关联的时间戳列;
- 限制:BOTTOM 函数不支持 FILL 子句。
810

811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829
### FIRST

```
SELECT FIRST(field_name) FROM { tb_name | stb_name } [WHERE clause];
```

**功能说明**:统计表/超级表中某列的值最先写入的非 NULL 值。

**返回数据类型**:同应用的字段。

**适用数据类型**:所有字段。

**适用于**:表和超级表。

**使用说明**:

- 如果要返回各个列的首个(时间戳最小)非 NULL 值,可以使用 FIRST(\*);
- 如果结果集中的某列全部为 NULL 值,则该列的返回结果也是 NULL;
- 如果结果集中所有列全部为 NULL 值,则不返回结果。
830

831
### INTERP
832 833

```
834
SELECT INTERP(field_name) FROM { tb_name | stb_name } [WHERE where_condition] [ RANGE(timestamp1,timestamp2) ] [EVERY(interval)] [FILL ({ VALUE | PREV | NULL | LINEAR | NEXT})];
835 836
```

837
**功能说明**:返回指定时间截面指定列的记录值或插值。
838

839
**返回数据类型**:同字段类型。
840

841
**适用数据类型**:数值类型。
842

843
**适用于**:表、超级表。
844

845
**使用说明**
846

847 848 849 850 851 852 853 854 855
- INTERP 用于在指定时间断面获取指定列的记录值,如果该时间断面不存在符合条件的行数据,那么会根据 FILL 参数的设定进行插值。
- INTERP 的输入数据为指定列的数据,可以通过条件语句(where 子句)来对原始列数据进行过滤,如果没有指定过滤条件则输入为全部数据。
- INTERP 的输出时间范围根据 RANGE(timestamp1,timestamp2)字段来指定,需满足 timestamp1<=timestamp2。其中 timestamp1(必选值)为输出时间范围的起始值,即如果 timestamp1 时刻符合插值条件则 timestamp1 为输出的第一条记录,timestamp2(必选值)为输出时间范围的结束值,即输出的最后一条记录的 timestamp 不能大于 timestamp2。如果没有指定 RANGE,那么满足过滤条件的输入数据中第一条记录的 timestamp 即为 timestamp1,最后一条记录的 timestamp 即为 timestamp2,同样也满足 timestamp1 <= timestamp2。
- INTERP 根据 EVERY 字段来确定输出时间范围内的结果条数,即从 timestamp1 开始每隔固定长度的时间(EVERY 值)进行插值。如果没有指定 EVERY,则默认窗口大小为无穷大,即从 timestamp1 开始只有一个窗口。
- INTERP 根据 FILL 字段来决定在每个符合输出条件的时刻如何进行插值,如果没有 FILL 字段则默认不插值,即输出为原始记录值或不输出(原始记录不存在)。
- INTERP 只能在一个时间序列内进行插值,因此当作用于超级表时必须跟 group by tbname 一起使用,当作用嵌套查询外层时内层子查询不能含 GROUP BY 信息。
- INTERP 的插值结果不受 ORDER BY timestamp 的影响,ORDER BY timestamp 只影响输出结果的排序。

### LAST
856 857

```
858
SELECT LAST(field_name) FROM { tb_name | stb_name } [WHERE clause];
859 860
```

861
**功能说明**:统计表/超级表中某列的值最后写入的非 NULL 值。
862

863
**返回数据类型**:同应用的字段。
864

865
**适用数据类型**:所有字段。
866

867 868 869 870 871 872 873
**适用于**:表和超级表。

**使用说明**:

- 如果要返回各个列的最后(时间戳最大)一个非 NULL 值,可以使用 LAST(\*);
- 如果结果集中的某列全部为 NULL 值,则该列的返回结果也是 NULL;如果结果集中所有列全部为 NULL 值,则不返回结果。
- 在用于超级表时,时间戳完全一样且同为最大的数据行可能有多个,那么会从中随机返回一条,而并不保证多次运行所挑选的数据行必然一致。
874 875


876
### LAST_ROW
877 878

```
879
SELECT LAST_ROW(field_name) FROM { tb_name | stb_name };
880 881
```

882
**功能说明**:返回表/超级表的最后一条记录。
883

884
**返回数据类型**:同应用的字段。
885

886
**适用数据类型**:所有字段。
887

888 889 890
**适用于**:表和超级表。

**使用说明**
891

892 893
- 在用于超级表时,时间戳完全一样且同为最大的数据行可能有多个,那么会从中随机返回一条,而并不保证多次运行所挑选的数据行必然一致。
- 不能与 INTERVAL 一起使用。
894

895
### MAX
896 897

```
898
SELECT MAX(field_name) FROM { tb_name | stb_name } [WHERE clause];
899 900
```

901
**功能说明**:统计表/超级表中某列的值最大值。
902

903
**返回数据类型**:同应用的字段。
904

905
**适用数据类型**:数值类型。
906

907
**适用于**:表和超级表。
908 909


910
### MIN
911 912

```
913
SELECT MIN(field_name) FROM {tb_name | stb_name} [WHERE clause];
914 915
```

916
**功能说明**:统计表/超级表中某列的值最小值。
917

918
**返回数据类型**:同应用的字段。
919

920
**适用数据类型**:数值类型。
921

922
**适用于**:表和超级表。
923 924


925
### PERCENTILE
926 927

```
928
SELECT PERCENTILE(field_name, P) FROM { tb_name } [WHERE clause];
929 930
```

931
**功能说明**:统计表中某列的值百分比分位数。
932

933
**返回数据类型**: 双精度浮点数 Double。
934

935
**应用字段**:数值类型。
936

937
**适用于**:表。
938

939
**使用说明***P*值取值范围 0≤*P*≤100,为 0 的时候等同于 MIN,为 100 的时候等同于 MAX。
940 941


942
### TAIL
943 944

```
945
SELECT TAIL(field_name, k, offset_val) FROM {tb_name | stb_name} [WHERE clause];
946 947
```

948
**功能说明**:返回跳过最后 offset_val 个,然后取连续 k 个记录,不忽略 NULL 值。offset_val 可以不输入。此时返回最后的 k 个记录。当有 offset_val 输入的情况下,该函数功能等效于 `order by ts desc LIMIT k OFFSET offset_val`
949

950
**参数范围**:k: [1,100] offset_val: [0,100]。
951

952
**返回数据类型**:同应用的字段。
953

954
**适用数据类型**:适合于除时间主列外的任何类型。
955

956
**适用于**:表、超级表。
957

958 959

### TOP
960 961

```
962
SELECT TOP(field_name, K) FROM { tb_name | stb_name } [WHERE clause];
963 964
```

965
**功能说明**: 统计表/超级表中某列的值最大 _k_ 个非 NULL 值。如果多条数据取值一样,全部取用又会超出 k 条限制时,系统会从相同值中随机选取符合要求的数量返回。
966

967
**返回数据类型**:同应用的字段。
968

969
**适用数据类型**:数值类型。
970

971
**适用于**:表、超级表。
972

973
**使用说明**:
974

975 976 977
- *k*值取值范围 1≤*k*≤100;
- 系统同时返回该记录关联的时间戳列;
- 限制:TOP 函数不支持 FILL 子句。
978

979
### UNIQUE
980

981 982 983
```
SELECT UNIQUE(field_name) FROM {tb_name | stb_name} [WHERE clause];
```
984

985
**功能说明**:返回该列的数值首次出现的值。该函数功能与 distinct 相似,但是可以匹配标签和时间戳信息。可以针对除时间列以外的字段进行查询,可以匹配标签和时间戳,其中的标签和时间戳是第一次出现时刻的标签和时间戳。
986

987
**返回数据类型**:同应用的字段。
988

989
**适用数据类型**:适合于除时间类型以外的字段。
990

991
**适用于**: 表和超级表。
992 993


994
## 时序数据特有函数
995

996
时序数据特有函数是 TDengine 为了满足时序数据的查询场景而量身定做出来的。在通用数据库中,实现类似功能通常需要复杂的查询语法,且效率很低。TDengine 以函数的方式内置了这些功能,最大程度的减轻了用户的使用成本。
997

998
### CSUM
999

1000 1001 1002
```sql
    SELECT CSUM(field_name) FROM { tb_name | stb_name } [WHERE clause]
```
1003

1004
**功能说明**:累加和(Cumulative sum),输出行与输入行数相同。
1005

1006
**返回结果类型**: 输入列如果是整数类型返回值为长整型 (int64_t),浮点数返回值为双精度浮点数(Double)。无符号整数类型返回值为无符号长整型(uint64_t)。 返回结果中同时带有每行记录对应的时间戳。
1007

G
gccgdb1234 已提交
1008
**适用数据类型**:数值类型。
1009

1010
**嵌套子查询支持**: 适用于内层查询和外层查询。
1011

1012
**适用于**:表和超级表
1013

1014 1015 1016 1017 1018
**使用说明**
  
  - 不支持 +、-、*、/ 运算,如 csum(col1) + csum(col2)。
  - 只能与聚合(Aggregation)函数一起使用。 该函数可以应用在普通表和超级表上。 
  - 使用在超级表上的时候,需要搭配 Group by tbname使用,将结果强制规约到单个时间线。
1019 1020


1021
### DERIVATIVE
1022

1023 1024
```
SELECT DERIVATIVE(field_name, time_interval, ignore_negative) FROM tb_name [WHERE clause];
1025 1026
```

1027
**功能说明**:统计表中某列数值的单位变化率。其中单位时间区间的长度可以通过 time_interval 参数指定,最小可以是 1 秒(1s);ignore_negative 参数的值可以是 0 或 1,为 1 时表示忽略负值。
1028

1029
**返回数据类型**:双精度浮点数。
1030

1031
**适用数据类型**:数值类型。
1032

1033
**适用于**:表、超级表
1034

1035
**使用说明**: DERIVATIVE 函数可以在由 GROUP BY 划分出单独时间线的情况下用于超级表(也即 GROUP BY tbname)。
1036 1037


1038
### DIFF
1039

1040 1041 1042
  ```sql
  SELECT {DIFF(field_name, ignore_negative) | DIFF(field_name)} FROM tb_name [WHERE clause];
  ```
1043

1044
**功能说明**:统计表中某列的值与前一行对应值的差。 ignore_negative 取值为 0|1 , 可以不填,默认值为 0. 不忽略负值。ignore_negative 为 1 时表示忽略负数。
1045

1046
**返回数据类型**:同应用字段。
1047

1048
**适用数据类型**:数值类型。
1049

1050
**适用于**:表、超级表。
1051

1052
**使用说明**: 输出结果行数是范围内总行数减一,第一行没有结果输出。
1053 1054


1055
### IRATE
1056

1057 1058
```
SELECT IRATE(field_name) FROM tb_name WHERE clause;
1059 1060
```

1061
**功能说明**:计算瞬时增长率。使用时间区间中最后两个样本数据来计算瞬时增长速率;如果这两个值呈递减关系,那么只取最后一个数用于计算,而不是使用二者差值。
1062

1063
**返回数据类型**:双精度浮点数 Double。
1064

1065
**适用数据类型**:数值类型。
1066 1067 1068

**适用于**:表、超级表。

1069
### MAVG
1070

1071 1072 1073
```sql
    SELECT MAVG(field_name, K) FROM { tb_name | stb_name } [WHERE clause]
```
1074

1075
  **功能说明**: 计算连续 k 个值的移动平均数(moving average)。如果输入行数小于 k,则无结果输出。参数 k 的合法输入范围是 1≤ k ≤ 1000。
1076

1077 1078
  **返回结果类型**: 返回双精度浮点数类型。

G
gccgdb1234 已提交
1079
  **适用数据类型**: 数值类型。
1080

1081
  **嵌套子查询支持**: 适用于内层查询和外层查询。
1082

1083
  **适用于**:表和超级表
1084

1085 1086 1087 1088 1089
  **使用说明**
  
  - 不支持 +、-、*、/ 运算,如 mavg(col1, k1) + mavg(col2, k1); 
  - 只能与普通列,选择(Selection)、投影(Projection)函数一起使用,不能与聚合(Aggregation)函数一起使用;
  - 使用在超级表上的时候,需要搭配 Group by tbname使用,将结果强制规约到单个时间线。
1090

1091
### SAMPLE
1092 1093

```sql
1094
    SELECT SAMPLE(field_name, K) FROM { tb_name | stb_name } [WHERE clause]
1095 1096
```

1097
  **功能说明**: 获取数据的 k 个采样值。参数 k 的合法输入范围是 1≤ k ≤ 1000。
1098

1099
  **返回结果类型**: 同原始数据类型, 返回结果中带有该行记录的时间戳。
1100

1101
  **适用数据类型**: 在超级表查询中使用时,不能应用在标签之上。
1102

1103
  **嵌套子查询支持**: 适用于内层查询和外层查询。
1104

1105
  **适用于**:表和超级表
1106

1107 1108 1109 1110
  **使用说明**
  
  - 不能参与表达式计算;该函数可以应用在普通表和超级表上;
  - 使用在超级表上的时候,需要搭配 Group by tbname 使用,将结果强制规约到单个时间线。
1111

1112
### STATECOUNT
1113

1114 1115
```
SELECT STATECOUNT(field_name, oper, val) FROM { tb_name | stb_name } [WHERE clause];
1116 1117
```

1118
**功能说明**:返回满足某个条件的连续记录的个数,结果作为新的一列追加在每行后面。条件根据参数计算,如果条件为 true 则加 1,条件为 false 则重置为-1,如果数据为 NULL,跳过该条数据。
1119

1120
**参数范围**
1121

1122 1123
- oper : LT (小于)、GT(大于)、LE(小于等于)、GE(大于等于)、NE(不等于)、EQ(等于),不区分大小写。
- val : 数值型
1124

1125
**返回结果类型**:整形。
1126

G
gccgdb1234 已提交
1127
**适用数据类型**:数值类型。
1128

1129
**嵌套子查询支持**:不支持应用在子查询上。
1130

1131
**适用于**:表和超级表。
1132

1133
**使用说明**
1134

1135 1136
- 该函数可以应用在普通表上,在由 GROUP BY 划分出单独时间线的情况下用于超级表(也即 GROUP BY tbname)
- 不能和窗口操作一起使用,例如 interval/state_window/session_window。
1137

1138 1139

### STATEDURATION
1140 1141

```sql
1142
SELECT stateDuration(field_name, oper, val, unit) FROM { tb_name | stb_name } [WHERE clause];
1143 1144
```

1145
**功能说明**:返回满足某个条件的连续记录的时间长度,结果作为新的一列追加在每行后面。条件根据参数计算,如果条件为 true 则加上两个记录之间的时间长度(第一个满足条件的记录时间长度记为 0),条件为 false 则重置为-1,如果数据为 NULL,跳过该条数据。
1146

1147
**参数范围**
1148

1149 1150 1151
- oper : LT (小于)、GT(大于)、LE(小于等于)、GE(大于等于)、NE(不等于)、EQ(等于),不区分大小写。
- val : 数值型
- unit : 时间长度的单位,范围[1s、1m、1h ],不足一个单位舍去。默认为 1s。
1152

1153
**返回结果类型**:整形。
1154

G
gccgdb1234 已提交
1155
**适用数据类型**:数值类型。
1156

1157
**嵌套子查询支持**:不支持应用在子查询上。
1158

1159
**适用于**:表和超级表。
1160

1161
**使用说明**
1162

1163 1164
- 该函数可以应用在普通表上,在由 GROUP BY 划分出单独时间线的情况下用于超级表(也即 GROUP BY tbname)
- 不能和窗口操作一起使用,例如 interval/state_window/session_window。
1165 1166


1167 1168 1169 1170
### TWA

```
SELECT TWA(field_name) FROM tb_name WHERE clause;
1171 1172
```

1173
**功能说明**:时间加权平均函数。统计表中某列在一段时间内的时间加权平均。
1174

1175
**返回数据类型**:双精度浮点数 Double。
1176

1177
**适用数据类型**:数值类型。
1178 1179 1180

**适用于**:表、超级表。

1181
**使用说明**: TWA 函数可以在由 GROUP BY 划分出单独时间线的情况下用于超级表(也即 GROUP BY tbname)。
1182 1183


1184
## 系统信息函数
1185

1186
### DATABASE
1187

1188 1189
```
SELECT DATABASE();
1190 1191
```

1192
**说明**:返回当前登录的数据库。如果登录的时候没有指定默认数据库,且没有使用USE命令切换数据库,则返回NULL。
1193 1194


1195
### CLIENT_VERSION
1196

1197 1198 1199
```
SELECT CLIENT_VERSION();
```
1200

1201
**说明**:返回客户端版本。
1202

1203
### SERVER_VERSION
1204

1205 1206 1207
```
SELECT SERVER_VERSION();
```
1208

1209
**说明**:返回服务端版本。
Y
Yu Chen 已提交
1210

1211
### SERVER_STATUS
1212 1213

```
1214 1215 1216 1217
SELECT SERVER_VERSION();
```

**说明**:返回服务端当前的状态。