<!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -->

English | 中文

IoTDB

Overview

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

Click for More Information

IoTDB depends on TsFile which is a columnar storage file format designed for time series data. The branch iotdb of TsFile project is used to deploy SNAPSHOT version for IoTDB project.

Main Features

The main features of IoTDB are as follows:

1. Flexible deployment strategy. IoTDB provides users with 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 structures from intelligent networking devices, organization for time series data from devices of the same type, and 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 are easy to use.
7. Seamless integration with state-of-the-practice Open Source Ecosystem. IoTDB supports analysis ecosystems, such as Hadoop and Spark, as well as visualization tools, 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.

<!-- TOC -->

Outline

• IoTDB
• Overview
• Main Features
  • Outline
• Quick Start
  • Prerequisites
  • Installation
    • Build from source
    • Configurations
  • Start
    • Start IoTDB
    • Use IoTDB
      • Use Cli
      • Basic commands for IoTDB
    • Stop IoTDB
  • Only build server
  • Only build cli
  • Usage of CSV Import and Export Tool

<!-- /TOC -->

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.

Prerequisites

To use IoTDB, you need to have:

1. Java >= 1.8 (1.8 to 25 are verified. Please make sure the environment path has been set accordingly).
2. Maven >= 3.6 (If you want to compile and install IoTDB from source code).
3. Set the max open files num as 65535 to avoid the "too many open files" error.
4. (Optional) Set the somaxconn as 65535 to avoid "connection reset" error when the system is under high load.

   # Linux
   > sudo sysctl -w net.core.somaxconn=65535
   
   # FreeBSD or Darwin
   > sudo sysctl -w kern.ipc.somaxconn=65535
   

⚠️ Important: System Resource Limits

IoTDB requires sufficient system resource limits to start correctly. If these limits are not configured, IoTDB may fail to start or emit warnings such as "too many open files" or "connection reset" in the logs.

Linux / macOS

ulimit -n 65535
sudo sysctl -w net.core.somaxconn=65535

Docker Users When running IoTDB in Docker, these limits must be applied on the host machine or explicitly passed to the container:

docker run --ulimit nofile=65535:65535 ...

Windows Users These commands are not applicable on Windows. Please follow the Windows installation steps below and ensure sufficient system resources.

Linux

(This guide is based on an installation of Ubuntu 22.04.)

Git

Make sure Git is installed, if it's missing, simply install it via:

sudo apt install git

Java

Make sure Java is installed, if it's missing, simply install it via:

sudo apt install default-jdk

Flex

sudo apt install flex

Bison

sudo apt install bison

Boost

sudo apt install libboost-all-dev

OpenSSL header files

Usually OpenSSL is already installed, however it's missing the header files we need to compile. So ensure these are installed:

sudo apt install libssl-dev

Mac OS

Git

First ensure git works.

Usually on a new Mac, as soon as you simply type git in a Terminal window, a popup will come up and ask if you want to finish installing the Mac developer tools. Just say yes. As soon as this is finished, you are free to use git.

Homebrew

Then install Homebrew - If this hasn't been installed yet, as we are going to be installing everything using Homebrew.

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

Java

As soon as that's done install Java, if this hasn't been installed yet:

brew install java

Depending on your version of Homebrew, it will tell you to do one of the following (depending on the type of processor in your device).

Mainly on the Intel-based models:

sudo ln -sfn /usr/local/opt/openjdk/libexec/openjdk.jdk /Library/Java/JavaVirtualMachines/openjdk.jdk

Mainly on the ARM-based models:

sudo ln -sfn /opt/homebrew/opt/openjdk/libexec/openjdk.jdk /Library/Java/JavaVirtualMachines/openjdk.jdk

CPP Prerequisites

Building Thrift requires us to add two more dependencies to the picture.

This however is only needed when enabling the with-cpp profile:

brew install boost
brew install bison
brew install openssl

Windows

Chocolatey

Then install Chocolatey - If this hasn't been installed yet, as we are going to be installing everything using Chocolatey.

https://chocolatey.org/install

Git

choco install git.install

Java

choco install openjdk

Visual Studio 19 2022

choco install visualstudio2022community
choco install visualstudio2022buildtools
choco install visualstudio2022-workload-nativedesktop

Flex / Bison

choco install winflexbison

Boost

choco install boost-msvc-14.2

OpenSSL

choco install openssl

Installation

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 D