TDengine is a time-series database designed to help traditional industries overcome the challenges of Industry 4.0 and Industrial IoT. It enables real-time ingestion, storage, analysis, and distribution of petabytes of data per day, generated by billions of sensors and data collectors. By making big data accessible and affordable, TDengine helps everyone — from independent developers and startups to industry stalwarts and multinationals — unlock the true value of their data.
This repository contains TDengine OSS, our open-source offering. Highlights include:
- Fast data ingestion through SQL or schemaless writing
- Efficient SQL queries including nested queries and UDF
- Windowed queries & extensions to SQL for time series data
- Cluster support with cloud native scalability
- Built-in caching, stream processing, and data subscription
- Client libraries for mainstream programming languages
TDengine also offers the on-prem TDengine Enterprise and fully managed TDengine Cloud built on the TDengine OSS codebase for enterprise customers. In addition to all features of TDengine OSS, these include:
- Ingestion from industrial data sources such as OPC, MQTT, PI System, and Wonderware Historian
- Integration with industry-specific analytics and visualization tools such as Seeq
- Data sharing with privilege management
- Automated data replication and backup
- Enterprise-grade security and O&M features
For more information about using and managing TDengine OSS, see TDengine Documentation.
At the moment, TDengine server supports running on Linux/Windows/macOS systems. Any application can also choose the RESTful interface provided by taosAdapter to connect the taosd service . TDengine supports X64/ARM64 CPU, and it will support MIPS64, Alpha64, ARM32, RISC-V and other CPU architectures in the future. Right now we don't support build with cross-compiling environment.
You can choose to install through source code, container, installation package or Kubernetes. This quick guide only applies to installing from source.
TDengine provide a few useful tools such as taosBenchmark (was named taosdemo) and taosdump. They were part of TDengine. By default, TDengine compiling does not include taosTools. You can use cmake .. -DBUILD_TOOLS=true to make them be compiled with TDengine.
To build TDengine, use CMake 3.13.0 or higher versions in the project directory.
sudo apt-get install -y gcc cmake build-essential git libssl-dev libgflags2.2 libgflags-dev libexpat1-dev libapr1-dev libaprutil1-dev libmxml-dev libgeos-dev To build the taosTools on Ubuntu/Debian, the following packages need to be installed.
sudo apt install build-essential libjansson-dev libsnappy-dev liblzma-dev libz-dev zlib1g pkg-config sudo yum install epel-release
sudo yum update
sudo yum install -y gcc gcc-c++ make cmake3 gflags git openssl-devel expat-devel geos-devel
sudo ln -sf /usr/bin/cmake3 /usr/bin/cmakesudo dnf install -y gcc gcc-c++ make cmake epel-release gflags git openssl-develsudo yum install -y zlib-devel zlib-static xz-devel snappy-devel jansson jansson-devel pkgconfig libatomic libatomic-static libstdc++-static openssl-devel
sudo yum install -y epel-release
sudo yum install -y dnf-plugins-core
sudo yum config-manager --set-enabled powertools
sudo yum install -y zlib-devel zlib-static xz-devel snappy-devel jansson jansson-devel pkgconfig libatomic libatomic-static libstdc++-static openssl-devel
Note: Since snappy lacks pkg-config support (refer to link), it leads a cmake prompt libsnappy not found. But snappy still works well.
If the PowerTools installation fails, you can try to use:
sudo yum config-manager --set-enabled powertools
Besides above dependencies, please run following commands:
sudo yum install centos-release-scl
sudo yum install devtoolset-9 devtoolset-9-libatomic-devel
scl enable devtoolset-9 -- bash
brew install argp-standalone gflags pkgconfig
TDengine includes a few components like taosAdapter developed by Go language. Please refer to golang.org official documentation for golang environment setup.
Please use version 1.20+. For the user in China, we recommend using a proxy to accelerate package downloading.
go env -w GO111MODULE=on
go env -w GOPROXY=https://goproxy.cn,direct
The default will not build taosAdapter, but you can use the following command to build taosAdapter as the service for RESTful interface.
cmake .. -DBUILD_HTTP=false
TDengine includes a few components developed by Rust language. Please refer to rust-lang.org official documentation for rust environment setup.
First of all, you may clone the source codes from github:
git clone https://github.com/taosdata/TDengine.git
cd TDengineYou can modify the file ~/.gitconfig to use ssh protocol instead of https for better download speed. You will need to upload ssh public key to GitHub first. Please refer to GitHub official documentation for detail.
[url "git@github.com:"]
insteadOf = https://github.com/
JDBC Connector， Go Connector，Python Connector，Node.js Connector，C# Connector ，Rust Connector and Grafana plugin has been moved to standalone repository.
You can run the bash script build.sh to build both TDengine and taosTools including taosBenchmark and taosdump as below:
./build.shIt equals to execute following commands:
mkdir debug
cd debug
cmake .. -DBUILD_TOOLS=true -DBUILD_CONTRIB=true
makeYou can use Jemalloc as memory allocator instead of glibc:
apt install autoconf
cmake .. -DJEMALLOC_ENABLED=true
TDengine build script can detect the host machine's architecture on X86-64, X86, arm64 platform. You can also specify CPUTYPE option like aarch64 too if the detection result is not correct:
aarch64:
cmake .. -DCPUTYPE=aarch64 && cmake --build .If you use the Visual Studio 2013, please open a command window by executing "cmd.exe". Please specify "amd64" for 64 bits Windows or specify "x86" for 32 bits Windows when you execute vcvarsall.bat.
mkdir debug && cd debug
"C:\Program Files (x86)\Microsoft Visual Studio 12.0\VC\vcvarsall.bat" < amd64 | x86 >
cmake .. -G "NMake Makefiles"
nmakeIf you use the Visual Studio 2019 or 2017:
please open a command window by executing "cmd.exe". Please specify "x64" for 64 bits Windows or specify "x86" for 32 bits Windows when you execute vcvarsall.bat.
mkdir debug && cd debug
"c:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvarsall.bat" < x64 | x86 >
cmake .. -G "NMake Makefiles"
nmakeOr, you can simply open a command window by clicking Windows Start -> "Visual Studio < 2019 | 2017 >" folder -> "x64 Native Tools Command Prompt for VS < 2019 | 2017 >" or "x86 Native Tools Command Prompt for VS < 2019 | 2017 >" depends what architecture your Windows is, then execute commands as follows:
mkdir debug && cd debug
cmake .. -G "NMake Makefiles"
nmakePlease install XCode command line tools and cmake. Verified with XCode 11.4+ on Catalina and Big Sur.
mkdir debug && cd debug
cmake .. && cmake --build .After building successfully, TDengine can be installed by
sudo make installUsers can find more information about directories installed on the system in the directory and files section.
Installing from source code will also configure service management for TDengine.Users can also choose to install from packages for it.
To start the service after installation, in a terminal, use:
sudo systemctl start taosdThen users can use the TDengine CLI to connect the TDengine server. In a terminal, use:
taosIf TDengine CLI connects the server successfully, welcome messages and version info are printed. Otherwise, an error message is shown.
After building successfully, TDengine can be installed by:
nmake installAfter building successfully, TDengine can be installed by:
sudo make installUsers can find more information about directories installed on the system in the directory and files section.
Installing from source code will also configure service management for TDengine.Users can also choose to install from packages for it.
To start the service after installation, double-click the /applications/TDengine to start the program, or in a terminal, use:
sudo launchctl start com.tdengine.taosdThen users can use the TDengine CLI to connect the TDengine server. In a terminal, use:
taosIf TDengine CLI connects the server successfully, welcome messages and version info are printed. Otherwise, an error message is shown.
If you don't want to run TDengine as a service, you can run it in current shell. For example, to quickly start a TDengine server after building, run the command below in terminal: (We take Linux as an example, command on Windows will be taosd.exe)
./build/bin/taosd -c test/cfgIn another terminal, use the TDengine CLI to connect the server:
./build/bin/taos -c test/cfgoption "-c test/cfg" specifies the system configuration file directory.
It is easy to run SQL commands from TDengine CLI which is the same as other SQL databases.
CREATE DATABASE demo;
USE demo;
CREATE TABLE t (ts TIMESTAMP, speed INT);
INSERT INTO t VALUES('2019-07-15 00:00:00', 10);
INSERT INTO t VALUES('2019-07-15 01:00:00', 20);
SELECT * FROM t;
ts | speed |
===================================
19-07-15 00:00:00.000| 10|
19-07-15 01:00:00.000| 20|
Query OK, 2 row(s) in set (0.001700s)TDengine provides client libraries with which you can develop applications for TDengine. The documentation for these libraries is listed as follows:
TDengine also provides a REST API through which your applications can connect to TDengine.
If you would like to contribute to TDengine, we ask that you review our contribution guidelines.
For more information about TDengine, you can follow us on social media and join our Discord server: