From 048bd7101ec1cb7d9525ee85b183bfbacfac8aac Mon Sep 17 00:00:00 2001 From: Bo Ding Date: Fri, 29 Apr 2022 17:35:00 +0800 Subject: [PATCH] docs: add description to many pages (#12060) --- docs-cn/04-develop/_category_.yml | 6 +++++- docs-cn/12-taos-sql/01-data-type.md | 7 +++---- docs-cn/12-taos-sql/02-database.md | 1 + docs-cn/12-taos-sql/index.md | 1 + docs-cn/14-reference/05-taosbenchmark.md | 1 + docs-cn/14-reference/06-taosdump.md | 4 ++-- docs-cn/14-reference/09-support-platform/index.md | 1 + docs-cn/14-reference/11-docker/index.md | 4 ++-- docs-cn/14-reference/12-directory.md | 1 + docs-cn/14-reference/13-schemaless/13-schemaless.md | 3 +-- docs-cn/14-reference/_category_.yml | 3 ++- 11 files changed, 20 insertions(+), 12 deletions(-) diff --git a/docs-cn/04-develop/_category_.yml b/docs-cn/04-develop/_category_.yml index 509a9405c4..b17f078b9a 100644 --- a/docs-cn/04-develop/_category_.yml +++ b/docs-cn/04-develop/_category_.yml @@ -1 +1,5 @@ -label: 开发指南 \ No newline at end of file +label: 开发指南 +link: + type: generated-index + slug: /develop + description: "开始指南是对开发者友好的使用教程，既包括数据建模、写入、查询等基础功能的使用，也包括数据订阅、连续查询等高级功能的使用。对于每个主题，都配有各编程语言的连接器的示例代码，方便开发者快速上手。如果想更深入地了解各连接器的使用，请阅读连接器参考指南。" diff --git a/docs-cn/12-taos-sql/01-data-type.md b/docs-cn/12-taos-sql/01-data-type.md index 7e63e1c950..be5c9a8cb4 100644 --- a/docs-cn/12-taos-sql/01-data-type.md +++ b/docs-cn/12-taos-sql/01-data-type.md @@ -1,6 +1,7 @@ --- sidebar_label: 支持的数据类型 title: 支持的数据类型 +description: "TDengine 支持的数据类型: 时间戳、浮点型、JSON 类型等" --- 使用 TDengine，最重要的是时间戳。创建并插入记录、查询历史记录的时候，均需要指定时间戳。时间戳有如下规则： @@ -13,7 +14,7 @@ title: 支持的数据类型 TDengine 缺省的时间戳精度是毫秒，但通过在 `CREATE DATABASE` 时传递的 PRECISION 参数也可以支持微秒和纳秒。（从 2.1.5.0 版本开始支持纳秒精度） -``` +```sql CREATE DATABASE db_name PRECISION 'ns'; ``` @@ -31,9 +32,7 @@ CREATE DATABASE db_name PRECISION 'ns'; | 8 | TINYINT | 1 | 单字节整型，范围 [-127, 127], -128 用作 NULL | | 9 | BOOL | 1 | 布尔型，{true, false} | | 10 | NCHAR | 自定义 | 记录包含多字节字符在内的字符串，如中文字符。每个 nchar 字符占用 4 bytes 的存储空间。字符串两端使用单引号引用，字符串内的单引号需用转义字符 `\’`。nchar 使用时须指定字符串大小，类型为 nchar(10) 的列表示此列的字符串最多存储 10 个 nchar 字符，会固定占用 40 bytes 的空间。如果用户字符串长度超出声明长度，将会报错。 | -| 11 | JSON | | json 数据类型， 只有 tag 可以是 json 格式 | - - +| 11 | JSON | | json 数据类型， 只有 tag 可以是 json 格式 | :::tip TDengine 对 SQL 语句中的英文字符不区分大小写，自动转化为小写执行。因此用户大小写敏感的字符串及密码，需要使用单引号将字符串引起来。 diff --git a/docs-cn/12-taos-sql/02-database.md b/docs-cn/12-taos-sql/02-database.md index 5240efa26f..5d358193f9 100644 --- a/docs-cn/12-taos-sql/02-database.md +++ b/docs-cn/12-taos-sql/02-database.md @@ -1,6 +1,7 @@ --- sidebar_label: 数据库管理 title: 数据库管理 +description: "创建、删除数据库，查看、修改数据库参数" --- ## 创建数据库 diff --git a/docs-cn/12-taos-sql/index.md b/docs-cn/12-taos-sql/index.md index bc5c2efd67..c34c1e5dc8 100644 --- a/docs-cn/12-taos-sql/index.md +++ b/docs-cn/12-taos-sql/index.md @@ -1,5 +1,6 @@ --- title: TAOS SQL +description: "TAOS SQL 支持的语法规则、主要查询功能、支持的 SQL 查询函数，以及常用技巧等内容" --- 本文档说明 TAOS SQL 支持的语法规则、主要查询功能、支持的 SQL 查询函数，以及常用技巧等内容。阅读本文档需要读者具有基本的 SQL 语言的基础。 diff --git a/docs-cn/14-reference/05-taosbenchmark.md b/docs-cn/14-reference/05-taosbenchmark.md index c8668dedc5..507fac684a 100644 --- a/docs-cn/14-reference/05-taosbenchmark.md +++ b/docs-cn/14-reference/05-taosbenchmark.md @@ -2,6 +2,7 @@ title: taosBenchmark sidebar_label: taosBenchmark toc_max_heading_level: 4 +description: "taosBenchmark (曾用名 taosdemo ) 是一个用于测试 TDengine 产品性能的工具" --- ## 简介 diff --git a/docs-cn/14-reference/06-taosdump.md b/docs-cn/14-reference/06-taosdump.md index ede5d236a9..7131493ec9 100644 --- a/docs-cn/14-reference/06-taosdump.md +++ b/docs-cn/14-reference/06-taosdump.md @@ -1,11 +1,11 @@ --- title: taosdump +description: "taosdump 是一个支持从运行中的 TDengine 集群备份数据并将备份的数据恢复到相同或另一个运行中的 TDengine 集群中的工具应用程序" --- ## 简介 -taosdump 是一个支持从运行中的 TDengine 集群备份数据并将备份的数据恢复 -到相同或另一个运行中的 TDengine 集群中的工具应用程序。 +taosdump 是一个支持从运行中的 TDengine 集群备份数据并将备份的数据恢复到相同或另一个运行中的 TDengine 集群中的工具应用程序。 taosdump 可以用数据库、超级表或普通表作为逻辑数据单元进行备份，也可以对数据库、超级 表和普通表中指定时间段内的数据记录进行备份。使用时可以指定数据备份的目录路径，如果 diff --git a/docs-cn/14-reference/09-support-platform/index.md b/docs-cn/14-reference/09-support-platform/index.md index 11374e4deb..d396e4be1f 100644 --- a/docs-cn/14-reference/09-support-platform/index.md +++ b/docs-cn/14-reference/09-support-platform/index.md @@ -1,5 +1,6 @@ --- title: 支持平台列表 +description: "TDengine 服务端、客户端和连接器支持的平台列表" --- ## TDengine 服务端支持的平台列表 diff --git a/docs-cn/14-reference/11-docker/index.md b/docs-cn/14-reference/11-docker/index.md index 6960db08b2..daac309c23 100644 --- a/docs-cn/14-reference/11-docker/index.md +++ b/docs-cn/14-reference/11-docker/index.md @@ -1,9 +1,9 @@ --- title: 用 Docker 部署 TDengine +description: "本章主要介绍如何在容器中启动 TDengine 服务并访问它" --- -本章主要介绍如何在容器中启动 TDengine 服务并访问它。 -注意：可以在 docker run 命令行中或者 docker-compose 文件中使用环境变量来控制容器中服务的行为。 +本章主要介绍如何在容器中启动 TDengine 服务并访问它。可以在 docker run 命令行中或者 docker-compose 文件中使用环境变量来控制容器中服务的行为。 ## 启动 TDengine diff --git a/docs-cn/14-reference/12-directory.md b/docs-cn/14-reference/12-directory.md index df2a6536ee..f8c8cb4a08 100644 --- a/docs-cn/14-reference/12-directory.md +++ b/docs-cn/14-reference/12-directory.md @@ -1,5 +1,6 @@ --- title: 文件目录结构 +description: "TDengine 安装目录说明" --- 安装 TDengine 后，默认会在操作系统中生成下列目录或文件： diff --git a/docs-cn/14-reference/13-schemaless/13-schemaless.md b/docs-cn/14-reference/13-schemaless/13-schemaless.md index 7b34b97ce0..d5ec8ddc44 100644 --- a/docs-cn/14-reference/13-schemaless/13-schemaless.md +++ b/docs-cn/14-reference/13-schemaless/13-schemaless.md @@ -1,9 +1,8 @@ --- title: Schemaless 写入 +description: "Schemaless 写入方式，可以免于预先创建超级表/子表的步骤，随着数据写入接口能够自动创建与数据对应的存储结构" --- -## 前言 - 在物联网应用中，常会采集比较多的数据项，用于实现智能控制、业务分析、设备监控等。由于应用逻辑的版本升级，或者设备自身的硬件调整等原因，数据采集项就有可能比较频繁地出现变动。为了在这种情况下方便地完成数据记录工作，TDengine 从 2.2.0.0 版本开始，提供调用 Schemaless 写入方式，可以免于预先创建超级表/子表的步骤，随着数据写入接口能够自动创建与数据对应的存储结构。并且在必要时，Schemaless 将自动增加必要的数据列，保证用户写入的数据可以被正确存储。 diff --git a/docs-cn/14-reference/_category_.yml b/docs-cn/14-reference/_category_.yml index f8031c3575..079c784e65 100644 --- a/docs-cn/14-reference/_category_.yml +++ b/docs-cn/14-reference/_category_.yml @@ -1,4 +1,5 @@ label: 参考指南 link: slug: /reference/ - type: generated-index \ No newline at end of file + type: generated-index + description: "参考指南是对 TDengine 本身、 TDengine 各语言连接器及自带的工具最详细的介绍。" -- GitLab