diff --git a/docs/en/01-index.md b/docs/en/01-index.md index 13552ea9dcfbae71a368cad9d55b4a0030ac266a..296cd968986d5dd7738d6c3b997901614f893763 100644 --- a/docs/en/01-index.md +++ b/docs/en/01-index.md @@ -1,6 +1,7 @@ --- title: TDengine Documentation sidebar_label: Documentation Home +description: This website contains the user manuals for TDengine, an open-source, cloud-native time-series database optimized for IoT, Connected Cars, and Industrial IoT. slug: / --- diff --git a/docs/en/02-intro/index.md b/docs/en/02-intro/index.md index a60bfab2ccd30fb585d72ee14054029b1c176a66..95dd4324f145800c139272381d2a07a40a2b5ce9 100644 --- a/docs/en/02-intro/index.md +++ b/docs/en/02-intro/index.md @@ -1,5 +1,6 @@ --- title: Introduction +description: This document introduces the major features, competitive advantages, typical use cases, and benchmarks of TDengine. toc_max_heading_level: 2 --- diff --git a/docs/en/04-concept/index.md b/docs/en/04-concept/index.md index 0b1b226c17100d56313b5480e26f437841afe8c7..771a061c310bd53c485394fe3a8897567b12e48b 100644 --- a/docs/en/04-concept/index.md +++ b/docs/en/04-concept/index.md @@ -1,5 +1,6 @@ --- title: Concepts +description: This document describes the basic concepts of TDengine, including the supertable. --- In order to explain the basic concepts and provide some sample code, the TDengine documentation smart meters as a typical time series use case. We assume the following: 1. Each smart meter collects three metrics i.e. current, voltage, and phase; 2. There are multiple smart meters; 3. Each meter has static attributes like location and group ID. Based on this, collected data will look similar to the following table: diff --git a/docs/en/05-get-started/01-docker.md b/docs/en/05-get-started/01-docker.md index ac273daba48d39bd0777ffdb30f431c6521d13b3..42e6861674434ad9800f69dcf00fe80a140e9bf7 100644 --- a/docs/en/05-get-started/01-docker.md +++ b/docs/en/05-get-started/01-docker.md @@ -1,6 +1,7 @@ --- -sidebar_label: Docker title: Quick Install on Docker +sidebar_label: Docker +description: This document describes how to install TDengine in a Docker container and perform queries and inserts. --- This document describes how to install TDengine in a Docker container and perform queries and inserts. diff --git a/docs/en/05-get-started/03-package.md b/docs/en/05-get-started/03-package.md index 54d2e046c214f2df8ecd5ff03b7d5108c701938d..a0c1d939831395da596ecf15247c46b5a5188a14 100644 --- a/docs/en/05-get-started/03-package.md +++ b/docs/en/05-get-started/03-package.md @@ -1,6 +1,7 @@ --- -sidebar_label: Package title: Quick Install from Package +sidebar_label: Package +description: This document describes how to install TDengine on Linux, Windows, and macOS and perform queries and inserts. --- import Tabs from "@theme/Tabs"; diff --git a/docs/en/05-get-started/index.md b/docs/en/05-get-started/index.md index 12cfa22c69b1db8e82de4cb251ca3d8c67fc4546..66573a89cd6e181192132cc0b304f415fa25b89c 100644 --- a/docs/en/05-get-started/index.md +++ b/docs/en/05-get-started/index.md @@ -1,6 +1,6 @@ --- title: Get Started -description: This article describes how to install TDengine and test its performance. +description: This document describes how to install TDengine on various platforms. --- import GitHubSVG from './github.svg' diff --git a/docs/en/07-develop/01-connect/index.md b/docs/en/07-develop/01-connect/index.md index 45bbaa2751a6ac6c04b4d6a7fcb00dd0fe03f638..913c24f1896e3c2af6614fc07e9319c6fb06783f 100644 --- a/docs/en/07-develop/01-connect/index.md +++ b/docs/en/07-develop/01-connect/index.md @@ -1,7 +1,7 @@ --- -sidebar_label: Connect title: Connect to TDengine -description: "How to establish connections to TDengine and how to install and use TDengine connectors." +sidebar_label: Connect +description: This document describes how to establish connections to TDengine and how to install and use TDengine connectors. --- import Tabs from "@theme/Tabs"; diff --git a/docs/en/07-develop/02-model/index.mdx b/docs/en/07-develop/02-model/index.mdx index 19a239805f1492eae0c463f5a942378b83ecf6b8..db5a259cfe6f8cc1fec6c588ec9b31888334ca06 100644 --- a/docs/en/07-develop/02-model/index.mdx +++ b/docs/en/07-develop/02-model/index.mdx @@ -1,5 +1,6 @@ --- title: Data Model +description: This document describes the data model of TDengine. --- The data model employed by TDengine is similar to that of a relational database. You have to create databases and tables. You must design the data model based on your own business and application requirements. You should design the [STable](/concept/#super-table-stable) (an abbreviation for super table) schema to fit your data. This chapter will explain the big picture without getting into syntactical details. diff --git a/docs/en/07-develop/03-insert-data/01-sql-writing.mdx b/docs/en/07-develop/03-insert-data/01-sql-writing.mdx index f2168645ff9e59d60e88c85f86e890945b9f336c..32ba53a0cb25b403dd93c2b8c758dc54cdcc0d15 100644 --- a/docs/en/07-develop/03-insert-data/01-sql-writing.mdx +++ b/docs/en/07-develop/03-insert-data/01-sql-writing.mdx @@ -1,5 +1,6 @@ --- title: Insert Using SQL +description: This document describes how to insert data into TDengine using SQL. --- import Tabs from "@theme/Tabs"; diff --git a/docs/en/07-develop/03-insert-data/20-kafka-writting.mdx b/docs/en/07-develop/03-insert-data/20-kafka-writting.mdx index ffb969a8a6d0bc61e23fee44f245a24236db5b1b..89ca10b669d094a156f55439429e329308e71935 100644 --- a/docs/en/07-develop/03-insert-data/20-kafka-writting.mdx +++ b/docs/en/07-develop/03-insert-data/20-kafka-writting.mdx @@ -1,5 +1,6 @@ --- title: Write from Kafka +description: This document describes how to insert data into TDengine using Kafka. --- import Tabs from "@theme/Tabs"; diff --git a/docs/en/07-develop/03-insert-data/30-influxdb-line.mdx b/docs/en/07-develop/03-insert-data/30-influxdb-line.mdx index fc5644850cbedcb91de2aebca29070dc3c021551..c559883d26c7ef5750f3ee1f828912f8d800c3a4 100644 --- a/docs/en/07-develop/03-insert-data/30-influxdb-line.mdx +++ b/docs/en/07-develop/03-insert-data/30-influxdb-line.mdx @@ -1,6 +1,7 @@ --- -sidebar_label: InfluxDB Line Protocol title: InfluxDB Line Protocol +sidebar_label: InfluxDB Line Protocol +description: This document describes how to insert data into TDengine using the InfluxDB Line Protocol. --- import Tabs from "@theme/Tabs"; diff --git a/docs/en/07-develop/03-insert-data/40-opentsdb-telnet.mdx b/docs/en/07-develop/03-insert-data/40-opentsdb-telnet.mdx index 5d3f25dca96a0d41a4562aa067800607e8e04277..30bc3b87bf035f563e1a03508a90466e9288f89c 100644 --- a/docs/en/07-develop/03-insert-data/40-opentsdb-telnet.mdx +++ b/docs/en/07-develop/03-insert-data/40-opentsdb-telnet.mdx @@ -1,6 +1,7 @@ --- -sidebar_label: OpenTSDB Line Protocol title: OpenTSDB Line Protocol +sidebar_label: OpenTSDB Line Protocol +description: This document describes how to insert data into TDengine using the OpenTSDB Line Protocol. --- import Tabs from "@theme/Tabs"; diff --git a/docs/en/07-develop/03-insert-data/50-opentsdb-json.mdx b/docs/en/07-develop/03-insert-data/50-opentsdb-json.mdx index 214580c179b97f46f94096411c57bf0004dc68e3..e9db130241236e7224e5965c4c3c651ddab8cb00 100644 --- a/docs/en/07-develop/03-insert-data/50-opentsdb-json.mdx +++ b/docs/en/07-develop/03-insert-data/50-opentsdb-json.mdx @@ -1,6 +1,7 @@ --- -sidebar_label: OpenTSDB JSON Protocol title: OpenTSDB JSON Protocol +sidebar_label: OpenTSDB JSON Protocol +description: This document describes how to insert data into TDengine using the OpenTSDB JSON protocol. --- import Tabs from "@theme/Tabs"; diff --git a/docs/en/07-develop/03-insert-data/60-high-volume.md b/docs/en/07-develop/03-insert-data/60-high-volume.md index 272a13881372b58a9a66c0d452cda54f9ee8c78c..d5afa8ef6ec120fa73854f5ca170504d7dd69b39 100644 --- a/docs/en/07-develop/03-insert-data/60-high-volume.md +++ b/docs/en/07-develop/03-insert-data/60-high-volume.md @@ -1,6 +1,7 @@ --- -sidebar_label: High Performance Writing title: High Performance Writing +sidebar_label: High Performance Writing +description: This document describes how to achieve high performance when writing data into TDengine. --- import Tabs from "@theme/Tabs"; diff --git a/docs/en/07-develop/03-insert-data/index.md b/docs/en/07-develop/03-insert-data/index.md index 1a71e719a56448e4b535632e570ce8a04d2282bb..15f8f4ee9e9b24e6b511e6d29505c7b99fea3ae8 100644 --- a/docs/en/07-develop/03-insert-data/index.md +++ b/docs/en/07-develop/03-insert-data/index.md @@ -1,5 +1,6 @@ --- title: Insert Data +description: This document describes how to insert data into TDengine. --- TDengine supports multiple protocols of inserting data, including SQL, InfluxDB Line protocol, OpenTSDB Telnet protocol, and OpenTSDB JSON protocol. Data can be inserted row by row, or in batches. Data from one or more collection points can be inserted simultaneously. Data can be inserted with multiple threads, and out of order data and historical data can be inserted as well. InfluxDB Line protocol, OpenTSDB Telnet protocol and OpenTSDB JSON protocol are the 3 kinds of schemaless insert protocols supported by TDengine. It's not necessary to create STables and tables in advance if using schemaless protocols, and the schemas can be adjusted automatically based on the data being inserted. diff --git a/docs/en/07-develop/04-query-data/index.mdx b/docs/en/07-develop/04-query-data/index.mdx index 38dc98d1ff262c7f8ec4951297e6f42e436682c8..7e167bb4f342167c486403259985976357e44496 100644 --- a/docs/en/07-develop/04-query-data/index.mdx +++ b/docs/en/07-develop/04-query-data/index.mdx @@ -1,6 +1,6 @@ --- title: Query Data -description: "This chapter introduces major query functionalities and how to perform sync and async query using connectors." +description: This document describes how to query data in TDengine and how to perform synchronous and asynchronous queries using connectors. --- import Tabs from "@theme/Tabs"; diff --git a/docs/en/07-develop/06-stream.md b/docs/en/07-develop/06-stream.md index 36f903ee9a4f2d210e63d0b79e702bc199f790ed..125173e60bae77bbbe782363ebd2103cf7e4b703 100644 --- a/docs/en/07-develop/06-stream.md +++ b/docs/en/07-develop/06-stream.md @@ -1,7 +1,7 @@ --- -sidebar_label: Stream Processing -description: "The TDengine stream processing engine combines data inserts, preprocessing, analytics, real-time computation, and alerting into a single component." title: Stream Processing +sidebar_label: Stream Processing +description: This document describes the stream processing component of TDengine. --- Raw time-series data is often cleaned and preprocessed before being permanently stored in a database. In a traditional time-series solution, this generally requires the deployment of stream processing systems such as Kafka or Flink. However, the complexity of such systems increases the cost of development and maintenance. diff --git a/docs/en/07-develop/08-cache.md b/docs/en/07-develop/08-cache.md index 82a4787016f608f8e32e89b1747443b7cd164551..6a6ca3e5947b6a3233f90e5e0a01417e6be3b19d 100644 --- a/docs/en/07-develop/08-cache.md +++ b/docs/en/07-develop/08-cache.md @@ -1,7 +1,7 @@ --- -sidebar_label: Caching title: Caching -description: "This document describes the caching component of TDengine." +sidebar_label: Caching +description: This document describes the caching component of TDengine. --- TDengine uses various kinds of caching techniques to efficiently write and query data. This document describes the caching component of TDengine. diff --git a/docs/en/07-develop/09-udf.md b/docs/en/07-develop/09-udf.md index 699b3ebe5f7cddaa6f56cb8027c784a5821a7a0d..553a7b932b013a1f4d2b5e4e291f71c28b64039f 100644 --- a/docs/en/07-develop/09-udf.md +++ b/docs/en/07-develop/09-udf.md @@ -1,7 +1,7 @@ --- -sidebar_label: UDF title: User-Defined Functions (UDF) -description: "You can define your own scalar and aggregate functions to expand the query capabilities of TDengine." +sidebar_label: UDF +description: This document describes how to create user-defined functions (UDF), your own scalar and aggregate functions that can expand the query capabilities of TDengine. --- The built-in functions of TDengine may not be sufficient for the use cases of every application. In this case, you can define custom functions for use in TDengine queries. These are known as user-defined functions (UDF). A user-defined function takes one column of data or the result of a subquery as its input. diff --git a/docs/en/07-develop/index.md b/docs/en/07-develop/index.md index 34649d32a2f758fda2bd79afbbd8f3427b714353..8f80b82b970c576945eee6f972bd901d910614a9 100644 --- a/docs/en/07-develop/index.md +++ b/docs/en/07-develop/index.md @@ -1,5 +1,6 @@ --- title: Developer Guide +description: This document describes how to use the various components of TDengine from a developer's perspective. --- Before creating an application to process time-series data with TDengine, consider the following: diff --git a/docs/en/10-deployment/01-deploy.md b/docs/en/10-deployment/01-deploy.md index 5dfcd3108d8b10cf24cdd5c852c4225ced0f16b2..da00e21a7ec7c7a34c0a3ae60b2928bd3b036cc4 100644 --- a/docs/en/10-deployment/01-deploy.md +++ b/docs/en/10-deployment/01-deploy.md @@ -1,6 +1,7 @@ --- -sidebar_label: Manual Deployment title: Manual Deployment and Management +sidebar_label: Manual Deployment +description: This document describes how to deploy TDengine on a server. --- ## Prerequisites diff --git a/docs/en/10-deployment/03-k8s.md b/docs/en/10-deployment/03-k8s.md index b0aa6777130864404e97dc332cf0e5ce830bf8ed..49e61caafce6414a10c4bc1937ce13394a7da9eb 100644 --- a/docs/en/10-deployment/03-k8s.md +++ b/docs/en/10-deployment/03-k8s.md @@ -1,6 +1,7 @@ --- -sidebar_label: Kubernetes title: Deploying a TDengine Cluster in Kubernetes +sidebar_label: Kubernetes +description: This document describes how to deploy TDengine on Kubernetes. --- TDengine is a cloud-native time-series database that can be deployed on Kubernetes. This document gives a step-by-step description of how you can use YAML files to create a TDengine cluster and introduces common operations for TDengine in a Kubernetes environment. diff --git a/docs/en/10-deployment/05-helm.md b/docs/en/10-deployment/05-helm.md index 90baa5f4459c6d9d01530d5e0c36477d79aa5ab9..aa617176693a576c8dbd37b83a70b1be3b983ef0 100644 --- a/docs/en/10-deployment/05-helm.md +++ b/docs/en/10-deployment/05-helm.md @@ -1,6 +1,7 @@ --- -sidebar_label: Helm title: Use Helm to deploy TDengine +sidebar_label: Helm +description: This document describes how to deploy TDengine on Kubernetes by using Helm. --- Helm is a package manager for Kubernetes that can provide more capabilities in deploying on Kubernetes. diff --git a/docs/en/10-deployment/index.md b/docs/en/10-deployment/index.md index 7054a33e4a40222ed5eb9a15837990e3e7a81cff..865fbc2da57bb985dabc03a743c5e0f7186b98be 100644 --- a/docs/en/10-deployment/index.md +++ b/docs/en/10-deployment/index.md @@ -1,5 +1,6 @@ --- title: Deployment +description: This document describes how to deploy a TDengine cluster on a server, on Kubernetes, and by using Helm. --- TDengine has a native distributed design and provides the ability to scale out. A few nodes can form a TDengine cluster. If you need higher processing power, you just need to add more nodes into the cluster. TDengine uses virtual node technology to virtualize a node into multiple virtual nodes to achieve load balancing. At the same time, TDengine can group virtual nodes on different nodes into virtual node groups, and use the replication mechanism to ensure the high availability of the system. The cluster feature of TDengine is completely open source. diff --git a/docs/en/12-taos-sql/01-data-type.md b/docs/en/12-taos-sql/01-data-type.md index 60046629a4c6f89ccfe9b20adcbb2fdba2ffb261..641fd3cbb7c4e2937cc1756a41a522f6eb4b51aa 100644 --- a/docs/en/12-taos-sql/01-data-type.md +++ b/docs/en/12-taos-sql/01-data-type.md @@ -1,7 +1,7 @@ --- -sidebar_label: Data Types title: Data Types -description: 'TDengine supports a variety of data types including timestamp, float, JSON and many others.' +sidebar_label: Data Types +description: This document describes the data types that TDengine supports. --- ## Timestamp diff --git a/docs/en/12-taos-sql/02-database.md b/docs/en/12-taos-sql/02-database.md index 059f124ea5b5f380cd72ba55a20b6cf3a80b035e..280d72697cd1fc72e754d48b56fa9a36bd8de40e 100644 --- a/docs/en/12-taos-sql/02-database.md +++ b/docs/en/12-taos-sql/02-database.md @@ -1,7 +1,7 @@ --- -sidebar_label: Database title: Database -description: "create and drop database, show or change database parameters" +sidebar_label: Database +description: This document describes how to create and perform operations on databases. --- ## Create a Database diff --git a/docs/en/12-taos-sql/03-table.md b/docs/en/12-taos-sql/03-table.md index 6d12b8c73056d049997a244ed0ab788742094d65..f61d1f51471bf042aea79023bff4f74c43831eb8 100644 --- a/docs/en/12-taos-sql/03-table.md +++ b/docs/en/12-taos-sql/03-table.md @@ -1,5 +1,6 @@ --- title: Table +description: This document describes how to create and perform operations on standard tables and subtables. --- ## Create Table diff --git a/docs/en/12-taos-sql/04-stable.md b/docs/en/12-taos-sql/04-stable.md index 8a7c713f8cad6d61c8b098583cc4e282b00d48cf..5b316d0d2460b497655e7f29acb897301b5b4769 100644 --- a/docs/en/12-taos-sql/04-stable.md +++ b/docs/en/12-taos-sql/04-stable.md @@ -1,6 +1,7 @@ --- -sidebar_label: Supertable title: Supertable +sidebar_label: Supertable +description: This document describes how to create and perform operations on supertables. --- ## Create a Supertable diff --git a/docs/en/12-taos-sql/05-insert.md b/docs/en/12-taos-sql/05-insert.md index ca3154c25e889b67d51bfdc6d8841d83d6bcfe02..c22357abfa1c9e2a4dece880c407cb4bbfdaa055 100644 --- a/docs/en/12-taos-sql/05-insert.md +++ b/docs/en/12-taos-sql/05-insert.md @@ -1,6 +1,7 @@ --- -sidebar_label: Insert title: Insert +sidebar_label: Insert +description: This document describes how to insert data into TDengine. --- ## Syntax diff --git a/docs/en/12-taos-sql/06-select.md b/docs/en/12-taos-sql/06-select.md index ee06a7be2d3172210bf35302d5bffbf7a49adabc..183ab58726d0b07b32430df5e1b9d87f41e90ba0 100644 --- a/docs/en/12-taos-sql/06-select.md +++ b/docs/en/12-taos-sql/06-select.md @@ -1,6 +1,7 @@ --- -sidebar_label: Select title: Select +sidebar_label: Select +description: This document describes how to query data in TDengine. --- ## Syntax diff --git a/docs/en/12-taos-sql/08-delete-data.mdx b/docs/en/12-taos-sql/08-delete-data.mdx index 999c467ad05b6d3e349e322141acfb02a49de5ff..f91a89a7ebe86a7699f5c9a3fd6d3bca200c1445 100644 --- a/docs/en/12-taos-sql/08-delete-data.mdx +++ b/docs/en/12-taos-sql/08-delete-data.mdx @@ -1,7 +1,7 @@ --- -sidebar_label: Delete Data -description: "Delete data from table or Stable" title: Delete Data +sidebar_label: Delete Data +description: This document describes how to delete data from TDengine. --- TDengine provides the functionality of deleting data from a table or STable according to specified time range, it can be used to cleanup abnormal data generated due to device failure. diff --git a/docs/en/12-taos-sql/10-function.md b/docs/en/12-taos-sql/10-function.md index 802eb259bf72687f9c75cdb34e3520040d3c9010..b2d44f1a1d4ad2a40de6163db64f8672a956bbe4 100644 --- a/docs/en/12-taos-sql/10-function.md +++ b/docs/en/12-taos-sql/10-function.md @@ -1,6 +1,7 @@ --- -sidebar_label: Functions title: Functions +sidebar_label: Functions +description: This document describes the standard SQL functions available in TDengine. toc_max_heading_level: 4 --- diff --git a/docs/en/12-taos-sql/12-distinguished.md b/docs/en/12-taos-sql/12-distinguished.md index 0763e85a53bc6021a2fe28d7df20f627d1b3fbe7..536fd8ffc3968996b8e31b5a2864fd730a7624a7 100644 --- a/docs/en/12-taos-sql/12-distinguished.md +++ b/docs/en/12-taos-sql/12-distinguished.md @@ -1,6 +1,7 @@ --- -sidebar_label: Time-Series Extensions title: Time-Series Extensions +sidebar_label: Time-Series Extensions +description: This document describes the extended functions specific to time-series data processing available in TDengine. --- As a purpose-built database for storing and processing time-series data, TDengine provides time-series-specific extensions to standard SQL. diff --git a/docs/en/12-taos-sql/13-tmq.md b/docs/en/12-taos-sql/13-tmq.md index befab4f4f01e595564e93ffcfbb0723e13294af0..1a805c76fb8e51ad22dd4e8b090860a6e1730a24 100644 --- a/docs/en/12-taos-sql/13-tmq.md +++ b/docs/en/12-taos-sql/13-tmq.md @@ -1,6 +1,7 @@ --- -sidebar_label: Data Subscription title: Data Subscription +sidebar_label: Data Subscription +description: This document describes the SQL statements related to the data subscription component of TDengine. --- The information in this document is related to the TDengine data subscription feature. diff --git a/docs/en/12-taos-sql/14-stream.md b/docs/en/12-taos-sql/14-stream.md index e70e962668d85ea6a84afd86657a7b26df90ccf4..b8f6c3a163e1c2fa37e437725652eabb1a71dbe6 100644 --- a/docs/en/12-taos-sql/14-stream.md +++ b/docs/en/12-taos-sql/14-stream.md @@ -1,6 +1,7 @@ --- -sidebar_label: Stream Processing title: Stream Processing +sidebar_label: Stream Processing +description: This document describes the SQL statements related to the stream processing component of TDengine. --- Raw time-series data is often cleaned and preprocessed before being permanently stored in a database. Stream processing components like Kafka, Flink, and Spark are often deployed alongside a time-series database to handle these operations, increasing system complexity and maintenance costs. diff --git a/docs/en/12-taos-sql/16-operators.md b/docs/en/12-taos-sql/16-operators.md index c426e2879342e430c61c4f8133aa9f8186888941..32ad4e7075b6a510cb537016effb6064e6c51794 100644 --- a/docs/en/12-taos-sql/16-operators.md +++ b/docs/en/12-taos-sql/16-operators.md @@ -1,6 +1,7 @@ --- -sidebar_label: Operators title: Operators +sidebar_label: Operators +description: This document describes the SQL operators available in TDengine. --- ## Arithmetic Operators diff --git a/docs/en/12-taos-sql/17-json.md b/docs/en/12-taos-sql/17-json.md index 77f774303316b466a15226f548f84da69be8f92d..b2494e0cc1a1829d0389b2cf634e5d8575817f57 100644 --- a/docs/en/12-taos-sql/17-json.md +++ b/docs/en/12-taos-sql/17-json.md @@ -1,6 +1,7 @@ --- -sidebar_label: JSON Type title: JSON Type +sidebar_label: JSON Type +description: This document describes the JSON data type in TDengine. --- diff --git a/docs/en/12-taos-sql/18-escape.md b/docs/en/12-taos-sql/18-escape.md index a2ae40de98be677e599e83a634952a39faeaafbf..85e4610e44f1a6f93e9727c32f8333cddf07ecc7 100644 --- a/docs/en/12-taos-sql/18-escape.md +++ b/docs/en/12-taos-sql/18-escape.md @@ -1,5 +1,6 @@ --- title: Escape Characters +description: This document describes the usage of escape characters in TDengine. --- ## Escape Characters diff --git a/docs/en/12-taos-sql/19-limit.md b/docs/en/12-taos-sql/19-limit.md index f00ec90f5755d3d004a35b210f93560c6f719536..654fae7560d3c24df1353b87952a3868ca307418 100644 --- a/docs/en/12-taos-sql/19-limit.md +++ b/docs/en/12-taos-sql/19-limit.md @@ -1,6 +1,7 @@ --- -sidebar_label: Name and Size Limits title: Name and Size Limits +sidebar_label: Name and Size Limits +description: This document describes the name and size limits in TDengine. --- ## Naming Rules diff --git a/docs/en/12-taos-sql/20-keywords.md b/docs/en/12-taos-sql/20-keywords.md index 23f85947e30ae2876cf631124e6485c09f2ff8da..a2191c87ee17444d5341b8e97b33a954be84dc98 100644 --- a/docs/en/12-taos-sql/20-keywords.md +++ b/docs/en/12-taos-sql/20-keywords.md @@ -1,6 +1,7 @@ --- -sidebar_label: Reserved Keywords title: Reserved Keywords +sidebar_label: Reserved Keywords +description: This document describes the reserved keywords in TDengine that cannot be used in object names. --- ## Keyword List diff --git a/docs/en/12-taos-sql/21-node.md b/docs/en/12-taos-sql/21-node.md index a0d49ab208448fa9dd90ef63deb235ef051b0e19..8a5069e66f5111c3c362829cfd654f16a80b60c7 100644 --- a/docs/en/12-taos-sql/21-node.md +++ b/docs/en/12-taos-sql/21-node.md @@ -1,6 +1,7 @@ --- -sidebar_label: Cluster title: Cluster +sidebar_label: Cluster +description: This document describes the SQL statements related to cluster management in TDengine. --- The physical entities that form TDengine clusters are known as data nodes (dnodes). Each dnode is a process running on the operating system of the physical machine. Dnodes can contain virtual nodes (vnodes), which store time-series data. Virtual nodes are formed into vgroups, which have 1 or 3 vnodes depending on the replica setting. If you want to enable replication on your cluster, it must contain at least three nodes. Dnodes can also contain management nodes (mnodes). Each cluster has up to three mnodes. Finally, dnodes can contain query nodes (qnodes), which compute time-series data, thus separating compute from storage. A single dnode can contain a vnode, qnode, and mnode. diff --git a/docs/en/12-taos-sql/22-meta.md b/docs/en/12-taos-sql/22-meta.md index 1cd759742a8714274712343a22cbf723cd9c3212..d2bc72f047a7e18c120a39e426caea70fd711018 100644 --- a/docs/en/12-taos-sql/22-meta.md +++ b/docs/en/12-taos-sql/22-meta.md @@ -1,6 +1,7 @@ --- -sidebar_label: Metadata title: Information_Schema Database +sidebar_label: Metadata +description: This document describes how to use the INFORMATION_SCHEMA database in TDengine. --- TDengine includes a built-in database named `INFORMATION_SCHEMA` to provide access to database metadata, system information, and status information. This information includes database names, table names, and currently running SQL statements. All information related to TDengine maintenance is stored in this database. It contains several read-only tables. These tables are more accurately described as views, and they do not correspond to specific files. You can query these tables but cannot write data to them. The INFORMATION_SCHEMA database is intended to provide a unified method for SHOW commands to access data. However, using SELECT ... FROM INFORMATION_SCHEMA.tablename offers several advantages over SHOW commands: diff --git a/docs/en/12-taos-sql/23-perf.md b/docs/en/12-taos-sql/23-perf.md index 29cf3af6abfbbc06e42ae99c78f35f33a3c7c30a..fc369ec663cf9130bd7d1af650f1f47a1054fad6 100644 --- a/docs/en/12-taos-sql/23-perf.md +++ b/docs/en/12-taos-sql/23-perf.md @@ -1,6 +1,7 @@ --- -sidebar_label: Statistics title: Performance_Schema Database +sidebar_label: Statistics +description: This document describes how to use the PERFORMANCE_SCHEMA database in TDengine. --- TDengine includes a built-in database named `PERFORMANCE_SCHEMA` to provide access to database performance statistics. This document introduces the tables of PERFORMANCE_SCHEMA and their structure. diff --git a/docs/en/12-taos-sql/24-show.md b/docs/en/12-taos-sql/24-show.md index f70d86570e5fe9cf4f9eb6e58dd1908c62adcc89..dc1db956a0db1eead3a6c729e51c140b5be30c37 100644 --- a/docs/en/12-taos-sql/24-show.md +++ b/docs/en/12-taos-sql/24-show.md @@ -1,6 +1,7 @@ --- -sidebar_label: SHOW Statement title: SHOW Statement for Metadata +sidebar_label: SHOW Statement +description: This document describes how to use the SHOW statement in TDengine. --- `SHOW` command can be used to get brief system information. To get details about metatadata, information, and status in the system, please use `select` to query the tables in database `INFORMATION_SCHEMA`. diff --git a/docs/en/12-taos-sql/25-grant.md b/docs/en/12-taos-sql/25-grant.md index f895567c621f123778c8a711a68357a889ca0098..8b4c4393523c90595c7dd5461fc2abc73fa44c93 100644 --- a/docs/en/12-taos-sql/25-grant.md +++ b/docs/en/12-taos-sql/25-grant.md @@ -1,7 +1,7 @@ --- -sidebar_label: Access Control title: User and Access Control -description: Manage user and user's permission +sidebar_label: Access Control +description: This document describes how to manage users and permissions in TDengine. --- This document describes how to manage permissions in TDengine. diff --git a/docs/en/12-taos-sql/26-udf.md b/docs/en/12-taos-sql/26-udf.md index 977f3bcc0844ad63e4d2fe0f28d9ca8f29c5cbd6..249fcd3b54aceee06139fd93acc25b8a5b6ba43d 100644 --- a/docs/en/12-taos-sql/26-udf.md +++ b/docs/en/12-taos-sql/26-udf.md @@ -1,6 +1,7 @@ --- -sidebar_label: User-Defined Functions title: User-Defined Functions (UDF) +sidebar_label: User-Defined Functions +description: This document describes the SQL statements related to user-defined functions (UDF) in TDengine. --- You can create user-defined functions and import them into TDengine. diff --git a/docs/en/12-taos-sql/27-index.md b/docs/en/12-taos-sql/27-index.md index 7d09bc43ab06932b82019923d4a8fda48cd99c97..7586e4af76983e785b2c6b3f03870a8bcd6df4a3 100644 --- a/docs/en/12-taos-sql/27-index.md +++ b/docs/en/12-taos-sql/27-index.md @@ -1,6 +1,7 @@ --- -sidebar_label: Index -title: Using Indices +title: Indexing +sidebar_label: Indexing +description: This document describes the SQL statements related to indexing in TDengine. --- TDengine supports SMA and FULLTEXT indexing. diff --git a/docs/en/12-taos-sql/28-recovery.md b/docs/en/12-taos-sql/28-recovery.md index e869ffc45ff7420836d91a2536d32ce6b08a0d82..b4da25ea0c3b4f2758c981ee5bd03985ef3f2754 100644 --- a/docs/en/12-taos-sql/28-recovery.md +++ b/docs/en/12-taos-sql/28-recovery.md @@ -1,6 +1,7 @@ --- -sidebar_label: Error Recovery title: Error Recovery +sidebar_label: Error Recovery +description: This document describes the SQL statements related to error recovery in TDengine. --- In a complex environment, connections and query tasks may encounter errors or fail to return in a reasonable time. If this occurs, you can terminate the connection or task. diff --git a/docs/en/12-taos-sql/29-changes.md b/docs/en/12-taos-sql/29-changes.md index f288cd7545c1de25f6cf8b003e084ba3622524a7..341791d6755aa66fddd98561823ee0e5ac74ba3f 100644 --- a/docs/en/12-taos-sql/29-changes.md +++ b/docs/en/12-taos-sql/29-changes.md @@ -1,7 +1,7 @@ --- -sidebar_label: Changes in TDengine 3.0 title: Changes in TDengine 3.0 -description: "This document explains how TDengine SQL has changed in version 3.0." +sidebar_label: Changes in TDengine 3.0 +description: This document describes how TDengine SQL has changed in version 3.0 compared with previous versions. --- ## Basic SQL Elements diff --git a/docs/en/12-taos-sql/index.md b/docs/en/12-taos-sql/index.md index a5ffc9dc8dce158eccc0fa0519f09ba346710c31..276f84f21bc8ab92d13f1975b298dbdcf25db249 100644 --- a/docs/en/12-taos-sql/index.md +++ b/docs/en/12-taos-sql/index.md @@ -1,6 +1,6 @@ --- title: TDengine SQL -description: 'The syntax supported by TDengine SQL ' +description: This document describes the syntax and functions supported by TDengine SQL. --- This section explains the syntax of SQL to perform operations on databases, tables and STables, insert data, select data and use functions. We also provide some tips that can be used in TDengine SQL. If you have previous experience with SQL this section will be fairly easy to understand. If you do not have previous experience with SQL, you'll come to appreciate the simplicity and power of SQL. TDengine SQL has been enhanced in version 3.0, and the query engine has been rearchitected. For information about how TDengine SQL has changed, see [Changes in TDengine 3.0](../taos-sql/changes). diff --git a/docs/en/13-operation/01-pkg-install.md b/docs/en/13-operation/01-pkg-install.md index d7713b943f5fe8fbd5e685b8ba03ff8cc8ed4e53..6e6c4aaebf7da8ed633cbb89233f9028f56d8302 100644 --- a/docs/en/13-operation/01-pkg-install.md +++ b/docs/en/13-operation/01-pkg-install.md @@ -1,6 +1,6 @@ --- title: Install and Uninstall -description: Install, Uninstall, Start, Stop and Upgrade +description: This document describes how to install, upgrade, and uninstall TDengine. --- import Tabs from "@theme/Tabs"; diff --git a/docs/en/13-operation/02-planning.mdx b/docs/en/13-operation/02-planning.mdx index 2dffa7bb8747e21e4754740208eafed65d341217..37ef6aae26ce55046ead09bcfbe37a14213bad46 100644 --- a/docs/en/13-operation/02-planning.mdx +++ b/docs/en/13-operation/02-planning.mdx @@ -1,6 +1,7 @@ --- -sidebar_label: Resource Planning title: Resource Planning +sidebar_label: Resource Planning +description: This document describes how to plan compute and storage resources for your TDengine cluster. --- It is important to plan computing and storage resources if using TDengine to build an IoT, time-series or Big Data platform. How to plan the CPU, memory and disk resources required, will be described in this chapter. diff --git a/docs/en/13-operation/03-tolerance.md b/docs/en/13-operation/03-tolerance.md index 21a5a902822d7b85f555114a112686d4e35c64aa..4f33748e68a0b51be619fe7aa8cc3b2152c71bf2 100644 --- a/docs/en/13-operation/03-tolerance.md +++ b/docs/en/13-operation/03-tolerance.md @@ -1,5 +1,6 @@ --- title: Fault Tolerance and Disaster Recovery +description: This document describes how TDengine provides fault tolerance and disaster recovery. --- ## Fault Tolerance diff --git a/docs/en/13-operation/07-import.md b/docs/en/13-operation/07-import.md index 8362cec1ab3072866018678b42a679d0c19b49de..e95824e927f4c65b427d0819d7bc968c52f5fbe5 100644 --- a/docs/en/13-operation/07-import.md +++ b/docs/en/13-operation/07-import.md @@ -1,5 +1,6 @@ --- title: Data Import +description: This document describes how to import data into TDengine. --- There are multiple ways of importing data provided by TDengine: import with script, import from data file, import using `taosdump`. diff --git a/docs/en/13-operation/08-export.md b/docs/en/13-operation/08-export.md index 5780de42faeaedbc1c985ad2aa2f52fe56c76971..bffda36e23741a7ff52394772c918fa7040ea047 100644 --- a/docs/en/13-operation/08-export.md +++ b/docs/en/13-operation/08-export.md @@ -1,5 +1,6 @@ --- title: Data Export +description: This document describes how to export data from TDengine. --- There are two ways of exporting data from a TDengine cluster: diff --git a/docs/en/13-operation/10-monitor.md b/docs/en/13-operation/10-monitor.md index 74a5564a2a7b82009e6b2406290a5c15afbf3c1d..346b874059a11c5608027b4ea6e2550765d64186 100644 --- a/docs/en/13-operation/10-monitor.md +++ b/docs/en/13-operation/10-monitor.md @@ -1,5 +1,6 @@ --- title: TDengine Monitoring +description: This document describes how to monitor your TDengine cluster. --- After TDengine is started, it automatically writes monitoring data including CPU, memory and disk usage, bandwidth, number of requests, disk I/O speed, slow queries, into a designated database at a predefined interval through taosKeeper. Additionally, some important system operations, like logon, create user, drop database, and alerts and warnings generated in TDengine are written into the `log` database too. A system operator can view the data in `log` database from TDengine CLI or from a web console. diff --git a/docs/en/13-operation/17-diagnose.md b/docs/en/13-operation/17-diagnose.md index fa202a23ea5b5d58eb0fc107045a9c27c7fa99ad..9d42b3ebbcfe0b87fa23bccaee12769d465fc24e 100644 --- a/docs/en/13-operation/17-diagnose.md +++ b/docs/en/13-operation/17-diagnose.md @@ -1,5 +1,6 @@ --- title: Problem Diagnostics +description: This document describes how to diagnose issues with your TDengine cluster. --- ## Network Connection Diagnostics diff --git a/docs/en/13-operation/index.md b/docs/en/13-operation/index.md index c64749c40e26f091e4a25e0238827ebceff4b069..8b386dc19a1113a84016bf3d03dd847216eed930 100644 --- a/docs/en/13-operation/index.md +++ b/docs/en/13-operation/index.md @@ -1,5 +1,6 @@ --- title: Administration +description: This document describes how to perform management operations on your TDengine cluster from an administrator's perspective. --- This chapter is mainly written for system administrators. It covers download, install/uninstall, data import/export, system monitoring, user management, connection management, capacity planning and system optimization. diff --git a/docs/en/14-reference/02-rest-api/02-rest-api.mdx b/docs/en/14-reference/02-rest-api/02-rest-api.mdx index 09e40b956f9a3b713335bec768fd1d5474f4bea1..b138d69bfc277401723e5b75b874b42914963f48 100644 --- a/docs/en/14-reference/02-rest-api/02-rest-api.mdx +++ b/docs/en/14-reference/02-rest-api/02-rest-api.mdx @@ -1,5 +1,6 @@ --- title: REST API +description: This document describes the TDengine REST API. --- To support the development of various types of applications and platforms, TDengine provides an API that conforms to REST principles; namely REST API. To minimize the learning cost, unlike REST APIs for other database engines, TDengine allows insertion of SQL commands in the BODY of an HTTP POST request, to operate the database. diff --git a/docs/en/14-reference/03-connector/03-cpp.mdx b/docs/en/14-reference/03-connector/03-cpp.mdx index 906d56ab158e20db4bafa9eb8375434568555184..3bd7b7f4c6ad0c2ca3cf5c05fa72d1b27f714653 100644 --- a/docs/en/14-reference/03-connector/03-cpp.mdx +++ b/docs/en/14-reference/03-connector/03-cpp.mdx @@ -1,6 +1,7 @@ --- -sidebar_label: C/C++ title: C/C++ Connector +sidebar_label: C/C++ +description: This document describes the TDengine C/C++ connector. --- C/C++ developers can use TDengine's client driver and the C/C++ connector, to develop their applications to connect to TDengine clusters for data writing, querying, and other functions. To use the C/C++ connector you must include the TDengine header file _taos.h_, which lists the function prototypes of the provided APIs. The application also needs to link to the corresponding dynamic libraries on the platform where it is located. diff --git a/docs/en/14-reference/03-connector/04-java.mdx b/docs/en/14-reference/03-connector/04-java.mdx index c37738b3f8ddba9879159e04573798dd61efa27e..61ce1660694aee4ded365cfbff0427ec48192348 100644 --- a/docs/en/14-reference/03-connector/04-java.mdx +++ b/docs/en/14-reference/03-connector/04-java.mdx @@ -1,8 +1,8 @@ --- -toc_max_heading_level: 4 -sidebar_label: Java title: TDengine Java Connector -description: The TDengine Java Connector is implemented on the standard JDBC API and provides native and REST connectors. +sidebar_label: Java +description: This document describes the TDengine Java Connector. +toc_max_heading_level: 4 --- import Tabs from '@theme/Tabs'; diff --git a/docs/en/14-reference/03-connector/05-go.mdx b/docs/en/14-reference/03-connector/05-go.mdx index 60407c0735bf9bcb42ae54bddcc9afa639a02fcc..da2f54708f550bc4ba9f35da81ad59a575bda169 100644 --- a/docs/en/14-reference/03-connector/05-go.mdx +++ b/docs/en/14-reference/03-connector/05-go.mdx @@ -1,7 +1,8 @@ --- -toc_max_heading_level: 4 -sidebar_label: Go title: TDengine Go Connector +sidebar_label: Go +description: This document describes the TDengine Go connector. +toc_max_heading_level: 4 --- import Tabs from '@theme/Tabs'; diff --git a/docs/en/14-reference/03-connector/06-rust.mdx b/docs/en/14-reference/03-connector/06-rust.mdx index 4e2a7848dc87ac0522b6d5aa5855b5a0998dc789..6e848596107f3dd8a0e99b4bf8fe1dc9530021a4 100644 --- a/docs/en/14-reference/03-connector/06-rust.mdx +++ b/docs/en/14-reference/03-connector/06-rust.mdx @@ -1,7 +1,8 @@ --- -toc_max_heading_level: 4 -sidebar_label: Rust title: TDengine Rust Connector +sidebar_label: Rust +description: This document describes the TDengine Rust connector. +toc_max_heading_level: 4 --- import Tabs from '@theme/Tabs'; diff --git a/docs/en/14-reference/03-connector/07-python.mdx b/docs/en/14-reference/03-connector/07-python.mdx index d593c3f133dafa3b5f8083577f8f0d4d75cb3d8b..146da268a8b7b4ebf799f3441efcd2d454afd65d 100644 --- a/docs/en/14-reference/03-connector/07-python.mdx +++ b/docs/en/14-reference/03-connector/07-python.mdx @@ -1,7 +1,7 @@ --- -sidebar_label: Python title: TDengine Python Connector -description: "taospy is the official Python connector for TDengine. taospy provides a rich API that makes it easy for Python applications to use TDengine. tasopy wraps both the native and REST interfaces of TDengine, corresponding to the two submodules of tasopy: taos and taosrest. In addition to wrapping the native and REST interfaces, taospy also provides a programming interface that conforms to the Python Data Access Specification (PEP 249), making it easy to integrate taospy with many third-party tools, such as SQLAlchemy and pandas." +sidebar_label: Python +description: This document describes taospy, the TDengine Python connector. --- import Tabs from "@theme/Tabs"; diff --git a/docs/en/14-reference/03-connector/08-node.mdx b/docs/en/14-reference/03-connector/08-node.mdx index a36cf0efc9432425ad16c4d8112cc813a8c528b9..1ac8f69d06d594e278e27328b340d49972ad815b 100644 --- a/docs/en/14-reference/03-connector/08-node.mdx +++ b/docs/en/14-reference/03-connector/08-node.mdx @@ -1,7 +1,8 @@ --- -toc_max_heading_level: 4 -sidebar_label: Node.js title: TDengine Node.js Connector +sidebar_label: Node.js +description: This document describes the TDengine Node.js connector. +toc_max_heading_level: 4 --- import Tabs from "@theme/Tabs"; diff --git a/docs/en/14-reference/03-connector/09-csharp.mdx b/docs/en/14-reference/03-connector/09-csharp.mdx index 756e948bd293477c37439b624bab9af86191e232..e984967fb7048bf4a89d5528be7f6c977820d255 100644 --- a/docs/en/14-reference/03-connector/09-csharp.mdx +++ b/docs/en/14-reference/03-connector/09-csharp.mdx @@ -1,7 +1,8 @@ --- -toc_max_heading_level: 4 -sidebar_label: C# title: C# Connector +sidebar_label: C# +description: This document describes the TDengine C# connector. +toc_max_heading_level: 4 --- import Tabs from '@theme/Tabs'; diff --git a/docs/en/14-reference/03-connector/10-php.mdx b/docs/en/14-reference/03-connector/10-php.mdx index 87f8616f9ebac598285406eb404b7c2544950ee3..fd00d11239315bbab6e59d838d472d3496ff8342 100644 --- a/docs/en/14-reference/03-connector/10-php.mdx +++ b/docs/en/14-reference/03-connector/10-php.mdx @@ -1,6 +1,7 @@ --- -sidebar_label: PHP title: PHP Connector +sidebar_label: PHP +description: This document describes the TDengine PHP connector. --- `php-tdengine` is the TDengine PHP connector provided by TDengine community. In particular, it supports Swoole coroutine. diff --git a/docs/en/14-reference/03-connector/index.mdx b/docs/en/14-reference/03-connector/index.mdx index da3aae8309a9282a37597a3ac4bb623e6dfd1b79..2df73b8592c496ca1e3e715c86a9fbb83420f425 100644 --- a/docs/en/14-reference/03-connector/index.mdx +++ b/docs/en/14-reference/03-connector/index.mdx @@ -1,5 +1,6 @@ --- title: Connector +description: This document describes the connectors that TDengine provides to interface with various programming languages. --- TDengine provides a rich set of APIs (application development interface). To facilitate users to develop their applications quickly, TDengine supports connectors for multiple programming languages, including official connectors for C/C++, Java, Python, Go, Node.js, C#, and Rust. These connectors support connecting to TDengine clusters using both native interfaces (taosc) and REST interfaces (not supported in a few languages yet). Community developers have also contributed several unofficial connectors, such as the ADO.NET connector, the Lua connector, and the PHP connector. diff --git a/docs/en/14-reference/04-taosadapter.md b/docs/en/14-reference/04-taosadapter.md index 9eb6cb921391df3ce494fddaae8caa23cb0f4adc..c1ec97b647c228b7302391f768033792e236c79b 100644 --- a/docs/en/14-reference/04-taosadapter.md +++ b/docs/en/14-reference/04-taosadapter.md @@ -1,7 +1,7 @@ --- -title: "taosAdapter" -description: "taosAdapter is a TDengine companion tool that acts as a bridge and adapter between TDengine clusters and applications. It provides an easy-to-use and efficient way to ingest data directly from data collection agent software such as Telegraf, StatsD, collectd, etc. It also provides an InfluxDB/OpenTSDB compatible data ingestion interface, allowing InfluxDB/OpenTSDB applications to be seamlessly ported to TDengine." -sidebar_label: "taosAdapter" +title: taosAdapter +sidebar_label: taosAdapter +description: This document describes how to use taosAdapter, a TDengine companion tool that acts as a bridge and adapter between TDengine clusters and applications. --- import Prometheus from "./_prometheus.mdx" diff --git a/docs/en/14-reference/05-taosbenchmark.md b/docs/en/14-reference/05-taosbenchmark.md index 4017b12be923a9bcb5696c8b4b57c2d67b5c1378..9828d71ece98ca6de2f079f5599f2eed7fcea891 100644 --- a/docs/en/14-reference/05-taosbenchmark.md +++ b/docs/en/14-reference/05-taosbenchmark.md @@ -1,8 +1,8 @@ --- title: taosBenchmark sidebar_label: taosBenchmark +description: This document describes how to use taosBenchmark, a tool for testing the performance of TDengine. toc_max_heading_level: 4 -description: "taosBenchmark (once called taosdemo ) is a tool for testing the performance of TDengine." --- # Introduction diff --git a/docs/en/14-reference/06-taosdump.md b/docs/en/14-reference/06-taosdump.md index 9c63b4dc035b6a6a18f8e17f19782527eef88bca..dcfc068a3d64eb9f755f498b2b80d0a2b228842f 100644 --- a/docs/en/14-reference/06-taosdump.md +++ b/docs/en/14-reference/06-taosdump.md @@ -1,6 +1,6 @@ --- title: taosdump -description: "taosdump is a tool that supports backing up data from a running TDengine cluster and restoring the backed up data to the same, or another running TDengine cluster." +description: This document describes how to use taosdump, a tool for backing up and restoring the data in a TDengine cluster. --- ## Introduction diff --git a/docs/en/14-reference/07-tdinsight/index.md b/docs/en/14-reference/07-tdinsight/index.md index d03c16a8bc25a39fb751ded4b5c12df4b69a8e4e..1c58dd6a763df6527738d048fccd36565dcdbd67 100644 --- a/docs/en/14-reference/07-tdinsight/index.md +++ b/docs/en/14-reference/07-tdinsight/index.md @@ -1,6 +1,7 @@ --- title: TDinsight - Grafana-based Zero-Dependency Monitoring Solution for TDengine sidebar_label: TDinsight +description: This document describes TDinsight, a monitoring solution for TDengine. --- TDinsight is a solution for monitoring TDengine using the builtin native monitoring database and [Grafana]. diff --git a/docs/en/14-reference/08-taos-shell.md b/docs/en/14-reference/08-taos-shell.md index 68e2f087658305ec408c50e27f4a87ef43b2c870..7833ac861fea5fb2dfd66ccc9ec2db8f0ddeff3f 100644 --- a/docs/en/14-reference/08-taos-shell.md +++ b/docs/en/14-reference/08-taos-shell.md @@ -1,7 +1,7 @@ --- title: TDengine Command Line Interface (CLI) sidebar_label: Command Line Interface -description: Instructions and tips for using the TDengine CLI +description: This document describes how to use the TDengine CLI. --- The TDengine command-line interface (hereafter referred to as `TDengine CLI`) is the simplest way for users to manipulate and interact with TDengine instances. diff --git a/docs/en/14-reference/09-support-platform/index.md b/docs/en/14-reference/09-support-platform/index.md index 061294f0160f5f07c7c032b4a7475f6b12c2efca..7dfa8ac93a9e91eb9238f7b56033a592c241079f 100644 --- a/docs/en/14-reference/09-support-platform/index.md +++ b/docs/en/14-reference/09-support-platform/index.md @@ -1,6 +1,6 @@ --- title: List of supported platforms -description: "List of platforms supported by TDengine server, client, and connector" +description: This document describes the supported platforms for the TDengine server, client, and connectors. --- ## List of supported platforms for TDengine server diff --git a/docs/en/14-reference/11-docker/index.md b/docs/en/14-reference/11-docker/index.md index 89987c456f14d243a4b59af5b15ae754225bbaf9..b9278c6961ec5f395f68795422bde682f9467f77 100644 --- a/docs/en/14-reference/11-docker/index.md +++ b/docs/en/14-reference/11-docker/index.md @@ -1,6 +1,6 @@ --- title: Deploying TDengine with Docker -description: "This chapter focuses on starting the TDengine service in a container and accessing it." +description: This chapter describes how to start and access TDengine in a Docker container. --- This chapter describes how to start the TDengine service in a container and access it. Users can control the behavior of the service in the container by using environment variables on the docker run command-line or in the docker-compose file. diff --git a/docs/en/14-reference/12-config/index.md b/docs/en/14-reference/12-config/index.md index e6fd6dbe6fecf4bf3d5549cf19aa869c928b8680..afa9f5a8aebe08d733b059a664467bc08d2c4aa6 100644 --- a/docs/en/14-reference/12-config/index.md +++ b/docs/en/14-reference/12-config/index.md @@ -1,6 +1,6 @@ --- title: Configuration Parameters -description: "Configuration parameters for client and server in TDengine" +description: This document describes the configuration parameters for the TDengine server and client. --- ## Configuration File on Server Side diff --git a/docs/en/14-reference/12-directory.md b/docs/en/14-reference/12-directory.md index 19b036418f18637bfd21fa286f24528c649d146d..651892c8b29447647d8edef12af58c469de951b1 100644 --- a/docs/en/14-reference/12-directory.md +++ b/docs/en/14-reference/12-directory.md @@ -1,6 +1,6 @@ --- title: File directory structure -description: "TDengine installation directory description" +description: This document describes the structure of the TDengine directory after installation. --- After TDengine is installed, the following directories or files will be created in the system by default. diff --git a/docs/en/14-reference/13-schemaless/13-schemaless.md b/docs/en/14-reference/13-schemaless/13-schemaless.md index a97a54af02601ddc2dde43614ac7ba8a6c8d4009..caedd76df8e41b4246891f686d61ed61af671d7e 100644 --- a/docs/en/14-reference/13-schemaless/13-schemaless.md +++ b/docs/en/14-reference/13-schemaless/13-schemaless.md @@ -1,6 +1,6 @@ --- title: Schemaless Writing -description: 'The Schemaless write method eliminates the need to create super tables/sub tables in advance and automatically creates the storage structure corresponding to the data, as it is written to the interface.' +description: This document describes how to use the schemaless write component of TDengine. --- In IoT applications, data is collected for many purposes such as intelligent control, business analysis, device monitoring and so on. Due to changes in business or functional requirements or changes in device hardware, the application logic and even the data collected may change. Schemaless writing automatically creates storage structures for your data as it is being written to TDengine, so that you do not need to create supertables in advance. When necessary, schemaless writing diff --git a/docs/en/14-reference/14-taosKeeper.md b/docs/en/14-reference/14-taosKeeper.md index 665bc75380d4f59666d792d074fb37c65c810264..0b4a1fbd60e1cb465ecb3e01f50e8c39aaa3497c 100644 --- a/docs/en/14-reference/14-taosKeeper.md +++ b/docs/en/14-reference/14-taosKeeper.md @@ -1,7 +1,7 @@ --- sidebar_label: taosKeeper title: taosKeeper -description: exports TDengine monitoring metrics. +description: This document describes how to use taosKeeper, a tool for exporting TDengine monitoring metrics. --- ## Introduction diff --git a/docs/en/14-reference/index.md b/docs/en/14-reference/index.md index f3a64913d065d1d8e321ce7433c9d605ef70bd13..bc8ec6996538bf15bf4cb4d52aaa126ed11b5b72 100644 --- a/docs/en/14-reference/index.md +++ b/docs/en/14-reference/index.md @@ -1,5 +1,6 @@ --- title: Reference +description: This document describes TDengine connectors and utilities. --- This section describes the TDengine connectors and utilities. diff --git a/docs/en/20-third-party/01-grafana.mdx b/docs/en/20-third-party/01-grafana.mdx index ca32ce8afce30eaa6756f7b403685b989d824bbf..b33e1c11993bfdc835228f13a7dbfed32f54c50b 100644 --- a/docs/en/20-third-party/01-grafana.mdx +++ b/docs/en/20-third-party/01-grafana.mdx @@ -1,6 +1,7 @@ --- -sidebar_label: Grafana title: Grafana +sidebar_label: Grafana +description: This document describes how to integrate TDengine with Grafana. --- import Tabs from "@theme/Tabs"; diff --git a/docs/en/20-third-party/02-prometheus.md b/docs/en/20-third-party/02-prometheus.md index ef9b9cb637ffc8da2de6acdd853fa097cfbc0193..bfdd3d015e6fcfa484fdceea6f0bebc43049ed17 100644 --- a/docs/en/20-third-party/02-prometheus.md +++ b/docs/en/20-third-party/02-prometheus.md @@ -1,6 +1,7 @@ --- -sidebar_label: Prometheus title: Prometheus writing and reading +sidebar_label: Prometheus +description: This document describes how to integrate TDengine with Prometheus. --- import Prometheus from "../14-reference/_prometheus.mdx" diff --git a/docs/en/20-third-party/03-telegraf.md b/docs/en/20-third-party/03-telegraf.md index 8f3cab0e57094a1d2fac5f54601489382ac3f9a1..7e99b84eab88614bf82da92a2db11ddf1be753bf 100644 --- a/docs/en/20-third-party/03-telegraf.md +++ b/docs/en/20-third-party/03-telegraf.md @@ -1,6 +1,7 @@ --- -sidebar_label: Telegraf title: Telegraf writing +sidebar_label: Telegraf +description: This document describes how to integrate TDengine with Telegraf. --- import Telegraf from "../14-reference/_telegraf.mdx" diff --git a/docs/en/20-third-party/05-collectd.md b/docs/en/20-third-party/05-collectd.md index 5b52e3b7bc75c2d21ab5a6c08331030fe4e423f7..d8c8e7f81def389418d28d62486ef32afb5d996c 100644 --- a/docs/en/20-third-party/05-collectd.md +++ b/docs/en/20-third-party/05-collectd.md @@ -1,6 +1,7 @@ --- -sidebar_label: collectd title: collectd writing +sidebar_label: collectd +description: This document describes how to integrate TDengine with collectd. --- import CollectD from "../14-reference/_collectd.mdx" diff --git a/docs/en/20-third-party/06-statsd.md b/docs/en/20-third-party/06-statsd.md index b861a48ecd59fa1f2036c6c323d3fdee8a3ee44b..ea428e9cdb45992cdebd6be4713583b88990a67f 100644 --- a/docs/en/20-third-party/06-statsd.md +++ b/docs/en/20-third-party/06-statsd.md @@ -1,6 +1,7 @@ --- -sidebar_label: StatsD title: StatsD Writing +sidebar_label: StatsD +description: This document describes how to integrate TDengine with StatsD. --- import StatsD from "../14-reference/_statsd.mdx" diff --git a/docs/en/20-third-party/07-icinga2.md b/docs/en/20-third-party/07-icinga2.md index 167b6a4303f838c8c9945a95dac802a54bad3525..540aae8689bc0885ab4649be8fd07fec04dad829 100644 --- a/docs/en/20-third-party/07-icinga2.md +++ b/docs/en/20-third-party/07-icinga2.md @@ -1,6 +1,7 @@ --- -sidebar_label: icinga2 title: icinga2 writing +sidebar_label: icinga2 +description: This document describes how to integrate TDengine with icinga2. --- import Icinga2 from "../14-reference/_icinga2.mdx" diff --git a/docs/en/20-third-party/08-tcollector.md b/docs/en/20-third-party/08-tcollector.md index b604a2d7125851a8f2ec4965f755f5400d0613bf..f1c0ecd44deaea6172d8d9b1d4e6c2e5ee8ccabb 100644 --- a/docs/en/20-third-party/08-tcollector.md +++ b/docs/en/20-third-party/08-tcollector.md @@ -1,6 +1,7 @@ --- -sidebar_label: TCollector title: TCollector writing +sidebar_label: TCollector +description: This document describes how to integrate TDengine with TCollector. --- import TCollector from "../14-reference/_tcollector.mdx" diff --git a/docs/en/20-third-party/09-emq-broker.md b/docs/en/20-third-party/09-emq-broker.md index 2ead1bbaf40f06fec2a5cbf85e46fdfdcc5216df..10ce0174ed5d362a113acd7ade59741a10155657 100644 --- a/docs/en/20-third-party/09-emq-broker.md +++ b/docs/en/20-third-party/09-emq-broker.md @@ -1,6 +1,7 @@ --- -sidebar_label: EMQX Broker title: EMQX Broker writing +sidebar_label: EMQX Broker +description: This document describes how to integrate TDengine with the EMQX broker. --- MQTT is a popular IoT data transfer protocol. [EMQX](https://github.com/emqx/emqx) is an open-source MQTT Broker software. You can write MQTT data directly to TDengine without any code. You only need to setup "rules" in EMQX Dashboard to create a simple configuration. EMQX supports saving data to TDengine by sending data to a web service and provides a native TDengine driver for direct saving in the Enterprise Edition. Please refer to the [EMQX official documentation](https://www.emqx.io/docs/en/v4.4/rule/rule-engine.html) for details on how to use it.). diff --git a/docs/en/20-third-party/10-hive-mq-broker.md b/docs/en/20-third-party/10-hive-mq-broker.md index 828a62ac5b336766d5c3770cc42cd3a61cfd8d5d..6c5165596e04678db1dd32d16756133719fdb4b9 100644 --- a/docs/en/20-third-party/10-hive-mq-broker.md +++ b/docs/en/20-third-party/10-hive-mq-broker.md @@ -1,6 +1,7 @@ --- -sidebar_label: HiveMQ Broker title: HiveMQ Broker Writing +sidebar_label: HiveMQ Broker +description: This document describes how to integrate TDengine with the HiveMQ broker. --- [HiveMQ](https://www.hivemq.com/) is an MQTT broker that provides community and enterprise editions. HiveMQ is mainly for enterprise emerging machine-to-machine M2M communication and internal transport, meeting scalability, ease of management, and security features. HiveMQ provides an open-source plug-in development kit. MQTT data can be saved to TDengine via TDengine extension for HiveMQ. For more information, see [HiveMQ TDengine Extension](https://github.com/huskar-t/hivemq-tdengine-extension/blob/b62a26ecc164a310104df57691691b237e091c89/README_EN.md). diff --git a/docs/en/20-third-party/11-kafka.md b/docs/en/20-third-party/11-kafka.md index 3e8f7c295d7b6ab81ecb678865ed3e4eff81b2c5..0998862b2d75b98fb65ff414d000535b0c8b7ea5 100644 --- a/docs/en/20-third-party/11-kafka.md +++ b/docs/en/20-third-party/11-kafka.md @@ -1,6 +1,7 @@ --- -sidebar_label: Kafka title: TDengine Kafka Connector Tutorial +sidebar_label: Kafka +description: This document describes how to integrate TDengine with Kafka. --- TDengine Kafka Connector contains two plugins: TDengine Source Connector and TDengine Sink Connector. Users only need to provide a simple configuration file to synchronize the data of the specified topic in Kafka (batch or real-time) to TDengine or synchronize the data (batch or real-time) of the specified database in TDengine to Kafka. diff --git a/docs/en/20-third-party/12-google-data-studio.md b/docs/en/20-third-party/12-google-data-studio.md index fc94f98056bbeeeec88ca7ea12a4a6a7e6f15dc5..ea6431fa5a81b3b9e51fe04e8e404cf52e9c0ad9 100644 --- a/docs/en/20-third-party/12-google-data-studio.md +++ b/docs/en/20-third-party/12-google-data-studio.md @@ -1,6 +1,7 @@ --- -sidebar_label: Google Data Studio title: Use Google Data Studio to access TDengine +sidebar_label: Google Data Studio +description: This document describes how to integrate TDengine with Google Data Studio. --- Data Studio is a powerful tool for reporting and visualization, offering a wide variety of charts and connectors and making it easy to generate reports based on predefined templates. Its ease of use and robust ecosystem have made it one of the first choices for people working in data analysis. diff --git a/docs/en/20-third-party/13-Jupyter.md b/docs/en/20-third-party/13-Jupyter.md index fbd7e530f0959740c53e48ce1d73d92ce0d6c5c5..1ac9df1da4c7756c4f186d456948ae65262e9d54 100644 --- a/docs/en/20-third-party/13-Jupyter.md +++ b/docs/en/20-third-party/13-Jupyter.md @@ -1,6 +1,7 @@ --- -sidebar_label: JupyterLab title: Connect JupyterLab to TDengine +sidebar_label: JupyterLab +description: This document describes how to integrate TDengine with JupyterLab. --- JupyterLab is the next generation of the ubiquitous Jupyter Notebook. In this note we show you how to install the TDengine Python connector to connect to TDengine in JupyterLab. You can then insert data and perform queries against the TDengine instance within JupyterLab. diff --git a/docs/en/20-third-party/index.md b/docs/en/20-third-party/index.md index 87bd9e075133d1182ee93d1c1c43617c766755b9..6fc8043eefef62d476e289195c8f38e385e020c4 100644 --- a/docs/en/20-third-party/index.md +++ b/docs/en/20-third-party/index.md @@ -1,5 +1,6 @@ --- title: Third Party Tools +description: This document describes how to integrate TDengine with various third-party tools. --- Since TDengine supports standard SQL commands, common database connector standards (e.g., JDBC), ORM, and other popular time-series database writing protocols (e.g., InfluxDB Line Protocol, OpenTSDB JSON, OpenTSDB Telnet, etc.), it is very easy to integrate TDengine with other third party tools. You only need to provide simple configuration, the integration can be done without a line of code. diff --git a/docs/en/21-tdinternal/01-arch.md b/docs/en/21-tdinternal/01-arch.md index 697ecb98a1c212dbdfef47a916fe1e288ea5508c..cef05dcc56793846fd36515121f6688f74999bbf 100644 --- a/docs/en/21-tdinternal/01-arch.md +++ b/docs/en/21-tdinternal/01-arch.md @@ -1,6 +1,7 @@ --- -sidebar_label: Architecture title: Architecture +sidebar_label: Architecture +description: This document describes the architecture of TDengine. --- ## Cluster and Primary Logic Unit diff --git a/docs/en/21-tdinternal/03-high-availability.md b/docs/en/21-tdinternal/03-high-availability.md index e2e1c6521efd59078e7dc9c9a1e5d8df3377d266..a0f6ca4ffe15ba5901709ffa3c6d64b8697fa93a 100644 --- a/docs/en/21-tdinternal/03-high-availability.md +++ b/docs/en/21-tdinternal/03-high-availability.md @@ -1,6 +1,7 @@ --- -sidebar_label: High Availability title: High Availability +sidebar_label: High Availability +description: This document describes how TDengine implements high availability. --- ## High Availability of Vnode diff --git a/docs/en/21-tdinternal/04-load-balance.md b/docs/en/21-tdinternal/04-load-balance.md index 7648398059a2a422533d6d687336988d207c79a4..73da1c1dd65ffb3251c86ff936f5b5b26dc9d1cb 100644 --- a/docs/en/21-tdinternal/04-load-balance.md +++ b/docs/en/21-tdinternal/04-load-balance.md @@ -1,6 +1,7 @@ --- -sidebar_label: Load Balance title: Load Balance +sidebar_label: Load Balance +description: This document describes how TDengine implements load balancing. --- The load balance in TDengine is mainly about processing data series data. TDengine employes builtin hash algorithm to distribute all the tables, sub-tables and their data of a database across all the vgroups that belongs to the database. Each table or sub-table can only be handled by a single vgroup, while each vgroup can process multiple table or sub-table. diff --git a/docs/en/21-tdinternal/index.md b/docs/en/21-tdinternal/index.md index 999d6f89ff57164d6e0372620504c8ecc9de7c9b..4f0846754382767b4694ab1c54f8ae2d3340948c 100644 --- a/docs/en/21-tdinternal/index.md +++ b/docs/en/21-tdinternal/index.md @@ -1,5 +1,6 @@ --- title: TDengine Inside +description: This document describes the internals of TDengine from an architectural perspective. --- ```mdx-code-block diff --git a/docs/en/25-application/01-telegraf.md b/docs/en/25-application/01-telegraf.md index 65fb08ee674cc9c952bbcfda57f0366fa129fdf2..e043aebcb64f6e3b26b1e79964c5875e3b64ee6f 100644 --- a/docs/en/25-application/01-telegraf.md +++ b/docs/en/25-application/01-telegraf.md @@ -1,6 +1,7 @@ --- -sidebar_label: TDengine + Telegraf + Grafana title: Quickly Build IT DevOps Visualization System with TDengine + Telegraf + Grafana +sidebar_label: TDengine + Telegraf + Grafana +description: This document describes how to create an IT visualization system by integrating TDengine with Telegraf and Grafana. --- ## Background diff --git a/docs/en/25-application/02-collectd.md b/docs/en/25-application/02-collectd.md index 97412b230941435a08df12c859d63bca68b79ec9..6ac7253fc46c50d3efe698d508de8669c65bf5d9 100644 --- a/docs/en/25-application/02-collectd.md +++ b/docs/en/25-application/02-collectd.md @@ -1,6 +1,7 @@ --- -sidebar_label: TDengine + collectd/StatsD + Grafana title: Quickly build an IT DevOps visualization system using TDengine + collectd/StatsD + Grafana +sidebar_label: TDengine + collectd/StatsD + Grafana +description: This document describes how to build an IT visualization system by integrating TDengine with Grafana and collectd or StatsD. --- ## Background diff --git a/docs/en/25-application/03-immigrate.md b/docs/en/25-application/03-immigrate.md index 1aabaa43e77660d72bca00d7d59cdee69b1a7c92..30d069e4e2be2498b3634ae02cc0fc444c886392 100644 --- a/docs/en/25-application/03-immigrate.md +++ b/docs/en/25-application/03-immigrate.md @@ -1,6 +1,7 @@ --- -sidebar_label: OpenTSDB Migration to TDengine title: Best Practices for Migrating OpenTSDB Applications to TDengine +sidebar_label: OpenTSDB Migration to TDengine +description: This document describes the best practices for migrating an OpenTSDB application to TDengine. --- As a distributed, scalable, distributed time-series database platform based on HBase, and thanks to its first-mover advantage, OpenTSDB is widely used for monitoring in DevOps. However, as new technologies like cloud computing, microservices, and containerization technology has developed rapidly, Enterprise-level services are becoming more and more diverse and the architecture is becoming more complex. diff --git a/docs/en/25-application/index.md b/docs/en/25-application/index.md index 5383a00c67c515dc65fd2ed1cac4b218710288b5..178fef47b64285efe732e53b316581ae4876a218 100644 --- a/docs/en/25-application/index.md +++ b/docs/en/25-application/index.md @@ -1,5 +1,6 @@ --- title: Application Practice +description: This document describes some examples of building systems around TDengine. --- ```mdx-code-block diff --git a/docs/en/27-train-faq/01-faq.md b/docs/en/27-train-faq/01-faq.md index 7650e9736556d3b9887e0c2fc8f9e94091c58c2d..9e7f4f8e0d3d94f0016c0dcc6701c670fd7d32c8 100644 --- a/docs/en/27-train-faq/01-faq.md +++ b/docs/en/27-train-faq/01-faq.md @@ -1,5 +1,6 @@ --- title: Frequently Asked Questions +description: This document describes the frequently asked questions about TDengine. --- ## Submit an Issue diff --git a/docs/en/27-train-faq/index.md b/docs/en/27-train-faq/index.md index 2cb87aab005b0ecc9275b6fe10e267487d38c336..cc55a41559a32fcb89b28a99705b59e07c22a81d 100644 --- a/docs/en/27-train-faq/index.md +++ b/docs/en/27-train-faq/index.md @@ -1,5 +1,6 @@ --- title: FAQ & Others +description: This document describes common issues related with TDengine. --- ```mdx-code-block diff --git a/docs/en/28-releases/01-tdengine.md b/docs/en/28-releases/01-tdengine.md index 83ea3eb5e6d3edd69d65774a9761324a8f77dcd9..a6a28e04c47ef16155ce420154f3cd5113a3fb8e 100644 --- a/docs/en/28-releases/01-tdengine.md +++ b/docs/en/28-releases/01-tdengine.md @@ -1,7 +1,7 @@ --- -sidebar_label: TDengine title: TDengine Release History and Download Links -description: TDengine release history, Release Notes and download links. +sidebar_label: TDengine +description: This document provides download links for all released versions of TDengine 3.0. --- TDengine 3.x installation packages can be downloaded at the following links: diff --git a/docs/en/28-releases/02-tools.md b/docs/en/28-releases/02-tools.md index 97fed654f2f25c782a036501c39204be5750d93e..3c1dc32f8df813fa7b91bae2a32bcb78185d6bbd 100644 --- a/docs/en/28-releases/02-tools.md +++ b/docs/en/28-releases/02-tools.md @@ -1,7 +1,7 @@ --- -sidebar_label: taosTools title: taosTools Release History and Download Links -description: taosTools release history, Release Notes, download links. +sidebar_label: taosTools +description: This document provides download links for all released versions of taosTools compatible with TDengine 3.0. --- taosTools installation packages can be downloaded at the following links: diff --git a/docs/en/28-releases/index.md b/docs/en/28-releases/index.md index c01c99cdce0190fb04f88d55a09e8cc406d4d8b0..d1f93c3b9b2cf297578953d9c262b60f3ad2a214 100644 --- a/docs/en/28-releases/index.md +++ b/docs/en/28-releases/index.md @@ -1,5 +1,6 @@ --- title: Releases +description: This document describes TDengine products that have been released. --- ```mdx-code-block