• Java 8+
    • Maven 3.5+
    • Flex
    • Bison 2.7+
    • Boost 1.56+
    • OpenSSL 1.0+
    • GCC 5.5.0+

    安装相关依赖

      1. 安装 Bison ：Mac 环境下预安装了 Bison 2.3 版本，但该版本过低不能够用来编译 Thrift。

        使用 Bison 2.3 版本会报以下错误：

        使用下面 brew 命令更新 bison 版本：

        添加环境变量：

        1. echo 'export PATH="/usr/local/opt/bison/bin:$PATH"' >> ~/.bash_profile

      2. 安装 Boost ：确保安装较新的 Boost 版本。

        1. brew install boost
        2. brew link boost

      3. 检查 OpenSSL ：确保 openssl 库已安装，默认的 openssl 头文件路径为”/usr/local/opt/openssl/include”

        如果在编译过程中出现找不到 openssl 的错误，尝试添加-Dopenssl.include.dir=""

    • Ubuntu 20

      使用以下命令安装所有依赖：

      1. sudo apt-get install gcc-9 g++-9 libstdc++-9-dev bison flex libboost-all-dev libssl-dev zlib1g-dev

    • CentOS 7.x

      使用 yum 命令安装部分依赖。

      1. sudo yum install bison flex openssl-devel

    • Windows

      1. 构建编译环境

        • 安装 MS Visual Studio（推荐安装 2019 版本）：安装时需要勾选 Visual Studio C/C++ IDE and compiler(supporting CMake, Clang, MinGW)。
        • 下载安装 。

      2. 下载安装 Flex、Bison

        • 下载 Win_Flex_BisonC++ 原生接口 - 图2open in new window 。
        • 下载后需要将可执行文件重命名为 flex.exe 和 bison.exe 以保证编译时能够被找到，添加可执行文件的目录到 PATH 环境变量中。

      3. 安装 Boost

        • 下载 。
        • 本地编译 Boost ：依次执行 bootstrap.bat 和 b2.exe 。

      4. 安装 OpenSSL

    执行编译

    从 git 克隆源代码:

    1. git clone https://github.com/apache/iotdb.git

    默认的主分支是master分支，如果你想使用某个发布版本，请切换分支 (如 0.13 版本):

    1. git checkout rel/0.13

    在 IoTDB 根目录下执行 maven 编译:

    • Mac & Linux

      1. mvn package -P compile-cpp -pl example/client-cpp-example -am -DskipTest

    • Windows

      1. mvn package -P compile-cpp -pl client-cpp,server,example/client-cpp-example -am -Dcmake.generator="your cmake generator" -Dboost.include.dir=${your boost header folder} -Dboost.library.dir=${your boost lib (stage) folder} -DskipTests
      • CMake 根据不同编译平台使用不同的生成器，需添加-Dcmake.generator=""选项来指定使用的生成器名称，例如： -Dcmake.generator="Visual Studio 16 2019"。（通过cmake --help命令可以查看 CMake 支持的生成器列表）
      • 为了帮助 CMake 找到本地安装好的 Boost，在编译命令中需添加相关参数，例如：-DboostIncludeDir="C:\Program Files (x86)\boost_1_78_0" -DboostLibraryDir="C:\Program Files (x86)\boost_1_78_0\stage\lib"

    编译成功后，打包好的 zip 文件位于 client-cpp/target/client-cpp-${project.version}-cpp-${os}.zip

    初始化

    • 开启 Session
    1. void open();
    • 开启 Session，并决定是否开启 RPC 压缩

      注意: 客户端的 RPC 压缩开启状态需和服务端一致。

      • 关闭 Session

      数据定义接口（DDL）

      Database 管理
      • 设置 database
      1. void setStorageGroup(const std::string &storageGroupId);
      • 删除单个或多个 database
      1. void deleteStorageGroup(const std::string &storageGroup);
      2. void deleteStorageGroups(const std::vector<std::string> &storageGroups);
      时间序列管理
      • 创建单个或多个非对齐时间序列
      1. void createTimeseries(const std::string &path, TSDataType::TSDataType dataType, TSEncoding::TSEncoding encoding,
      2.                           CompressionType::CompressionType compressor);
      4. void createMultiTimeseries(const std::vector<std::string> &paths,
      5.                            const std::vector<TSDataType::TSDataType> &dataTypes,
      6.                            const std::vector<TSEncoding::TSEncoding> &encodings,
      7.                            const std::vector<CompressionType::CompressionType> &compressors,
      8.                            std::vector<std::map<std::string, std::string>> *propsList,
      9.                            std::vector<std::map<std::string, std::string>> *tagsList,
      10.                            std::vector<std::map<std::string, std::string>> *attributesList,
      11.                            std::vector<std::string> *measurementAliasList);
      • 创建对齐时间序列
      1. void createAlignedTimeseries(const std::string &deviceId,
      2.                              const std::vector<std::string> &measurements,
      3.                              const std::vector<TSDataType::TSDataType> &dataTypes,
      4.                              const std::vector<TSEncoding::TSEncoding> &encodings,
      • 删除一个或多个时间序列
      1. void deleteTimeseries(const std::string &path);
      2. void deleteTimeseries(const std::vector<std::string> &paths);
      • 检查时间序列是否存在
      1. bool checkTimeseriesExists(const std::string &path);
      元数据模版
      • 创建元数据模板
      1. void createSchemaTemplate(const Template &templ);
      • 挂载元数据模板
      1. void setSchemaTemplate(const std::string &template_name, const std::string &prefix_path);

      请注意，如果一个子树中有多个孩子节点需要使用模板，可以在其共同父母节点上使用 setSchemaTemplate 。而只有在已有数据点插入模板对应的物理量时，模板才会被设置为激活状态，进而被 show timeseries 等查询检测到。

      • 卸载元数据模板
      1. void unsetSchemaTemplate(const std::string &prefix_path, const std::string &template_name);

      注意：目前不支持从曾经在prefixPath路径及其后代节点使用模板插入数据后（即使数据已被删除）卸载模板。

      • 在创建概念元数据模板以后，还可以通过以下接口增加或删除模板内的物理量。请注意，已经挂载的模板不能删除内部的物理量。
      1. // 为指定模板新增一组对齐的物理量，若其父节点在模板中已经存在，且不要求对齐，则报错
      2. void addAlignedMeasurementsInTemplate(const std::string &template_name,
      3.                                       const std::vector<std::string> &measurements,
      4.                                       const std::vector<TSDataType::TSDataType> &dataTypes,
      5.                                       const std::vector<TSEncoding::TSEncoding> &encodings,
      6.                                       const std::vector<CompressionType::CompressionType> &compressors);
      8. // 为指定模板新增一个对齐物理量, 若其父节点在模板中已经存在，且不要求对齐，则报错
      9. void addAlignedMeasurementsInTemplate(const std::string &template_name,
      10.                                       const std::string &measurement,
      11.                                       TSDataType::TSDataType dataType,
      12.                                       TSEncoding::TSEncoding encoding,
      13.                                       CompressionType::CompressionType compressor);
      15. // 为指定模板新增一个不对齐物理量, 若其父节在模板中已经存在，且要求对齐，则报错
      16. void addUnalignedMeasurementsInTemplate(const std::string &template_name,
      17.                                         const std::vector<std::string> &measurements,
      18.                                         const std::vector<TSDataType::TSDataType> &dataTypes,
      19.                                         const std::vector<TSEncoding::TSEncoding> &encodings,
      20.                                         const std::vector<CompressionType::CompressionType> &compressors);
      22. // 为指定模板新增一组不对齐的物理量, 若其父节在模板中已经存在，且要求对齐，则报错
      23. void addUnalignedMeasurementsInTemplate(const std::string &template_name,
      24.                                         const std::string &measurement,
      25.                                         TSEncoding::TSEncoding encoding,
      26.                                         CompressionType::CompressionType compressor);
      29. void deleteNodeInTemplate(const std::string &template_name, const std::string &path);
      • 对于已经创建的元数据模板，还可以通过以下接口查询模板信息：

      数据操作接口（DML）

      数据写入
      • 插入一个 Tablet，Tablet 是一个设备若干行数据块，每一行的列都相同。
        • 写入效率高。
        • 支持写入空值：空值处可以填入任意值，然后通过 BitMap 标记空值。
      1. void insertTablet(Tablet &tablet);
      • 插入多个 Tablet
      1. void insertTablets(std::unordered_map<std::string, Tablet *> &tablets);
      • 插入一个 Record，一个 Record 是一个设备一个时间戳下多个测点的数据
      1. void insertRecord(const std::string &deviceId, int64_t time, const std::vector<std::string> &measurements,
      2.                   const std::vector<TSDataType::TSDataType> &types, const std::vector<char *> &values);
      • 插入多个 Record
      1. void insertRecords(const std::vector<std::string> &deviceIds,
      2.                    const std::vector<int64_t> &times,
      3.                    const std::vector<std::vector<std::string>> &measurementsList,
      4.                    const std::vector<std::vector<TSDataType::TSDataType>> &typesList,
      5.                    const std::vector<std::vector<char *>> &valuesList);
      • 插入同属于一个 device 的多个 Record
      1. void insertRecordsOfOneDevice(const std::string &deviceId,
      2.                               std::vector<int64_t> &times,
      3.                               std::vector<std::vector<std::string>> &measurementsList,
      4.                               std::vector<std::vector<TSDataType::TSDataType>> &typesList,
      5.                               std::vector<std::vector<char *>> &valuesList);
      带有类型推断的写入

      服务器需要做类型推断，可能会有额外耗时，速度较无需类型推断的写入慢。

      1. void insertRecord(const std::string &deviceId, int64_t time, const std::vector<std::string> &measurements,
      2.                   const std::vector<std::string> &values);
      5. void insertRecords(const std::vector<std::string> &deviceIds,
      6.                    const std::vector<int64_t> &times,
      7.                    const std::vector<std::vector<std::string>> &measurementsList,
      8.                    const std::vector<std::vector<std::string>> &valuesList);
      11. void insertRecordsOfOneDevice(const std::string &deviceId,
      12.                               std::vector<int64_t> &times,
      13.                               std::vector<std::vector<std::string>> &measurementsList,
      14.                               const std::vector<std::vector<std::string>> &valuesList);
      对齐时间序列写入

      对齐时间序列的写入使用 insertAlignedXXX 接口，其余与上述接口类似：

      • insertAlignedRecord
      • insertAlignedRecords
      • insertAlignedRecordsOfOneDevice
      • insertAlignedTablet
      • insertAlignedTablets
      数据删除
      • 删除一个或多个时间序列在某个时间点前或这个时间点的数据
      1. void deleteData(const std::string &path, int64_t time);
      2. void deleteData(const std::vector<std::string> &deviceId, int64_t time);

      IoTDB-SQL 接口

      • 执行查询语句
      1. void executeNonQueryStatement(const std::string &sql);
      • 执行非查询语句
      1. void executeNonQueryStatement(const std::string &sql);

      示例工程源代码：

      • example/client-cpp-example/src/SessionExample.cpp
      • example/client-cpp-example/src/AlignedTimeseriesSessionExample.cpp （使用对齐时间序列）

      编译成功后，示例代码工程位于

      Thrift 编译相关问题

      1. MAC：本地 Maven 编译 Thrift 时如出现以下链接的问题，可以尝试将 xcode-commandline 版本从 12 降低到 11.5

      2. Windows：Maven 编译 Thrift 时需要使用 wget 下载远端文件，可能出现以下报错：

        1. Failed to delete cached file C:\Users\Administrator\.m2\repository\.cache\download-maven-plugin\index.ser

        解决方法：

        • 尝试删除 “.m2\repository\.cache” 目录并重试。
        • 在添加 pom 文件对应的 download-maven-plugin 中添加 “<skipCache>true</skipCache>”