Skip to content

Latest commit

 

History

History
399 lines (285 loc) · 16.5 KB

README_ZH.md

File metadata and controls

399 lines (285 loc) · 16.5 KB

English | 中文

IoTDB

Main Mac and Linux Main Win GitHub release License Language grade: Java IoTDB Website Maven Version Slack Status

简介

IoTDB (Internet of Things Database) 是一款时序数据库管理系统,可以为用户提供数据收集、存储和分析等服务。IoTDB由于其轻量级架构、高性能和高可用的特性,以及与 Hadoop 和 Spark 生态的无缝集成,满足了工业 IoT 领域中海量数据存储、高吞吐量数据写入和复杂数据查询分析的需求。 更多功能请见时序数据库IoTDB:功能详解与行业应用

主要特点

IoTDB的主要特点如下:

  1. 灵活的部署策略。IoTDB为用户提供了一个在云平台或终端设备上的一键安装工具,以及一个连接云平台和终端上的数据的数据同步工具。
  2. 硬件成本低。IoTDB可以达到很高的磁盘存储压缩比。
  3. 高效的目录结构。IoTDB支持智能网络设备对复杂时间序列数据结构的高效组织,同类设备对时间序列数据的组织,海量复杂时间序列数据目录的模糊搜索策略。
  4. 高吞吐量读写。IoTDB支持数以百万计的低功耗设备的强连接数据访问、高速数据读写,适用于上述智能网络设备和混合设备。
  5. 丰富的查询语义。IoTDB支持跨设备和测量的时间序列数据的时间对齐、时间序列字段的计算(频域转换)和时间维度的丰富聚合函数支持。
  6. 学习成本非常低。IoTDB支持类似sql的语言、JDBC标准API和易于使用的导入/导出工具。
  7. 与先进的开放源码生态系统的无缝集成。IoTDB支持分析生态系统,如Hadoop、Spark和可视化工具(如Grafana)。

有关IoTDB的最新信息,请访问IoTDB官方网站。如果您在使用IoTDB时遇到任何问题或发现任何bug,请在[jira]中提交(https://issues.apache.org/jira/projects/IOTDB/issues)。

目录

快速开始

这篇简短的指南将带您了解使用IoTDB的基本过程。如需更详细的介绍,请访问我们的网站用户指南

环境准备

要使用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。如需进一步资料,请参阅官网用户指南

从源码构建

关于准备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,请切换 tag:

git checkout vx.x.x

或者切换大版本所在分支,如 1.0 版本的分支为 rel/1.0

git checkout rel/x.x

源码编译 IoTDB

在 iotdb 根目录下执行:

> mvn clean package -pl distribution -am -DskipTests

编译完成后, IoTDB 二进制包将生成在: "distribution/target".

只编译 cli

在 iotdb/iotdb-client 目录下执行:

> mvn clean package -pl cli -am -DskipTests

编译完成后, IoTDB cli 将生成在 "cli/target".

编译其他模块

通过添加 -P compile-cpp 可以进行c++客户端API的编译。

注意:"thrift/target/generated-sources/thrift", "thrift-sync/target/generated-sources/thrift","thrift-cluster/target/generated-sources/thrift","thrift-influxdb/target/generated-sources/thrift" 和 "antlr/target/generated-sources/antlr4" 目录需要添加到源代码根中,以免在 IDE 中产生编译错误。

IDEA的操作方法:在上述maven命令编译好后,右键项目名称,选择"Maven->Reload project",即可。

配置

配置文件在"conf"文件夹下

  • 环境配置模块(datanode-env.bat, datanode-env.sh),
  • 系统配置模块(iotdb-datanode.properties)
  • 日志配置模块(logback.xml)。

有关详细信息,请参见配置参数

开始

您可以通过以下步骤来测试安装,如果执行后没有返回错误,安装就完成了。

启动 IoTDB

可以通过运行 sbin 文件夹下的 start-standalone 脚本启动 1C1D IoTDB。

# Unix/OS X
> sbin/start-standalone.sh

# Windows
> sbin\start-standalone.bat

使用 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 包含多个数据-时间对,由一个 database 拥有。 在定义 timeseries 之前,我们应该先使用 CREATE DATABASE 来创建一个数据库,下面是一个例子:

IoTDB> CREATE DATABASE root.ln

我们也可以使用SHOW DATABASES来检查已创建的数据库:

IoTDB> SHOW DATABASES
+--------+
|Database|
+--------+
| root.ln|
+--------+
Total line number = 1

在设置 database 之后,我们可以使用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>. 表示被查询的 timeseries 的路径. 默认值是null, 表示查询系统中所有的 timeseries (同SHOW TIMESERIES root). 以下是一些示例:

  1. 查询系统中所有 timeseries:
IoTDB> SHOW TIMESERIES
+-----------------------------+-----+-------------+--------+--------+-----------+----+----------+
|                   timeseries|alias|database|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
  1. 查询指定的 timeseries(root.ln.wf01.wt01.status):
IoTDB> SHOW TIMESERIES root.ln.wf01.wt01.status
+------------------------+-----+-------------+--------+--------+-----------+----+----------+
|              timeseries|alias|database|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支持的命令的更多信息,请参见用户指南

停止 IoTDB

server 可以使用 "ctrl-C" 或者执行下面的脚本:

# Unix/OS X
> sbin/stop-standalone.sh

# Windows
> sbin\stop-standalone.bat

导入导出CSV工具

查看 导入导出CSV工具

常见编译错误

查看 常见编译错误

联系我们

QQ群

  • Apache IoTDB 交流群:659990460

Wechat Group

  • 添加好友 tietouqiao 或者 liutaohua001,我们会邀请您进群

Slack

获取更多内容,请查看 加入社区