doc: fix agg/system function cn version document errors/typo.

TD-16224
This commit is contained in:
Ganlin Zhao 2022-07-28 16:17:22 +08:00 committed by GitHub
parent 360cb388f1
commit a85d13ee58
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 61 additions and 56 deletions

View File

@ -520,7 +520,7 @@ SELECT TIMEDIFF(ts | datetime_string1, ts | datetime_string2 [, time_unit]) FROM
**应用字段**:表示 UNIX 时间戳的 BIGINT, TIMESTAMP 类型,或符合日期时间格式的 VARCHAR, NCHAR 类型。 **应用字段**:表示 UNIX 时间戳的 BIGINT, TIMESTAMP 类型,或符合日期时间格式的 VARCHAR, NCHAR 类型。
**适用于**:表超级表。 **适用于**:表超级表。
**嵌套子查询支持**:适用于内层查询和外层查询。 **嵌套子查询支持**:适用于内层查询和外层查询。
@ -542,7 +542,7 @@ SELECT TIMETRUNCATE(ts | datetime_string , time_unit) FROM { tb_name | stb_name
**应用字段**:表示 UNIX 时间戳的 BIGINT, TIMESTAMP 类型,或符合日期时间格式的 VARCHAR, NCHAR 类型。 **应用字段**:表示 UNIX 时间戳的 BIGINT, TIMESTAMP 类型,或符合日期时间格式的 VARCHAR, NCHAR 类型。
**适用于**:表超级表。 **适用于**:表超级表。
**使用说明** **使用说明**
- 支持的时间单位 time_unit 如下: - 支持的时间单位 time_unit 如下:
@ -562,7 +562,7 @@ SELECT TIMEZONE() FROM { tb_name | stb_name } [WHERE clause];
**应用字段**:无 **应用字段**:无
**适用于**:表超级表。 **适用于**:表超级表。
#### TODAY #### TODAY
@ -579,7 +579,7 @@ INSERT INTO tb_name VALUES (TODAY(), ...);
**应用字段**:在 WHERE 或 INSERT 语句中使用时只能作用于 TIMESTAMP 类型的字段。 **应用字段**:在 WHERE 或 INSERT 语句中使用时只能作用于 TIMESTAMP 类型的字段。
**适用于**:表超级表。 **适用于**:表超级表。
**使用说明** **使用说明**
@ -600,13 +600,13 @@ TDengine 支持针对数据的聚合查询。提供如下聚合函数。
SELECT AVG(field_name) FROM tb_name [WHERE clause]; SELECT AVG(field_name) FROM tb_name [WHERE clause];
``` ```
**功能说明**:统计表/超级表中某列的平均值。 **功能说明**:统计指定字段的平均值。
**返回数据类型**双精度浮点数 Double **返回数据类型**DOUBLE
**适用数据类型**:数值类型。 **适用数据类型**:数值类型。
**适用于**:表超级表。 **适用于**:表超级表。
### COUNT ### COUNT
@ -615,19 +615,18 @@ SELECT AVG(field_name) FROM tb_name [WHERE clause];
SELECT COUNT([*|field_name]) FROM tb_name [WHERE clause]; SELECT COUNT([*|field_name]) FROM tb_name [WHERE clause];
``` ```
**功能说明**:统计表/超级表中记录行数或某列的非空值个数。 **功能说明**:统计指定字段的记录行数。
**返回数据类型**长整型 INT64 **返回数据类型**BIGINT
**适用数据类型**应用全部字段。 **适用数据类型**:全部类型字段。
**适用于**:表超级表。 **适用于**:表超级表。
**使用说明**: **使用说明**:
- 可以使用星号(\*)来替代具体的字段,使用星号(\*)返回全部记录数量。 - 可以使用星号(\*)来替代具体的字段,使用星号(\*)返回全部记录数量。
- 针对同一表的(不包含 NULL 值)字段查询结果均相同。 - 如果统计字段是具体的列,则返回该列中非 NULL 值的记录数量。
- 如果统计对象是具体的列,则返回该列中非 NULL 值的记录数量。
### ELAPSED ### ELAPSED
@ -638,17 +637,18 @@ SELECT ELAPSED(ts_primary_key [, time_unit]) FROM { tb_name | stb_name } [WHERE
**功能说明**elapsed函数表达了统计周期内连续的时间长度和twa函数配合使用可以计算统计曲线下的面积。在通过INTERVAL子句指定窗口的情况下统计在给定时间范围内的每个窗口内有数据覆盖的时间范围如果没有INTERVAL子句则返回整个给定时间范围内的有数据覆盖的时间范围。注意ELAPSED返回的并不是时间范围的绝对值而是绝对值除以time_unit所得到的单位个数。 **功能说明**elapsed函数表达了统计周期内连续的时间长度和twa函数配合使用可以计算统计曲线下的面积。在通过INTERVAL子句指定窗口的情况下统计在给定时间范围内的每个窗口内有数据覆盖的时间范围如果没有INTERVAL子句则返回整个给定时间范围内的有数据覆盖的时间范围。注意ELAPSED返回的并不是时间范围的绝对值而是绝对值除以time_unit所得到的单位个数。
**返回结果类型**Double **返回结果类型**DOUBLE。
**适用数据类型**Timestamp类型 **适用数据类型**TIMESTAMP。
**支持的版本**2.6.0.0 及以后的版本。 **支持的版本**2.6.0.0 及以后的版本。
**适用于**: 表,超级表,嵌套查询的外层查询 **适用于**: 表,超级表,嵌套查询的外层查询
**说明** **说明**
- field_name参数只能是表的第一列即timestamp主键列。 - field_name参数只能是表的第一列即 TIMESTAMP 类型的主键列。
- 按time_unit参数指定的时间单位返回最小是数据库的时间分辨率。time_unit参数未指定时以数据库的时间分辨率为时间单位。 - 按time_unit参数指定的时间单位返回最小是数据库的时间分辨率。time_unit 参数未指定时,以数据库的时间分辨率为时间单位。支持的时间单位 time_unit 如下:
1b(纳秒), 1u(微秒)1a(毫秒)1s(秒)1m(分)1h(小时)1d(天), 1w(周)。
- 可以和interval组合使用返回每个时间窗口的时间戳差值。需要特别注意的是除第一个时间窗口和最后一个时间窗口外中间窗口的时间戳差值均为窗口长度。 - 可以和interval组合使用返回每个时间窗口的时间戳差值。需要特别注意的是除第一个时间窗口和最后一个时间窗口外中间窗口的时间戳差值均为窗口长度。
- order by asc/desc不影响差值的计算结果。 - order by asc/desc不影响差值的计算结果。
- 对于超级表需要和group by tbname子句组合使用不可以直接使用。 - 对于超级表需要和group by tbname子句组合使用不可以直接使用。
@ -677,11 +677,11 @@ SELECT LEASTSQUARES(field_name, start_val, step_val) FROM tb_name [WHERE clause]
SELECT MODE(field_name) FROM tb_name [WHERE clause]; SELECT MODE(field_name) FROM tb_name [WHERE clause];
``` ```
**功能说明**:返回出现频率最高的值,若存在多个频率相同的最高值,输出 **功能说明**:返回出现频率最高的值,若存在多个频率相同的最高值,输出NULL
**返回数据类型**同应用的字段 **返回数据类型**与输入数据类型一致
**适用数据类型** 数值类型 **适用数据类型**全部类型字段
**适用于**:表和超级表。 **适用于**:表和超级表。
@ -692,11 +692,11 @@ SELECT MODE(field_name) FROM tb_name [WHERE clause];
SELECT SPREAD(field_name) FROM { tb_name | stb_name } [WHERE clause]; SELECT SPREAD(field_name) FROM { tb_name | stb_name } [WHERE clause];
``` ```
**功能说明**:统计表/超级表中某列的最大值和最小值之差。 **功能说明**:统计表中某列的最大值和最小值之差。
**返回数据类型**双精度浮点数 **返回数据类型**DOUBLE
**适用数据类型**数值类型或TIMESTAMP类型 **适用数据类型**INTEGER, TIMESTAMP
**适用于**:表和超级表。 **适用于**:表和超级表。
@ -709,7 +709,7 @@ SELECT STDDEV(field_name) FROM tb_name [WHERE clause];
**功能说明**:统计表中某列的均方差。 **功能说明**:统计表中某列的均方差。
**返回数据类型**双精度浮点数 Double **返回数据类型**DOUBLE
**适用数据类型**:数值类型。 **适用数据类型**:数值类型。
@ -724,7 +724,7 @@ SELECT SUM(field_name) FROM tb_name [WHERE clause];
**功能说明**:统计表/超级表中某列的和。 **功能说明**:统计表/超级表中某列的和。
**返回数据类型**双精度浮点数 Double 和长整型 INT64 **返回数据类型**DOUBLE, BIGINT
**适用数据类型**:数值类型。 **适用数据类型**:数值类型。
@ -738,10 +738,10 @@ SELECT HYPERLOGLOG(field_name) FROM { tb_name | stb_name } [WHERE clause];
``` ```
**功能说明** **功能说明**
- 采用 hyperloglog 算法,返回某列的基数。该算法在数据量很大的情况下,可以明显降低内存的占用,但是求出来的基数是个估算值,标准误差(标准误差是多次实验,每次的平均数的标准差,不是与真实结果的误差)为 0.81%。 - 采用 hyperloglog 算法,返回某列的基数。该算法在数据量很大的情况下,可以明显降低内存的占用,求出来的基数是个估算值,标准误差(标准误差是多次实验,每次的平均数的标准差,不是与真实结果的误差)为 0.81%。
- 在数据量较少的时候该算法不是很准确,可以使用 select count(data) from (select unique(col) as data from table) 的方法。 - 在数据量较少的时候该算法不是很准确,可以使用 select count(data) from (select unique(col) as data from table) 的方法。
**返回结果类型**整形 **返回结果类型**INTEGER
**适用数据类型**:任何类型。 **适用数据类型**:任何类型。
@ -756,7 +756,7 @@ SELECT HISTOGRAM(field_namebin_type, bin_description, normalized) FROM tb_nam
**功能说明**:统计数据按照用户指定区间的分布。 **功能说明**:统计数据按照用户指定区间的分布。
**返回结果类型**:如归一化参数 normalized 设置为 1返回结果为双精度浮点类型 DOUBLE否则为长整形 INT64 **返回结果类型**:如归一化参数 normalized 设置为 1返回结果为 DOUBLE 类型,否则为 BIGINT 类型
**适用数据类型**:数值型字段。 **适用数据类型**:数值型字段。
@ -791,11 +791,15 @@ FROM { tb_name | stb_name } [WHERE clause]
**功能说明**:统计表/超级表中指定列的值的近似百分比分位数,与 PERCENTILE 函数相似,但是返回近似结果。 **功能说明**:统计表/超级表中指定列的值的近似百分比分位数,与 PERCENTILE 函数相似,但是返回近似结果。
**返回数据类型** 双精度浮点数 Double **返回数据类型** DOUBLE
**适用数据类型**:数值类型。P值范围是[0,100]当为0时等同于MIN为100时等同于MAX。如果不指定 algo_type 则使用默认算法 。 **适用数据类型**:数值类型。
**适用于**:表、超级表。 **适用于**:表和超级表。
**说明**
- P值范围是[0,100]当为0时等同于MIN为100时等同于MAX。
- algo_type 取值为 "default" 或 "t-digest"。 输入为 "default" 时函数使用基于直方图算法进行计算。输入为 "t-digest" 时使用t-digest算法计算分位数的近似结果。如果不指定 algo_type 则使用 "default" 算法。
### BOTTOM ### BOTTOM
@ -939,7 +943,7 @@ SELECT PERCENTILE(field_name, P) FROM { tb_name } [WHERE clause];
**功能说明**:统计表中某列的值百分比分位数。 **功能说明**:统计表中某列的值百分比分位数。
**返回数据类型** 双精度浮点数 Double **返回数据类型** DOUBLE
**应用字段**:数值类型。 **应用字段**:数值类型。
@ -960,7 +964,7 @@ SELECT TAIL(field_name, k, offset_val) FROM {tb_name | stb_name} [WHERE clause];
**返回数据类型**:同应用的字段。 **返回数据类型**:同应用的字段。
**适用数据类型**:适合于除时间主列外的任何类型。 **适用数据类型**:适合于除时间主列外的任何类型。
**适用于**:表、超级表。 **适用于**:表、超级表。
@ -977,7 +981,7 @@ SELECT TOP(field_name, K) FROM { tb_name | stb_name } [WHERE clause];
**适用数据类型**:数值类型。 **适用数据类型**:数值类型。
**适用于**:表超级表。 **适用于**:表超级表。
**使用说明**: **使用说明**:
@ -1018,13 +1022,13 @@ SELECT CSUM(field_name) FROM { tb_name | stb_name } [WHERE clause]
**嵌套子查询支持** 适用于内层查询和外层查询。 **嵌套子查询支持** 适用于内层查询和外层查询。
**适用于**:表和超级表 **适用于**:表和超级表
**使用说明** **使用说明**
- 不支持 +、-、*、/ 运算,如 csum(col1) + csum(col2)。 - 不支持 +、-、*、/ 运算,如 csum(col1) + csum(col2)。
- 只能与聚合Aggregation函数一起使用。 该函数可以应用在普通表和超级表上。 - 只能与聚合Aggregation函数一起使用。 该函数可以应用在普通表和超级表上。
- 使用在超级表上的时候,需要搭配 Group by tbname使用将结果强制规约到单个时间线。 - 使用在超级表上的时候,需要搭配 PARTITION BY tbname使用将结果强制规约到单个时间线。
### DERIVATIVE ### DERIVATIVE
@ -1035,13 +1039,13 @@ SELECT DERIVATIVE(field_name, time_interval, ignore_negative) FROM tb_name [WHER
**功能说明**:统计表中某列数值的单位变化率。其中单位时间区间的长度可以通过 time_interval 参数指定,最小可以是 1 秒1signore_negative 参数的值可以是 0 或 1为 1 时表示忽略负值。 **功能说明**:统计表中某列数值的单位变化率。其中单位时间区间的长度可以通过 time_interval 参数指定,最小可以是 1 秒1signore_negative 参数的值可以是 0 或 1为 1 时表示忽略负值。
**返回数据类型**双精度浮点数 **返回数据类型**DOUBLE
**适用数据类型**:数值类型。 **适用数据类型**:数值类型。
**适用于**:表、超级表 **适用于**:表和超级表。
**使用说明**: DERIVATIVE 函数可以在由 GROUP BY 划分出单独时间线的情况下用于超级表(也即 GROUP BY tbname **使用说明**: DERIVATIVE 函数可以在由 PARTITION BY 划分出单独时间线的情况下用于超级表(也即 PARTITION BY tbname
### DIFF ### DIFF
@ -1056,7 +1060,7 @@ SELECT {DIFF(field_name, ignore_negative) | DIFF(field_name)} FROM tb_name [WHER
**适用数据类型**:数值类型。 **适用数据类型**:数值类型。
**适用于**:表超级表。 **适用于**:表超级表。
**使用说明**: 输出结果行数是范围内总行数减一,第一行没有结果输出。 **使用说明**: 输出结果行数是范围内总行数减一,第一行没有结果输出。
@ -1069,11 +1073,12 @@ SELECT IRATE(field_name) FROM tb_name WHERE clause;
**功能说明**:计算瞬时增长率。使用时间区间中最后两个样本数据来计算瞬时增长速率;如果这两个值呈递减关系,那么只取最后一个数用于计算,而不是使用二者差值。 **功能说明**:计算瞬时增长率。使用时间区间中最后两个样本数据来计算瞬时增长速率;如果这两个值呈递减关系,那么只取最后一个数用于计算,而不是使用二者差值。
**返回数据类型**双精度浮点数 Double **返回数据类型**DOUBLE
**适用数据类型**:数值类型。 **适用数据类型**:数值类型。
**适用于**:表、超级表。 **适用于**:表和超级表。
### MAVG ### MAVG
@ -1083,19 +1088,19 @@ SELECT MAVG(field_name, K) FROM { tb_name | stb_name } [WHERE clause]
**功能说明** 计算连续 k 个值的移动平均数moving average。如果输入行数小于 k则无结果输出。参数 k 的合法输入范围是 1≤ k ≤ 1000。 **功能说明** 计算连续 k 个值的移动平均数moving average。如果输入行数小于 k则无结果输出。参数 k 的合法输入范围是 1≤ k ≤ 1000。
**返回结果类型** 返回双精度浮点数类型 **返回结果类型** DOUBLE
**适用数据类型** 数值类型。 **适用数据类型** 数值类型。
**嵌套子查询支持** 适用于内层查询和外层查询。 **嵌套子查询支持** 适用于内层查询和外层查询。
**适用于**:表和超级表 **适用于**:表和超级表
**使用说明** **使用说明**
- 不支持 +、-、*、/ 运算,如 mavg(col1, k1) + mavg(col2, k1); - 不支持 +、-、*、/ 运算,如 mavg(col1, k1) + mavg(col2, k1);
- 只能与普通列选择Selection、投影Projection函数一起使用不能与聚合Aggregation函数一起使用 - 只能与普通列选择Selection、投影Projection函数一起使用不能与聚合Aggregation函数一起使用
- 使用在超级表上的时候,需要搭配 Group by tbname使用将结果强制规约到单个时间线。 - 使用在超级表上的时候,需要搭配 PARTITION BY tbname使用将结果强制规约到单个时间线。
### SAMPLE ### SAMPLE
@ -1111,12 +1116,12 @@ SELECT SAMPLE(field_name, K) FROM { tb_name | stb_name } [WHERE clause]
**嵌套子查询支持** 适用于内层查询和外层查询。 **嵌套子查询支持** 适用于内层查询和外层查询。
**适用于**:表和超级表 **适用于**:表和超级表
**使用说明** **使用说明**
- 不能参与表达式计算;该函数可以应用在普通表和超级表上; - 不能参与表达式计算;该函数可以应用在普通表和超级表上;
- 使用在超级表上的时候,需要搭配 Group by tbname 使用,将结果强制规约到单个时间线。 - 使用在超级表上的时候,需要搭配 PARTITION by tbname 使用,将结果强制规约到单个时间线。
### STATECOUNT ### STATECOUNT
@ -1128,10 +1133,10 @@ SELECT STATECOUNT(field_name, oper, val) FROM { tb_name | stb_name } [WHERE clau
**参数范围** **参数范围**
- oper : LT (小于)、GT大于、LE小于等于、GE大于等于、NE不等于、EQ等于不区分大小写。 - oper : "LT" (小于)、"GT"(大于)、"LE"(小于等于)、"GE"(大于等于)、"NE"(不等于)、"EQ"(等于),不区分大小写。
- val : 数值型 - val : 数值型
**返回结果类型**整形 **返回结果类型**INTEGER
**适用数据类型**:数值类型。 **适用数据类型**:数值类型。
@ -1141,7 +1146,7 @@ SELECT STATECOUNT(field_name, oper, val) FROM { tb_name | stb_name } [WHERE clau
**使用说明** **使用说明**
- 该函数可以应用在普通表上,在由 GROUP BY 划分出单独时间线的情况下用于超级表(也即 GROUP BY tbname - 该函数可以应用在普通表上,在由 PARTITION BY 划分出单独时间线的情况下用于超级表(也即 PARTITION BY tbname
- 不能和窗口操作一起使用,例如 interval/state_window/session_window。 - 不能和窗口操作一起使用,例如 interval/state_window/session_window。
@ -1155,11 +1160,11 @@ SELECT stateDuration(field_name, oper, val, unit) FROM { tb_name | stb_name } [W
**参数范围** **参数范围**
- oper : LT (小于)、GT大于、LE小于等于、GE大于等于、NE不等于、EQ等于不区分大小写。 - oper : "LT" (小于)、"GT"(大于)、"LE"(小于等于)、"GE"(大于等于)、"NE"(不等于)、"EQ"(等于),不区分大小写。
- val : 数值型 - val : 数值型
- unit : 时间长度的单位,范围[1s、1m、1h ],不足一个单位舍去。默认为 1s。 - unit : 时间长度的单位,范围[1s、1m、1h ],不足一个单位舍去。默认为 1s。
**返回结果类型**整形 **返回结果类型**INTEGER
**适用数据类型**:数值类型。 **适用数据类型**:数值类型。
@ -1169,7 +1174,7 @@ SELECT stateDuration(field_name, oper, val, unit) FROM { tb_name | stb_name } [W
**使用说明** **使用说明**
- 该函数可以应用在普通表上,在由 GROUP BY 划分出单独时间线的情况下用于超级表(也即 GROUP BY tbname - 该函数可以应用在普通表上,在由 PARTITION BY 划分出单独时间线的情况下用于超级表(也即 PARTITION BY tbname
- 不能和窗口操作一起使用,例如 interval/state_window/session_window。 - 不能和窗口操作一起使用,例如 interval/state_window/session_window。
@ -1181,13 +1186,13 @@ SELECT TWA(field_name) FROM tb_name WHERE clause;
**功能说明**:时间加权平均函数。统计表中某列在一段时间内的时间加权平均。 **功能说明**:时间加权平均函数。统计表中某列在一段时间内的时间加权平均。
**返回数据类型**双精度浮点数 Double **返回数据类型**DOUBLE
**适用数据类型**:数值类型。 **适用数据类型**:数值类型。
**适用于**:表超级表。 **适用于**:表超级表。
**使用说明** TWA 函数可以在由 GROUP BY 划分出单独时间线的情况下用于超级表(也即 GROUP BY tbname **使用说明** TWA 函数可以在由 PARTITION BY 划分出单独时间线的情况下用于超级表(也即 PARTITION BY tbname
## 系统信息函数 ## 系统信息函数