Merge pull request #29080 from taosdata/doc/internal

doc: minor changes
2024-12-10 15:21:55 +08:00 · 2024-12-10 15:21:55 +08:00 · f04f63c1d3
parent 4c48d05bd3 b0cf6205f3
commit f04f63c1d3
6 changed files with 47 additions and 51 deletions
--- a/docs/en/14-reference/03-taos-sql/22-meta.md
+++ b/docs/en/14-reference/03-taos-sql/22-meta.md
@ -318,7 +318,7 @@ Configuration parameters for each dnode in the system. Users with SYSINFO attrib
 Note: Users with SYSINFO property set to 0 cannot view this table.

 | #    | **Column Name** | **Data Type**  | **Description**                      |
-| ---- | :-------------: | -------------- | ------------------------------------ |
+|:-----|:----------------|:---------------|:-------------------------------------|
 | 1    |    user_name    | VARCHAR(24)    | Username                             |
 | 2    |    privilege    | VARCHAR(10)    | Permission description               |
 | 3    |     db_name     | VARCHAR(65)    | Database name                        |
@ -328,17 +328,17 @@ Note: Users with SYSINFO property set to 0 cannot view this table.

 ## INS_DISK_USAGE

-| #   |   **Column Name**    | **Data type** | **Description**|
-| --- | :----------: | ------------ | ------------------------|
-| 1   | db_name      | VARCHAR(32)       | Database name 
-| 2   | vgroup_id    | INT       | vgroup ID 
-| 3   | wal          | BIGINT    | WAL file size, in KB
-| 4   | data1        | BIGINT    | Data file size on primary storage, in KB 
-| 5   | data2        | BIGINT    | Data file size on secondary storage, in KB
-| 6   | data3        | BIGINT    | Data file size on tertiary storage, in KB 
-| 7   | cache_rdb    | BIGINT    | Size of last/last_row files, in KB
-| 8   | table_meta   | BIGINT    | Size of meta files, in KB 
-| 9   | s3           | BIGINT    | Size occupied on S3, in KB
-| 10  | raw_data     | BIGINT    | Estimated size of raw data, in KB
+| # | **Column Name** | **Data type** | **Description**|
+|:----|:-----------|:-----------|:--------------------|
+| 1   | db_name    | VARCHAR(32) | Database name                              |
+| 2   | vgroup_id  | INT         | vgroup ID                                  |
+| 3   | wal        | BIGINT      | WAL file size, in KB                       |
+| 4   | data1      | BIGINT      | Data file size on primary storage, in KB   |
+| 5   | data2      | BIGINT      | Data file size on secondary storage, in KB |
+| 6   | data3      | BIGINT      | Data file size on tertiary storage, in KB  | 
+| 7   | cache_rdb  | BIGINT      | Size of last/last_row files, in KB         |
+| 8   | table_meta | BIGINT      | Size of meta files, in KB                  | 
+| 9   | s3         | BIGINT      | Size occupied on S3, in KB                 |
+| 10  | raw_data   | BIGINT      | Estimated size of raw data, in KB          |

 note: 
--- a/docs/zh/05-basic/03-query.md
+++ b/docs/zh/05-basic/03-query.md
@ -303,13 +303,12 @@ Query OK, 5 row(s) in set (0.016812s)

 #### FILL 子句

-FILL 子句，用于指定某一窗口区间数据缺失的情况下的填充模式。填充模式包括以下几种：
 1. 不进行填充：NONE（默认填充模式）。
-2. VALUE 填充：固定值填充，此时需要指定填充的数值。例如：FILL（VALUE， 1.23）。这里需要注意，最终填充的值受由相应列的类型决定，如 FILL（VALUE， 1.23），相应列为 INT 类型，则填充值为 1。
-3. PREV 填充：使用前一个非 NULL 值填充数据。例如：FILL（PREV）。
-4. NULL 填充：使用 NULL 填充数据。例如：FILL（NULL）。
-5. LINEAR 填充：根据前后距离最近的非 NULL 值做线性插值填充。例如：FILL（LINEAR）。
-6. NEXT 填充：使用下一个非 NULL 值填充数据。例如：FILL（NEXT）。
+2. VALUE 填充：固定值填充，此时需要指定填充的数值。例如：FILL(VALUE, 1.23)。这里需要注意，最终填充的值受由相应列的类型决定，如 FILL(VALUE, 1.23)，相应列为 INT 类型，则填充值为 1, 若查询列表中有多列需要 FILL, 则需要给每一个 FILL 列指定 VALUE, 如 `SELECT _wstart, min(c1), max(c1) FROM ... FILL(VALUE, 0, 0)`, 注意, SELECT 表达式中只有包含普通列时才需要指定 FILL VALUE, 如 `_wstart`, `_wstart+1a`, `now`, `1+1` 以及使用 partition by 时的 partition key (如 tbname)都不需要指定 VALUE, 如 `timediff(last(ts), _wstart)` 则需要指定VALUE。
+3. PREV 填充：使用前一个非 NULL 值填充数据。例如：FILL(PREV)。
+4. NULL 填充：使用 NULL 填充数据。例如：FILL(NULL)。
+5. LINEAR 填充：根据前后距离最近的非 NULL 值做线性插值填充。例如：FILL(LINEAR)。
+6. NEXT 填充：使用下一个非 NULL 值填充数据。例如：FILL(NEXT)。

 以上填充模式中，除了 NONE 模式默认不填充值之外，其他模式在查询的整个时间范围内如果没有数据 FILL 子句将被忽略，即不产生填充数据，查询结果为空。这种行为在部分模式（PREV、NEXT、LINEAR）下具有合理性，因为在这些模式下没有数据意味着无法产生填充数值。

--- a/docs/zh/14-reference/03-taos-sql/02-database.md
+++ b/docs/zh/14-reference/03-taos-sql/02-database.md
@ -232,6 +232,3 @@ SHOW db_name.disk_info;

 该命令本质上等同于 `select sum(data1 + data2 + data3)/sum(raw_data), sum(data1 + data2 + data3) from information_schema.ins_disk_usage where db_name="dbname"`

-
-
-
--- a/docs/zh/14-reference/03-taos-sql/12-distinguished.md
+++ b/docs/zh/14-reference/03-taos-sql/12-distinguished.md
@ -124,7 +124,7 @@ INTERVAL 子句允许使用 AUTO 关键字来指定窗口偏移量，此时如

 ```sql
 -- 有起始时间限制，从 '2018-10-03 14:38:05' 切分时间窗口
-SELECT COUNT(*) FROM meters WHERE _rowts >= '2018-10-03 14:38:05' INTERVAL (1m， AUTO);
+SELECT COUNT(*) FROM meters WHERE _rowts >= '2018-10-03 14:38:05' INTERVAL (1m, AUTO);

 -- 无起始时间限制，不生效，仍以 0 为偏移量
 SELECT COUNT(*) FROM meters WHERE _rowts < '2018-10-03 15:00:00' INTERVAL (1m, AUTO);
--- a/docs/zh/14-reference/03-taos-sql/22-meta.md
+++ b/docs/zh/14-reference/03-taos-sql/22-meta.md
@ -303,24 +303,24 @@ TDengine 内置了一个名为 `INFORMATION_SCHEMA` 的数据库，提供对数

 ## INS_STREAMS

-| #   |   **列名**   | **数据类型** | **说明**                                                                                                             |
-| --- | :----------: | ------------ | -------------------------------------------------------------------------------------------------------------------- |
-| 1   | stream_name  | VARCHAR(64)   | 流计算名称                                                                                                           |
-| 2   | create_time  | TIMESTAMP    | 创建时间                                                                                                             |
-| 3   |     sql      | VARCHAR(1024) | 创建流计算时提供的 SQL 语句                                                                                          |
-| 4   |    status    | VARCHAR(20)   | 流当前状态                                                                                                           |
-| 5   |  source_db   | VARCHAR(64)   | 源数据库                                                                                                             |
-| 6   |  target_db   | VARCHAR(64)   | 目的数据库                                                                                                           |
-| 7   | target_table | VARCHAR(192)  | 流计算写入的目标表                                                                                                   |
-| 8   |  watermark   | BIGINT       | watermark，详见 SQL 手册流式计算。需要注意，`watermark` 为 TDengine 关键字，作为列名使用时需要使用 ` 进行转义。      |
-| 9   |   trigger    | INT          | 计算结果推送模式，详见 SQL 手册流式计算。需要注意，`trigger` 为 TDengine 关键字，作为列名使用时需要使用 ` 进行转义。 |
+| #   |   **列名** | **数据类型** | **说明** |
+|:----|:-----------|:------------|:--------|
+| 1   | stream_name  | VARCHAR(64)   | 流计算名称                |
+| 2   | create_time  | TIMESTAMP     | 创建时间                  |
+| 3   |     sql      | VARCHAR(1024) | 创建流计算时提供的 SQL 语句 |
+| 4   |    status    | VARCHAR(20)   | 流当前状态                |
+| 5   |  source_db   | VARCHAR(64)   | 源数据库                  |
+| 6   |  target_db   | VARCHAR(64)   | 目的数据库                |
+| 7   | target_table | VARCHAR(192)  | 流计算写入的目标表         |
+| 8   |  watermark   | BIGINT        | watermark，详见 SQL 手册流式计算。需要注意，`watermark` 为 TDengine 关键字，作为列名使用时需要使用 ` 进行转义。  |
+| 9   |   trigger    | INT           | 计算结果推送模式，详见 SQL 手册流式计算。需要注意，`trigger` 为 TDengine 关键字，作为列名使用时需要使用 ` 进行转义。|

 ## INS_USER_PRIVILEGES

 注：SYSINFO 属性为 0 的用户不能查看此表。

-| #   |   **列名**    | **数据类型** | **说明**                                                                                                             |
-| --- | :----------: | ------------ | -------------------------------------------------------------------------------------------------------------------- |
+| #   |   **列名** | **数据类型** | **说明** |
+|:----|:-----------|:------------|:--------|
 | 1   | user_name    | VARCHAR(24)       | 用户名
 | 2   | privilege    | VARCHAR(10)       | 权限描述
 | 3   | db_name      | VARCHAR(65)       | 数据库名称
@ -329,17 +329,17 @@ TDengine 内置了一个名为 `INFORMATION_SCHEMA` 的数据库，提供对数

 ## INS_DISK_USAGE

-| #   |   **列名**    | **数据类型** | **说明**                                                                                                             |
-| --- | :----------: | ------------ | -------------------------------------------------------------------------------------------------------------------- |
-| 1   | db_name      | VARCHAR(32)       | 数据库名称 
-| 2   | vgroup_id    | INT       | vgroup 的 ID 
-| 3   | wal          | BIGINT    | wal 文件大小, 单位为 K
-| 4   | data1        | BIGINT    | 一级存储上数据文件的大小,单位为KB 
-| 5   | data2        | BIGINT    | 二级存储上数据文件的大小,单位为 KB
-| 6   | data3        | BIGINT    | 三级存储上数据文件的大小, 单位为KB 
-| 7   | cache_rdb    | BIGINT    | last/last_row 文件的大小,单位为KB
-| 8   | table_meta   | BIGINT    | meta 文件的大小, 单位为KB 
-| 9   | s3           | BIGINT    | s3 上占用的大小, 单位为KB
-| 10   | raw_data  | BIGINT    | 预估的原始数据的大小, 单位为KB 
+| #   |   **列名** | **数据类型** | **说明** |
+|:----|:-----------|:------------|:--------|
+| 1   | db_name    | VARCHAR(32) | 数据库名称                      |
+| 2   | vgroup_id  | INT         | vgroup 的 ID                   |
+| 3   | wal        | BIGINT      | wal 文件大小, 单位为 K           |
+| 4   | data1      | BIGINT      | 一级存储上数据文件的大小,单位为KB   |
+| 5   | data2      | BIGINT      | 二级存储上数据文件的大小,单位为 KB  |
+| 6   | data3      | BIGINT      | 三级存储上数据文件的大小, 单位为KB  |
+| 7   | cache_rdb  | BIGINT      | last/last_row 文件的大小,单位为KB |
+| 8   | table_meta | BIGINT      | meta 文件的大小, 单位为KB         |
+| 9   | s3         | BIGINT      | s3 上占用的大小, 单位为KB          |
+| 10  | raw_data   | BIGINT      | 预估的原始数据的大小, 单位为KB      | 


--- a/docs/zh/14-reference/05-connector/10-cpp.mdx
+++ b/docs/zh/14-reference/05-connector/10-cpp.mdx
@ -680,14 +680,14 @@ TDengine 客户端驱动的版本号与 TDengine 服务端的版本号是一一
  - **接口说明**：清理运行环境，应用退出前应调用。

 - `int taos_options(TSDB_OPTION option, const void * arg, ...)`
-  - **接口说明**：设置客户端选项，目前支持区域设置（`TSDB_OPTION_LOCALE`）、字符集设置（`TSDB_OPTION_CHARSET`）、时区设置（`TSDB_OPTION_TIMEZONE`）、配置文件路径设置（`TSDB_OPTION_CONFIGDIR`）。区域设置、字符集、时区默认为操作系统当前设置。
+  - **接口说明**：设置客户端选项，支持区域设置（`TSDB_OPTION_LOCALE`）、字符集设置（`TSDB_OPTION_CHARSET`）、时区设置（`TSDB_OPTION_TIMEZONE`）、配置文件路径设置（`TSDB_OPTION_CONFIGDIR`）。区域设置、字符集、时区默认为操作系统当前设置。
  - **参数说明**：
    - `option`：[入参] 设置项类型。
    - `arg`：[入参] 设置项值。
  - **返回值**：`0`：成功，`-1`：失败。

 - `int taos_options_connection(TAOS *taos, TSDB_OPTION_CONNECTION option, const void *arg, ...)`
-  - **接口说明**：设置客户端每个连接选项，目前支持字符集设置（`TSDB_OPTION_CONNECTION_CHARSET`）、时区设置（`TSDB_OPTION_CONNECTION_TIMEZONE`）、用户 IP 设置（`TSDB_OPTION_CONNECTION_USER_IP`）、用户 APP 设置（`TSDB_OPTION_CONNECTION_USER_APP`）。
+  - **接口说明**：设置客户端连接选项，目前支持字符集设置（`TSDB_OPTION_CONNECTION_CHARSET`）、时区设置（`TSDB_OPTION_CONNECTION_TIMEZONE`）、用户 IP 设置（`TSDB_OPTION_CONNECTION_USER_IP`）、用户 APP 设置（`TSDB_OPTION_CONNECTION_USER_APP`）。
  - **参数说明**：
    - `taos`:   [入参] taos_connect 返回的连接句柄。
    - `option`：[入参] 设置项类型。
@ -700,7 +700,7 @@ TDengine 客户端驱动的版本号与 TDengine 服务端的版本号是一一
    - 同样参数多次调用该接口，以后面的为准，可以作为修改的方法。
    - TSDB_OPTION_CONNECTION_CLEAR 选项用于重置所有连接选项。
    - 时区和字符集重置后，使用系统的设置，user ip 和 user app 重置后为空。
-    - 连接选项的值都是 string 类型，user app 参数值最大为 23，超过该值会被截断；其他参数非法时报错。
+    - 连接选项的值都是 string 类型，user app 参数值最大长度为 23，超过该长度会被截断；其他参数非法时报错。
    - 时区配置找不到时区文件或者不能按照规范解释时，默认为 UTC，和操作系统时区规则相同，详见 tzset 函数说明。可通过 select timezone() 查看当前连接的时区。
    - 时区和字符集只在 client 侧起作用，对于在服务端的相关行为不起作用。
    - 时区文件使用操作系统时区文件，可以自行更新操作系统时区文件。如果设置时区报错，请检查是否有时区文件或路径（mac:/var/db/timezone/zoneinfo, linux:/usr/share/zoneinfo）是否正确。
				`@ -232,6 +232,3 @@ SHOW db_name.disk_info;`

				该命令本质上等同于 `select sum(data1 + data2 + data3)/sum(raw_data), sum(data1 + data2 + data3) from information_schema.ins_disk_usage where db_name="dbname"`