doc: add descriptions to all docs
This commit is contained in:
parent
4a215852b6
commit
7a11008316
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
title: TDengine Documentation
|
title: TDengine Documentation
|
||||||
sidebar_label: Documentation Home
|
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: /
|
slug: /
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
---
|
---
|
||||||
title: Introduction
|
title: Introduction
|
||||||
|
description: This document introduces the major features, competitive advantages, typical use cases, and benchmarks of TDengine.
|
||||||
toc_max_heading_level: 2
|
toc_max_heading_level: 2
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
---
|
---
|
||||||
title: Concepts
|
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:
|
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:
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: Docker
|
|
||||||
title: Quick Install on 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.
|
This document describes how to install TDengine in a Docker container and perform queries and inserts.
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: Package
|
|
||||||
title: Quick Install from 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";
|
import Tabs from "@theme/Tabs";
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
---
|
---
|
||||||
title: Get Started
|
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'
|
import GitHubSVG from './github.svg'
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: Connect
|
|
||||||
title: Connect to TDengine
|
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";
|
import Tabs from "@theme/Tabs";
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
---
|
---
|
||||||
title: Data Model
|
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.
|
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.
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
---
|
---
|
||||||
title: Insert Using SQL
|
title: Insert Using SQL
|
||||||
|
description: This document describes how to insert data into TDengine using SQL.
|
||||||
---
|
---
|
||||||
|
|
||||||
import Tabs from "@theme/Tabs";
|
import Tabs from "@theme/Tabs";
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
---
|
---
|
||||||
title: Write from Kafka
|
title: Write from Kafka
|
||||||
|
description: This document describes how to insert data into TDengine using Kafka.
|
||||||
---
|
---
|
||||||
|
|
||||||
import Tabs from "@theme/Tabs";
|
import Tabs from "@theme/Tabs";
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: InfluxDB Line Protocol
|
|
||||||
title: 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";
|
import Tabs from "@theme/Tabs";
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: OpenTSDB Line Protocol
|
|
||||||
title: 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";
|
import Tabs from "@theme/Tabs";
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: OpenTSDB JSON Protocol
|
|
||||||
title: 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";
|
import Tabs from "@theme/Tabs";
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: High Performance Writing
|
|
||||||
title: 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";
|
import Tabs from "@theme/Tabs";
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
---
|
---
|
||||||
title: Insert Data
|
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.
|
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.
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
---
|
---
|
||||||
title: Query Data
|
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";
|
import Tabs from "@theme/Tabs";
|
||||||
|
|
|
@ -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
|
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.
|
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.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: Caching
|
|
||||||
title: 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.
|
TDengine uses various kinds of caching techniques to efficiently write and query data. This document describes the caching component of TDengine.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: UDF
|
|
||||||
title: User-Defined Functions (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.
|
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.
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
---
|
---
|
||||||
title: Developer Guide
|
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:
|
Before creating an application to process time-series data with TDengine, consider the following:
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: Manual Deployment
|
|
||||||
title: Manual Deployment and Management
|
title: Manual Deployment and Management
|
||||||
|
sidebar_label: Manual Deployment
|
||||||
|
description: This document describes how to deploy TDengine on a server.
|
||||||
---
|
---
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: Kubernetes
|
|
||||||
title: Deploying a TDengine Cluster in 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.
|
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.
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: Helm
|
|
||||||
title: Use Helm to deploy TDengine
|
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.
|
Helm is a package manager for Kubernetes that can provide more capabilities in deploying on Kubernetes.
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
---
|
---
|
||||||
title: Deployment
|
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.
|
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.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: Data Types
|
|
||||||
title: 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
|
## Timestamp
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: Database
|
|
||||||
title: 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
|
## Create a Database
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
---
|
---
|
||||||
title: Table
|
title: Table
|
||||||
|
description: This document describes how to create and perform operations on standard tables and subtables.
|
||||||
---
|
---
|
||||||
|
|
||||||
## Create Table
|
## Create Table
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: Supertable
|
|
||||||
title: Supertable
|
title: Supertable
|
||||||
|
sidebar_label: Supertable
|
||||||
|
description: This document describes how to create and perform operations on supertables.
|
||||||
---
|
---
|
||||||
|
|
||||||
## Create a Supertable
|
## Create a Supertable
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: Insert
|
|
||||||
title: Insert
|
title: Insert
|
||||||
|
sidebar_label: Insert
|
||||||
|
description: This document describes how to insert data into TDengine.
|
||||||
---
|
---
|
||||||
|
|
||||||
## Syntax
|
## Syntax
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: Select
|
|
||||||
title: Select
|
title: Select
|
||||||
|
sidebar_label: Select
|
||||||
|
description: This document describes how to query data in TDengine.
|
||||||
---
|
---
|
||||||
|
|
||||||
## Syntax
|
## Syntax
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: Delete Data
|
|
||||||
description: "Delete data from table or Stable"
|
|
||||||
title: Delete Data
|
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.
|
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.
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: Functions
|
|
||||||
title: Functions
|
title: Functions
|
||||||
|
sidebar_label: Functions
|
||||||
|
description: This document describes the standard SQL functions available in TDengine.
|
||||||
toc_max_heading_level: 4
|
toc_max_heading_level: 4
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: Time-Series Extensions
|
|
||||||
title: 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.
|
As a purpose-built database for storing and processing time-series data, TDengine provides time-series-specific extensions to standard SQL.
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: Data Subscription
|
|
||||||
title: 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.
|
The information in this document is related to the TDengine data subscription feature.
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: Stream Processing
|
|
||||||
title: 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.
|
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.
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: Operators
|
|
||||||
title: Operators
|
title: Operators
|
||||||
|
sidebar_label: Operators
|
||||||
|
description: This document describes the SQL operators available in TDengine.
|
||||||
---
|
---
|
||||||
|
|
||||||
## Arithmetic Operators
|
## Arithmetic Operators
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: JSON Type
|
|
||||||
title: JSON Type
|
title: JSON Type
|
||||||
|
sidebar_label: JSON Type
|
||||||
|
description: This document describes the JSON data type in TDengine.
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
---
|
---
|
||||||
title: Escape Characters
|
title: Escape Characters
|
||||||
|
description: This document describes the usage of escape characters in TDengine.
|
||||||
---
|
---
|
||||||
|
|
||||||
## Escape Characters
|
## Escape Characters
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: Name and Size Limits
|
|
||||||
title: 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
|
## Naming Rules
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: Reserved Keywords
|
|
||||||
title: 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
|
## Keyword List
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: Cluster
|
|
||||||
title: 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.
|
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.
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: Metadata
|
|
||||||
title: Information_Schema Database
|
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:
|
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:
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: Statistics
|
|
||||||
title: Performance_Schema Database
|
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.
|
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.
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: SHOW Statement
|
|
||||||
title: SHOW Statement for Metadata
|
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`.
|
`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`.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: Access Control
|
|
||||||
title: User and 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.
|
This document describes how to manage permissions in TDengine.
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: User-Defined Functions
|
|
||||||
title: User-Defined Functions (UDF)
|
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.
|
You can create user-defined functions and import them into TDengine.
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: Index
|
title: Indexing
|
||||||
title: Using Indices
|
sidebar_label: Indexing
|
||||||
|
description: This document describes the SQL statements related to indexing in TDengine.
|
||||||
---
|
---
|
||||||
|
|
||||||
TDengine supports SMA and FULLTEXT indexing.
|
TDengine supports SMA and FULLTEXT indexing.
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: Error Recovery
|
|
||||||
title: 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.
|
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.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: Changes in TDengine 3.0
|
|
||||||
title: 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
|
## Basic SQL Elements
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
---
|
---
|
||||||
title: TDengine SQL
|
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).
|
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).
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
---
|
---
|
||||||
title: Install and Uninstall
|
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";
|
import Tabs from "@theme/Tabs";
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: Resource Planning
|
|
||||||
title: 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.
|
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.
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
---
|
---
|
||||||
title: Fault Tolerance and Disaster Recovery
|
title: Fault Tolerance and Disaster Recovery
|
||||||
|
description: This document describes how TDengine provides fault tolerance and disaster recovery.
|
||||||
---
|
---
|
||||||
|
|
||||||
## Fault Tolerance
|
## Fault Tolerance
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
---
|
---
|
||||||
title: Data Import
|
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`.
|
There are multiple ways of importing data provided by TDengine: import with script, import from data file, import using `taosdump`.
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
---
|
---
|
||||||
title: Data Export
|
title: Data Export
|
||||||
|
description: This document describes how to export data from TDengine.
|
||||||
---
|
---
|
||||||
|
|
||||||
There are two ways of exporting data from a TDengine cluster:
|
There are two ways of exporting data from a TDengine cluster:
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
---
|
---
|
||||||
title: TDengine Monitoring
|
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.
|
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.
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
---
|
---
|
||||||
title: Problem Diagnostics
|
title: Problem Diagnostics
|
||||||
|
description: This document describes how to diagnose issues with your TDengine cluster.
|
||||||
---
|
---
|
||||||
|
|
||||||
## Network Connection Diagnostics
|
## Network Connection Diagnostics
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
---
|
---
|
||||||
title: Administration
|
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.
|
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.
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
---
|
---
|
||||||
title: REST API
|
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.
|
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.
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: C/C++
|
|
||||||
title: C/C++ Connector
|
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.
|
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.
|
||||||
|
|
|
@ -1,8 +1,8 @@
|
||||||
---
|
---
|
||||||
toc_max_heading_level: 4
|
|
||||||
sidebar_label: Java
|
|
||||||
title: TDengine Java Connector
|
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';
|
import Tabs from '@theme/Tabs';
|
||||||
|
|
|
@ -1,7 +1,8 @@
|
||||||
---
|
---
|
||||||
toc_max_heading_level: 4
|
|
||||||
sidebar_label: Go
|
|
||||||
title: TDengine Go Connector
|
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';
|
import Tabs from '@theme/Tabs';
|
||||||
|
|
|
@ -1,7 +1,8 @@
|
||||||
---
|
---
|
||||||
toc_max_heading_level: 4
|
|
||||||
sidebar_label: Rust
|
|
||||||
title: TDengine Rust Connector
|
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';
|
import Tabs from '@theme/Tabs';
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: Python
|
|
||||||
title: TDengine Python Connector
|
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";
|
import Tabs from "@theme/Tabs";
|
||||||
|
|
|
@ -1,7 +1,8 @@
|
||||||
---
|
---
|
||||||
toc_max_heading_level: 4
|
|
||||||
sidebar_label: Node.js
|
|
||||||
title: TDengine Node.js Connector
|
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";
|
import Tabs from "@theme/Tabs";
|
||||||
|
|
|
@ -1,7 +1,8 @@
|
||||||
---
|
---
|
||||||
toc_max_heading_level: 4
|
|
||||||
sidebar_label: C#
|
|
||||||
title: C# Connector
|
title: C# Connector
|
||||||
|
sidebar_label: C#
|
||||||
|
description: This document describes the TDengine C# connector.
|
||||||
|
toc_max_heading_level: 4
|
||||||
---
|
---
|
||||||
|
|
||||||
import Tabs from '@theme/Tabs';
|
import Tabs from '@theme/Tabs';
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: PHP
|
|
||||||
title: PHP Connector
|
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.
|
`php-tdengine` is the TDengine PHP connector provided by TDengine community. In particular, it supports Swoole coroutine.
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
---
|
---
|
||||||
title: Connector
|
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.
|
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.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: "taosAdapter"
|
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
|
||||||
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"
|
import Prometheus from "./_prometheus.mdx"
|
||||||
|
|
|
@ -1,8 +1,8 @@
|
||||||
---
|
---
|
||||||
title: taosBenchmark
|
title: taosBenchmark
|
||||||
sidebar_label: 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
|
toc_max_heading_level: 4
|
||||||
description: "taosBenchmark (once called taosdemo ) is a tool for testing the performance of TDengine."
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Introduction
|
# Introduction
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
---
|
---
|
||||||
title: taosdump
|
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
|
## Introduction
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
title: TDinsight - Grafana-based Zero-Dependency Monitoring Solution for TDengine
|
title: TDinsight - Grafana-based Zero-Dependency Monitoring Solution for TDengine
|
||||||
sidebar_label: TDinsight
|
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].
|
TDinsight is a solution for monitoring TDengine using the builtin native monitoring database and [Grafana].
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: TDengine Command Line Interface (CLI)
|
title: TDengine Command Line Interface (CLI)
|
||||||
sidebar_label: Command Line Interface
|
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.
|
The TDengine command-line interface (hereafter referred to as `TDengine CLI`) is the simplest way for users to manipulate and interact with TDengine instances.
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
---
|
---
|
||||||
title: List of supported platforms
|
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
|
## List of supported platforms for TDengine server
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
---
|
---
|
||||||
title: Deploying TDengine with Docker
|
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.
|
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.
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
---
|
---
|
||||||
title: Configuration Parameters
|
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
|
## Configuration File on Server Side
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
---
|
---
|
||||||
title: File directory structure
|
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.
|
After TDengine is installed, the following directories or files will be created in the system by default.
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
---
|
---
|
||||||
title: Schemaless Writing
|
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
|
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
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: taosKeeper
|
sidebar_label: taosKeeper
|
||||||
title: taosKeeper
|
title: taosKeeper
|
||||||
description: exports TDengine monitoring metrics.
|
description: This document describes how to use taosKeeper, a tool for exporting TDengine monitoring metrics.
|
||||||
---
|
---
|
||||||
|
|
||||||
## Introduction
|
## Introduction
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
---
|
---
|
||||||
title: Reference
|
title: Reference
|
||||||
|
description: This document describes TDengine connectors and utilities.
|
||||||
---
|
---
|
||||||
|
|
||||||
This section describes the TDengine connectors and utilities.
|
This section describes the TDengine connectors and utilities.
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: Grafana
|
|
||||||
title: Grafana
|
title: Grafana
|
||||||
|
sidebar_label: Grafana
|
||||||
|
description: This document describes how to integrate TDengine with Grafana.
|
||||||
---
|
---
|
||||||
|
|
||||||
import Tabs from "@theme/Tabs";
|
import Tabs from "@theme/Tabs";
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: Prometheus
|
|
||||||
title: Prometheus writing and reading
|
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"
|
import Prometheus from "../14-reference/_prometheus.mdx"
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: Telegraf
|
|
||||||
title: Telegraf writing
|
title: Telegraf writing
|
||||||
|
sidebar_label: Telegraf
|
||||||
|
description: This document describes how to integrate TDengine with Telegraf.
|
||||||
---
|
---
|
||||||
|
|
||||||
import Telegraf from "../14-reference/_telegraf.mdx"
|
import Telegraf from "../14-reference/_telegraf.mdx"
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: collectd
|
|
||||||
title: collectd writing
|
title: collectd writing
|
||||||
|
sidebar_label: collectd
|
||||||
|
description: This document describes how to integrate TDengine with collectd.
|
||||||
---
|
---
|
||||||
|
|
||||||
import CollectD from "../14-reference/_collectd.mdx"
|
import CollectD from "../14-reference/_collectd.mdx"
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: StatsD
|
|
||||||
title: StatsD Writing
|
title: StatsD Writing
|
||||||
|
sidebar_label: StatsD
|
||||||
|
description: This document describes how to integrate TDengine with StatsD.
|
||||||
---
|
---
|
||||||
|
|
||||||
import StatsD from "../14-reference/_statsd.mdx"
|
import StatsD from "../14-reference/_statsd.mdx"
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: icinga2
|
|
||||||
title: icinga2 writing
|
title: icinga2 writing
|
||||||
|
sidebar_label: icinga2
|
||||||
|
description: This document describes how to integrate TDengine with icinga2.
|
||||||
---
|
---
|
||||||
|
|
||||||
import Icinga2 from "../14-reference/_icinga2.mdx"
|
import Icinga2 from "../14-reference/_icinga2.mdx"
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: TCollector
|
|
||||||
title: TCollector writing
|
title: TCollector writing
|
||||||
|
sidebar_label: TCollector
|
||||||
|
description: This document describes how to integrate TDengine with TCollector.
|
||||||
---
|
---
|
||||||
|
|
||||||
import TCollector from "../14-reference/_tcollector.mdx"
|
import TCollector from "../14-reference/_tcollector.mdx"
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: EMQX Broker
|
|
||||||
title: EMQX Broker writing
|
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.).
|
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.).
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: HiveMQ Broker
|
|
||||||
title: HiveMQ Broker Writing
|
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).
|
[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).
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: Kafka
|
|
||||||
title: TDengine Kafka Connector Tutorial
|
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.
|
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.
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: Google Data Studio
|
|
||||||
title: Use Google Data Studio to access TDengine
|
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.
|
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.
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: JupyterLab
|
|
||||||
title: Connect JupyterLab to TDengine
|
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.
|
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.
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
---
|
---
|
||||||
title: Third Party Tools
|
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.
|
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.
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: Architecture
|
|
||||||
title: Architecture
|
title: Architecture
|
||||||
|
sidebar_label: Architecture
|
||||||
|
description: This document describes the architecture of TDengine.
|
||||||
---
|
---
|
||||||
|
|
||||||
## Cluster and Primary Logic Unit
|
## Cluster and Primary Logic Unit
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: High Availability
|
|
||||||
title: High Availability
|
title: High Availability
|
||||||
|
sidebar_label: High Availability
|
||||||
|
description: This document describes how TDengine implements high availability.
|
||||||
---
|
---
|
||||||
|
|
||||||
## High Availability of Vnode
|
## High Availability of Vnode
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: Load Balance
|
|
||||||
title: 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.
|
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.
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
---
|
---
|
||||||
title: TDengine Inside
|
title: TDengine Inside
|
||||||
|
description: This document describes the internals of TDengine from an architectural perspective.
|
||||||
---
|
---
|
||||||
|
|
||||||
```mdx-code-block
|
```mdx-code-block
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: TDengine + Telegraf + Grafana
|
|
||||||
title: Quickly Build IT DevOps Visualization System with 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
|
## Background
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: TDengine + collectd/StatsD + Grafana
|
|
||||||
title: Quickly build an IT DevOps visualization system using 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
|
## Background
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: OpenTSDB Migration to TDengine
|
|
||||||
title: Best Practices for Migrating OpenTSDB Applications 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.
|
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.
|
||||||
|
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue