Developer Guide
To develop an application to process time-series data using TDengine, we recommend taking the following steps:
- Choose the method to connect to TDengine. No matter what programming language you use, you can always use the REST interface to access TDengine, but you can also use connectors unique to each programming language.
- Design the data model based on your own use cases. Learn the concepts of TDengine including "one table for one data collection point" and the "super table" (STable) concept; learn about static labels, collected metrics, and subtables. Depending on the characteristics of your data and your requirements, you may decide to create one or more databases, and you should design the STable schema to fit your data.
- Decide how you will insert data. TDengine supports writing using standard SQL, but also supports schemaless writing, so that data can be written directly without creating tables manually.
- Based on business requirements, find out what SQL query statements need to be written. You may be able to repurpose any existing SQL.
- If you want to run real-time analysis based on time series data, including various dashboards, it is recommended that you use the TDengine continuous query feature instead of deploying complex streaming processing systems such as Spark or Flink.
- If your application has modules that need to consume inserted data, and they need to be notified when new data is inserted, it is recommended that you use the data subscription function provided by TDengine without the need to deploy Kafka.
- In many use cases (such as fleet management), the application needs to obtain the latest status of each data collection point. It is recommended that you use the cache function of TDengine instead of deploying Redis separately.
- If you find that the SQL functions of TDengine cannot meet your requirements, then you can use user-defined functions to solve the problem.
This section is organized in the order described above. For ease of understanding, TDengine provides sample code for each supported programming language for each function. If you want to learn more about the use of SQL, please read the SQL manual. For a more in-depth understanding of the use of each connector, please read the Connector Reference Guide. If you also want to integrate TDengine with third-party systems, such as Grafana, please refer to the third-party tools.
If you encounter any problems during the development process, please click "Submit an issue" at the bottom of each page and submit it on GitHub right away.
📄️ Connect
This document explains how to establish connections to TDengine, and briefly introduces how to install and use TDengine connectors.
📄️ Data Model
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 (an abbreviation for super table) schema to fit your data. This chapter will explain the big picture without getting into syntactical details.
🗃️ Insert Data
4 items
📄️ Query Data
This chapter introduces major query functionalities and how to perform sync and async query using connectors.
📄️ Continuous Query
Continuous query is a query that's executed automatically at a predefined frequency to provide aggregate query capability by time window. It is essentially simplified, time driven, stream computing.
📄️ Data Subscription
Lightweight service for data subscription and publishing. Time series data inserted into TDengine continuously can be pushed automatically to subscribing clients.
📄️ Cache
The latest row of each table is kept in cache to provide high performance query of latest state.
📄️ UDF
Scalar functions and aggregate functions developed by users can be utilized by the query framework to expand query capability
