README.md 7.4 KB
Newer Older
1 2
[![Build Status](https://travis-ci.org/taosdata/TDengine.svg?branch=master)](https://travis-ci.org/taosdata/TDengine)
[![Build status](https://ci.appveyor.com/api/projects/status/kf3pwh2or5afsgl9/branch/master?svg=true)](https://ci.appveyor.com/project/sangshuduo/tdengine-2n8ge/branch/master)
3
[![Coverage Status](https://coveralls.io/repos/github/taosdata/TDengine/badge.svg?branch=develop)](https://coveralls.io/github/taosdata/TDengine?branch=develop)
S
Shuduo Sang 已提交
4
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/4201/badge)](https://bestpractices.coreinfrastructure.org/projects/4201)
5
![Docker Pulls](https://img.shields.io/docker/pulls/tdengine/tdengine)
6

J
Jeff Tao 已提交
7
[![TDengine](TDenginelogo.png)](https://www.taosdata.com)
H
hzcheng 已提交
8 9 10

# What is TDengine?

J
johnnyhou327 已提交
11
TDengine is an open-sourced big data platform under [GNU AGPL v3.0](http://www.gnu.org/licenses/agpl-3.0.html), designed and optimized for the Internet of Things (IoT), Connected Cars, Industrial IoT, and IT Infrastructure and Application Monitoring. Besides the 10x faster time-series database, it provides caching, stream computing, message queuing and other functionalities to reduce the complexity and cost of development and operation.
H
hzcheng 已提交
12

J
johnnyhou327 已提交
13
- **10x Faster on Insert/Query Speeds**: Through the innovative design on storage, on a single-core machine, over 20K requests can be processed, millions of data points can be ingested, and over 10 million data points can be retrieved in a second. It is 10 times faster than other databases.
H
hzcheng 已提交
14

S
StoneT2000 已提交
15
- **1/5 Hardware/Cloud Service Costs**: Compared with typical big data solutions, less than 1/5 of computing resources are required. Via column-based storage and tuned compression algorithms for different data types, less than 1/10 of storage space is needed.
H
hzcheng 已提交
16

H
Hongze Cheng 已提交
17
- **Full Stack for Time-Series Data**: By integrating a database with message queuing, caching, and stream computing features together, it is no longer necessary to integrate Kafka/Redis/HBase/Spark or other software. It makes the system architecture much simpler and more robust.
H
hzcheng 已提交
18

S
StoneT2000 已提交
19
- **Powerful Data Analysis**: Whether it is 10 years or one minute ago, data can be queried just by specifying the time range. Data can be aggregated over time, multiple time streams or both. Ad Hoc queries or analyses can be executed via TDengine shell, Python, R or Matlab.
H
hzcheng 已提交
20

S
StoneT2000 已提交
21
- **Seamless Integration with Other Tools**: Telegraf, Grafana, Matlab, R, and other tools can be integrated with TDengine without a line of code. MQTT, OPC, Hadoop, Spark, and many others will be integrated soon.
H
hzcheng 已提交
22

J
johnnyhou327 已提交
23
- **Zero Management, No Learning Curve**: It takes only seconds to download, install, and run it successfully; there are no other dependencies. Automatic partitioning on tables or DBs. Standard SQL is used, with C/C++, Python, JDBC, Go and RESTful connectors.
H
hzcheng 已提交
24 25

# Documentation
X
Xiaxin Li 已提交
26
For user manual, system design and architecture, engineering blogs, refer to [TDengine Documentation](https://www.taosdata.com/en/documentation/)(中文版请点击[这里](https://www.taosdata.com/cn/documentation20/))
S
StoneT2000 已提交
27
 for details. The documentation from our website can also be downloaded locally from *documentation/tdenginedocs-en* or *documentation/tdenginedocs-cn*.
H
hzcheng 已提交
28 29

# Building
H
hzcheng 已提交
30
At the moment, TDengine only supports building and running on Linux systems. You can choose to [install from packages](https://www.taosdata.com/en/getting-started/#Install-from-Package) or from the source code. This quick guide is for installation from the source only.
H
hzcheng 已提交
31

J
Jeff Tao 已提交
32
To build TDengine, use [CMake](https://cmake.org/) 2.8 or higher versions in the project directory. Install CMake for example on Ubuntu:
33 34 35 36
```
sudo apt-get install -y cmake build-essential
```

J
johnnyhou327 已提交
37 38 39 40 41 42 43 44 45 46
To compile and package the JDBC driver source code, you should have a Java jdk-8 or higher and Apache Maven 2.7 or higher installed. 
To install openjdk-8 on Ubuntu:
```
sudo apt-get install openjdk-8-jdk
```
To install Apache Maven on Ubuntu:
```
sudo apt-get install maven
```

47 48
Build TDengine:

L
lihui 已提交
49
```
S
Shuduo Sang 已提交
50
mkdir debug && cd debug
H
hzcheng 已提交
51 52
cmake .. && cmake --build .
```
J
John Zhuang 已提交
53

H
huili 已提交
54
To compile on an ARM processor (aarch64 or aarch32), please add option CPUTYPE as below:
L
lihui 已提交
55

H
huili 已提交
56
aarch64:
H
huili 已提交
57
```cmd
H
huili 已提交
58
cmake .. -DCPUTYPE=aarch64 && cmake --build .
H
huili 已提交
59
```
H
huili 已提交
60 61

aarch32:
H
huili 已提交
62
```cmd
H
huili 已提交
63
cmake .. -DCPUTYPE=aarch32 && cmake --build .
L
lihui 已提交
64 65
```

J
Jeff Tao 已提交
66
# Quick Run
H
Hongze Cheng 已提交
67
To quickly start a TDengine server after building, run the command below in terminal:
J
John Zhuang 已提交
68
```cmd
H
hzcheng 已提交
69 70
./build/bin/taosd -c test/cfg
```
J
johnnyhou327 已提交
71
In another terminal, use the TDengine shell to connect the server:
H
hzcheng 已提交
72 73 74
```
./build/bin/taos -c test/cfg
```
J
Jeff Tao 已提交
75
option "-c test/cfg" specifies the system configuration file directory. 
H
hzcheng 已提交
76

H
Hongze Cheng 已提交
77 78 79 80 81 82 83
# Installing
After building successfully, TDengine can be installed by:
```cmd
make install
```
Users can find more information about directories installed on the system in the [directory and files](https://www.taosdata.com/en/documentation/administrator/#Directory-and-Files) section. It should be noted that installing from source code does not configure service management for TDengine.
Users can also choose to [install from packages](https://www.taosdata.com/en/getting-started/#Install-from-Package) for it.
H
hzcheng 已提交
84

H
Hongze Cheng 已提交
85
To start the service after installation, in a terminal, use:
H
hzcheng 已提交
86 87 88 89
```cmd
taosd
```

J
Jeff Tao 已提交
90
Then users can use the [TDengine shell](https://www.taosdata.com/en/getting-started/#TDengine-Shell) to connect the TDengine server. In a terminal, use:
H
hzcheng 已提交
91 92 93 94
```cmd
taos
```

J
Jeff Tao 已提交
95
If TDengine shell connects the server successfully, welcome messages and version info are printed. Otherwise, an error message is shown.
H
hzcheng 已提交
96 97

# Try TDengine
J
Jeff Tao 已提交
98
It is easy to run SQL commands from TDengine shell which is the same as other SQL databases.
H
hzcheng 已提交
99 100 101 102 103 104 105 106 107 108 109
```sql
create database db;
use db;
create table t (ts timestamp, a int);
insert into t values ('2019-07-15 00:00:00', 1);
insert into t values ('2019-07-15 01:00:00', 2);
select * from t;
drop database db;
```

# Developing with TDengine
110 111 112
### Official Connectors

TDengine provides abundant developing tools for users to develop on TDengine. Follow the links below to find your desired connectors and relevant documentation.
H
hzcheng 已提交
113 114 115 116 117 118

- [Java](https://www.taosdata.com/en/documentation/connector/#Java-Connector)
- [C/C++](https://www.taosdata.com/en/documentation/connector/#C/C++-Connector)
- [Python](https://www.taosdata.com/en/documentation/connector/#Python-Connector)
- [Go](https://www.taosdata.com/en/documentation/connector/#Go-Connector)
- [RESTful API](https://www.taosdata.com/en/documentation/connector/#RESTful-Connector)
S
StoneT2000 已提交
119
- [Node.js](https://www.taosdata.com/en/documentation/connector/#Node.js-Connector)
H
hzcheng 已提交
120

121 122 123 124 125 126 127
### Third Party Connectors

The TDengine community has also kindly built some of their own connectors! Follow the links below to find the source code for them.

- [Rust Connector](https://github.com/taosdata/TDengine/tree/master/tests/examples/rust)
- [.Net Core Connector](https://github.com/maikebing/Maikebing.EntityFrameworkCore.Taos)

sangshuduo's avatar
sangshuduo 已提交
128 129 130 131
# How to run the test cases and how to add a new test case?
  TDengine's test framework and all test cases are fully open source.
  Please refer to [this document](tests/How-To-Run-Test-And-How-To-Add-New-Test-Case.md) for how to run test and develop new test case.

J
Jeff Tao 已提交
132
# TDengine Roadmap
S
StoneT2000 已提交
133
- Support event-driven stream computing
J
Jeff Tao 已提交
134 135 136
- Support user defined functions
- Support MQTT connection
- Support OPC connection
S
StoneT2000 已提交
137
- Support Hadoop, Spark connections
J
Jeff Tao 已提交
138 139
- Support Tableau and other BI tools

W
winshining 已提交
140
# Contribute to TDengine
H
hzcheng 已提交
141 142

Please follow the [contribution guidelines](CONTRIBUTING.md) to contribute to the project.
L
lihui 已提交
143 144 145 146 147

# Join TDengine WeChat Group

Add WeChat “tdengine” to join the group,you can communicate with other users.