You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@iotdb.apache.org by qi...@apache.org on 2022/10/21 07:15:16 UTC

svn commit: r57503 [1/2] - /release/iotdb/0.13.3/

Author: qiaojialin
Date: Fri Oct 21 07:15:16 2022
New Revision: 57503

Log:
upload 0.13.3 release files

Added:
    release/iotdb/0.13.3/
    release/iotdb/0.13.3/README.md
    release/iotdb/0.13.3/README_ZH.md
    release/iotdb/0.13.3/RELEASE_NOTES.md
    release/iotdb/0.13.3/apache-iotdb-0.13.3-all-bin.zip   (with props)
    release/iotdb/0.13.3/apache-iotdb-0.13.3-all-bin.zip.asc
    release/iotdb/0.13.3/apache-iotdb-0.13.3-all-bin.zip.sha512
    release/iotdb/0.13.3/apache-iotdb-0.13.3-cli-bin.zip   (with props)
    release/iotdb/0.13.3/apache-iotdb-0.13.3-cli-bin.zip.asc
    release/iotdb/0.13.3/apache-iotdb-0.13.3-cli-bin.zip.sha512
    release/iotdb/0.13.3/apache-iotdb-0.13.3-client-cpp-mac-x86_64-bin.zip   (with props)
    release/iotdb/0.13.3/apache-iotdb-0.13.3-client-cpp-mac-x86_64-bin.zip.asc
    release/iotdb/0.13.3/apache-iotdb-0.13.3-client-cpp-mac-x86_64-bin.zip.sha512
    release/iotdb/0.13.3/apache-iotdb-0.13.3-cluster-bin.zip   (with props)
    release/iotdb/0.13.3/apache-iotdb-0.13.3-cluster-bin.zip.asc
    release/iotdb/0.13.3/apache-iotdb-0.13.3-cluster-bin.zip.sha512
    release/iotdb/0.13.3/apache-iotdb-0.13.3-grafana-connector-bin.zip   (with props)
    release/iotdb/0.13.3/apache-iotdb-0.13.3-grafana-connector-bin.zip.asc
    release/iotdb/0.13.3/apache-iotdb-0.13.3-grafana-connector-bin.zip.sha512
    release/iotdb/0.13.3/apache-iotdb-0.13.3-grafana-plugin-bin.zip   (with props)
    release/iotdb/0.13.3/apache-iotdb-0.13.3-grafana-plugin-bin.zip.asc
    release/iotdb/0.13.3/apache-iotdb-0.13.3-grafana-plugin-bin.zip.sha512
    release/iotdb/0.13.3/apache-iotdb-0.13.3-server-bin.zip   (with props)
    release/iotdb/0.13.3/apache-iotdb-0.13.3-server-bin.zip.asc
    release/iotdb/0.13.3/apache-iotdb-0.13.3-server-bin.zip.sha512
    release/iotdb/0.13.3/apache-iotdb-0.13.3-source-release.zip   (with props)
    release/iotdb/0.13.3/apache-iotdb-0.13.3-source-release.zip.asc
    release/iotdb/0.13.3/apache-iotdb-0.13.3-source-release.zip.sha512

Added: release/iotdb/0.13.3/README.md
==============================================================================
--- release/iotdb/0.13.3/README.md (added)
+++ release/iotdb/0.13.3/README.md Fri Oct 21 07:15:16 2022
@@ -0,0 +1,419 @@
+<!--
+
+    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](./README.md) | [中文](./README_ZH.md)
+
+# IoTDB
+[![Main Mac and Linux](https://github.com/apache/iotdb/actions/workflows/main-unix.yml/badge.svg)](https://github.com/apache/iotdb/actions/workflows/main-unix.yml)
+[![Main Win](https://github.com/apache/iotdb/actions/workflows/main-win.yml/badge.svg)](https://github.com/apache/iotdb/actions/workflows/main-win.yml)
+[![coveralls](https://coveralls.io/repos/github/apache/iotdb/badge.svg?branch=master)](https://coveralls.io/repos/github/apache/iotdb/badge.svg?branch=master)
+[![GitHub release](https://img.shields.io/github/release/apache/iotdb.svg)](https://github.com/apache/iotdb/releases)
+[![License](https://img.shields.io/badge/license-Apache%202-4EB1BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)
+![](https://github-size-badge.herokuapp.com/apache/iotdb.svg)
+![](https://img.shields.io/github/downloads/apache/iotdb/total.svg)
+![](https://img.shields.io/badge/platform-win10%20%7C%20macox%20%7C%20linux-yellow.svg)
+![](https://img.shields.io/badge/java--language-1.8-blue.svg)
+[![Language grade: Java](https://img.shields.io/lgtm/grade/java/g/apache/iotdb.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/apache/iotdb/context:java)
+[![IoTDB Website](https://img.shields.io/website-up-down-green-red/https/shields.io.svg?label=iotdb-website)](https://iotdb.apache.org/)
+[![Maven Version](https://maven-badges.herokuapp.com/maven-central/org.apache.iotdb/iotdb-parent/badge.svg)](http://search.maven.org/#search|gav|1|g:"org.apache.iotdb")
+[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/apache/iotdb)
+[![Slack Status](https://img.shields.io/badge/slack-join_chat-white.svg?logo=slack&style=social)](https://join.slack.com/t/apacheiotdb/shared_invite/zt-qvso1nj8-7715TpySZtZqmyG5qXQwpg)
+
+# Overview
+
+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](https://iotdb.apache.org/). If you encounter any problems or identify any bugs while using IoTDB, please report an issue in [jira](https://issues.apache.org/jira/projects/IOTDB/issues).
+
+<!-- TOC -->
+
+## Outline
+
+- [IoTDB](#iotdb)
+- [Overview](#overview)
+- [Main Features](#main-features)
+  - [Outline](#outline)
+- [Quick Start](#quick-start)
+  - [Prerequisites](#prerequisites)
+  - [Installation](#installation)
+    - [Build from source](#build-from-source)
+    - [Configurations](#configurations)
+  - [Start](#start)
+    - [Start IoTDB](#start-iotdb)
+    - [Use IoTDB](#use-iotdb)
+      - [Use Cli](#use-cli)
+      - [Basic commands for IoTDB](#basic-commands-for-iotdb)
+    - [Stop IoTDB](#stop-iotdb)
+  - [Only build server](#only-build-server)
+  - [Only build cli](#only-build-cli)
+  - [Usage of CSV Import and Export Tool](#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](https://iotdb.apache.org/UserGuide/Master/QuickStart/QuickStart.html).
+
+## Prerequisites
+
+To use IoTDB, you need to have:
+
+1. Java >= 1.8 (1.8, 11 to 17 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 "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
+    ```
+
+## 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 Docker：The path to the dockerfile is https://github.com/apache/iotdb/tree/master/docker/src/main
+
+
+Here in the Quick Start, we give a brief introduction of using source code to install IoTDB. For further information, please refer to [User Guide](https://iotdb.apache.org/UserGuide/Master/QuickStart/QuickStart.html).
+
+## Build from source
+
+### Prepare Thrift compiler
+
+Skip this chapter if you are using Windows. 
+
+As we use Thrift for our RPC module (communication and
+protocol definition), we involve Thrift during the compilation, so Thrift compiler 0.13.0 (or
+higher) is required to generate Thrift Java code. Thrift officially provides binary compiler for
+Windows, but unfortunately, they do not provide that for Unix OSs. 
+
+If you have permission to install new softwares, use `apt install` or `yum install` or `brew install`
+to install the Thrift compiler (If you already have installed the thrift compiler, skip this step).
+Then, you may add the following parameter
+when running Maven: `-Dthrift.download-url=http://apache.org/licenses/LICENSE-2.0.txt -Dthrift.exec.absolute.path=<YOUR LOCAL THRIFT BINARY FILE>`.
+
+If not, then you have to compile the thrift compiler, and it requires you install a boost library first.
+Therefore, we compiled a Unix  compiler ourselves and put it onto GitHub, and with the help of a
+maven plugin, it will be  downloaded automatically during compilation. 
+This compiler works fine with gcc8 or later, Ubuntu  MacOS, and CentOS, but previous versions 
+and other OSs are not guaranteed.
+
+If you can not download the thrift compiler automatically because of network problem, you can download 
+it yourself, and then either:
+rename your thrift file to `{project_root}\thrift\target\tools\thrift_0.12.0_0.13.0_linux.exe`;
+or, add Maven commands:
+`-Dthrift.download-url=http://apache.org/licenses/LICENSE-2.0.txt -Dthrift.exec.absolute.path=<YOUR LOCAL THRIFT BINARY FILE>`.
+
+### Compile IoTDB
+
+You can download the source code from:
+
+```
+git clone https://github.com/apache/iotdb.git
+```
+
+The default dev branch is the master branch, If you want to use a released version x.x.x:
+
+```
+git checkout release/x.x.x
+```
+
+From v0.11.3 on, the tag name format is change to: vx.x.x:
+
+```
+git checkout vx.x.x
+```
+
+Under the root path of iotdb:
+
+```
+> mvn clean package -DskipTests
+```
+
+Using `-P compile-cpp` for compiling cpp client (For more details, read client-cpp's Readme file.)
+
+Then the binary version (including both server and cli) can be found at **distribution/target/apache-iotdb-{project.version}-all-bin.zip**
+
+**NOTE: Directories "`thrift/target/generated-sources/thrift`", "`thrift-sync/target/generated-sources/thrift`",
+"`thrift-cluster/target/generated-sources/thrift`"
+and "`antlr/target/generated-sources/antlr4`" need to be added to sources roots to avoid compilation errors in the IDE.**
+
+**In IDEA, you just need to right click on the root project name and choose "`Maven->Reload Project`" after 
+you run `mvn package` successfully.**
+
+### Configurations
+
+configuration files are under "conf" folder
+
+  * environment config module (`iotdb-env.bat`, `iotdb-env.sh`),
+  * system config module (`iotdb-engine.properties`)
+  * log config module (`logback.xml`).
+
+For more information, please see [Config Manual](https://iotdb.apache.org/UserGuide/Master/Reference/Config-Manual.html).
+
+## Start
+
+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/start-server.sh >/dev/null 2>&1 &
+or
+> nohup sbin/start-server.sh -c <conf_path> >/dev/null 2>&1 &
+
+# Windows
+> sbin\start-server.bat -c <conf_path>
+```
+
+- "-c" is optional.
+- option "-c" specifies the system configuration file directory.
+
+
+### Use IoTDB
+
+#### 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 127.0.0.1 -p 6667 -u root -pw -root".
+
+Here is the command for starting the Cli:
+
+```
+# Unix/OS X
+> sbin/start-cli.sh -h 127.0.0.1 -p 6667 -u root -pw root
+
+# Windows
+> sbin\start-cli.bat -h 127.0.0.1 -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
+IoTDB>
+```
+
+#### 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:
+
+```
+IoTDB> SET STORAGE GROUP TO root.ln
+```
+
+We can also use SHOW STORAGE GROUP to check the storage group being created:
+
+```
+IoTDB> SHOW STORAGE GROUP
++-------------+
+|storage group|
++-------------+
+|      root.ln|
++-------------+
+Total line 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:
+
+```
+IoTDB> CREATE TIMESERIES root.ln.wf01.wt01.status WITH DATATYPE=BOOLEAN, ENCODING=PLAIN
+IoTDB> CREATE TIMESERIES root.ln.wf01.wt01.temperature WITH DATATYPE=FLOAT, ENCODING=RLE
+```
+
+In order to query the specific timeseries, we can use SHOW TIMESERIES <Path>. <Path> 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:
+
+```
+IoTDB> SHOW TIMESERIES
++-----------------------------+-----+-------------+--------+--------+-----------+----+----------+
+|                   timeseries|alias|storage group|dataType|encoding|compression|tags|attributes|
++-----------------------------+-----+-------------+--------+--------+-----------+----+----------+
+|root.ln.wf01.wt01.temperature| null|      root.ln|   FLOAT|     RLE|     SNAPPY|null|      null|
+|     root.ln.wf01.wt01.status| null|      root.ln| BOOLEAN|   PLAIN|     SNAPPY|null|      null|
++-----------------------------+-----+-------------+--------+--------+-----------+----+----------+
+Total line number = 2
+```
+
+2. 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 line 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-01T00:00:00.100Z|                    true|
+|1970-01-01T00:00:00.200Z|                   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.temperature|root.ln.wf01.wt01.status|
++------------------------+-----------------------------+------------------------+
+|1970-01-01T00:00:00.100Z|                         null|                    true|
+|1970-01-01T00:00:00.200Z|                        20.71|                   false|
++------------------------+-----------------------------+------------------------+
+Total line number = 2
+```
+
+To change the time zone in Cli, you can use the following SQL:
+
+```
+IoTDB> SET time_zone=+08:00
+Time zone has set to +08:00
+IoTDB> SHOW time_zone
+Current time zone: Asia/Shanghai
+```
+
+Add then the query result will show using the new time zone.
+
+```
+IoTDB> SELECT * FROM root.ln.wf01.wt01
++-----------------------------+-----------------------------+------------------------+
+|                         Time|root.ln.wf01.wt01.temperature|root.ln.wf01.wt01.status|
++-----------------------------+-----------------------------+------------------------+
+|1970-01-01T08:00:00.100+08:00|                         null|                    true|
+|1970-01-01T08:00:00.200+08:00|                        20.71|                   false|
++-----------------------------+-----------------------------+------------------------+
+Total line number = 2
+```
+
+The commands to exit the Cli are:
+
+```
+IoTDB> quit
+or
+IoTDB> exit
+```
+
+For more information about the commands supported by IoTDB SQL, please see [User Guide](https://iotdb.apache.org/UserGuide/Master/QuickStart/QuickStart.html).
+
+### Stop IoTDB
+
+The server can be stopped with "ctrl-C" or the following script:
+
+```
+# Unix/OS X
+> sbin/stop-server.sh
+
+# 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}".
+
+# Usage of CSV Import and Export Tool
+
+see [Usage of CSV Import and Export Tool](https://iotdb.apache.org/UserGuide/Master/Write-And-Delete-Data/CSV-Tool.html)
+
+# Frequent Questions for Compiling
+see [Frequent Questions when Compiling the Source Code](https://iotdb.apache.org/Development/ContributeGuide.html#_Frequent-Questions-when-Compiling-the-Source-Code)
+
+# Contact Us
+### QQ Group
+
+* Apache IoTDB User Group: 659990460
+
+### Wechat Group
+
+* Add friend: `tietouqiao` or `liutaohua001`, and then we'll invite you to the group.
+
+### Slack
+
+* https://join.slack.com/t/apacheiotdb/shared_invite/zt-qvso1nj8-7715TpySZtZqmyG5qXQwpg
+
+see [Join the community](https://github.com/apache/iotdb/issues/1995) for more!

Added: release/iotdb/0.13.3/README_ZH.md
==============================================================================
--- release/iotdb/0.13.3/README_ZH.md (added)
+++ release/iotdb/0.13.3/README_ZH.md Fri Oct 21 07:15:16 2022
@@ -0,0 +1,409 @@
+<!--
+
+    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](./README.md) | [中文](./README_ZH.md)
+
+# IoTDB
+[![Main Mac and Linux](https://github.com/apache/iotdb/actions/workflows/main-unix.yml/badge.svg)](https://github.com/apache/iotdb/actions/workflows/main-unix.yml)
+[![Main Win](https://github.com/apache/iotdb/actions/workflows/main-win.yml/badge.svg)](https://github.com/apache/iotdb/actions/workflows/main-win.yml)
+[![coveralls](https://coveralls.io/repos/github/apache/iotdb/badge.svg?branch=master)](https://coveralls.io/repos/github/apache/iotdb/badge.svg?branch=master)
+[![GitHub release](https://img.shields.io/github/release/apache/iotdb.svg)](https://github.com/apache/iotdb/releases)
+[![License](https://img.shields.io/badge/license-Apache%202-4EB1BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)
+![](https://github-size-badge.herokuapp.com/apache/iotdb.svg)
+![](https://img.shields.io/github/downloads/apache/iotdb/total.svg)
+![](https://img.shields.io/badge/platform-win10%20%7C%20macox%20%7C%20linux-yellow.svg)
+![](https://img.shields.io/badge/java--language-1.8-blue.svg)
+[![Language grade: Java](https://img.shields.io/lgtm/grade/java/g/apache/iotdb.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/apache/iotdb/context:java)
+[![IoTDB Website](https://img.shields.io/website-up-down-green-red/https/shields.io.svg?label=iotdb-website)](https://iotdb.apache.org/)
+[![Maven Version](https://maven-badges.herokuapp.com/maven-central/org.apache.iotdb/iotdb-parent/badge.svg)](http://search.maven.org/#search|gav|1|g:"org.apache.iotdb")
+[![Slack Status](https://img.shields.io/badge/slack-join_chat-white.svg?logo=slack&style=social)](https://join.slack.com/t/apacheiotdb/shared_invite/zt-qvso1nj8-7715TpySZtZqmyG5qXQwpg)
+
+# 简介
+IoTDB (Internet of Things Database) 是一款时序数据库管理系统，可以为用户提供数据收集、存储和分析等服务。IoTDB由于其轻量级架构、高性能和高可用的特性，以及与 Hadoop 和 Spark 生态的无缝集成，满足了工业 IoT 领域中海量数据存储、高吞吐量数据写入和复杂数据查询分析的需求。
+
+# 主要特点
+
+IoTDB的主要特点如下:
+
+1. 灵活的部署策略。IoTDB为用户提供了一个在云平台或终端设备上的一键安装工具，以及一个连接云平台和终端上的数据的数据同步工具。
+2. 硬件成本低。IoTDB可以达到很高的磁盘存储压缩比。
+3. 高效的目录结构。IoTDB支持智能网络设备对复杂时间序列数据结构的高效组织，同类设备对时间序列数据的组织，海量复杂时间序列数据目录的模糊搜索策略。
+4. 高吞吐量读写。IoTDB支持数以百万计的低功耗设备的强连接数据访问、高速数据读写，适用于上述智能网络设备和混合设备。
+5. 丰富的查询语义。IoTDB支持跨设备和测量的时间序列数据的时间对齐、时间序列字段的计算(频域转换)和时间维度的丰富聚合函数支持。
+6. 学习成本非常低。IoTDB支持类似sql的语言、JDBC标准API和易于使用的导入/导出工具。
+7. 与先进的开放源码生态系统的无缝集成。IoTDB支持分析生态系统，如Hadoop、Spark和可视化工具(如Grafana)。
+
+有关IoTDB的最新信息，请访问[IoTDB官方网站](https://iotdb.apache.org/)。如果您在使用IoTDB时遇到任何问题或发现任何bug，请在[jira]中提交(https://issues.apache.org/jira/projects/IOTDB/issues)。
+
+<!-- TOC -->
+
+## 目录
+
+- [IoTDB](#iotdb)
+- [简介](#简介)
+- [主要特点](#主要特点)
+  - [目录](#目录)
+- [快速开始](#快速开始)
+  - [环境准备](#环境准备)
+  - [安装](#安装)
+    - [从源码构建](#从源码构建)
+      - [配置](#配置)
+  - [开始](#开始)
+    - [启动 IoTDB](#启动-iotdb)
+    - [使用 IoTDB](#使用-iotdb)
+      - [使用 Cli 命令行](#使用-cli-命令行)
+      - [基本的 IoTDB 命令](#基本的-iotdb-命令)
+    - [停止 IoTDB](#停止-iotdb)
+  - [只编译 server](#只编译-server)
+  - [只编译 cli](#只编译-cli)
+  - [导入导出CSV工具](#导入导出CSV工具)
+
+<!-- /TOC -->
+
+# 快速开始
+
+这篇简短的指南将带您了解使用IoTDB的基本过程。如需更详细的介绍，请访问我们的网站[用户指南](https://iotdb.apache.org/zh/UserGuide/Master/QuickStart/QuickStart.html)。
+
+## 环境准备
+
+要使用IoTDB，您需要:
+1. Java >= 1.8 (目前 1.8、11 到 17 已经被验证可用。请确保环变量境路径已正确设置)。
+2. Maven >= 3.6 (如果希望从源代码编译和安装IoTDB)。
+3. 设置 max open files 为 65535，以避免"too many open files"错误。
+4. （可选） 将 somaxconn 设置为 65535 以避免系统在高负载时出现 "connection reset" 错误。 
+    ```
+    # Linux
+    > sudo sysctl -w net.core.somaxconn=65535
+   
+    # FreeBSD or Darwin
+    > sudo sysctl -w kern.ipc.somaxconn=65535
+    ```
+
+## 安装
+
+IoTDB提供了三种安装方法，您可以参考以下建议，选择最适合您的一种:
+
+* 从源代码安装。如果需要自己修改代码，可以使用此方法。
+
+* 从二进制文件安装。推荐的方法是从官方网站下载二进制文件，您将获得一个开箱即用的二进制发布包。
+
+* 使用Docker: dockerfile的路径是https://github.com/apache/iotdb/tree/master/docker/src/main
+
+在这篇《快速入门》中，我们简要介绍如何使用源代码安装IoTDB。如需进一步资料，请参阅官网[用户指南](https://iotdb.apache.org/zh/UserGuide/Master/QuickStart/QuickStart.html)。
+
+## 从源码构建
+
+### 关于准备Thrift编译器
+
+如果您使用Windows，请跳过此段。
+
+我们使用Thrift作为RPC模块来提供客户端-服务器间的通信和协议支持，因此在编译阶段我们需要使用Thrift 0.13.0
+（或更高）编译器生成对应的Java代码。 Thrift只提供了Windows下的二进制编译器，Unix下需要通过源码自行编译。
+
+如果你有安装权限，可以通过`apt install`, `yum install`, `brew install`来安装thrift编译器，然后在下面的编译命令中
+都添加如下参数即可：`-Dthrift.download-url=http://apache.org/licenses/LICENSE-2.0.txt -Dthrift.exec.absolute.path=<你的thrift可执行文件路径>`。
+
+
+同时我们预先编译了一个Thrift编译器，并将其上传到了GitHub ，借助一个Maven插件，在编译时可以自动将其下载。
+该预编译的Thrift编译器在gcc8，Ubuntu, CentOS, MacOS下可以工作，但是在更低的gcc
+版本以及其他操作系统上尚未确认。
+如果您发现因为网络问题总是提示下载不到thrift文件，那么您需要手动下载，并并将编译器放置到目录`{project_root}\thrift\target\tools\thrift_0.12.0_0.13.0_linux.exe`。
+如果您放到其他地方，就需要在运行maven的命令中添加：`-Dthrift.download-url=http://apache.org/licenses/LICENSE-2.0.txt -Dthrift.exec.absolute.path=<你的thrift可执行文件路径>`。
+
+如果您对Maven足够熟悉，您也可以直接修改我们的根pom文件来避免每次编译都使用上述参数。
+Thrift官方网址为：https://thrift.apache.org/
+
+从 git 克隆源代码:
+
+```
+git clone https://github.com/apache/iotdb.git
+```
+
+默认的主分支是master分支，如果你想使用某个发布版本x.x.x，请切换分支:
+
+```
+git checkout release/x.x.x
+```
+
+从0.11.3开始，版本的标签风格改为vx.x.x：
+```
+git checkout vx.x.x
+```
+
+在 iotdb 根目录下执行 maven 编译:
+
+```
+> mvn clean package -DskipTests
+```
+
+通过添加 `-P compile-cpp` 可以进行c++客户端API的编译。
+
+执行完成之后，可以在**distribution/target/apache-iotdb-{project.version}-all-bin.zip**找到编译完成的二进制版本(包括服务器和客户端)
+
+**注意："`thrift/target/generated-sources/thrift`"， "`thrift-sync/target/generated-sources/thrift`"，"`thrift-cluster/target/generated-sources/thrift`" 和 "`antlr/target/generated-sources/antlr4`" 目录需要添加到源代码根中，以免在 IDE 中产生编译错误。**
+
+**IDEA的操作方法：在上述maven命令编译好后，右键项目名称，选择"`Maven->Reload project`"，即可。**
+
+### 配置
+
+配置文件在"conf"文件夹下
+* 环境配置模块(`iotdb-env.bat`, `iotdb-env.sh`),
+* 系统配置模块(`iotdb-engine.properties`)
+* 日志配置模块(`logback.xml`)。
+
+有关详细信息，请参见[配置参数](https://iotdb.apache.org/zh/UserGuide/Master/Reference/Config-Manual.html)。
+
+## 开始
+
+您可以通过以下步骤来测试安装，如果执行后没有返回错误，安装就完成了。
+
+### 启动 IoTDB
+
+可以通过运行 sbin 文件夹下的 start-server 脚本启动 IoTDB。
+
+```
+# Unix/OS X
+> nohup sbin/start-server.sh >/dev/null 2>&1 &
+or
+> nohup sbin/start-server.sh -c <conf_path> >/dev/null 2>&1 &
+
+# Windows
+> sbin\start-server.bat -c <conf_path>
+```
+- "-c" and "-rpc_port" 都是可选的。
+- 选项 "-c" 指定了配置文件所在的文件夹。
+
+### 使用 IoTDB
+
+#### 使用 Cli 命令行
+
+IoTDB提供了与服务器交互的不同方式，这里我们将介绍使用 Cli 工具插入和查询数据的基本步骤。
+
+安装 IoTDB 后，有一个默认的用户`root`，它的默认密码也是`root`。用户可以使用这个
+默认用户登录 Cli 并使用 IoTDB。Cli 的启动脚本是 sbin 文件夹中的 start-cli 脚本。
+在执行脚本时，用户应该指定 IP，端口，USER_NAME 和 密码。默认参数为`-h 127.0.0.1 -p 6667 -u root -pw root`。
+
+
+下面是启动 Cli 的命令:
+
+```
+# Unix/OS X
+> sbin/start-cli.sh -h 127.0.0.1 -p 6667 -u root -pw root
+
+# Windows
+> sbin\start-cli.bat -h 127.0.0.1 -p 6667 -u root -pw root
+```
+
+命令行客户端是交互式的，所以如果一切就绪，您应该看到欢迎标志和声明:
+
+```
+ _____       _________  ______   ______
+|_   _|     |  _   _  ||_   _ `.|_   _ \
+  | |   .--.|_/ | | \_|  | | `. \ | |_) |
+  | | / .'`\ \  | |      | |  | | |  __'.
+ _| |_| \__. | _| |_    _| |_.' /_| |__) |
+|_____|'.__.' |_____|  |______.'|_______/  version x.x.x
+
+
+IoTDB> login successfully
+IoTDB>
+```
+
+#### 基本的 IoTDB 命令
+
+现在，让我们介绍创建 timeseries、插入数据和查询数据的方法。
+
+
+IoTDB中的数据组织为 timeseries。每个 timeseries 包含多个`数据-时间`对，由一个存储组拥有。
+在定义 timeseries 之前，我们应该先使用SET storage group来定义一个存储组，下面是一个例子:
+
+```
+IoTDB> SET STORAGE GROUP TO root.ln
+```
+
+我们也可以使用`SHOW STORAGE GROUP`来检查正在创建的存储组:
+
+```
+IoTDB> SHOW STORAGE GROUP
++-------------+
+|storage group|
++-------------+
+|      root.ln|
++-------------+
+Total line number = 1
+```
+
+在设置存储组之后，我们可以使用CREATE TIMESERIES来创建一个新的TIMESERIES。
+在创建 timeseries 时，我们应该定义它的数据类型和编码方案。这里我们创建两个 timeseries:
+
+
+```
+IoTDB> CREATE TIMESERIES root.ln.wf01.wt01.status WITH DATATYPE=BOOLEAN, ENCODING=PLAIN
+IoTDB> CREATE TIMESERIES root.ln.wf01.wt01.temperature WITH DATATYPE=FLOAT, ENCODING=RLE
+```
+
+为了查询特定的timeseries，我们可以使用 `SHOW TIMESERIES <Path>`. <Path> 表示被查询的 timeseries 的路径. 默认值是`null`, 表示查询系统中所有的 timeseries (同`SHOW TIMESERIES root`). 
+以下是一些示例:
+
+1. 查询系统中所有 timeseries:
+
+```
+IoTDB> SHOW TIMESERIES
++-----------------------------+-----+-------------+--------+--------+-----------+----+----------+
+|                   timeseries|alias|storage group|dataType|encoding|compression|tags|attributes|
++-----------------------------+-----+-------------+--------+--------+-----------+----+----------+
+|root.ln.wf01.wt01.temperature| null|      root.ln|   FLOAT|     RLE|     SNAPPY|null|      null|
+|     root.ln.wf01.wt01.status| null|      root.ln| BOOLEAN|   PLAIN|     SNAPPY|null|      null|
++-----------------------------+-----+-------------+--------+--------+-----------+----+----------+
+Total line number = 2
+```
+
+2. 查询指定的 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 line number = 1
+```
+
+插入 timeseries 数据是IoTDB的一个基本操作，你可以使用`INSERT` 命令来完成这个操作。
+在插入之前，您应该指定时间戳和后缀路径名:
+
+```
+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)
+```
+
+你刚才插入的数据会显示如下:
+
+```
+IoTDB> SELECT status FROM root.ln.wf01.wt01
++-----------------------------+------------------------+
+|                         Time|root.ln.wf01.wt01.status|
++-----------------------------+------------------------+
+|1970-01-01T08:00:00.100+08:00|                    true|
+|1970-01-01T08:00:00.200+08:00|                   false|
++-----------------------------+------------------------+
+Total line number = 2
+```
+
+您还可以使用一条SQL语句查询多个 timeseries 数据:
+
+```
+IoTDB> SELECT * FROM root.ln.wf01.wt01
++-----------------------------+-----------------------------+------------------------+
+|                         Time|root.ln.wf01.wt01.temperature|root.ln.wf01.wt01.status|
++-----------------------------+-----------------------------+------------------------+
+|1970-01-01T08:00:00.100+08:00|                         null|                    true|
+|1970-01-01T08:00:00.200+08:00|                        20.71|                   false|
++-----------------------------+-----------------------------+------------------------+
+Total line number = 2
+```
+
+如果需要修改 Cli 中的时区，您可以使用以下语句:
+
+```
+IoTDB> SET time_zone=+00:00
+Time zone has set to +00:00
+IoTDB> SHOW time_zone
+Current time zone: Z
+```
+
+之后查询结果将会以更新后的新时区显示:
+
+```
+IoTDB> SELECT * FROM root.ln.wf01.wt01
++------------------------+-----------------------------+------------------------+
+|                    Time|root.ln.wf01.wt01.temperature|root.ln.wf01.wt01.status|
++------------------------+-----------------------------+------------------------+
+|1970-01-01T00:00:00.100Z|                         null|                    true|
+|1970-01-01T00:00:00.200Z|                        20.71|                   false|
++------------------------+-----------------------------+------------------------+
+Total line number = 2
+```
+
+你可以使用如下命令退出:
+
+```
+IoTDB> quit
+or
+IoTDB> exit
+```
+
+有关IoTDB SQL支持的命令的更多信息，请参见[用户指南](https://iotdb.apache.org/zh/UserGuide/Master/QuickStart/QuickStart.html)。
+
+### 停止 IoTDB
+
+server 可以使用 "ctrl-C" 或者执行下面的脚本:
+
+```
+# Unix/OS X
+> sbin/stop-server.sh
+
+# Windows
+> sbin\stop-server.bat
+```
+
+## 只编译 server
+
+在 iotdb 根目录下执行:
+
+```
+> mvn clean package -pl server -am -DskipTests
+```
+
+编译完成后, IoTDB server 将生成在: "server/target/iotdb-server-{project.version}".
+
+
+## 只编译 cli
+
+在 iotdb 根目录下执行:
+
+```
+> mvn clean package -pl cli -am -DskipTests
+```
+
+编译完成后, IoTDB cli 将生成在 "cli/target/iotdb-cli-{project.version}".
+
+# 导入导出CSV工具
+
+查看 [导入导出CSV工具](https://iotdb.apache.org/zh/UserGuide/Master/Write-And-Delete-Data/CSV-Tool.html)
+
+# 常见编译错误
+查看 [常见编译错误](https://iotdb.apache.org/zh/Development/ContributeGuide.html#%E5%B8%B8%E8%A7%81%E7%BC%96%E8%AF%91%E9%94%99%E8%AF%AF)
+
+# 联系我们
+### QQ群
+
+* Apache IoTDB 交流群：659990460
+
+### Wechat Group
+
+* 添加好友 `tietouqiao` 或者 `liutaohua001`，我们会邀请您进群
+
+### Slack
+
+* https://join.slack.com/t/apacheiotdb/shared_invite/zt-qvso1nj8-7715TpySZtZqmyG5qXQwpg
+
+获取更多内容，请查看 [加入社区](https://github.com/apache/iotdb/issues/1995)