From c87e04c1b109e988207e2b75c4a4fe53619a2a97 Mon Sep 17 00:00:00 2001 From: xiao-77 Date: Wed, 5 Feb 2025 10:41:32 +0800 Subject: [PATCH] docs:update taosc's query config --- .../zh/14-reference/01-components/02-taosc.md | 132 +++++++++++++++--- 1 file changed, 114 insertions(+), 18 deletions(-) diff --git a/docs/zh/14-reference/01-components/02-taosc.md b/docs/zh/14-reference/01-components/02-taosc.md index 314903666b..aedb863d8e 100755 --- a/docs/zh/14-reference/01-components/02-taosc.md +++ b/docs/zh/14-reference/01-components/02-taosc.md @@ -106,24 +106,120 @@ TDengine 客户端驱动提供了应用编程所需要的全部 API，并且在 - 支持版本：从 v3.3.4.0 版本开始引入 ### 查询相关 -|参数名称|支持版本|动态修改|参数含义| -|----------------------|----------|-------------------------|-------------| -|countAlwaysReturnValue | |支持动态修改 立即生效 |count/hyperloglog 函数在输入数据为空或者 NULL 的情况下是否返回值；0：返回空行，1：返回；默认值 1；该参数设置为 1 时，如果查询中含有 INTERVAL 子句或者该查询使用了 TSMA 时，且相应的组或窗口内数据为空或者 NULL，对应的组或窗口将不返回查询结果；注意此参数客户端和服务端值应保持一致| -|keepColumnName | |支持动态修改 立即生效 |Last、First、LastRow 函数查询且未指定别名时，自动设置别名为列名（不含函数名），因此 order by 子句如果引用了该列名将自动引用该列对应的函数；1：表示自动设置别名为列名(不包含函数名)，0：表示不自动设置别名；缺省值：0| -|multiResultFunctionStarReturnTags|3.3.3.0 后|支持动态修改 立即生效 |查询超级表时，last(\*)/last_row(\*)/first(\*) 是否返回标签列；查询普通表、子表时，不受该参数影响；0：不返回标签列，1：返回标签列；缺省值：0；该参数设置为 0 时，last(\*)/last_row(\*)/first(\*) 只返回超级表的普通列；为 1 时，返回超级表的普通列和标签列| -|metaCacheMaxSize | |支持动态修改 立即生效 |指定单个客户端元数据缓存大小的最大值，单位 MB；缺省值 -1，表示无限制| -|maxTsmaCalcDelay | |支持动态修改 立即生效 |查询时客户端可允许的 tsma 计算延迟，若 tsma 的计算延迟大于配置值，则该 TSMA 将不会被使用；取值范围 600s - 86400s，即 10 分钟 - 1 小时；缺省值：600 秒| -|tsmaDataDeleteMark | |支持动态修改 立即生效 |TSMA 计算的历史数据中间结果保存时间，单位为毫秒；取值范围 >= 3600000，即大于等于1h；缺省值：86400000，即 1d | -|queryPolicy | |支持动态修改 立即生效 |查询语句的执行策略，1：只使用 vnode，不使用 qnode；2：没有扫描算子的子任务在 qnode 执行，带扫描算子的子任务在 vnode 执行；3：vnode 只运行扫描算子，其余算子均在 qnode 执行；缺省值：1| -|queryTableNotExistAsEmpty | |支持动态修改 立即生效 |查询表不存在时是否返回空结果集；false：返回错误；true：返回空结果集；缺省值 false| -|querySmaOptimize | |支持动态修改 立即生效 |sma index 的优化策略，0：表示不使用 sma index，永远从原始数据进行查询；1：表示使用 sma index，对符合的语句，直接从预计算的结果进行查询；缺省值：0| -|queryPlannerTrace | |支持动态修改 立即生效 |内部参数，查询计划是否输出详细日志| -|queryNodeChunkSize | |支持动态修改 立即生效 |内部参数，查询计划的块大小| -|queryUseNodeAllocator | |支持动态修改 立即生效 |内部参数，查询计划的分配方法| -|queryMaxConcurrentTables | |不支持动态修改 |内部参数，查询计划的并发数目| -|enableQueryHb | |支持动态修改 立即生效 |内部参数，是否发送查询心跳消息| -|minSlidingTime | |支持动态修改 立即生效 |内部参数，sliding 的最小允许值| -|minIntervalTime | |支持动态修改 立即生效 |内部参数，interval 的最小允许值| + +#### countAlwaysReturnValue +- 说明：count/hyperloglog 函数在输入数据为空或者 NULL 的情况下是否返回值；该参数设置为 1 时，如果查询中含有 INTERVAL 子句或者该查询使用了 TSMA 时，且相应的组或窗口内数据为空或者 NULL，对应的组或窗口将不返回查询结果；注意此参数客户端和服务端值应保持一致 +- 类型：整数；0：返回空行，1：返回 +- 最小值：0 +- 最大值：1 +- 默认值：1 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### keepColumnName +- 说明：Last、First、LastRow 函数查询且未指定别名时，自动设置别名为列名（不含函数名），因此 order by 子句如果引用了该列名将自动引用该列对应的函数 +- 类型：整数；1：表示自动设置别名为列名(不包含函数名)，0：表示不自动设置别名 +- 最小值：0 +- 最大值：1 +- 默认值：0 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### multiResultFunctionStarReturnTags +- 说明：查询超级表时，last(\*)/last_row(\*)/first(\*) 是否返回标签列；查询普通表、子表时，不受该参数影响； +- 类型：整数；0：不返回标签列，1：返回标签列；该参数设置为 0 时，last(\*)/last_row(\*)/first(\*) 只返回超级表的普通列；为 1 时，返回超级表的普通列和标签列 +- 最小值：0 +- 最大值：1 +- 默认值：0 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.3.3.0 版本开始引入 + +#### metaCacheMaxSize +- 说明：指定单个客户端元数据缓存大小的最大值 +- 类型：整数；0：不返回标签列，1：返回标签列；该参数设置为 0 时，last(\*)/last_row(\*)/first(\*) 只返回超级表的普通列；为 1 时，返回超级表的普通列和标签列 +- 单位：MB +- 最小值：-1 +- 最大值：2147483647 +- 默认值：-1 表示无限制 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### maxTsmaCalcDelay +- 说明：查询时客户端可允许的 tsma 计算延迟，若 tsma 的计算延迟大于配置值，则该 TSMA 将不会被使用 +- 类型：整数 +- 单位：秒 +- 最小值：600 +- 最大值：86400 +- 默认值：600 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### tsmaDataDeleteMark +- 说明：TSMA 计算的历史数据中间结果保存时间 +- 类型：整数 +- 单位：毫秒 +- 最小值：3600000 +- 最大值：9223372036854775807 +- 默认值：86400000 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### queryPolicy +- 说明：查询语句的执行策略 +- 类型：整数；1：只使用 vnode，不使用 qnode；2：没有扫描算子的子任务在 qnode 执行，带扫描算子的子任务在 vnode 执行；3：vnode 只运行扫描算子，其余算子均在 qnode 执行； +- 单位：秒 +- 默认值：1 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### queryTableNotExistAsEmpty +- 说明：查询表不存在时是否返回空结果集 +- 类型：布尔；false：返回错误；true：返回空结果集 +- 默认值：false +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### querySmaOptimize +- 说明：querSmaOptimize，永远从原始数据进行查询 +- 类型：整数 ；1：表示使用 sma index，对符合的语句，直接从预计算的结果进行查询 +- 默认值：false +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### queryPlannerTrace +- 说明：查询计划是否输出详细日志 `内部参数` +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### queryNodeChunkSize +- 说明：查询计划的块大小 `内部参数` +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### queryUseNodeAllocator +- 说明：查询计划的分配方法 `内部参数` +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### queryMaxConcurrentTables +- 说明：查询计划的并发数目 `内部参数` +- 动态修改：不支持 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### enableQueryHb +- 说明：是否发送查询心跳消息 `内部参数` +- 动态修改：不支持 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### minSlidingTime +- 说明：sliding 的最小允许值 `内部参数` +- 动态修改：不支持 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### minIntervalTime +- 说明：interval 的最小允许值 `内部参数` +- 动态修改：不支持 +- 支持版本：从 v3.0.0.0 版本开始引入 ### 写入相关 |参数名称|支持版本|动态修改|参数含义|