diff --git a/docs-cn/01-intro/01-intro.md b/docs-cn/01-intro/01-intro.md index d6b0968e47dd71bdfa648072b198641d74caa8b3..d5664d2fd2175e73a8f12587a2a2d2f947fe9cac 100644 --- a/docs-cn/01-intro/01-intro.md +++ b/docs-cn/01-intro/01-intro.md @@ -1,10 +1,9 @@ --- sidebar_label: 产品简介 +title: 产品简介 toc_max_heading_level: 2 --- -# 产品简介 - ## TDengine 简介 TDengine 是一款高性能、分布式、支持 SQL 的时序数据库。而且除时序数据库功能外，它还提供缓存、数据订阅、流式计算等功能，最大程度减少研发和运维的复杂度，且核心代码，包括集群功能全部开源（开源协议，AGPL v3.0）。与其他时序数据数据库相比，TDengine 有以下特点： diff --git a/docs-cn/02-concept/02-concept.md b/docs-cn/02-concept/02-concept.md index ccaa1b51e0410c2a2e02513f5ce6e4a2c6e00325..b65bb6afe8077da28a1ae58251c35f84df4ea1f9 100644 --- a/docs-cn/02-concept/02-concept.md +++ b/docs-cn/02-concept/02-concept.md @@ -1,4 +1,6 @@ -# 基本概念 +--- +title: 基本概念 +--- ## 物联网典型场景 diff --git a/docs-cn/03-get-started/03-get-started.md b/docs-cn/03-get-started/03-get-started.md index 90a86b44e6ceb4bc6cfe3c6851e189d169b6ccdb..2506228eff6a3a0ba3fb9046b675add1f521ecf2 100644 --- a/docs-cn/03-get-started/03-get-started.md +++ b/docs-cn/03-get-started/03-get-started.md @@ -1,4 +1,6 @@ -# 立即开始 +--- +title: 立即开始 +--- ## 从 Docker 快速开始 diff --git a/docs-cn/04-connect/_connect_node_native.mdx b/docs-cn/04-connect/_connect_node_native.mdx index 7168d9268a10f23c66dcc7a85cc54b162ff5f80f..c6d5089c3d19a1bdd38d72cc3b808361a96d925d 100644 --- a/docs-cn/04-connect/_connect_node_native.mdx +++ b/docs-cn/04-connect/_connect_node_native.mdx @@ -5,7 +5,7 @@ npm install td2.0-connector ``` :::note -推荐使用 `node-v12.8.0` 或 `node-v12.20.0` +推荐Node版本大于等于 `node-v12.8.0` 小于 `node-v13.0.0` ::: diff --git a/docs-cn/04-connect/index.mdx b/docs-cn/04-connect/index.mdx index 4594f5b907c6b49e65668f6205d909c9d417f0db..fe5b46ab3fc43e04722b9d0368a1e9dba9f69982 100644 --- a/docs-cn/04-connect/index.mdx +++ b/docs-cn/04-connect/index.mdx @@ -1,4 +1,6 @@ -# 建立连接 +--- +title: 建立连接 +--- import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; diff --git a/docs-cn/05-model/index.mdx b/docs-cn/05-model/index.mdx index 7b1ae38439a5644340d9600eb2332546b335bc14..f075084b7fb5c7ab84e4491ca063a92e165dc36e 100644 --- a/docs-cn/05-model/index.mdx +++ b/docs-cn/05-model/index.mdx @@ -1,9 +1,8 @@ --- slug: /model +title: TDengine 数据建模 --- -# TDengine 数据建模 - TDengine 采用关系型数据模型，需要建库、建表。因此对于一个具体的应用场景，需要考虑库、超级表和普通表的设计。本节不讨论细致的语法规则，只介绍概念。 关于数据建模请参考[视频教程](https://www.taosdata.com/blog/2020/11/11/1945.html)。 diff --git a/docs-cn/06-insert-data/01-sql-writing.mdx b/docs-cn/06-insert-data/01-sql-writing.mdx index bd41f2f4552759cdde9a34207bee50feeda197c1..d61523199a9998112dfd5165cce072c90a558a1e 100644 --- a/docs-cn/06-insert-data/01-sql-writing.mdx +++ b/docs-cn/06-insert-data/01-sql-writing.mdx @@ -1,4 +1,6 @@ -# SQL 写入 +--- +title: SQL 写入 +--- import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; diff --git a/docs-cn/06-insert-data/02-influxdb-line.mdx b/docs-cn/06-insert-data/02-influxdb-line.mdx index af7136cde408ef3bf11e5e9f2a85acfeea7256ae..038adbec17ec6ae149acc11f0061f37109ac095e 100644 --- a/docs-cn/06-insert-data/02-influxdb-line.mdx +++ b/docs-cn/06-insert-data/02-influxdb-line.mdx @@ -1,9 +1,8 @@ --- sidebar_label: InfluxDB Line 协议 +title: InfluxDB Line 协议 --- -# InfluxDB Line 协议 - import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; import JavaLine from "./_java_line.mdx"; diff --git a/docs-cn/06-insert-data/03-opentsdb-telnet.mdx b/docs-cn/06-insert-data/03-opentsdb-telnet.mdx index 85ef3762738a84453de5934baf381183b9766a89..75c560fbcebf9b3dfc6f11ea071decd27b903fc2 100644 --- a/docs-cn/06-insert-data/03-opentsdb-telnet.mdx +++ b/docs-cn/06-insert-data/03-opentsdb-telnet.mdx @@ -1,9 +1,8 @@ --- sidebar_label: OpentsDB Telnet 协议 +title: OpentsDB Telnet 协议 --- -# OpentsDB Telnet 协议 - import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; import JavaTelnet from "./_java_opts_telnet.mdx"; diff --git a/docs-cn/06-insert-data/04-opentsdb-json.mdx b/docs-cn/06-insert-data/04-opentsdb-json.mdx index 469ba89e016e7358924ceb26b428cc0362e761f3..0c998d66f489b6d4b58744965c8d66814db1da72 100644 --- a/docs-cn/06-insert-data/04-opentsdb-json.mdx +++ b/docs-cn/06-insert-data/04-opentsdb-json.mdx @@ -1,9 +1,8 @@ --- sidebar_label: OpentsDB JSON 格式协议 +title: OpentsDB JSON 格式协议 --- -# OpentsDB JSON 格式协议 - import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; import JavaJson from "./_java_opts_json.mdx"; diff --git a/docs-cn/07-query-data/index.mdx b/docs-cn/07-query-data/index.mdx index ae03007eb61e8ab64fb783f8c5c06fbcf6f47ce6..073a012c4c4d8d17e708a7cad22d0f8449127f08 100644 --- a/docs-cn/07-query-data/index.mdx +++ b/docs-cn/07-query-data/index.mdx @@ -1,9 +1,8 @@ --- slug: /query-data +title: 查询数据 --- -# 查询数据 - import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; import JavaQuery from "./_java.mdx"; diff --git a/docs-cn/08-advance-feature/03-cache.md b/docs-cn/08-advance-feature/03-cache.md index 909404085ad9ba05517a6201495bbcfc1ab6ce9e..a4404ac30a8d9e4d9b972b92601ea411214e6bdd 100644 --- a/docs-cn/08-advance-feature/03-cache.md +++ b/docs-cn/08-advance-feature/03-cache.md @@ -1,9 +1,8 @@ --- sidebar_label: 缓存 +title: 缓存 --- -# 缓存（Cache） - TDengine 采用时间驱动缓存管理策略（First-In-First-Out，FIFO），又称为写驱动的缓存管理机制。这种策略有别于读驱动的数据缓存模式（Least-Recent-Used，LRU），直接将最近写入的数据保存在系统的缓存中。当缓存达到临界值的时候，将最早的数据批量写入磁盘。一般意义上来说，对于物联网数据的使用，用户最为关心最近产生的数据，即当前状态。TDengine 充分利用了这一特性，将最近到达的（当前状态）数据保存在缓存中。 TDengine 通过查询函数向用户提供毫秒级的数据获取能力。直接将最近到达的数据保存在缓存中，可以更加快速地响应用户针对最近一条或一批数据的查询分析，整体上提供更快的数据库查询响应能力。从这个意义上来说，可通过设置合适的配置参数将 TDengine 作为数据缓存来使用，而不需要再部署额外的缓存系统，可有效地简化系统架构，降低运维的成本。需要注意的是，TDengine 重启以后系统的缓存将被清空，之前缓存的数据均会被批量写入磁盘，缓存的数据将不会像专门的 key-value 缓存系统再将之前缓存的数据重新加载到缓存中。 diff --git a/docs-cn/08-advance-feature/04-udf.md b/docs-cn/08-advance-feature/04-udf.md index 2cc88d8963e9eb57e908ed3f062fe287301b1d30..136d2e03ca6d27aa58233a5ca9ca7a1c47b6a33e 100644 --- a/docs-cn/08-advance-feature/04-udf.md +++ b/docs-cn/08-advance-feature/04-udf.md @@ -1,9 +1,8 @@ --- sidebar_label: UDF +title: UDF（用户定义函数） --- -# UDF（用户定义函数） - 在有些应用场景中，应用逻辑需要的查询无法直接使用系统内置的函数来表示。利用 UDF 功能，TDengine 可以插入用户编写的处理代码并在查询中使用它们，就能够很方便地解决特殊应用场景中的使用需求。 UDF 通常以数据表中的一列数据做为输入，同时支持以嵌套子查询的结果作为输入。 从 2.2.0.0 版本开始，TDengine 支持通过 C/C++ 语言进行 UDF 定义。接下来结合示例讲解 UDF 的使用方法。 diff --git a/docs-cn/08-advance-feature/08-advance-feature.md b/docs-cn/08-advance-feature/08-advance-feature.md index 4de393203389c0df473d471c3d934aa640d06b49..ae9bbe3c907bf4c542eb2ac47e2436fe81719653 100644 --- a/docs-cn/08-advance-feature/08-advance-feature.md +++ b/docs-cn/08-advance-feature/08-advance-feature.md @@ -1,4 +1,6 @@ -# 高级功能 +--- +title: 高级功能 +--- 本章介绍以下TDengine中的高级功能。 diff --git a/docs-cn/09-third-party/01-grafana.mdx b/docs-cn/09-third-party/01-grafana.mdx index c34c617010daf92225f5e086355ec5d822c39d51..80e7d623d9e5b6333567fff633c9662d5166c072 100644 --- a/docs-cn/09-third-party/01-grafana.mdx +++ b/docs-cn/09-third-party/01-grafana.mdx @@ -1,9 +1,8 @@ --- sidebar_label: Grafana +title: Grafana --- -# Grafana - TDengine 能够与开源数据可视化系统 [Grafana](https://www.grafana.com/) 快速集成搭建数据监测报警系统，整个过程无需任何代码开发，TDengine 中数据表中内容可以在仪表盘(DashBoard)上进行可视化展现。关于 TDengine 插件的使用您可以在[GitHub](https://github.com/taosdata/grafanaplugin/blob/master/README.md)中了解更多。 ## 安装 Grafana diff --git a/docs-cn/09-third-party/02-prometheus.md b/docs-cn/09-third-party/02-prometheus.md index 605fe817fe2dde219dea2448f8c8e45fa8a50183..e30c50d67fff449ad3adeafa9489f3bd43b02b28 100644 --- a/docs-cn/09-third-party/02-prometheus.md +++ b/docs-cn/09-third-party/02-prometheus.md @@ -1,9 +1,8 @@ --- sidebar_label: Prometheus +title: Prometheus 写入 --- -# Prometheus 写入 - remote_read 和 remote_write 是 Prometheus 数据读写分离的集群方案。 只需要将 remote_read 和 remote_write url 指向 taosAdapter 对应的 url 同时设置 Basic 验证即可使用。 diff --git a/docs-cn/09-third-party/03-telegraf.md b/docs-cn/09-third-party/03-telegraf.md index 191193b426995fb7e3036605f52ddef963da0d55..b66d7ec6d88f9b412e608754dff2b75520e83b9a 100644 --- a/docs-cn/09-third-party/03-telegraf.md +++ b/docs-cn/09-third-party/03-telegraf.md @@ -1,9 +1,8 @@ --- sidebar_label: Telegraf +title: Telegraf 写入 --- -# Telegraf 写入 - 安装 Telegraf 请参考[官方文档](https://portal.influxdata.com/downloads/)。 TDengine 新版本（2.3.0.0+）包含一个 taosAdapter 独立程序，负责接收包括 Telegraf 的多种应用的数据写入。 diff --git a/docs-cn/09-third-party/05-collectd.md b/docs-cn/09-third-party/05-collectd.md index c94dd8cb977c0a01d67839467b04e414e33eaf3d..083c46993523048fcae9995da799030a0a4f934f 100644 --- a/docs-cn/09-third-party/05-collectd.md +++ b/docs-cn/09-third-party/05-collectd.md @@ -1,9 +1,8 @@ --- sidebar_label: collectd +title: collectd 写入 --- -# collectd 写入 - 安装 collectd，请参考[官方文档](https://collectd.org/download.shtml)。 TDengine 新版本（2.3.0.0+）包含一个 taosAdapter 独立程序，负责接收包括 collectd 的多种应用的数据写入。 diff --git a/docs-cn/09-third-party/06-statsd.md b/docs-cn/09-third-party/06-statsd.md index b1bf4b06e4a52258df0a2aa3ed5a0a4c7872abb5..ddf6a8772ceb78bba8968190c6568e87ecf6871a 100644 --- a/docs-cn/09-third-party/06-statsd.md +++ b/docs-cn/09-third-party/06-statsd.md @@ -1,9 +1,8 @@ --- sidebar_label: StatsD +title: StatsD 直接写入 --- -# StatsD 直接写入 - 安装 StatsD 请参考[官方文档](https://github.com/statsd/statsd)。 diff --git a/docs-cn/09-third-party/07-icinga2.md b/docs-cn/09-third-party/07-icinga2.md index d83e4fcd309ba2ce54bb0a8a8754bdd2ca19968d..fcfe7a1fc312fad8e3cad59f44e3d6df1398031b 100644 --- a/docs-cn/09-third-party/07-icinga2.md +++ b/docs-cn/09-third-party/07-icinga2.md @@ -1,9 +1,8 @@ --- sidebar_label: icinga2 +title: icinga2 写入 --- -# icinga2 写入 - - 参考链接 `https://icinga.com/docs/icinga-2/latest/doc/14-features/#opentsdb-writer` 使能 opentsdb-writer - 使能 taosAdapter 配置项 opentsdb_telnet.enable - 修改配置文件 /etc/icinga2/features-enabled/opentsdb.conf diff --git a/docs-cn/09-third-party/08-tcollector.md b/docs-cn/09-third-party/08-tcollector.md index 70ae0762ee3e1d39876569d4169b26afe1038a34..c0da0c2c5c29e1ee4de2b9a618ad2bb799330f49 100644 --- a/docs-cn/09-third-party/08-tcollector.md +++ b/docs-cn/09-third-party/08-tcollector.md @@ -1,9 +1,8 @@ --- sidebar_label: TCollector +title: TCollector 写入 --- -# TCollector 写入 - TCollector 是一个在客户侧收集本地收集器并发送数据到 OpenTSDB 的进程，taosAdaapter 可以支持接收 TCollector 的数据并写入到 TDengine 中。 使能 taosAdapter 配置项 opentsdb_telnet.enable diff --git a/docs-cn/09-third-party/09-emq-broder.md b/docs-cn/09-third-party/09-emq-broder.md index 0d2bd4d2f996247119bca736d295b7faf5d55e23..a661943088e2b478ff9940b6679a47c1bbb039ed 100644 --- a/docs-cn/09-third-party/09-emq-broder.md +++ b/docs-cn/09-third-party/09-emq-broder.md @@ -1,7 +1,6 @@ --- sidebar_label: EMQ Broker +title: EMQ Broker 写入 --- -# EMQ Broker 写入 - MQTT 是流行的物联网数据传输协议，[EMQ](https://github.com/emqx/emqx)是一开源的 MQTT Broker 软件，无需任何代码，只需要在 EMQ Dashboard 里使用“规则”做简单配置，即可将 MQTT 的数据直接写入 TDengine。EMQ X 支持通过 发送到 Web 服务的方式保存数据到 TDEngine，也在企业版上提供原生的 TDEngine 驱动实现直接保存。详细使用方法请参考 [EMQ 官方文档](https://docs.emqx.io/broker/latest/cn/rule/rule-example.html#%E4%BF%9D%E5%AD%98%E6%95%B0%E6%8D%AE%E5%88%B0-tdengine)。 diff --git a/docs-cn/09-third-party/10-hive-mq-broker.md b/docs-cn/09-third-party/10-hive-mq-broker.md index 81657da1009c286ece906116abf33428868c1971..f75ed793d6272ae27f92676e2096ef455f638aa6 100644 --- a/docs-cn/09-third-party/10-hive-mq-broker.md +++ b/docs-cn/09-third-party/10-hive-mq-broker.md @@ -1,7 +1,6 @@ --- sidebar_label: HiveMQ Broker +title: HiveMQ Broker 写入 --- -# HiveMQ Broker 写入 - [HiveMQ](https://www.hivemq.com/) 是一个提供免费个人版和企业版的 MQTT 代理，主要用于企业和新兴的机器到机器 M2M 通讯和内部传输，满足可伸缩性、易管理和安全特性。HiveMQ 提供了开源的插件开发包。可以通过 HiveMQ extension - TDengine 保存数据到 TDengine。详细使用方法请参考 [HiveMQ extension - TDengine 说明文档](https://github.com/huskar-t/hivemq-tdengine-extension/blob/b62a26ecc164a310104df57691691b237e091c89/README.md)。 diff --git a/docs-cn/10-cluster/01-deploy.md b/docs-cn/10-cluster/01-deploy.md index 338d672d50504d3bf36825f9130ed1a7bfcf2041..edff7f0fd4f7ab5ff1caeba263c4be82e99f4ca2 100644 --- a/docs-cn/10-cluster/01-deploy.md +++ b/docs-cn/10-cluster/01-deploy.md @@ -1,4 +1,6 @@ -# 集群部署 +--- +title: 集群部署 +--- ## 准备工作 diff --git a/docs-cn/10-cluster/02-cluster-mgmt.md b/docs-cn/10-cluster/02-cluster-mgmt.md index 625dd4a7744fbf380b139c2c3e36ff553fd044cf..901ac474ab7eaa4e6cb870846d2894361deb6757 100644 --- a/docs-cn/10-cluster/02-cluster-mgmt.md +++ b/docs-cn/10-cluster/02-cluster-mgmt.md @@ -1,4 +1,6 @@ -# 集群管理 +--- +title: 集群管理 +--- ## 数据节点管理 diff --git a/docs-cn/10-cluster/03-ha-and-lb.md b/docs-cn/10-cluster/03-ha-and-lb.md index 0ac526a8754902e077dd91d7da6ce84f952a0860..8144892114f5505915364117f5a974a3e1f49600 100644 --- a/docs-cn/10-cluster/03-ha-and-lb.md +++ b/docs-cn/10-cluster/03-ha-and-lb.md @@ -1,4 +1,6 @@ -# 高可用与负载均衡 +--- +title: 高可用与负载均衡 +--- ## vnode 的高可用性 diff --git a/docs-cn/11-operation/01-pkg-install.md b/docs-cn/11-operation/01-pkg-install.md index 257e9bb351bd18071dad7a7f149937c74e45c0ed..d8c005d9991918ed01cc3bf536e5581deb5929dd 100644 --- a/docs-cn/11-operation/01-pkg-install.md +++ b/docs-cn/11-operation/01-pkg-install.md @@ -1,4 +1,6 @@ -# 安装、卸载、启动和停止 +--- +title: 安装、卸载、启动和停止 +--- TDengine 开源版本提供 deb 和 rpm 格式安装包，用户可以根据自己的运行环境选择合适的安装包。其中 deb 支持 Debian/Ubuntu 等系统，rpm 支持 CentOS/RHEL/SUSE 等系统。同时我们也为企业用户提供 tar.gz 格式安装包。 diff --git a/docs-cn/11-operation/02-planning.mdx b/docs-cn/11-operation/02-planning.mdx index 1e62c54ff04f4204be996cf2c92b51f6fdf59d91..57edf316cb0e8f3333d0fd738b3e965a28fbac91 100644 --- a/docs-cn/11-operation/02-planning.mdx +++ b/docs-cn/11-operation/02-planning.mdx @@ -1,9 +1,8 @@ --- sidebar_label: 容量规划 +title: 容量规划 --- -# 容量规划 - 使用 TDengine 来搭建一个物联网大数据平台，计算资源、存储资源需要根据业务场景进行规划。下面分别讨论系统运行所需要的内存、CPU 以及硬盘空间。 ## 内存需求 diff --git a/docs-cn/11-operation/03-tolerance.md b/docs-cn/11-operation/03-tolerance.md index bd293f1609d1fd7bfd5ef22171ed13ff0e822a25..054e5c4cee07f7066038a6bfc5c4b25306b033ce 100644 --- a/docs-cn/11-operation/03-tolerance.md +++ b/docs-cn/11-operation/03-tolerance.md @@ -1,4 +1,6 @@ -# 容错和灾备 +--- +title: 容错和灾备 +--- ## 容错 diff --git a/docs-cn/11-operation/06-admin.md b/docs-cn/11-operation/06-admin.md index 0ecbe0ae2e3c6e5132c7ca84da182987ecce779f..7934d31eafb774fb45e1902bee29e8b518d152d6 100644 --- a/docs-cn/11-operation/06-admin.md +++ b/docs-cn/11-operation/06-admin.md @@ -1,4 +1,6 @@ -# 用户管理 +--- +title: 用户管理 +--- 系统管理员可以在 CLI 界面里添加、删除用户，也可以修改密码。CLI 里 SQL 语法如下： diff --git a/docs-cn/11-operation/07-import.md b/docs-cn/11-operation/07-import.md index 422842aa588c5c8d0253a2a8f841dcf3dbdf1143..fa9215c3aa4bb1316cd120a5155da51ebbf82461 100644 --- a/docs-cn/11-operation/07-import.md +++ b/docs-cn/11-operation/07-import.md @@ -1,4 +1,6 @@ -# 数据导入 +--- +title: 数据导入 +--- TDengine 提供多种方便的数据导入功能，一种按脚本文件导入，一种按数据文件导入，一种是 taosdump 工具导入本身导出的文件。 diff --git a/docs-cn/11-operation/08-export.md b/docs-cn/11-operation/08-export.md index fc5be04d5975bd035eed994a9b3a18dff0eacc50..5f4596dd5c5d573282bcae347f2a4babf0f50279 100644 --- a/docs-cn/11-operation/08-export.md +++ b/docs-cn/11-operation/08-export.md @@ -1,4 +1,6 @@ -# 数据导出 +--- +title: 数据导出 +--- 为方便数据导出，TDengine 提供了两种导出方式，分别是按表导出和用 taosdump 导出。 diff --git a/docs-cn/11-operation/09-status.md b/docs-cn/11-operation/09-status.md index fec725292bf56b924d5ca6f824b7e1628b22670c..18220ac3ea72b9bd7969c209fccbc29b12bfbb37 100644 --- a/docs-cn/11-operation/09-status.md +++ b/docs-cn/11-operation/09-status.md @@ -1,4 +1,6 @@ -# 系统连接、任务查询管理 +--- +title: 系统连接、任务查询管理 +--- 系统管理员可以从 CLI 查询系统的连接、正在进行的查询、流式计算，并且可以关闭连接、停止正在进行的查询和流式计算。CLI 里 SQL 语法如下： diff --git a/docs-cn/11-operation/10-monitor.md b/docs-cn/11-operation/10-monitor.md index 367d1dd54ef5d53b43542600c55b8337e721c013..d866748613a00e85efa844bf1a2cd1acd97f8e40 100644 --- a/docs-cn/11-operation/10-monitor.md +++ b/docs-cn/11-operation/10-monitor.md @@ -1,4 +1,6 @@ -# 系统监控 +--- +title: 系统监控 +--- TDengine 启动后，会自动创建一个监测数据库 log，并自动将服务器的 CPU、内存、硬盘空间、带宽、请求数、磁盘读写速度、慢查询等信息定时写入该数据库。TDengine 还将重要的系统操作（比如登录、创建、删除数据库等）日志以及各种错误报警信息记录下来存放在 log 库里。系统管理员可以从 CLI 直接查看这个数据库，也可以在 WEB 通过图形化界面查看这些监测信息。 diff --git a/docs-cn/11-operation/11-optimize.md b/docs-cn/11-operation/11-optimize.md index ea82246770349113d08d2ac05b0ee321b696fbf4..4db2c76598f86e501de2ce60d8883af7bb6520df 100644 --- a/docs-cn/11-operation/11-optimize.md +++ b/docs-cn/11-operation/11-optimize.md @@ -1,4 +1,6 @@ -# 性能优化 +--- +title: 性能优化 +--- 因数据行 [update](https://www.taosdata.com/cn/documentation/faq#update)、表删除、数据过期等原因，TDengine 的磁盘存储文件有可能出现数据碎片，影响查询操作的性能表现。从 2.1.3.0 版本开始，新增 SQL 指令 COMPACT 来启动碎片重整过程： diff --git a/docs-cn/11-operation/17-diagnose.md b/docs-cn/11-operation/17-diagnose.md index 666fe6e655cab27962d156d97bf14086feaa32b5..7caccf55937b8bbb4fbea111703c8536044ffac4 100644 --- a/docs-cn/11-operation/17-diagnose.md +++ b/docs-cn/11-operation/17-diagnose.md @@ -1,4 +1,6 @@ -# 诊断及其他 +--- +title: 诊断及其他 +--- ## 网络连接诊断 diff --git a/docs-cn/13-tdinternal/01-arch.md b/docs-cn/13-tdinternal/01-arch.md index f276a8e86ba52aa63a49b0c8f3022a3acb7f39ba..eec55af9bb1b271bf4b3f1ae271b1bafcd9caae3 100644 --- a/docs-cn/13-tdinternal/01-arch.md +++ b/docs-cn/13-tdinternal/01-arch.md @@ -1,9 +1,8 @@ --- sidebar_label: 数据模型和整体架构 +title: 数据模型和整体架构 --- -# 数据模型和整体架构 - ## 数据模型 ### 物联网典型场景 diff --git a/docs-cn/13-tdinternal/02-replica.md b/docs-cn/13-tdinternal/02-replica.md index 037ce0682ade1677da00287dd5f30696c3eaf17b..81d7fc4d79c53011b82a4dea4695eb90fa91f391 100644 --- a/docs-cn/13-tdinternal/02-replica.md +++ b/docs-cn/13-tdinternal/02-replica.md @@ -1,9 +1,8 @@ --- sidebar_label: 数据复制模块设计 +title: 数据复制模块设计 --- -# 数据复制模块设计 - ## 数据复制概述 数据复制(Replication)是指同一份数据在多个物理地点保存。它的目的是防止数据丢失，提高系统的高可用性(High Availability)，而且通过应用访问多个副本，提升数据查询性能。 diff --git a/docs-cn/13-tdinternal/03-taosd.md b/docs-cn/13-tdinternal/03-taosd.md index 874fa230290016b88fbc905233745a1052ca5a18..b1cfabadbca3a08e9adb7abd976594fc59674741 100644 --- a/docs-cn/13-tdinternal/03-taosd.md +++ b/docs-cn/13-tdinternal/03-taosd.md @@ -1,8 +1,8 @@ --- sidebar_label: taosd 的设计 +title: taosd的设计 --- -# taosd的设计 逻辑上，TDengine系统包含dnode, taosc和App，dnode是服务器侧执行代码taosd的一个运行实例，因此taosd是TDengine的核心，本文对taosd的设计做一简单的介绍，模块内的实现细节请见其他文档。 diff --git a/docs-cn/13-tdinternal/12-tsz-compress.md b/docs-cn/13-tdinternal/12-tsz-compress.md index 5072b474195fa648f5f8e29a6954e8ef6fe35e06..baf5df15db3b44edc9e0bd6909e46fa84b676a0b 100644 --- a/docs-cn/13-tdinternal/12-tsz-compress.md +++ b/docs-cn/13-tdinternal/12-tsz-compress.md @@ -1,4 +1,6 @@ -# TSZ 压缩算法 +--- +title: TSZ 压缩算法 +--- TSZ 压缩算法是 TDengine 为浮点数据类型提供更加丰富的压缩功能，可以实现浮点数的有损至无损全状态压缩，相比原来在 TDengine 中原有压缩算法，TSZ 压缩算法压缩选项更丰富，压缩率更高，即使切到无损状态下对浮点数压缩，压缩率也会比原来的压缩算法高一倍。 diff --git a/docs-cn/14-reference/01-taos-sql/01-data-type.md b/docs-cn/14-reference/01-taos-sql/01-data-type.md index 107e73de5b6903d7aeaa6d6c8a68fb9f5941b7e9..2c74fd183aac7ac85405f012a0f6fbaeb491785a 100644 --- a/docs-cn/14-reference/01-taos-sql/01-data-type.md +++ b/docs-cn/14-reference/01-taos-sql/01-data-type.md @@ -1,9 +1,8 @@ --- sidebar_label: 支持的数据类型 +title: 支持的数据类型 --- -# 支持的数据类型 - 使用 TDengine，最重要的是时间戳。创建并插入记录、查询历史记录的时候，均需要指定时间戳。时间戳有如下规则： - 时间格式为 `YYYY-MM-DD HH:mm:ss.MS`，默认时间分辨率为毫秒。比如：`2017-08-12 18:25:58.128` diff --git a/docs-cn/14-reference/01-taos-sql/02-database.md b/docs-cn/14-reference/01-taos-sql/02-database.md index 1fe934e87796313b647222a000635d113ef391bb..b3b63c282282dbcae7d0ff9b7194674745211c4e 100644 --- a/docs-cn/14-reference/01-taos-sql/02-database.md +++ b/docs-cn/14-reference/01-taos-sql/02-database.md @@ -1,9 +1,8 @@ --- sidebar_label: 数据库管理 +title: 数据库管理 --- -# 数据库管理 - ## 创建数据库 ``` diff --git a/docs-cn/14-reference/01-taos-sql/03-table.md b/docs-cn/14-reference/01-taos-sql/03-table.md index 81834bacd47e04249b72aa4f28d31a73b4c74e75..166aba4b31270e3b73246aa09468817313499d87 100644 --- a/docs-cn/14-reference/01-taos-sql/03-table.md +++ b/docs-cn/14-reference/01-taos-sql/03-table.md @@ -1,4 +1,6 @@ -# 表管理 +--- +title: 表管理 +--- ## 创建数据表 diff --git a/docs-cn/14-reference/01-taos-sql/04-stable.md b/docs-cn/14-reference/01-taos-sql/04-stable.md index 8ac8e669f36fc0dd7066006e5b1e4d4ca7d15cc2..614d4aeb0a40d8cdac02e93470d764848683ebc3 100644 --- a/docs-cn/14-reference/01-taos-sql/04-stable.md +++ b/docs-cn/14-reference/01-taos-sql/04-stable.md @@ -1,8 +1,8 @@ --- sidebar_label: 超级表管理 +title: 超级表 STable 管理 --- -# 超级表 STable 管理 注意：在 2.0.15.0 及以后的版本中，开始支持 STABLE 保留字。也即，在本节后文的指令说明中，CREATE、DROP、ALTER 三个指令在老版本中保留字需写作 TABLE 而不是 STABLE。 diff --git a/docs-cn/14-reference/01-taos-sql/05-insert.md b/docs-cn/14-reference/01-taos-sql/05-insert.md index d0c0c28dba3f5f64ff066f6a313e8307488c13b5..e542e442b78c9033ae37196f4913a7c67fb19d8b 100644 --- a/docs-cn/14-reference/01-taos-sql/05-insert.md +++ b/docs-cn/14-reference/01-taos-sql/05-insert.md @@ -1,9 +1,8 @@ --- sidebar_label: 数据写入 +title: 数据写入 --- -# 数据写入 - ## 写入语法 ``` diff --git a/docs-cn/14-reference/01-taos-sql/06-select.md b/docs-cn/14-reference/01-taos-sql/06-select.md index dab208f0860ab4eed435d097205e1a803350dcde..5671422d5284a721570f18bbcf76346feb4d403f 100644 --- a/docs-cn/14-reference/01-taos-sql/06-select.md +++ b/docs-cn/14-reference/01-taos-sql/06-select.md @@ -1,9 +1,8 @@ --- sidebar_label: 数据查询 +title: 数据查询 --- -# 数据查询 - ## 查询语法 ``` diff --git a/docs-cn/14-reference/01-taos-sql/07-function.md b/docs-cn/14-reference/01-taos-sql/07-function.md index 8b9dd773e516a68b6caed191f427319ce32bce81..e51880d2d40bfc97bb14c7ea1636bd3d6e1b1351 100644 --- a/docs-cn/14-reference/01-taos-sql/07-function.md +++ b/docs-cn/14-reference/01-taos-sql/07-function.md @@ -1,9 +1,8 @@ --- sidebar_label: SQL 函数 +title: SQL 函数 --- -# SQL 函数 - ## 聚合函数 TDengine 支持针对数据的聚合查询。提供支持的聚合和选择函数如下： 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 362ca1bef6ffa2b1e01d739907da5ebff726a500..ef81ba78ea5f2e0f7a87a1d43a6cd98e605dedcf 100644 --- a/docs-cn/14-reference/01-taos-sql/08-interval.md +++ b/docs-cn/14-reference/01-taos-sql/08-interval.md @@ -1,8 +1,8 @@ --- sidebar_label: 按窗口切分聚合 +title: 按窗口切分聚合 --- -# 按窗口切分聚合 TDengine 支持按时间段窗口切分方式进行聚合结果查询，比如温度传感器每秒采集一次数据，但需查询每隔 10 分钟的温度平均值。这种场景下可以使用窗口子句来获得需要的查询结果。 窗口子句用于针对查询的数据集合进行按照窗口切分成为查询子集并进行聚合，窗口包含时间窗口（time window）、状态窗口（status window）、会话窗口（session window）三种窗口。其中时间窗口又可划分为滑动时间窗口和翻转时间窗口。 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 c4e7c6b2f03f3a3f469d32f713bf15bba32f54bc..327ee165cc9b780a48f0e60584cecff2799b50c4 100644 --- a/docs-cn/14-reference/01-taos-sql/09-limit.md +++ b/docs-cn/14-reference/01-taos-sql/09-limit.md @@ -1,9 +1,8 @@ --- sidebar_label: 边界限制 +title: 边界限制 --- -# 边界限制 - ## 一般限制 - 数据库名最大长度为 32。 diff --git a/docs-cn/14-reference/01-taos-sql/10-json.md b/docs-cn/14-reference/01-taos-sql/10-json.md index 6a06bd30ea9eec9eb8e1471d60f74416f6e45e96..4a4a8cca732ac433ba5ada1ec3805ebfa663edb3 100644 --- a/docs-cn/14-reference/01-taos-sql/10-json.md +++ b/docs-cn/14-reference/01-taos-sql/10-json.md @@ -1,8 +1,8 @@ --- sidebar_label: JSON 类型使用说明 +title: JSON 类型使用说明 --- -# JSON 类型使用说明 ## 语法说明 diff --git a/docs-cn/14-reference/01-taos-sql/11-escape.md b/docs-cn/14-reference/01-taos-sql/11-escape.md index be27dd4e7b6dd59264d8740f47d4baaf4182a678..a25a0f109a70f43b4fc54afc4dc3ffe15bb63987 100644 --- a/docs-cn/14-reference/01-taos-sql/11-escape.md +++ b/docs-cn/14-reference/01-taos-sql/11-escape.md @@ -1,4 +1,6 @@ -# 转义字符说明 +--- +title: 转义字符说明 +--- ## 转义字符表 diff --git a/docs-cn/14-reference/01-taos-sql/12-errorcode.md b/docs-cn/14-reference/01-taos-sql/12-errorcode.md index 2013e1e640d10bbd09572ca1d9c4ba12a38620d8..f68eb8852b0f603dad128ce9fe32f68c33316635 100644 --- a/docs-cn/14-reference/01-taos-sql/12-errorcode.md +++ b/docs-cn/14-reference/01-taos-sql/12-errorcode.md @@ -1,9 +1,8 @@ --- sidebar_label: 错误码 +title: 错误码以及对应的十进制码 --- -# 错误码以及对应的十进制码 - | 状态码 | 模 | 错误码（十六进制） | 错误描述 | 错误码（十进制） | | :-------------------------------------- | :-: | :----------------: | :------------------------------------------- | :--------------- | | TSDB_CODE_RPC_ACTION_IN_PROGRESS | 0 | 0x0001 | "Action in progress" | -2147483647 | diff --git a/docs-cn/14-reference/01-taos-sql/index.md b/docs-cn/14-reference/01-taos-sql/index.md index 2c8d11288e55fd007b62b0a5fecc7dc7f2dc2737..1718256ed4c16bb21412ace95826ba8d67a339cd 100644 --- a/docs-cn/14-reference/01-taos-sql/index.md +++ b/docs-cn/14-reference/01-taos-sql/index.md @@ -1,4 +1,6 @@ -# TAOS SQL +--- +title: TAOS SQL +--- 本文档说明 TAOS SQL 支持的语法规则、主要查询功能、支持的 SQL 查询函数，以及常用技巧等内容。阅读本文档需要读者具有基本的 SQL 语言的基础。 diff --git a/docs-cn/14-reference/02-restful-api/02-restful-api.mdx b/docs-cn/14-reference/02-restful-api/02-restful-api.mdx index 6173c3215ac5a5dccc1caa206f89b77d101a6e70..722078ec39cb397a3f20a688d32395df6555c4b8 100644 --- a/docs-cn/14-reference/02-restful-api/02-restful-api.mdx +++ b/docs-cn/14-reference/02-restful-api/02-restful-api.mdx @@ -1,4 +1,6 @@ -# RESTful API +--- +title: RESTful API +--- 为支持各种不同类型平台的开发，TDengine 提供符合 REST 设计标准的 API，即 RESTful API。为最大程度降低学习成本，不同于其他数据库 RESTful API 的设计方法，TDengine 直接通过 HTTP POST 请求 BODY 中包含的 SQL 语句来操作数据库，仅需要一个 URL。RESTful 连接器的使用参见[视频教程](https://www.taosdata.com/blog/2020/11/11/1965.html)。 diff --git a/docs-cn/14-reference/03-connector/03-connector.mdx b/docs-cn/14-reference/03-connector/03-connector.mdx index 2036a591ff1f6f579dfec4e2e014573900d3c21d..b8b510cdf00bcae62a437164e5015d288bb64fad 100644 --- a/docs-cn/14-reference/03-connector/03-connector.mdx +++ b/docs-cn/14-reference/03-connector/03-connector.mdx @@ -1,4 +1,6 @@ -# 连接器 +--- +title: 连接器 +--- TDengine 提供了丰富的应用程序开发接口，其中包括 C/C++、Java、Python、Go、Node.js、C# 、RESTful 等，便于用户快速开发应用。 diff --git a/docs-cn/14-reference/03-connector/cpp.mdx b/docs-cn/14-reference/03-connector/cpp.mdx index 6ff6b413b9fcfb5d9c4552ef06184a4db2777a08..00b62dcf2a8074ee52a0de185c55222b0afd3bd3 100644 --- a/docs-cn/14-reference/03-connector/cpp.mdx +++ b/docs-cn/14-reference/03-connector/cpp.mdx @@ -1,10 +1,10 @@ --- sidebar_position: 1 +title: C/C++ Connector --- -# C/C++ Connector -**C/C++连接器支持的系统有**： +## 支持的系统 | **CPU 类型** | x64（64bit） | | | ARM64 | ARM32 | | ------------ | ------------ | -------- | -------- | -------- | -------- | @@ -26,7 +26,7 @@ C/C++的 API 类似于 MySQL 的 C API。应用程序使用时，需要包含 TD - 如未特别说明，当 API 的返回值是整数时，_0_ 代表成功，其它是代表失败原因的错误码，当返回值是指针时， _NULL_ 表示失败。 - 在 taoserror.h 中有所有的错误码，以及对应的原因描述。 -### 示例程序 +## 示例程序 使用 C/C++连接器的示例代码请参见 https://github.com/taosdata/TDengine/tree/develop/examples/c 。 @@ -40,7 +40,7 @@ C/C++的 API 类似于 MySQL 的 C API。应用程序使用时，需要包含 TD **提示：**在 ARM 环境下编译时，请将 makefile 中的-msse4.2 打开，这个选项只有在 x64/x86 硬件平台上才能支持。 -### 基础 API +## 基础 API 基础 API 用于完成创建数据库连接等工作，为其它 API 的执行提供运行时环境。 @@ -89,7 +89,7 @@ C/C++的 API 类似于 MySQL 的 C API。应用程序使用时，需要包含 TD 关闭连接，其中`taos`是`taos_connect`函数返回的指针。 -### 同步查询 API +## 同步查询 API 传统的数据库操作 API，都属于同步操作。应用调用 API 后，一直处于阻塞状态，直到服务器返回结果。TDengine 支持如下 API： @@ -154,7 +154,7 @@ typedef struct taosField { ::: -### 异步查询 API +## 异步查询 API 同步 API 之外，TDengine 还提供性能更高的异步调用 API 处理数据插入、查询操作。在软硬件环境相同的情况下，异步 API 处理数据插入的速度比同步 API 快 2 ～ 4 倍。异步 API 采用非阻塞式的调用方式，在系统真正完成某个具体数据库操作前，立即返回。调用的线程可以去处理其他工作，从而可以提升整个应用的性能。异步 API 在网络延迟严重的情况下，优点尤为突出。 @@ -180,7 +180,7 @@ typedef struct taosField { TDengine 的异步 API 均采用非阻塞调用模式。应用程序可以用多线程同时打开多张表，并可以同时对每张打开的表进行查询或者插入操作。需要指出的是，**客户端应用必须确保对同一张表的操作完全串行化**，即对同一个表的插入或查询操作未完成时（未返回时），不能够执行第二个插入或查询操作。 -### 参数绑定 API +## 参数绑定 API 除了直接调用 `taos_query` 进行查询，TDengine 也提供了支持参数绑定的 Prepare API，与 MySQL 一样，这些 API 目前也仅支持用问号 `?` 来代表待绑定的参数。文档中有时也会把此功能称为“原生接口写入”。 @@ -215,17 +215,17 @@ TDengine 的异步 API 均采用非阻塞调用模式。应用程序可以用多 不如 `taos_stmt_bind_param_batch` 效率高，但可以支持非 INSERT 类型的 SQL 语句。 进行参数绑定，bind 指向一个数组（代表所要绑定的一行数据），需保证此数组中的元素数量和顺序与 SQL 语句中的参数完全一致。TAOS_BIND 的使用方法与 MySQL 中的 MYSQL_BIND 一致，具体定义如下： -```c -typedef struct TAOS_BIND { - int buffer_type; - void * buffer; - unsigned long buffer_length; // 未实际使用 - unsigned long *length; - int * is_null; - int is_unsigned; // 未实际使用 - int * error; // 未实际使用 -} TAOS_BIND; -``` + ```c + typedef struct TAOS_BIND { + int buffer_type; + void * buffer; + unsigned long buffer_length; // 未实际使用 + unsigned long *length; + int * is_null; + int is_unsigned; // 未实际使用 + int * error; // 未实际使用 + } TAOS_BIND; + ``` - `int taos_stmt_set_tbname(TAOS_STMT* stmt, const char* name)` @@ -242,16 +242,16 @@ typedef struct TAOS_BIND { （2.1.1.0 版本新增，仅支持用于替换 INSERT 语句中的参数值） 以多列的方式传递待绑定的数据，需要保证这里传递的数据列的顺序、列的数量与 SQL 语句中的 VALUES 参数完全一致。TAOS_MULTI_BIND 的具体定义如下： -```c -typedef struct TAOS_MULTI_BIND { - int buffer_type; - void * buffer; - uintptr_t buffer_length; - int32_t * length; - char * is_null; - int num; // 列的个数，即 buffer 中的参数个数 -} TAOS_MULTI_BIND; -``` + ```c + typedef struct TAOS_MULTI_BIND { + int buffer_type; + void * buffer; + uintptr_t buffer_length; + int32_t * length; + char * is_null; + int num; // 列的个数，即 buffer 中的参数个数 + } TAOS_MULTI_BIND; + ``` - `int taos_stmt_add_batch(TAOS_STMT *stmt)` @@ -274,7 +274,7 @@ typedef struct TAOS_MULTI_BIND { （2.1.3.0 版本新增） 用于在其他 stmt API 返回错误（返回错误码或空指针）时获取错误信息。 -### Schemaless 方式写入接口 +## Schemaless 方式写入接口 除了使用 SQL 方式或者使用参数绑定 API 写入数据外，还可以使用 Schemaless 的方式完成写入。Schemaless 可以免于预先创建超级表/数据子表的数据结构，而是可以直接写入数据，TDengine 系统会根据写入的数据内容自动创建和维护所需要的表结构。Schemaless 的使用方式详见 [Schemaless 写入](https://www.taosdata.com/cn/documentation/insert#schemaless) 章节，这里介绍与之配套使用的 C/C++ API。 @@ -316,40 +316,40 @@ typedef struct TAOS_MULTI_BIND { **支持版本** 该功能接口从 2.3.0.0 版本开始支持。 -```c -#include -#include -#include + ```c + #include + #include + #include -int main() { - const char* host = "127.0.0.1"; - const char* user = "root"; - const char* passwd = "taosdata"; + int main() { + const char* host = "127.0.0.1"; + const char* user = "root"; + const char* passwd = "taosdata"; - // connect to server - TAOS* taos = taos_connect(host, user, passwd, "test", 0); + // connect to server + TAOS* taos = taos_connect(host, user, passwd, "test", 0); - // prepare the line string - char* lines1[] = { - "stg,t1=3i64,t2=4f64,t3=\"t3\" c1=3i64,c3=L\"passit\",c2=false,c4=4f64 1626006833639000000", - "stg,t1=4i64,t3=\"t4\",t2=5f64,t4=5f64 c1=3i64,c3=L\"passitagin\",c2=true,c4=5f64,c5=5f64 1626006833641000000" - }; + // prepare the line string + char* lines1[] = { + "stg,t1=3i64,t2=4f64,t3=\"t3\" c1=3i64,c3=L\"passit\",c2=false,c4=4f64 1626006833639000000", + "stg,t1=4i64,t3=\"t4\",t2=5f64,t4=5f64 c1=3i64,c3=L\"passitagin\",c2=true,c4=5f64,c5=5f64 1626006833641000000" + }; - // schema-less insert - TAOS_RES* res = taos_schemaless_insert(taos, lines1, 2, TSDB_SML_LINE_PROTOCOL, TSDB_SML_TIMESTAMP_NANO_SECONDS); - if (taos_errno(res) != 0) { - printf("failed to insert schema-less data, reason: %s\n", taos_errstr(res)); - } + // schema-less insert + TAOS_RES* res = taos_schemaless_insert(taos, lines1, 2, TSDB_SML_LINE_PROTOCOL, TSDB_SML_TIMESTAMP_NANO_SECONDS); + if (taos_errno(res) != 0) { + printf("failed to insert schema-less data, reason: %s\n", taos_errstr(res)); + } - taos_free_result(res); + taos_free_result(res); - // close the connection - taos_close(taos); - return (code); -} -``` + // close the connection + taos_close(taos); + return (code); + } + ``` -### 连续查询接口 +## 连续查询接口 TDengine 提供时间驱动的实时流式计算 API。可以每隔一指定的时间段，对一张或多张数据库的表(数据流)进行各种实时聚合计算操作。操作简单，仅有打开、关闭流的 API。具体如下： @@ -370,7 +370,7 @@ TDengine 提供时间驱动的实时流式计算 API。可以每隔一指定的 关闭数据流，其中提供的参数是 taos_open_stream 的返回值。用户停止流式计算的时候，务必关闭该数据流。 -### 数据订阅接口 +## 数据订阅接口 订阅 API 目前支持订阅一张或多张表，并通过定期轮询的方式不断获取写入表中的最新数据。 diff --git a/docs-cn/14-reference/03-connector/csharp.mdx b/docs-cn/14-reference/03-connector/csharp.mdx index d5fd1fddf37f2ab2a1acf4e547169b0432d2feb3..bde89dbeed05d0bbd08a3cd2f1f23e34c441725a 100644 --- a/docs-cn/14-reference/03-connector/csharp.mdx +++ b/docs-cn/14-reference/03-connector/csharp.mdx @@ -1,9 +1,10 @@ --- sidebar_position: 7 sidebar_label: C# +title: C# Connector --- -# C# 连接器 +## 简介 - C# 连接器支持的系统有：Linux 64/Windows x64/Windows x86 diff --git a/docs-cn/14-reference/03-connector/go.mdx b/docs-cn/14-reference/03-connector/go.mdx index 859775500e0a4e23de621d144fee243b9eb6c76e..5919278086120a76c6dbfcbfaf74eb67ed35607f 100644 --- a/docs-cn/14-reference/03-connector/go.mdx +++ b/docs-cn/14-reference/03-connector/go.mdx @@ -1,9 +1,8 @@ --- sidebar_position: 4 +title: Go Connector --- -# Go Connector - ## 安装准备 Go 连接器支持的系统有： diff --git a/docs-cn/14-reference/03-connector/java.mdx b/docs-cn/14-reference/03-connector/java.mdx index a65e314e9bdb0c3d543d16fa8b57c0b04d80a620..58ddf0db5efb1ac7e95f93aeed67c2e5dea97c9f 100644 --- a/docs-cn/14-reference/03-connector/java.mdx +++ b/docs-cn/14-reference/03-connector/java.mdx @@ -1,9 +1,8 @@ --- sidebar_position: 2 +title: Java Connector --- -# Java Connector - ## 总体介绍 `taos-jdbcdriver` 的实现包括 2 种形式： JDBC-JNI 和 JDBC-RESTful（taos-jdbcdriver-2.0.18 开始支持 JDBC-RESTful）。 JDBC-JNI 通过调用客户端 libtaos.so（或 taos.dll ）的本地方法实现， JDBC-RESTful 则在内部封装了 RESTful 接口实现。 diff --git a/docs-cn/14-reference/03-connector/node.mdx b/docs-cn/14-reference/03-connector/node.mdx index c19038c38d83d01f6da5b707fa2d8fe0e2875b93..5e6f5a0bd9a692fa4e3def4f8e730620380f3706 100644 --- a/docs-cn/14-reference/03-connector/node.mdx +++ b/docs-cn/14-reference/03-connector/node.mdx @@ -1,8 +1,9 @@ --- sidebar_position: 5 +title: Node.js Connector --- -# Node.js Connector +## 简介 Node.js 连接器支持的系统有： diff --git a/docs-cn/14-reference/03-connector/python.mdx b/docs-cn/14-reference/03-connector/python.mdx index 9baf9e0edf6f57a24a728ba88ac2a18e187aef46..eacad9d2e3804d5371a05ba0dff9acfd97ef77f0 100644 --- a/docs-cn/14-reference/03-connector/python.mdx +++ b/docs-cn/14-reference/03-connector/python.mdx @@ -1,15 +1,15 @@ --- sidebar_position: 3 +title: Python Connector --- -# Python Connector Python 连接器的使用参见[视频教程](https://www.taosdata.com/blog/2020/11/11/1963.html) - **安装**：参见下面具体步骤 - **示例程序**：位于 install_directory/examples/python -### 安装 +## 安装 Python 连接器支持的系统有：Linux 64/Windows x64 @@ -19,7 +19,7 @@ Python 连接器支持的系统有：Linux 64/Windows x64 - 已安装 python 2.7 or >= 3.4 - 已安装 pip -### Python 连接器安装 +## Python 连接器安装 Python 连接器可以通过 `pip` 从 PyPI 下载安装。注意 TDengine Python 连接器的包名为 `taospy` 而不是 `taos`（这是一个与 TDengine 无关的另一个程序）。但为保持向后兼容性，仍然使用 `import taos` 导入。 @@ -38,7 +38,7 @@ Python 命令行依赖 taos 动态库 `libtaos.so` 或 `taos.dll`, 对于 Window 对于无法联网用户，可以将 TDengine 客户端中的 `connector/python` 路径（Linux 下其安装路径为 `/usr/local/taos/connector/python/`，Windows 下默认安装路径为 `C:\TDengine\connector\python`）添加到 `PYTHONPATH` 环境变量中使用。 -### 示例程序 +## 示例程序 示例程序源码位于 `/examples/python`，有： @@ -58,7 +58,7 @@ Python 命令行依赖 taos 动态库 `libtaos.so` 或 `taos.dll`, 对于 Window - 如果执行的是查询语句，则 execute 执行成功后，需要通过 fetchall 方法去拉取结果集。 具体方法可以参考示例代码。 -### 安装验证 +## 安装验证 运行如下指令： @@ -69,9 +69,8 @@ python3 PythonChecker.py -host 验证通过将打印出成功信息。 -### Python 连接器的使用 -#### PEP-249 兼容 API +## PEP-249 兼容 API 您可以像其他数据库一样，使用类似 [PEP-249](https://www.python.org/dev/peps/pep-0249/) 数据库 API 规范风格的 API： @@ -87,7 +86,7 @@ for row in results: print(row) ``` -##### 代码示例 +### 代码示例 1. 导入 TDengine 客户端模块 @@ -144,7 +143,7 @@ for row in results: print("ts=%s, temperature=%d, humidity=%f" %(data[0], data[1], data[2])) ``` -#### Query API +## Query API 从 v2.1.0 版本开始, 我们提供另外一种方法：`connection.query` 来操作数据库。 @@ -183,7 +182,7 @@ conn.execute("drop database pytest") - `errstr`: 错误信息 - `close`: 关闭结果对象，一般不需要直接调用 -#### 订阅 API +## 订阅 API 1. 创建一个同步订阅队列： @@ -214,7 +213,7 @@ conn.execute("drop database pytest") conn.close() ``` -#### JSON 类型 +## JSON 类型 从 `taospy` `v2.2.0` 开始，Python 连接器开始支持 JSON 数据类型的标签（TDengine 版本要求 Beta 版 2.3.5+， 稳定版 2.4.0+）。 @@ -257,14 +256,14 @@ k1 = conn.query("select info->'k1' as k1 from s1").fetch_all_into_dict() 更多 JSON 类型的操作方式请参考 [JSON 类型使用说明](https://www.taosdata.com/cn/documentation/taos-sql)。 -#### 关于纳秒 (nanosecond) 在 Python 连接器中的说明 +## 关于纳秒 (nanosecond) 在 Python 连接器中的说明 由于目前 Python 对 nanosecond 支持的不完善(参见链接 1. 2. )，目前的实现方式是在 nanosecond 精度时返回整数，而不是 ms 和 us 返回的 datetime 类型，应用开发者需要自行处理，建议使用 pandas 的 to_datetime()。未来如果 Python 正式完整支持了纳秒，涛思数据可能会修改相关接口。 1. https://stackoverflow.com/questions/10611328/parsing-datetime-strings-containing-nanoseconds 2. https://www.python.org/dev/peps/pep-0564/ -#### 帮助信息 +## 帮助信息 用户可通过 python 的帮助信息直接查看模块的使用信息，或者参考 tests/examples/python 中的示例程序。以下为部分常用类和方法： diff --git a/docs-cn/14-reference/03-connector/rust.mdx b/docs-cn/14-reference/03-connector/rust.mdx index ab09f605e82af55ee893951aefae817cf5c423db..73e0c8b3f2533adcfe95cf9dfd341d3900fd0d73 100644 --- a/docs-cn/14-reference/03-connector/rust.mdx +++ b/docs-cn/14-reference/03-connector/rust.mdx @@ -1,4 +1,6 @@ -# Rust Connector +--- +title: Rust Connector +--- ![Crates.io](https://img.shields.io/crates/v/libtaos) ![Crates.io](https://img.shields.io/crates/d/libtaos) diff --git a/docs-cn/14-reference/05-support-platform/05-support-platform.md b/docs-cn/14-reference/05-support-platform/05-support-platform.md index 35fb659b08c6fb9426d76cbb0d854e39a82f226d..11374e4deb44de4a08ce5c239cd6166014e7ee1d 100644 --- a/docs-cn/14-reference/05-support-platform/05-support-platform.md +++ b/docs-cn/14-reference/05-support-platform/05-support-platform.md @@ -1,4 +1,6 @@ -# 支持平台列表 +--- +title: 支持平台列表 +--- ## TDengine 服务端支持的平台列表 diff --git a/docs-cn/14-reference/06-keywords/06-keywords.md b/docs-cn/14-reference/06-keywords/06-keywords.md index e43d09e8123b46b51c04c2359d1f43e17d569c4c..608d4e080967cfd97072706cf0963ae669960be6 100644 --- a/docs-cn/14-reference/06-keywords/06-keywords.md +++ b/docs-cn/14-reference/06-keywords/06-keywords.md @@ -1,7 +1,7 @@ --- sidebar_label: 参数限制与保留关键字 +title: TDengine 参数限制与保留关键字 --- -# TDengine 参数限制与保留关键字 ## 名称命名规则 diff --git a/docs-cn/14-reference/07-docker/07-docker.md b/docs-cn/14-reference/07-docker/07-docker.md index 3efcd0bace13c0b391f06a312e0affb7991610bd..6960db08b271b628d5c3c451865e4a7187b1712f 100644 --- a/docs-cn/14-reference/07-docker/07-docker.md +++ b/docs-cn/14-reference/07-docker/07-docker.md @@ -1,4 +1,6 @@ -# 用 Docker 部署 TDengine +--- +title: 用 Docker 部署 TDengine +--- 本章主要介绍如何在容器中启动 TDengine 服务并访问它。 注意：可以在 docker run 命令行中或者 docker-compose 文件中使用环境变量来控制容器中服务的行为。 diff --git a/docs-cn/14-reference/08-server-config/08-server-config.md b/docs-cn/14-reference/08-server-config/08-server-config.md index 844aa21c4378e892e1379e28b5501f8eaceb4750..328d0d96cde7375ee39b5774e49829a73f5cdd31 100644 --- a/docs-cn/14-reference/08-server-config/08-server-config.md +++ b/docs-cn/14-reference/08-server-config/08-server-config.md @@ -1,4 +1,6 @@ -# 服务端配置 +--- +title: 服务端配置 +--- TDengine 系统后台服务由 taosd 提供，可以在配置文件 taos.cfg 里修改配置参数，以满足不同场景的需求。配置文件的缺省位置在/etc/taos 目录，可以通过 taosd 命令行执行参数 -c 指定配置文件目录。比如，指定配置文件位于`/home/user` 这个目录： diff --git a/docs-cn/14-reference/09-client-config/09-client-config.md b/docs-cn/14-reference/09-client-config/09-client-config.md index 15ca79b029d8194c5af0c43ab579aac8727b06d4..c32861c6f76b4b5a090e3d52498243a27672136a 100644 --- a/docs-cn/14-reference/09-client-config/09-client-config.md +++ b/docs-cn/14-reference/09-client-config/09-client-config.md @@ -1,4 +1,6 @@ -# 客户端及应用驱动配置 +--- +title: 客户端及应用驱动配置 +--- TDengine 系统的前台交互客户端应用程序为 taos，以及应用驱动，它与 taosd 共享同一个配置文件 taos.cfg。运行 taos 时，使用参数-c 指定配置文件目录，如 taos -c /home/cfg，表示使用/home/cfg/目录下的 taos.cfg 配置文件中的参数，缺省目录是/etc/taos。更多 taos 的使用方法请见帮助信息 `taos --help`。本节主要说明 taos 客户端应用在配置文件 taos.cfg 文件中使用到的参数。 diff --git a/docs-cn/14-reference/12-direcotry.md b/docs-cn/14-reference/12-direcotry.md index c2746de1c1dd98f9ffa715680d4a1048cd3e8c02..4c0fbec5a5d0c678ad1b797a8ebc9ae5b7ec6faf 100644 --- a/docs-cn/14-reference/12-direcotry.md +++ b/docs-cn/14-reference/12-direcotry.md @@ -1,4 +1,6 @@ -# 文件目录结构 +--- +title: 文件目录结构 +--- 安装 TDengine 后，默认会在操作系统中生成下列目录或文件： diff --git a/docs-cn/14-reference/13-schemaless/13-schemaless.md b/docs-cn/14-reference/13-schemaless/13-schemaless.md index 1c5fbea726eb5153d4db0ef6d42ef53b478232f5..2f5430e13c9eb2f0063293b7b562386113478e48 100644 --- a/docs-cn/14-reference/13-schemaless/13-schemaless.md +++ b/docs-cn/14-reference/13-schemaless/13-schemaless.md @@ -1,4 +1,6 @@ -# Schemaless 写入 +--- +title: Schemaless 写入 +--- ## 前言 diff --git a/docs-cn/15-application/01-telegraf.md b/docs-cn/15-application/01-telegraf.md index a23240debebbbf4a9da023f904562f04276f5b12..87f74fa67fbdbc3e4c5631b9cd393c4a78d3e25e 100644 --- a/docs-cn/15-application/01-telegraf.md +++ b/docs-cn/15-application/01-telegraf.md @@ -1,9 +1,8 @@ --- sidebar_label: TDengine + Telegraf + Grafana +title: 使用 TDengine + Telegraf + Grafana 快速搭建 IT 运维展示系统 --- -# 使用 TDengine + Telegraf + Grafana 快速搭建 IT 运维展示系统 - ## 背景介绍 TDengine 是涛思数据专为物联网、车联网、工业互联网、IT 运维等设计和优化的大数据平台。自从 2019 年 7 月开源以来，凭借创新的数据建模设计、快捷的安装方式、易用的编程接口和强大的数据写入查询性能博得了大量时序数据开发者的青睐。 diff --git a/docs-cn/15-application/02-collectd.md b/docs-cn/15-application/02-collectd.md index 10f8eff8b7ade5a66357fb095a600fa453f53731..0d37d7f6cda01425d4fe14763d2f86b45ded88bd 100644 --- a/docs-cn/15-application/02-collectd.md +++ b/docs-cn/15-application/02-collectd.md @@ -1,9 +1,8 @@ --- sidebar_label: TDengine + collectd/StatsD + Grafana +title: 使用 TDengine + collectd/StatsD + Grafana 快速搭建 IT 运维监控系统 --- -# 使用 TDengine + collectd/StatsD + Grafana 快速搭建 IT 运维监控系统 - ## 背景介绍 TDengine 是涛思数据专为物联网、车联网、工业互联网、IT 运维等设计和优化的大数据平台。自从 2019 年 7 月开源以来，凭借创新的数据建模设计、快捷的安装方式、易用的编程接口和强大的数据写入查询性能博得了大量时序数据开发者的青睐。 diff --git a/docs-cn/15-application/03-immigrate.md b/docs-cn/15-application/03-immigrate.md index 1e3087c06f40ae393ad55f71b534ca0cf424cb74..86b9a666535e85a85d045bb09092d0211332c5df 100644 --- a/docs-cn/15-application/03-immigrate.md +++ b/docs-cn/15-application/03-immigrate.md @@ -1,9 +1,8 @@ --- sidebar_label: OpenTSDB 迁移到 TDengine +title: OpenTSDB 应用迁移到 TDengine 的最佳实践 --- -# OpenTSDB 应用迁移到 TDengine 的最佳实践 - 作为一个分布式、可伸缩、基于 HBase 的分布式时序数据库系统，得益于其先发优势，OpenTSDB 被 DevOps 领域的人员引入并广泛地应用在了运维监控领域。但最近几年，随着云计算、微服务、容器化等新技术快速落地发展，企业级服务种类变得越来越多，架构也越来越复杂，应用运行基础环境日益多样化，给系统和运行监控带来的压力也越来越大。从这一现状出发，使用 OpenTSDB 作为 DevOps 的监控后端存储，越来越受困于其性能问题以及迟缓的功能升级，以及由此而衍生出来的应用部署成本上升和运行效率降低等问题，这些问题随着系统规模的扩大日益严重。 在这一背景下，为满足高速增长的物联网大数据市场和技术需求，在吸取众多传统关系型数据库、NoSQL 数据库、流计算引擎、消息队列等软件的优点之后，涛思数据自主开发出创新型大数据处理产品 TDengine。在时序大数据处理上，TDengine 有着自己独特的优势。就 OpenTSDB 当前遇到的问题来说，TDengine 能够有效解决。 diff --git a/docs-cn/16-iot-big-data/index.md b/docs-cn/16-iot-big-data/index.md index 5687dd3fda161c426108dba298b73fc4db949c28..6a4b9c301ca5ca78f61abe78638e2dfc8f9ac6d6 100644 --- a/docs-cn/16-iot-big-data/index.md +++ b/docs-cn/16-iot-big-data/index.md @@ -1,5 +1,6 @@ -# 物联网大数据 - +--- +title: 物联网大数据 +--- - [物联网、工业互联网大数据的特点](https://www.taosdata.com/blog/2019/07/09/105.html) - [物联网大数据平台应具备的功能和特点](https://www.taosdata.com/blog/2019/07/29/542.html) diff --git a/docs-cn/17-train-fqa/01-faq.md b/docs-cn/17-train-fqa/01-faq.md index 9f3baccf7f765325129ac72bd4e62ede0c7e8e87..3e44c502f7753e1a076d2859f08de95153de4552 100644 --- a/docs-cn/17-train-fqa/01-faq.md +++ b/docs-cn/17-train-fqa/01-faq.md @@ -1,4 +1,6 @@ -# 常见问题及反馈 +--- +title: 常见问题及反馈 +--- ## 问题反馈 diff --git a/docs-cn/17-train-fqa/02-video.mdx b/docs-cn/17-train-fqa/02-video.mdx index 767b154fd34f3898a269bb505999a9de2bf11799..b644412332fe817ea7fdc2c9ddc176ecc9858c56 100644 --- a/docs-cn/17-train-fqa/02-video.mdx +++ b/docs-cn/17-train-fqa/02-video.mdx @@ -1,6 +1,6 @@ -# 视频教程 - -## +--- +title: 视频教程 +--- ## 技术公开课 diff --git a/docs-cn/17-train-fqa/03-docker.md b/docs-cn/17-train-fqa/03-docker.md index 54b94c9abae50d5a6581ed4bce321bc5d5e761f3..5bb6934b1359a90f496228b8d0e811e061b6548c 100644 --- a/docs-cn/17-train-fqa/03-docker.md +++ b/docs-cn/17-train-fqa/03-docker.md @@ -1,4 +1,6 @@ -# 通过 Docker 快速体验 TDengine +--- +title: 通过 Docker 快速体验 TDengine +--- 虽然并不推荐在生产环境中通过 Docker 来部署 TDengine 服务，但 Docker 工具能够很好地屏蔽底层操作系统的环境差异，很适合在开发测试或初次体验时用于安装运行 TDengine 的工具集。特别是，借助 Docker，能够比较方便地在 macOS 和 Windows 系统上尝试 TDengine，而无需安装虚拟机或额外租用 Linux 服务器。另外，从 2.0.14.0 版本开始，TDengine 提供的镜像已经可以同时支持 X86-64、X86、arm64、arm32 平台，像 NAS、树莓派、嵌入式开发板之类可以运行 docker 的非主流计算机也可以基于本文档轻松体验 TDengine。