Merge branch 'rel/0.11' of into CRRC-log
tree: d59c229872c84a12c3d3c82737b253d79006ae2b
  1. .github/
  2. .mvn/
  3. antlr/
  4. cli/
  5. client-cpp/
  6. client-py/
  7. compile-tools/
  8. cross-tests/
  9. distribution/
  10. docker/
  11. docs/
  12. example/
  13. flink-iotdb-connector/
  14. flink-tsfile-connector/
  15. grafana/
  16. hadoop/
  17. hive-connector/
  18. jdbc/
  19. licenses/
  20. server/
  21. service-rpc/
  22. session/
  23. site/
  24. spark-iotdb-connector/
  25. spark-tsfile/
  26. thrift/
  27. tools/
  28. tsfile/
  29. .asf.yaml
  30. .checkstyle
  31. .gitignore
  32. .travis.yml
  33. asf.header
  34. checkstyle.xml
  35. codecov.yml
  36. java-google-style.xml
  37. jenkins.pom
  38. Jenkinsfile
  40. LICENSE-binary
  41. mvnw.cmd
  43. NOTICE
  44. NOTICE-binary
  45. pom.xml

English | 中文


Build Status coveralls GitHub release License IoTDB Website Maven Version Gitpod Ready-to-Code


IoTDB (Internet of Things Database) is a data management system for time series data, which can provide users specific services, such as, data collection, storage and analysis. Due to its light weight structure, high performance and usable features together with its seamless integration with the Hadoop and Spark ecology, IoTDB meets the requirements of massive dataset storage, high throughput data input, and complex data analysis in the industrial IoT field.

Main Features

Main features of IoTDB are as follows:

  1. Flexible deployment strategy. IoTDB provides users a one-click installation tool on either the cloud platform or the terminal devices, and a data synchronization tool bridging the data on cloud platform and terminals.
  2. Low cost on hardware. IoTDB can reach a high compression ratio of disk storage.
  3. Efficient directory structure. IoTDB supports efficient organization for complex time series data structure from intelligent networking devices, organization for time series data from devices of the same type, fuzzy searching strategy for massive and complex directory of time series data.
  4. High-throughput read and write. IoTDB supports millions of low-power devices' strong connection data access, high-speed data read and write for intelligent networking devices and mixed devices mentioned above.
  5. Rich query semantics. IoTDB supports time alignment for time series data across devices and measurements, computation in time series field (frequency domain transformation) and rich aggregation function support in time dimension.
  6. Easy to get started. IoTDB supports SQL-Like language, JDBC standard API and import/export tools which is easy to use.
  7. Seamless integration with state-of-the-practice Open Source Ecosystem. IoTDB supports analysis ecosystems such as, Hadoop, Spark, and visualization tool, such as, Grafana.

For the latest information about IoTDB, please visit IoTDB official website. If you encounter any problems or identify any bugs while using IoTDB, please report an issue in jira.


Quick Start

This short guide will walk you through the basic process of using IoTDB. For a more detailed introduction, please visit our website's User Guide.


To use IoTDB, you need to have:

  1. Java >= 1.8 (1.8, 11, and 13 are verified. Please make sure the environment path has been set accordingly).
  2. Maven >= 3.1 (If you want to compile and install IoTDB from source code).
  3. Set the max open files num as 65535 to avoid “too many open files” error.


IoTDB provides three installation methods, you can refer to the following suggestions, choose the one fits you best:

  • Installation from source code. If you need to modify the code yourself, you can use this method.
  • Installation from binary files. Download the binary files from the official website. This is the recommended method, in which you will get a binary released package which is out-of-the-box.
  • Using Docker:The path to the dockerfile is

Here in the Quick Start, we give a brief introduction of using source code to install IoTDB. For further information, please refer to Chapter 3 of the User Guide.

Build from source

You can download the source code from:

git clone

The default master branch is the dev branch, If you want to use a released version x.x.x:

git checkout release/x.x.x

Under the root path of iotdb:

> mvn clean package -DskipTests

Then the binary version (including both server and cli) can be found at distribution/target/apache-iotdb-{project.version}

NOTE: Directories “thrift/target/generated-sources/thrift” and “antlr/target/generated-sources/antlr4” need to be added to sources roots to avoid compilation errors in the IDE.


configuration files are under “conf” folder

  • environment config module (iotdb-env.bat,,
  • system config module (
  • log config module (logback.xml).

For more information, please see Chapter3: Server.


You can go through the following steps to test the installation, if there is no error returned after execution, the installation is completed.

Start IoTDB

Users can start IoTDB by the start-server script under the sbin folder.

# Unix/OS X
> nohup sbin/ >/dev/null 2>&1 &
> nohup sbin/ -c <conf_path> -rpc_port <rpc_port> >/dev/null 2>&1 &

# Windows
> sbin\start-server.bat -c <conf_path> -rpc_port <rpc_port>
  • “-c” and “-rpc_port” are optional.
  • option “-c” specifies the system configuration file directory.
  • option “-rpc_port” specifies the rpc port.
  • if both option specified, the rpc_port will overrides the rpc_port in conf_path.


Use Cli

IoTDB offers different ways to interact with server, here we introduce the basic steps of using Cli tool to insert and query data.

After installing IoTDB, there is a default user ‘root’, its default password is also ‘root’. Users can use this default user to login Cli to use IoTDB. The startup script of Cli is the start-cli script in the folder sbin. When executing the script, user should assign IP, PORT, USER_NAME and PASSWORD. The default parameters are “-h -p 6667 -u root -pw -root”.

Here is the command for starting the Cli:

# Unix/OS X
> sbin/ -h -p 6667 -u root -pw root

# Windows
> sbin\start-cli.bat -h -p 6667 -u root -pw root

The command line cli is interactive, so you should see the welcome logo and statements if everything is ready:

 _____       _________  ______   ______
|_   _|     |  _   _  ||_   _ `.|_   _ \
  | |   .--.|_/ | | \_|  | | `. \ | |_) |
  | | / .'`\ \  | |      | |  | | |  __'.
 _| |_| \__. | _| |_    _| |_.' /_| |__) |
|_____|'.__.' |_____|  |______.'|_______/  version x.x.x

IoTDB> login successfully

Basic commands for IoTDB

Now, let us introduce the way of creating timeseries, inserting data and querying data.

The data in IoTDB is organized as timeseries. Each timeseries includes multiple data-time pairs, and is owned by a storage group. Before defining a timeseries, we should define a storage group using SET STORAGE GROUP first, and here is an example:


We can also use SHOW STORAGE GROUP to check the storage group being created:

|                      Storage Group|
|                            root.ln|
storage group number = 1

After the storage group is set, we can use CREATE TIMESERIES to create a new timeseries. When creating a timeseries, we should define its data type and the encoding scheme. Here We create two timeseries:


In order to query the specific timeseries, we can use SHOW TIMESERIES . represent the location of the timeseries. The default value is “null”, which queries all the timeseries in the system(the same as using “SHOW TIMESERIES root”). Here are some examples:

  1. Querying all timeseries in the system:
|                   timeseries  | alias|storage group|dataType|encoding|compression|tags|attributes|
|       root.ln.wf01.wt01.status|  null|      root.ln| BOOLEAN|   PLAIN|     SNAPPY|null|      null|
|  root.ln.wf01.wt01.temperature|  null|      root.ln|   FLOAT|     RLE|     SNAPPY|null|      null|
Total timeseries number = 2
  1. Querying a specific timeseries(root.ln.wf01.wt01.status):
IoTDB> SHOW TIMESERIES root.ln.wf01.wt01.status
|                   timeseries  | alias|storage group|dataType|encoding|compression|tags|attributes|
|       root.ln.wf01.wt01.status|  null|      root.ln| BOOLEAN|   PLAIN|     SNAPPY|null|      null|
Total timeseries number = 1

Insert timeseries data is a basic operation of IoTDB, you can use ‘INSERT’ command to finish this. Before insertion, you should assign the timestamp and the suffix path name:

IoTDB> INSERT INTO root.ln.wf01.wt01(timestamp,status) values(100,true);
IoTDB> INSERT INTO root.ln.wf01.wt01(timestamp,status,temperature) values(200,false,20.71)

The data that you have just inserted will display as follows:

IoTDB> SELECT status FROM root.ln.wf01.wt01
|                   Time|root.ln.wf01.wt01.status|
|1970-01-01T08:00:00.100|                    true|
|1970-01-01T08:00:00.200|                   false|
Total line number = 2

You can also query several timeseries data using one SQL statement:

IoTDB> SELECT * FROM root.ln.wf01.wt01
|                   Time|  root.ln.wf01.wt01.status|root.ln.wf01.wt01.temperature|
|1970-01-01T08:00:00.100|                      true|                         null|
|1970-01-01T08:00:00.200|                     false|                        20.71|
Total line number = 2

The commands to exit the Cli are:

IoTDB> quit
IoTDB> exit

For more information about the commands supported by IoTDB SQL, please see SQL Reference.

Stop IoTDB

The server can be stopped with “ctrl-C” or the following script:

# Unix/OS X
> sbin/

# Windows
> sbin\stop-server.bat

Only build server

Under the root path of iotdb:

> mvn clean package -pl server -am -DskipTests

After being built, the IoTDB server is located at the folder: “server/target/iotdb-server-{project.version}”.

Only build cli

Under the root path of iotdb:

> mvn clean package -pl cli -am -DskipTests

After being built, the IoTDB cli is located at the folder “cli/target/iotdb-cli-{project.version}”.

Frequent Questions for Compiling

see Frequent Questions when Compiling the Source Code