From 2f325d9ef9b2085a963abc829b0aa23a68f19311 Mon Sep 17 00:00:00 2001 From: wade zhang Date: Fri, 15 Apr 2022 09:29:10 +0800 Subject: [PATCH] docs: refine some documents in advanced features, reference guide and operation guide --- docs-cn/08-advance-feature/02-subscribe.mdx | 2 +- docs-cn/11-operation/09-status.md | 26 ++++++++++++++----- .../14-reference/01-taos-sql/08-interval.md | 10 +++---- docs-cn/14-reference/01-taos-sql/09-limit.md | 16 +++++++----- 4 files changed, 35 insertions(+), 19 deletions(-) diff --git a/docs-cn/08-advance-feature/02-subscribe.mdx b/docs-cn/08-advance-feature/02-subscribe.mdx index f9952edf56..274140868d 100644 --- a/docs-cn/08-advance-feature/02-subscribe.mdx +++ b/docs-cn/08-advance-feature/02-subscribe.mdx @@ -14,7 +14,7 @@ import Node from "./_sub_node.mdx"; import CSharp from "./_sub_cs.mdx"; import CDemo from "./_sub_c.mdx"; -基于数据天然的时间序列特性,TDengine 的数据写入(insert)与消息系统的数据发布(pub)逻辑上一致,均可视为系统中插入一条带时间戳的新记录。同时,TDengine 在内部严格按照数据时间序列单调递增的方式保存数据。本质上来说,TDengine 中里每一张表均可视为一个标准的消息队列。 +基于数据天然的时间序列特性,TDengine 的数据写入(insert)与消息系统的数据发布(pub)逻辑上一致,均可视为系统中插入一条带时间戳的新记录。同时,TDengine 在内部严格按照数据时间序列单调递增的方式保存数据。本质上来说,TDengine 中每一张表均可视为一个标准的消息队列。 TDengine 内嵌支持轻量级的消息订阅与推送服务。使用系统提供的 API,用户可使用普通查询语句订阅数据库中的一张或多张表。订阅的逻辑和操作状态的维护均是由客户端完成,客户端定时轮询服务器是否有新的记录到达,有新的记录到达就会将结果反馈到客户。 diff --git a/docs-cn/11-operation/09-status.md b/docs-cn/11-operation/09-status.md index 18220ac3ea..209633a596 100644 --- a/docs-cn/11-operation/09-status.md +++ b/docs-cn/11-operation/09-status.md @@ -2,40 +2,52 @@ title: 系统连接、任务查询管理 --- -系统管理员可以从 CLI 查询系统的连接、正在进行的查询、流式计算,并且可以关闭连接、停止正在进行的查询和流式计算。CLI 里 SQL 语法如下: +系统管理员可以从 CLI 查询系统的连接、正在进行的查询、流式计算,并且可以关闭连接、停止正在进行的查询和流式计算。 + +## 显示数据库的连接 ```sql SHOW CONNECTIONS; ``` -显示数据库的连接,其中一列显示 ip:port, 为连接的 IP 地址和端口号。 +其结果中的一列显示 ip:port, 为连接的 IP 地址和端口号。 + +## 强制关闭数据库连接 ```sql KILL CONNECTION ; ``` -强制关闭数据库连接,其中的 connection-id 是 SHOW CONNECTIONS 中显示的第一列的数字。 +其中的 connection-id 是 SHOW CONNECTIONS 中显示的第一列的数字。 + +## 显示数据查询 ```sql SHOW QUERIES; ``` -显示数据查询,其中第一列显示的以冒号隔开的两个数字为 query-id,为发起该 query 应用连接的 connection-id 和查询次数。 +其中第一列显示的以冒号隔开的两个数字为 query-id,为发起该 query 应用连接的 connection-id 和查询次数。 + +## 强制关闭数据查询 ```sql KILL QUERY ; ``` -强制关闭数据查询,其中 query-id 是 SHOW QUERIES 中显示的 connection-id:query-no 字串,如“105:2”,拷贝粘贴即可。 +其中 query-id 是 SHOW QUERIES 中显示的 connection-id:query-no 字串,如“105:2”,拷贝粘贴即可。 + +## 显示流式计算 ```sql SHOW STREAMS; ``` -显示流式计算,其中第一列显示的以冒号隔开的两个数字为 stream-id, 为启动该 stream 应用连接的 connection-id 和发起 stream 的次数。 +其中第一列显示的以冒号隔开的两个数字为 stream-id, 为启动该 stream 应用连接的 connection-id 和发起 stream 的次数。 + +## 强制关闭流式计算 ```sql KILL STREAM ; ``` -强制关闭流式计算,其中的中 stream-id 是 SHOW STREAMS 中显示的 connection-id:stream-no 字串,如 103:2,拷贝粘贴即可。 +其中的 stream-id 是 SHOW STREAMS 中显示的 connection-id:stream-no 字串,如 103:2,拷贝粘贴即可。 diff --git a/docs-cn/14-reference/01-taos-sql/08-interval.md b/docs-cn/14-reference/01-taos-sql/08-interval.md index ef81ba78ea..8fb3296b04 100644 --- a/docs-cn/14-reference/01-taos-sql/08-interval.md +++ b/docs-cn/14-reference/01-taos-sql/08-interval.md @@ -16,13 +16,13 @@ INTERVAL 子句用于产生相等时间周期的窗口,SLIDING 用以指定窗 INTERVAL 和 SLIDING 子句需要配合聚合和选择函数来使用。以下 SQL 语句非法: ``` -SELECT * FROM temp_table INTERVAL(1S) +SELECT * FROM temp_tb_1 INTERVAL(1m); ``` SLIDING 的向前滑动的时间不能超过一个窗口的时间范围。以下语句非法: ``` -SELECT COUNT(*) FROM temp_table INTERVAL(1D) SLIDING(2D) +SELECT COUNT(*) FROM temp_tb_1 INTERVAL(1m) SLIDING(2m); ``` 当 SLIDING 与 INTERVAL 取值相等的时候,滑动窗口即为翻转窗口。 @@ -38,7 +38,7 @@ _ 从 2.1.5.0 版本开始,INTERVAL 语句允许的最短时间间隔调整为 使用 STATE_WINDOW 来确定状态窗口划分的列。例如: ``` -SELECT COUNT(*), FIRST(ts), status FROM temp_tb_1 STATE_WINDOW(status) +SELECT COUNT(*), FIRST(ts), status FROM temp_tb_1 STATE_WINDOW(status); ``` ## 会话窗口 @@ -51,7 +51,7 @@ SELECT COUNT(*), FIRST(ts), status FROM temp_tb_1 STATE_WINDOW(status) ``` -SELECT COUNT(*), FIRST(ts) FROM temp_tb_1 SESSION(ts, tol_val) +SELECT COUNT(*), FIRST(ts) FROM temp_tb_1 SESSION(ts, tol_val); ``` 这种类型的查询语法如下: @@ -72,7 +72,7 @@ SELECT function_list FROM stb_name ``` - 在聚合查询中,function_list 位置允许使用聚合和选择函数,并要求每个函数仅输出单个结果(例如:COUNT、AVG、SUM、STDDEV、LEASTSQUARES、PERCENTILE、MIN、MAX、FIRST、LAST),而不能使用具有多行输出结果的函数(例如:DIFF 以及四则运算)。 -- 此外也 LAST_ROW 查询也不能与窗口聚合同时出现。 +- 此外 LAST_ROW 查询也不能与窗口聚合同时出现。 - 标量函数(如:CEIL/FLOOR 等)也不能使用在窗口聚合查询中。 - diff --git a/docs-cn/14-reference/01-taos-sql/09-limit.md b/docs-cn/14-reference/01-taos-sql/09-limit.md index 327ee165cc..c7934685bc 100644 --- a/docs-cn/14-reference/01-taos-sql/09-limit.md +++ b/docs-cn/14-reference/01-taos-sql/09-limit.md @@ -6,11 +6,12 @@ title: 边界限制 ## 一般限制 - 数据库名最大长度为 32。 -- 表名最大长度为 192,每行数据最大长度 16k 个字符, 从 2.1.7.0 版本开始,每行数据最大长度 48k 个字符(注意:数据行内每个 BINARY/NCHAR 类型的列还会额外占用 2 个字节的存储位置)。 -- 列名最大长度为 64,最多允许 1024 列,最少需要 2 列,第一列必须是时间戳。(从 2.1.7.0 版本开始,改为最多允许 4096 列) +- 表名最大长度为 192,不包括数据库名前缀和分隔符 +- 每行数据最大长度 16k 个字符, 从 2.1.7.0 版本开始,每行数据最大长度 48k 个字符(注意:数据行内每个 BINARY/NCHAR 类型的列还会额外占用 2 个字节的存储位置)。 +- 列名最大长度为 64,最多允许 4096 列,最少需要 2 列,第一列必须是时间戳。注:从 2.1.7.0 版本(不含)以前最多允许 4096 列 - 标签名最大长度为 64,最多允许 128 个,可以 1 个,一个表中标签值的总长度不超过 16k 个字符。 - SQL 语句最大长度 1048576 个字符,也可通过客户端配置参数 maxSQLLength 修改,取值范围 65480 ~ 1048576。 -- SELECT 语句的查询结果,最多允许返回 1024 列(语句中的函数调用可能也会占用一些列空间),超限时需要显式指定较少的返回数据列,以避免语句执行报错。(从 2.1.7.0 版本开始,改为最多允许 4096 列) +- SELECT 语句的查询结果,最多允许返回 4096 列(语句中的函数调用可能也会占用一些列空间),超限时需要显式指定较少的返回数据列,以避免语句执行报错。注: 2.1.7.0 版本(不含)之前为最多允许 1024 列 - 库的数目,超级表的数目、表的数目,系统不做限制,仅受系统资源限制。 ## GROUP BY 的限制 @@ -34,17 +35,20 @@ IS NOT NULL 支持所有类型的列。不为空的表达式为 <\>"",仅对 ## 表(列)名合法性说明 -TDengine 中的表(列)名命名规则如下: +### TDengine 中的表(列)名命名规则如下: 只能由字母、数字、下划线构成,数字不能在首位,长度不能超过 192 字节,不区分大小写。这里表名称不包括数据库名的前缀和分隔符。 -转移后表(列)名规则: +### 转义后表(列)名规则: 为了兼容支持更多形式的表(列)名,TDengine 引入新的转义符 "`"。可用让表名与关键词不冲突,同时不受限于上述表名称合法性约束检查,转义符不计入表名称的长度。 转义后的表(列)名同样受到长度限制要求,且长度计算的时候不计算转义符。使用转义字符以后,不再对转义字符中的内容进行大小写统一。 例如: \`aBc\` 和 \`abc\` 是不同的表(列)名,但是 abc 和 aBc 是相同的表(列)名。 +:::note 需要注意的是转义字符中的内容必须是可打印字符。 -支持版本 +::: + +### 支持版本 支持转义符的功能从 2.3.0.1 版本开始。 \ No newline at end of file -- GitLab