From 8ecd9eb089ad412e6afb3f0b8c30efbde355b972 Mon Sep 17 00:00:00 2001 From: gccgdb1234 Date: Mon, 16 May 2022 14:36:43 +0800 Subject: [PATCH] docs: unify some terms and labels, and refine database parameters --- docs-cn/12-taos-sql/02-database.md | 18 +- docs-cn/14-reference/12-config/index.md | 271 +++++++++--------- docs-en/04-develop/01-connect/index.md | 2 +- docs-en/04-develop/02-model/index.mdx | 1 - .../04-develop/03-insert-data/_category_.yml | 2 +- .../04-develop/04-query-data/_category_.yml | 2 +- docs-en/12-taos-sql/02-database.md | 20 +- docs-en/12-taos-sql/05-insert.md | 1 - docs-en/12-taos-sql/06-select.md | 1 - docs-en/12-taos-sql/07-function.md | 1 - docs-en/12-taos-sql/08-interval.md | 4 +- docs-en/12-taos-sql/09-limit.md | 3 +- docs-en/12-taos-sql/10-json.md | 1 - docs-en/12-taos-sql/11-escape.md | 5 +- docs-en/12-taos-sql/12-keywords.md | 5 +- docs-en/13-operation/03-tolerance.md | 4 +- docs-en/13-operation/07-import.md | 1 - docs-en/13-operation/08-export.md | 1 - docs-en/13-operation/10-monitor.md | 1 - docs-en/13-operation/11-optimize.md | 1 - docs-en/13-operation/17-diagnose.md | 3 +- docs-en/14-reference/12-config/index.md | 9 + 22 files changed, 194 insertions(+), 163 deletions(-) diff --git a/docs-cn/12-taos-sql/02-database.md b/docs-cn/12-taos-sql/02-database.md index 5d358193f9..6ea8b1568e 100644 --- a/docs-cn/12-taos-sql/02-database.md +++ b/docs-cn/12-taos-sql/02-database.md @@ -19,7 +19,23 @@ CREATE DATABASE [IF NOT EXISTS] db_name [KEEP keep] [DAYS days] [UPDATE 1]; 4. 更多关于 UPDATE 参数的用法，请参考[FAQ](/train-faq/faq)。 3. 数据库名最大长度为 33； 4. 一条 SQL 语句的最大长度为 65480 个字符； -5. 数据库还有更多与数据库相关的配置参数，如 cache, blocks, days, keep, minRows, maxRows, wal, fsync, update, cacheLast, replica, quorum, maxVgroupsPerDb, ctime, comp, prec, 具体细节请参见 [配置参数](/reference/config/) 章节。 +5. 创建数据库时可用的参数有： + - cache: [Description](/reference/config/#cache) + - blocks: [Description](/reference/config/#blocks) + - days: [Description](/reference/config/#days) + - keep: [Description](/reference/config/#keep) + - minRows: [Description](/reference/config/#minrows) + - maxRows: [Description](/reference/config/#maxrows) + - wal: [Description](/reference/config/#wallevel) + - fsync: [Description](/reference/config/#fsync) + - update: [Description](/reference/config/#update) + - cacheLast: [Description](/reference/config/#cachelast) + - replica: [Description](/reference/config/#replica) + - quorum: [Description](/reference/config/#quorum) + - maxVgroupsPerDb: [Description](/reference/config/#maxvgroupsperdb) + - comp: [Description](/reference/config/#comp) + - precision: [Description](reference/config/#precision) +6. 请注意上面列出的所有参数都可以配置在配置文件 `taosd.cfg` 中作为创建数据库时使用的默认配置， `create database` 的参数中明确指定的会覆盖配置文件中的设置。 ::: diff --git a/docs-cn/14-reference/12-config/index.md b/docs-cn/14-reference/12-config/index.md index 9fff685ee6..e153f82a21 100644 --- a/docs-cn/14-reference/12-config/index.md +++ b/docs-cn/14-reference/12-config/index.md @@ -38,7 +38,6 @@ taos --dump-config ::: - :::note 配置文件参数修改后，需要重启*taosd*服务，或客户端应用才能生效。 @@ -48,54 +47,54 @@ taos --dump-config ### firstEp -| 属性 | 说明 | -| -------- | ----------------------------------------------------- | -| 适用范围 | 服务端和客户端均适用 | +| 属性 | 说明 | +| -------- | --------------------------------------------------------------- | +| 适用范围 | 服务端和客户端均适用 | | 含义 | taosd 或者 taos 启动时，主动连接的集群中首个 dnode 的 end point | -| 缺省值 | localhost:6030 | +| 缺省值 | localhost:6030 | ### secondEp -| 属性 | 说明 | -| -------- | ---------------------------------------------------------------------------- | -| 适用范围 | 服务端和客户端均适用 | +| 属性 | 说明 | +| -------- | -------------------------------------------------------------------------------------- | +| 适用范围 | 服务端和客户端均适用 | | 含义 | taosd 或者 taos 启动时，如果 firstEp 连接不上，尝试连接集群中第二个 dnode 的 end point | -| 缺省值 | 无 | +| 缺省值 | 无 | ### fqdn | 属性 | 说明 | | -------- | ----------------------------------------------------------------- | -| 适用范围 | 仅服务端适用 | +| 适用范围 | 仅服务端适用 | | 含义 | 数据节点的 FQDN。如果习惯 IP 地址访问，可设置为该节点的 IP 地址。 | | 缺省值 | 缺省为操作系统配置的第一个 hostname。 | | 补充说明 | 这个参数值的长度需要控制在 96 个字符以内。 | ### serverPort -| 属性 | 说明 | -| -------- | ------------------------------------------------------------------------------------------------------------------- | -| 适用范围 | 仅服务端适用 | -| 含义 | taosd 启动后，对外服务的端口号 | -| 缺省值 | 6030 | -| 补充说明 | RESTful 服务在2.4.0.0之前（不含）由taosd提供，默认端口为 6041; 在2.4.0.0 及后续版本由 taosAdapter，默认端口为6041 | +| 属性 | 说明 | +| -------- | ----------------------------------------------------------------------------------------------------------------------- | +| 适用范围 | 仅服务端适用 | +| 含义 | taosd 启动后，对外服务的端口号 | +| 缺省值 | 6030 | +| 补充说明 | RESTful 服务在 2.4.0.0 之前（不含）由 taosd 提供，默认端口为 6041; 在 2.4.0.0 及后续版本由 taosAdapter，默认端口为 6041 | :::note 对于端口，TDengine 会使用从 serverPort 起 13 个连续的 TCP 和 UDP 端口号，请务必在防火墙打开。因此如果是缺省配置，需要打开从 6030 到 6042 共 13 个端口，而且必须 TCP 和 UDP 都打开。（详细的端口情况请参见下表） ::: -| 协议 | 默认端口 | 用途说明 | 修改方法 | +| 协议 | 默认端口 | 用途说明 | 修改方法 | | :--- | :-------- | :---------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------- | -| TCP | 6030 | 客户端与服务端之间通讯。 | 由配置文件设置 serverPort 决定。 | -| TCP | 6035 | 多节点集群的节点间通讯。 | 随 serverPort 端口变化。 | -| TCP | 6040 | 多节点集群的节点间数据同步。 | 随 serverPort 端口变化。 | -| TCP | 6041 | 客户端与服务端之间的 RESTful 通讯。 | 随 serverPort 端口变化。注意 taosAdapter 配置或有不同，请参考相应[文档](/reference/taosadapter/)。 | -| TCP | 6042 | Arbitrator 的服务端口。 | 随 Arbitrator 启动参数设置变化。 | -| TCP | 6043 | TaosKeeper 监控服务端口。 | 随 TaosKeeper 启动参数设置变化。 | -| TCP | 6044 | 支持 StatsD 的数据接入端口。 | 随 taosAdapter 启动参数设置变化（2.3.0.1+以上版本）。 | -| UDP | 6045 | 支持 collectd 数据接入端口。 | 随 taosAdapter 启动参数设置变化（2.3.0.1+以上版本）。 | -| TCP | 6060 | 企业版内 Monitor 服务的网络端口。 | | -| UDP | 6030-6034 | 客户端与服务端之间通讯。 | 随 serverPort 端口变化。 | -| UDP | 6035-6039 | 多节点集群的节点间通讯。 | 随 serverPort 端口变化。 +| TCP | 6030 | 客户端与服务端之间通讯。 | 由配置文件设置 serverPort 决定。 | +| TCP | 6035 | 多节点集群的节点间通讯。 | 随 serverPort 端口变化。 | +| TCP | 6040 | 多节点集群的节点间数据同步。 | 随 serverPort 端口变化。 | +| TCP | 6041 | 客户端与服务端之间的 RESTful 通讯。 | 随 serverPort 端口变化。注意 taosAdapter 配置或有不同，请参考相应[文档](/reference/taosadapter/)。 | +| TCP | 6042 | Arbitrator 的服务端口。 | 随 Arbitrator 启动参数设置变化。 | +| TCP | 6043 | TaosKeeper 监控服务端口。 | 随 TaosKeeper 启动参数设置变化。 | +| TCP | 6044 | 支持 StatsD 的数据接入端口。 | 随 taosAdapter 启动参数设置变化（2.3.0.1+以上版本）。 | +| UDP | 6045 | 支持 collectd 数据接入端口。 | 随 taosAdapter 启动参数设置变化（2.3.0.1+以上版本）。 | +| TCP | 6060 | 企业版内 Monitor 服务的网络端口。 | | +| UDP | 6030-6034 | 客户端与服务端之间通讯。 | 随 serverPort 端口变化。 | +| UDP | 6035-6039 | 多节点集群的节点间通讯。 | 随 serverPort 端口变化。 ### maxShellConns @@ -147,14 +146,13 @@ taos --dump-config | 取值范围 | 1-600 | | 缺省值 | 30 | - ### telemetryReporting | 属性 | 说明 | | -------- | ---------------------------------------- | | 适用范围 | 仅服务端适用 | | 含义 | 是否允许 TDengine 采集和上报基本使用信息 | -| 取值范围 | 0：不允许 1：允许 | +| 取值范围 | 0：不允许 1：允许 | | 缺省值 | 1 | ## 查询相关 @@ -166,27 +164,27 @@ taos --dump-config | 适用范围 | 仅服务端适用 | | 含义 | 为所有并发查询占用保留的内存大小。 | | 单位 | MB | -| 缺省值 | 无 | +| 缺省值 | 无 | | 补充说明 | 计算规则可以根据实际应用可能的最大并发数和表的数字相乘，再乘 170 。
（2.0.15 以前的版本中，此参数的单位是字节） | ### ratioOfQueryCores | 属性 | 说明 | -| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | +| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | 适用范围 | 仅服务端适用 | | 含义 | 设置查询线程的最大数量。 | -| 缺省值 | 1 | -| 补充说明 | 最小值 0 表示只有 1 个查询线程
最大值 2 表示最大建立 2 倍 CPU 核数的查询线程。
默认为 1，表示最大和 CPU 核数相等的查询线程。
该值可以为小数，即 0.5 表示最大建立 CPU 核数一半的查询线程。 | +| 缺省值 | 1 | +| 补充说明 | 最小值 0 表示只有 1 个查询线程
最大值 2 表示最大建立 2 倍 CPU 核数的查询线程。
默认为 1，表示最大和 CPU 核数相等的查询线程。
该值可以为小数，即 0.5 表示最大建立 CPU 核数一半的查询线程。 | ### maxNumOfDistinctRes | 属性 | 说明 | -| -------- | -------------------------------- | +| -------- | -------------------------------- | --- | | 适用范围 | 仅服务端适用 | | 含义 | 允许返回的 distinct 结果最大行数 | | 取值范围 | 默认值为 10 万，最大值 1 亿 | | 缺省值 | 10 万 | -| 补充说明 | 2.3 版本新增。 | | +| 补充说明 | 2.3 版本新增。 | | ## 区域相关 @@ -201,35 +199,35 @@ taos --dump-config :::info 为应对多时区的数据写入和查询问题，TDengine 采用 Unix 时间戳(Unix Timestamp)来记录和存储时间戳。Unix 时间戳的特点决定了任一时刻不论在任何时区，产生的时间戳均一致。需要注意的是，Unix 时间戳是在客户端完成转换和记录。为了确保客户端其他形式的时间转换为正确的 Unix 时间戳，需要设置正确的时区。 - 在 Linux 系统中，客户端会自动读取系统设置的时区信息。用户也可以采用多种方式在配置文件设置时区。例如： +在 Linux 系统中，客户端会自动读取系统设置的时区信息。用户也可以采用多种方式在配置文件设置时区。例如： - ``` - timezone UTC-8 - timezone GMT-8 - timezone Asia/Shanghai - ``` +``` +timezone UTC-8 +timezone GMT-8 +timezone Asia/Shanghai +``` - 均是合法的设置东八区时区的格式。但需注意，Windows 下并不支持 `timezone Asia/Shanghai` 这样的写法，而必须写成 `timezone UTC-8`。 +均是合法的设置东八区时区的格式。但需注意，Windows 下并不支持 `timezone Asia/Shanghai` 这样的写法，而必须写成 `timezone UTC-8`。 - 时区的设置对于查询和写入 SQL 语句中非 Unix 时间戳的内容（时间戳字符串、关键词 now 的解析）产生影响。例如： +时区的设置对于查询和写入 SQL 语句中非 Unix 时间戳的内容（时间戳字符串、关键词 now 的解析）产生影响。例如： - ```sql - SELECT count(*) FROM table_name WHERE TS<'2019-04-11 12:01:08'; - ``` +```sql +SELECT count(*) FROM table_name WHERE TS<'2019-04-11 12:01:08'; +``` - 在东八区，SQL 语句等效于 +在东八区，SQL 语句等效于 - ```sql - SELECT count(*) FROM table_name WHERE TS<1554955268000; - ``` +```sql +SELECT count(*) FROM table_name WHERE TS<1554955268000; +``` - 在 UTC 时区，SQL 语句等效于 +在 UTC 时区，SQL 语句等效于 - ```sql - SELECT count(*) FROM table_name WHERE TS<1554984068000; - ``` +```sql +SELECT count(*) FROM table_name WHERE TS<1554984068000; +``` - 为了避免使用字符串时间格式带来的不确定性，也可以直接使用 Unix 时间戳。此外，还可以在 SQL 语句中使用带有时区的时间戳字符串，例如：RFC3339 格式的时间戳字符串，2013-04-12T15:52:01.123+08:00 或者 ISO-8601 格式时间戳字符串 2013-04-12T15:52:01.123+0800。上述两个字符串转化为 Unix 时间戳不受系统所在时区的影响。 +为了避免使用字符串时间格式带来的不确定性，也可以直接使用 Unix 时间戳。此外，还可以在 SQL 语句中使用带有时区的时间戳字符串，例如：RFC3339 格式的时间戳字符串，2013-04-12T15:52:01.123+08:00 或者 ISO-8601 格式时间戳字符串 2013-04-12T15:52:01.123+0800。上述两个字符串转化为 Unix 时间戳不受系统所在时区的影响。 ::: @@ -242,11 +240,11 @@ taos --dump-config | 缺省值 | 系统中动态获取，如果自动获取失败，需要用户在配置文件设置或通过 API 设置 | :::info - TDengine 为存储中文、日文、韩文等非 ASCII 编码的宽字符，提供一种专门的字段类型 nchar。写入 nchar 字段的数据将统一采用 UCS4-LE 格式进行编码并发送到服务器。需要注意的是，编码正确性是客户端来保证。因此，如果用户想要正常使用 nchar 字段来存储诸如中文、日文、韩文等非 ASCII 字符，需要正确设置客户端的编码格式。 +TDengine 为存储中文、日文、韩文等非 ASCII 编码的宽字符，提供一种专门的字段类型 nchar。写入 nchar 字段的数据将统一采用 UCS4-LE 格式进行编码并发送到服务器。需要注意的是，编码正确性是客户端来保证。因此，如果用户想要正常使用 nchar 字段来存储诸如中文、日文、韩文等非 ASCII 字符，需要正确设置客户端的编码格式。 - 客户端的输入的字符均采用操作系统当前默认的编码格式，在 Linux 系统上多为 UTF-8，部分中文系统编码则可能是 GB18030 或 GBK 等。在 docker 环境中默认的编码是 POSIX。在中文版 Windows 系统中，编码则是 CP936。客户端需要确保正确设置自己所使用的字符集，即客户端运行的操作系统当前编码字符集，才能保证 nchar 中的数据正确转换为 UCS4-LE 编码格式。 +客户端的输入的字符均采用操作系统当前默认的编码格式，在 Linux 系统上多为 UTF-8，部分中文系统编码则可能是 GB18030 或 GBK 等。在 docker 环境中默认的编码是 POSIX。在中文版 Windows 系统中，编码则是 CP936。客户端需要确保正确设置自己所使用的字符集，即客户端运行的操作系统当前编码字符集，才能保证 nchar 中的数据正确转换为 UCS4-LE 编码格式。 - 在 Linux 中 locale 的命名规则为: <语言>\_<地区>.<字符集编码> 如：zh_CN.UTF-8，zh 代表中文，CN 代表大陆地区，UTF-8 表示字符集。字符集编码为客户端正确解析本地字符串提供编码转换的说明。Linux 系统与 Mac OSX 系统可以通过设置 locale 来确定系统的字符编码，由于 Windows 使用的 locale 中不是 POSIX 标准的 locale 格式，因此在 Windows 下需要采用另一个配置参数 charset 来指定字符编码。在 Linux 系统中也可以使用 charset 来指定字符编码。 +在 Linux 中 locale 的命名规则为: <语言>\_<地区>.<字符集编码> 如：zh_CN.UTF-8，zh 代表中文，CN 代表大陆地区，UTF-8 表示字符集。字符集编码为客户端正确解析本地字符串提供编码转换的说明。Linux 系统与 Mac OSX 系统可以通过设置 locale 来确定系统的字符编码，由于 Windows 使用的 locale 中不是 POSIX 标准的 locale 格式，因此在 Windows 下需要采用另一个配置参数 charset 来指定字符编码。在 Linux 系统中也可以使用 charset 来指定字符编码。 ::: @@ -261,35 +259,35 @@ taos --dump-config :::info 如果配置文件中不设置 charset，在 Linux 系统中，taos 在启动时候，自动读取系统当前的 locale 信息，并从 locale 信息中解析提取 charset 编码格式。如果自动读取 locale 信息失败，则尝试读取 charset 配置，如果读取 charset 配置也失败，则中断启动过程。 - 在 Linux 系统中，locale 信息包含了字符编码信息，因此正确设置了 Linux 系统 locale 以后可以不用再单独设置 charset。例如： +在 Linux 系统中，locale 信息包含了字符编码信息，因此正确设置了 Linux 系统 locale 以后可以不用再单独设置 charset。例如： - ``` - locale zh_CN.UTF-8 - ``` +``` +locale zh_CN.UTF-8 +``` - 在 Windows 系统中，无法从 locale 获取系统当前编码。如果无法从配置文件中读取字符串编码信息，taos 默认设置为字符编码为 CP936。其等效在配置文件中添加如下配置： +在 Windows 系统中，无法从 locale 获取系统当前编码。如果无法从配置文件中读取字符串编码信息，taos 默认设置为字符编码为 CP936。其等效在配置文件中添加如下配置： - ``` - charset CP936 - ``` +``` +charset CP936 +``` - 如果需要调整字符编码，请查阅当前操作系统使用的编码，并在配置文件中正确设置。 +如果需要调整字符编码，请查阅当前操作系统使用的编码，并在配置文件中正确设置。 - 在 Linux 系统中，如果用户同时设置了 locale 和字符集编码 charset，并且 locale 和 charset 的不一致，后设置的值将覆盖前面设置的值。 +在 Linux 系统中，如果用户同时设置了 locale 和字符集编码 charset，并且 locale 和 charset 的不一致，后设置的值将覆盖前面设置的值。 - ``` - locale zh_CN.UTF-8 - charset GBK - ``` +``` +locale zh_CN.UTF-8 +charset GBK +``` - 则 charset 的有效值是 GBK。 +则 charset 的有效值是 GBK。 - ``` - charset GBK - locale zh_CN.UTF-8 - ``` +``` +charset GBK +locale zh_CN.UTF-8 +``` - charset 的有效值是 UTF-8。 +charset 的有效值是 UTF-8。 ::: @@ -391,7 +389,7 @@ taos --dump-config | 含义 | 是否在内存中缓存子表的最近数据 | | 取值范围 | 0：关闭
1：缓存子表最近一行数据
2：缓存子表每一列的最近的非 NULL 值
3：同时打开缓存最近行和列功能。（2.1.2.0 版本开始此参数支持 0 ～ 3 的取值范围，在此之前取值只能是 [0, 1]） | | 缺省值 | 0 | -| 补充说明 | 2.1.2.0 版本之前、2.0.20.7 版本之前在 taos.cfg 文件中不支持此参数。 +| 补充说明 | 2.1.2.0 版本之前、2.0.20.7 版本之前在 taos.cfg 文件中不支持此参数。 | ### minimalTmpDirGB @@ -400,7 +398,7 @@ taos --dump-config | 适用范围 | 服务端和客户端均适用 | | 含义 | 当日志文件夹的磁盘大小小于该值时，停止写临时文件 | | 单位 | GB | -| 缺省值 | 1.0 | +| 缺省值 | 1.0 | ### minimalDataDirGB @@ -456,6 +454,7 @@ taos --dump-config | 含义 | dnode 的可选角色 | | 取值范围 | 0：any（既可作为 mnode，也可分配 vnode）
1：mgmt（只能作为 mnode，不能分配 vnode）
2：dnode（不能作为 mnode，只能分配 vnode） | | 缺省值 | 0 | + ### balance | 属性 | 说明 | @@ -477,14 +476,23 @@ taos --dump-config ### arbitrator -| 属性 | 说明 | -| -------- | ------------------------ | -| 适用范围 | 仅服务端适用 | -| 含义 | 系统中裁决器的 end point，其格式如firstEp | -| 缺省值 | 空 | +| 属性 | 说明 | +| -------- | ------------------------------------------ | +| 适用范围 | 仅服务端适用 | +| 含义 | 系统中裁决器的 end point，其格式如 firstEp | +| 缺省值 | 空 | ## 时间相关 +### precision + +| 属性 | 说明 | +| -------- | ------------------------------------------------- | +| 适用范围 | 仅服务端 | +| 含义 | 创建数据库时使用的时间精度 | +| 取值范围 | ms: millisecond; us: microsecond ; ns: nanosecond | +| 缺省值 | ms | + ### rpcTimer | 属性 | 说明 | @@ -555,7 +563,6 @@ taos --dump-config | 取值范围 | 5-7200000 | | 缺省值 | 86400\*10（10 天） | - ## 性能调优 ### numOfThreadsPerCore @@ -603,11 +610,11 @@ taos --dump-config ### tableIncStepPerVnode -| 属性 | 说明 | -| -------- | ----------------------------------- | -| 适用范围 | 仅服务端适用 | +| 属性 | 说明 | +| -------- | ------------------------------------------------------------- | +| 适用范围 | 仅服务端适用 | | 含义 | 每个 vnode 中超过最小表数，i.e. minTablesPerVnode, 后递增步长 | -| 缺省值 | 1000 | +| 缺省值 | 1000 | ### maxNumOfOrderedRes @@ -617,14 +624,13 @@ taos --dump-config | 含义 | 支持超级表时间排序允许的最多记录数限制 | | 缺省值 | 10 万 | - ### mnodeEqualVnodeNum -| 属性 | 说明 | -| -------- | ---------------------------------- | -| 适用范围 | 仅服务端适用 | +| 属性 | 说明 | +| -------- | ------------------------------------ | +| 适用范围 | 仅服务端适用 | | 含义 | 将一个 mnode 等同于 vnode 消耗的个数 | -| 缺省值 | 4 | +| 缺省值 | 4 | ### numOfCommitThreads @@ -681,7 +687,7 @@ taos --dump-config | 适用范围 | 服务器端 | | 含义 | 配置要进行有损压缩的浮点数据类型 | | 取值范围 | 空字符串：关闭有损压缩
float：只对 float 类型进行有损压缩
double：只对 double 类型进行有损压缩
float \| double：float double 都进行有损压缩 | -| 缺省值 | 空字符串 | +| 缺省值 | 空字符串 | | 补充说明 | 有损压缩默认为关闭状态，只有配置后才生效 | ### fPrecision @@ -738,13 +744,13 @@ taos --dump-config ### maxStreamCompDelay -| 属性 | 说明 | -| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| 适用范围 | 仅服务端适用 | -| 含义 | 连续查询启动最大延迟 | -| 单位 | 毫秒 | -| 取值范围 | 10-1000000000 | -| 缺省值 | 20000 | +| 属性 | 说明 | +| -------- | -------------------- | +| 适用范围 | 仅服务端适用 | +| 含义 | 连续查询启动最大延迟 | +| 单位 | 毫秒 | +| 取值范围 | 10-1000000000 | +| 缺省值 | 20000 | ### maxFirstStreamCompDelay @@ -768,12 +774,12 @@ taos --dump-config ### streamCompDelayRatio -| 属性 | 说明 | -| -------- | -------------------------- | -| 适用范围 | 仅服务端适用 | +| 属性 | 说明 | +| -------- | ---------------------------------------------------------------- | +| 适用范围 | 仅服务端适用 | | 含义 | 连续查询的延迟时间计算系数，实际延迟时间为本参数乘以计算时间窗口 | -| 取值范围 | 0.1-0.9 | -| 缺省值 | 0.1 | +| 取值范围 | 0.1-0.9 | +| 缺省值 | 0.1 | :::info 为避免多个 stream 同时执行占用太多系统资源，程序中对 stream 的执行时间人为增加了一些随机的延时。
maxFirstStreamCompDelay 是 stream 第一次执行前最少要等待的时间。
streamCompDelayRatio 是延迟时间的计算系数，它乘以查询的 interval 后为延迟时间基准。
maxStreamCompDelay 是延迟时间基准的上限。
实际延迟时间为一个不超过延迟时间基准的随机值。
stream 某次计算失败后需要重试，retryStreamCompDelay 是重试的等待时间基准。
实际重试等待时间为不超过等待时间基准的随机值。 @@ -783,8 +789,8 @@ taos --dump-config ## HTTP 相关 :::note -HTTP服务在2.4.0.0（不含）以前的版本中由taosd提供，在2.4.0.0以后（含）由taosAdapter提供。 -本节的配置参数仅在2.4.0.0（不含）以前的版本中生效。如果您使用的是2.4.0.0（含）及以后的版本请参考[文档](/reference/taosadapter/)。 +HTTP 服务在 2.4.0.0（不含）以前的版本中由 taosd 提供，在 2.4.0.0 以后（含）由 taosAdapter 提供。 +本节的配置参数仅在 2.4.0.0（不含）以前的版本中生效。如果您使用的是 2.4.0.0（含）及以后的版本请参考[文档](/reference/taosadapter/)。 ::: @@ -799,29 +805,29 @@ HTTP服务在2.4.0.0（不含）以前的版本中由taosd提供，在2.4.0.0以 ### httpEnableRecordSql -| 属性 | 说明 | -| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -| 适用范围 | 仅服务端适用 | -| 含义 | 记录通过 RESTFul 接口，产生的 SQL 调用。 | -| 缺省值 | 0 | -| 补充说明 | 生成的文件（httpnote.0/httpnote.1），与服务端日志所在目录相同。 | +| 属性 | 说明 | +| -------- | --------------------------------------------------------------- | +| 适用范围 | 仅服务端适用 | +| 含义 | 记录通过 RESTFul 接口，产生的 SQL 调用。 | +| 缺省值 | 0 | +| 补充说明 | 生成的文件（httpnote.0/httpnote.1），与服务端日志所在目录相同。 | ### httpMaxThreads -| 属性 | 说明 | -| -------- | --------------------------------------------------------------------------------------------------------------------------- | -| 适用范围 | 仅服务端适用 | +| 属性 | 说明 | +| -------- | ------------------------------------------------------------------------------------------- | +| 适用范围 | 仅服务端适用 | | 含义 | RESTFul 接口的线程数。taosAdapter 配置或有不同，请参考相应[文档](/reference/taosadapter/)。 | -| 缺省值 | 2 | +| 缺省值 | 2 | ### restfulRowLimit -| 属性 | 说明 | -| -------- | ------------------------------------------------------------------------------------------------------------------------------------- | -| 适用范围 | 仅服务端适用 | +| 属性 | 说明 | +| -------- | ----------------------------------------------------------------------------------------------------- | +| 适用范围 | 仅服务端适用 | | 含义 | RESTFul 接口单次返回的记录条数。taosAdapter 配置或有不同，请参考相应[文档](/reference/taosadapter/)。 | -| 缺省值 | 10240 | -| 补充说明 | 最大 10,000,000 | +| 缺省值 | 10240 | +| 补充说明 | 最大 10,000,000 | ### httpDBNameMandatory @@ -850,8 +856,7 @@ HTTP服务在2.4.0.0（不含）以前的版本中由taosd提供，在2.4.0.0以 | 适用范围 | 服务端和客户端均适用 | | 含义 | 当日志文件夹的磁盘大小小于该值时，停止写日志 | | 单位 | GB | -| 缺省值 | 1.0 | - +| 缺省值 | 1.0 | ### numOfLogLines @@ -1074,11 +1079,11 @@ HTTP服务在2.4.0.0（不含）以前的版本中由taosd提供，在2.4.0.0以 ### maxBinaryDisplayWidth -| 属性 | 说明 | -| -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| 含义 | Taos shell 中 binary 和 nchar 字段的显示宽度上限，超过此限制的部分将被隐藏 | -| 取值范围 | 5 - | -| 缺省值 | 30 | +| 属性 | 说明 | +| -------- | -------------------------------------------------------------------------- | +| 含义 | Taos shell 中 binary 和 nchar 字段的显示宽度上限，超过此限制的部分将被隐藏 | +| 取值范围 | 5 - | +| 缺省值 | 30 | :::info 实际上限按以下规则计算：如果字段值的长度大于 maxBinaryDisplayWidth，则显示上限为 **字段名长度** 和 **maxBinaryDisplayWidth** 的较大者。
否则，上限为 **字段名长度** 和 **字段值长度** 的较大者。
可在 shell 中通过命令 set max_binary_display_width nn 动态修改此选项 diff --git a/docs-en/04-develop/01-connect/index.md b/docs-en/04-develop/01-connect/index.md index 49cff672dd..e319969ad4 100644 --- a/docs-en/04-develop/01-connect/index.md +++ b/docs-en/04-develop/01-connect/index.md @@ -1,5 +1,5 @@ --- -sidebar_label: Connect +sidebar_label: Connection title: Connect to TDengine description: "This document explains how to establish connection to TDengine, and briefly introduce how to install and use TDengine connectors." --- diff --git a/docs-en/04-develop/02-model/index.mdx b/docs-en/04-develop/02-model/index.mdx index c36e5f3e13..5ff92eddb1 100644 --- a/docs-en/04-develop/02-model/index.mdx +++ b/docs-en/04-develop/02-model/index.mdx @@ -1,5 +1,4 @@ --- -sidebar_label: Data Model slug: /model title: Data Model --- diff --git a/docs-en/04-develop/03-insert-data/_category_.yml b/docs-en/04-develop/03-insert-data/_category_.yml index 8f42ee1a41..27bb1fe6d5 100644 --- a/docs-en/04-develop/03-insert-data/_category_.yml +++ b/docs-en/04-develop/03-insert-data/_category_.yml @@ -1,4 +1,4 @@ -label: Insert +label: Insert Data link: type: generated-index slug: /insert-data/ diff --git a/docs-en/04-develop/04-query-data/_category_.yml b/docs-en/04-develop/04-query-data/_category_.yml index 5507791d15..5912a48fc3 100644 --- a/docs-en/04-develop/04-query-data/_category_.yml +++ b/docs-en/04-develop/04-query-data/_category_.yml @@ -1 +1 @@ -label: Select +label: Select Data diff --git a/docs-en/12-taos-sql/02-database.md b/docs-en/12-taos-sql/02-database.md index 21cef3380c..c9d2ba8713 100644 --- a/docs-en/12-taos-sql/02-database.md +++ b/docs-en/12-taos-sql/02-database.md @@ -19,8 +19,24 @@ CREATE DATABASE [IF NOT EXISTS] db_name [KEEP keep] [DAYS days] [UPDATE 1]; 3. UPDATE set to 2 means updating a part of columns for a row is allowed, the columns for which no value is specified will be kept as no change 3. The maximum length of database name is 33 bytes. 4. The maximum length of a SQL statement is 65,480 bytes. -5. For more parameters that can be used when creating a database, like cache, blocks, days, keep, minRows, maxRows, wal, fsync, update, cacheLast, replica, quorum, maxVgroupsPerDb, ctime, comp, prec, Please refer to [Configuration Parameters](/reference/config/). - +5. Below are the parameters that can be used when creating a database + - cache: [Description](/reference/config/#cache) + - blocks: [Description](/reference/config/#blocks) + - days: [Description](/reference/config/#days) + - keep: [Description](/reference/config/#keep) + - minRows: [Description](/reference/config/#minrows) + - maxRows: [Description](/reference/config/#maxrows) + - wal: [Description](/reference/config/#wallevel) + - fsync: [Description](/reference/config/#fsync) + - update: [Description](/reference/config/#update) + - cacheLast: [Description](/reference/config/#cachelast) + - replica: [Description](/reference/config/#replica) + - quorum: [Description](/reference/config/#quorum) + - maxVgroupsPerDb: [Description](/reference/config/#maxvgroupsperdb) + - comp: [Description](/reference/config/#comp) + - precision: [Description](reference/config/#precision) +6. Please be noted that all of the parameters mentioned in this section can be configured in configuration file `taosd.cfg` at server side and used by default, can be override if they are specifically in `create database` statement. + ::: ## Show Current Configuration diff --git a/docs-en/12-taos-sql/05-insert.md b/docs-en/12-taos-sql/05-insert.md index 11283f6e85..47900a44fd 100644 --- a/docs-en/12-taos-sql/05-insert.md +++ b/docs-en/12-taos-sql/05-insert.md @@ -1,5 +1,4 @@ --- -sidebar_label: Insert title: Insert --- diff --git a/docs-en/12-taos-sql/06-select.md b/docs-en/12-taos-sql/06-select.md index f28c8dc2e6..22c2ee5e28 100644 --- a/docs-en/12-taos-sql/06-select.md +++ b/docs-en/12-taos-sql/06-select.md @@ -1,5 +1,4 @@ --- -sidebar_label: Select title: Select --- diff --git a/docs-en/12-taos-sql/07-function.md b/docs-en/12-taos-sql/07-function.md index 1badb5915e..44389f35a2 100644 --- a/docs-en/12-taos-sql/07-function.md +++ b/docs-en/12-taos-sql/07-function.md @@ -1,5 +1,4 @@ --- -sidebar_label: Functions title: Functions --- diff --git a/docs-en/12-taos-sql/08-interval.md b/docs-en/12-taos-sql/08-interval.md index 7bf2bd207e..7c365fc9a6 100644 --- a/docs-en/12-taos-sql/08-interval.md +++ b/docs-en/12-taos-sql/08-interval.md @@ -1,6 +1,6 @@ --- -sidebar_label: Window -title: Aggregate by Window +sidebar_label: Interval +title: Aggregate by Time Window --- Aggregate by time window is supported in TDengine. For example, each temperature sensor reports the temperature every second, the average temperature every 10 minutes can be retrieved by query with time window. diff --git a/docs-en/12-taos-sql/09-limit.md b/docs-en/12-taos-sql/09-limit.md index d695f9d999..873e484fbb 100644 --- a/docs-en/12-taos-sql/09-limit.md +++ b/docs-en/12-taos-sql/09-limit.md @@ -1,6 +1,5 @@ --- -sidebar_label: Limits -title: Limits and Restrictions +title: Limits & Restrictions --- ## Naming Rules diff --git a/docs-en/12-taos-sql/10-json.md b/docs-en/12-taos-sql/10-json.md index bd9606a84e..60468f1e0f 100644 --- a/docs-en/12-taos-sql/10-json.md +++ b/docs-en/12-taos-sql/10-json.md @@ -1,5 +1,4 @@ --- -sidebar_label: JSON title: JSON Type --- diff --git a/docs-en/12-taos-sql/11-escape.md b/docs-en/12-taos-sql/11-escape.md index 1b09a0416d..34ce9f7848 100644 --- a/docs-en/12-taos-sql/11-escape.md +++ b/docs-en/12-taos-sql/11-escape.md @@ -1,9 +1,8 @@ --- -sidebar-label: Escape -title: Escape +title: Escape Characters --- -## Escape Characters +Below table is the list of escape characters used in TDengine. | Escape Character | **Actual Meaning** | | :--------------: | ------------------------ | diff --git a/docs-en/12-taos-sql/12-keywords.md b/docs-en/12-taos-sql/12-keywords.md index b124024feb..fa750300b7 100644 --- a/docs-en/12-taos-sql/12-keywords.md +++ b/docs-en/12-taos-sql/12-keywords.md @@ -1,10 +1,7 @@ --- -sidebar_label: Keywords -title: Reserved Keywords +title: Keywords --- -## Reserved Keywords - There are about 200 keywords reserved by TDengine, they can't be used as the name of database, STable or table with either upper case, lower case or mixed case. **Keywords List** diff --git a/docs-en/13-operation/03-tolerance.md b/docs-en/13-operation/03-tolerance.md index fa731f2ee6..367474cddb 100644 --- a/docs-en/13-operation/03-tolerance.md +++ b/docs-en/13-operation/03-tolerance.md @@ -1,6 +1,6 @@ --- -sidebar_label: Tolerance -title: Fault Tolerance and Disaster Recovery +sidebar_label: Fault Tolerance +title: Fault Tolerance & Disaster Recovery --- ## Fault Tolerance diff --git a/docs-en/13-operation/07-import.md b/docs-en/13-operation/07-import.md index 1577c17cc5..d3f82c84bc 100644 --- a/docs-en/13-operation/07-import.md +++ b/docs-en/13-operation/07-import.md @@ -1,5 +1,4 @@ --- -sidebar_label: Import title: Import Data --- diff --git a/docs-en/13-operation/08-export.md b/docs-en/13-operation/08-export.md index 0e84ee0d25..dd8c4b8edd 100644 --- a/docs-en/13-operation/08-export.md +++ b/docs-en/13-operation/08-export.md @@ -1,5 +1,4 @@ --- -sidebar_label: Export title: Export Data --- diff --git a/docs-en/13-operation/10-monitor.md b/docs-en/13-operation/10-monitor.md index 738086ebe2..26f5aaed27 100644 --- a/docs-en/13-operation/10-monitor.md +++ b/docs-en/13-operation/10-monitor.md @@ -1,5 +1,4 @@ --- -sidebar_label: Monitor title: Monitor TDengine --- diff --git a/docs-en/13-operation/11-optimize.md b/docs-en/13-operation/11-optimize.md index a3c5df633b..ab80f04522 100644 --- a/docs-en/13-operation/11-optimize.md +++ b/docs-en/13-operation/11-optimize.md @@ -1,5 +1,4 @@ --- -sidebar_label: Optimize title: Optimize Performance --- diff --git a/docs-en/13-operation/17-diagnose.md b/docs-en/13-operation/17-diagnose.md index bbf6b55bf5..7382c5d232 100644 --- a/docs-en/13-operation/17-diagnose.md +++ b/docs-en/13-operation/17-diagnose.md @@ -1,9 +1,8 @@ --- -sidebar_label: Diagnose title: Diagnose Problems --- -## Diagnose Network Connection +## Network Connection Diagnostics When the client is unable to access the server, the network connection between the client side and the server side needs to be checked to find out the root cause and resolve problems. diff --git a/docs-en/14-reference/12-config/index.md b/docs-en/14-reference/12-config/index.md index cf7e5c5028..108863ac58 100644 --- a/docs-en/14-reference/12-config/index.md +++ b/docs-en/14-reference/12-config/index.md @@ -475,6 +475,15 @@ charset CP936 ## Time Parameters +### precision + +| Attribute | Description | +| ------------- | ------------------------------------------------- | +| Applicable | Server only | +| Meaning | Time precision used for each database | +| Value Range | ms: millisecond; us: microsecond ; ns: nanosecond | +| Default Value | ms | + ### rpcTimer | Attribute | Description | -- GitLab