C++ 原生接口

1. 依赖

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

2. 安装

2.1 安装相关依赖

  • MAC

  1. 安装 Bison ：

    使用下面 brew 命令安装 bison 版本：

    brew install bison

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

    brew install boost

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

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

  • Ubuntu 16.04+ 或其他 Debian 系列

    使用以下命令安装所赖：

    sudo apt-get update
sudo apt-get install gcc g++ bison flex libboost-all-dev libssl-dev

  • CentOS 7.7+/Fedora/Rocky Linux 或其他 Red-hat 系列

    使用 yum 命令安装依赖：

    sudo yum update
sudo yum install gcc gcc-c++ boost-devel bison flex openssl-devel

  • Windows

  1. 构建编译环境

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

  2. 下载安装 Flex、Bison

    • 下载 Win_Flex_Bison
    • 下载后需要将可执行文件重命名为 flex.exe 和 bison.exe 以保证编译时能够被找到，添加可执行文件的目录到 PATH 环境变量中

  3. 安装 Boost 库

    • 下载 Boost
    • 本地编译 Boost ：依次执行 bootstrap.bat 和 b2.exe
    • 添加 Boost 安装目录到 PATH 环境变量中，例如 C:\Program Files (x86)\boost_1_78_0

  4. 安装 OpenSSL

    • 下载安装 OpenSSL
    • 添加 OpenSSL 下的 include 目录到 PATH 环境变量中

2.2 执行编译

从 git 克隆源代码:

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

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

git checkout rc/1.3.2

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

  • Mac 或 glibc 版本 >= 2.32 的 Linux

    ./mvnw clean package -pl example/client-cpp-example -am -DskipTests -P with-cpp

  • glibc 版本 >= 2.31 的 Linux

    ./mvnw clean package -pl example/client-cpp-example -am -DskipTests -P with-cpp -Diotdb-tools-thrift.version=0.14.1.1-old-glibc-SNAPSHOT

  • glibc 版本 >= 2.17 的 Linux

    ./mvnw clean package -pl example/client-cpp-example -am -DskipTests -P with-cpp -Diotdb-tools-thrift.version=0.14.1.1-glibc223-SNAPSHOT

  • 使用 Visual Studio 2022 的 Windows

    .\mvnw.cmd clean package -pl example/client-cpp-example -am -DskipTests -P with-cpp

  • 使用 Visual Studio 2019 的 Windows

    .\mvnw.cmd clean package -pl example/client-cpp-example -am -DskipTests -P with-cpp -Dcmake.generator="Visual Studio 16 2019" -Diotdb-tools-thrift.version=0.14.1.1-msvc142-SNAPSHOT
    • 如果没有将 Boost 库地址加入 PATH 环境变量，在编译命令中还需添加相关参数，例如：-DboostIncludeDir="C:\Program Files (x86)\boost_1_78_0" -DboostLibraryDir="C:\Program Files (x86)\boost_1_78_0\stage\lib"

编译成功后，打包好的库文件位于 iotdb-client/client-cpp/target 中，同时可以在 example/client-cpp-example/target 下找到编译好的示例程序。

2.3 编译 Q&A

Q：Linux 上的环境有哪些要求呢？

A：

  • 已知依赖的 glibc (x86_64 版本) 最低版本要求为 2.17，GCC 最低版本为 5.5
  • 已知依赖的 glibc (ARM 版本) 最低版本要求为 2.31，GCC 最低版本为 10.2
  • 如果不满足上面的要求，可以尝试自己本地编译 Thrift

Q：Linux 编译报错undefined reference to '_libc_sinle_thread'如何处理？

A：

  • 该问题是用于默认的预编译 Thrift 依赖了过高的 glibc 版本导致的
  • 可以尝试在编译的 maven 命令中增加 -Diotdb-tools-thrift.version=0.14.1.1-glibc223-SNAPSHOT 或者 -Diotdb-tools-thrift.version=0.14.1.1-old-glibc-SNAPSHOT

Q：如果在 Windows 上需要使用 Visual Studio 2017 或更早版本进行编译，要怎么做？

A:

3. 基本接口说明

下面将给出 Session 接口的简要介绍和原型定义：

3.1 初始化

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

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

  • 关闭 Session
void close();

3.2 数据定义接口（DDL）

Database 管理

  • 设置 database
void setStorageGroup(const std::string &storageGroupId);
  • 删除单个或多个 database
void deleteStorageGroup(const std::string &storageGroup);
void deleteStorageGroups(const std::vector<std::string> &storageGroups);

时间序列管理

  • 创建单个或多个非对齐时间序列
void createTimeseries(const std::string &path, TSDataType::TSDataType dataType, TSEncoding::TSEncoding encoding,
                          CompressionType::CompressionType compressor);
                          
void createMultiTimeseries(const std::vector<std::string> &paths,
                           const std::vector<TSDataType::TSDataType> &dataTypes,
                           const std::vector<TSEncoding::TSEncoding> &encodings,
                           const std::vector<CompressionType::CompressionType> &compressors,
                           std::vector<std::map<std::string, std::string>> *propsList,
                           std::vector<std::map<std::string, std::string>> *tagsList,
                           std::vector<std::map<std::string, std::string>> *attributesList,
                           std::vector<std::string> *measurementAliasList);
  • 创建对齐时间序列
void createAlignedTimeseries(const std::string &deviceId,
                             const std::vector<std::string> &measurements,
                             const std::vector<TSDataType::TSDataType> &dataTypes,
                             const std::vector<TSEncoding::TSEncoding> &encodings,
                             const std::vector<CompressionType::CompressionType> &compressors);
  • 删除一个或多个时间序列
void deleteTimeseries(const std::string &path);
void deleteTimeseries(const std::vector<std::string> &paths);
  • 检查时间序列是否存在
bool checkTimeseriesExists(const std::string &path);

元数据模版

  • 创建元数据模板
void createSchemaTemplate(const Template &templ);
  • 挂载元数据模板
void setSchemaTemplate(const std::string &template_name, const std::string &prefix_path);

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

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

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

  • 在创建概念元数据模板以后，还可以通过以下接口增加或删除模板内的物理量。请注意，已经挂载的模板不能删除内部的物理量。
// 为指定模板新增一组对齐的物理量，若其父节点在模板中已经存在，且不要求对齐，则报错
void addAlignedMeasurementsInTemplate(const std::string &template_name,
                                      const std::vector<std::string> &measurements,
                                      const std::vector<TSDataType::TSDataType> &dataTypes,
                                      const std::vector<TSEncoding::TSEncoding> &encodings,
                                      const std::vector<CompressionType::CompressionType> &compressors);

// 为指定模板新增一个对齐物理量, 若其父节点在模板中已经存在，且不要求对齐，则报错
void addAlignedMeasurementsInTemplate(const std::string &template_name,
                                      const std::string &measurement,
                                      TSDataType::TSDataType dataType,
                                      TSEncoding::TSEncoding encoding,
                                      CompressionType::CompressionType compressor);

// 为指定模板新增一个不对齐物理量, 若其父节在模板中已经存在，且要求对齐，则报错
void addUnalignedMeasurementsInTemplate(const std::string &template_name,
                                        const std::vector<std::string> &measurements,
                                        const std::vector<TSDataType::TSDataType> &dataTypes,
                                        const std::vector<TSEncoding::TSEncoding> &encodings,
                                        const std::vector<CompressionType::CompressionType> &compressors);

// 为指定模板新增一组不对齐的物理量, 若其父节在模板中已经存在，且要求对齐，则报错
void addUnalignedMeasurementsInTemplate(const std::string &template_name,
                                        const std::string &measurement,
                                        TSDataType::TSDataType dataType,
                                        TSEncoding::TSEncoding encoding,
                                        CompressionType::CompressionType compressor);

// 从指定模板中删除一个节点及其子树
void deleteNodeInTemplate(const std::string &template_name, const std::string &path);
  • 对于已经创建的元数据模板，还可以通过以下接口查询模板信息：
// 查询返回目前模板中所有物理量的数量
int countMeasurementsInTemplate(const std::string &template_name);

// 检查模板内指定路径是否为物理量
bool isMeasurementInTemplate(const std::string &template_name, const std::string &path);

// 检查在指定模板内是否存在某路径
bool isPathExistInTemplate(const std::string &template_name, const std::string &path);

// 返回指定模板内所有物理量的路径
std::vector<std::string> showMeasurementsInTemplate(const std::string &template_name);

// 返回指定模板内某前缀路径下的所有物理量的路径
std::vector<std::string> showMeasurementsInTemplate(const std::string &template_name, const std::string &pattern);

3.3 数据操作接口（DML）

数据写入

推荐使用 insertTablet 帮助提高写入效率。

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

带有类型推断的写入

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

void insertRecord(const std::string &deviceId, int64_t time, const std::vector<std::string> &measurements,
                  const std::vector<std::string> &values);


void insertRecords(const std::vector<std::string> &deviceIds,
                   const std::vector<int64_t> &times,
                   const std::vector<std::vector<std::string>> &measurementsList,
                   const std::vector<std::vector<std::string>> &valuesList);


void insertRecordsOfOneDevice(const std::string &deviceId,
                              std::vector<int64_t> &times,
                              std::vector<std::vector<std::string>> &measurementsList,
                              const std::vector<std::vector<std::string>> &valuesList);

对齐时间序列写入

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

  • insertAlignedRecord
  • insertAlignedRecords
  • insertAlignedRecordsOfOneDevice
  • insertAlignedTablet
  • insertAlignedTablets

数据删除

  • 删除一个或多个时间序列在某个时间范围的数据
void deleteData(const std::string &path, int64_t endTime);
void deleteData(const std::vector<std::string> &paths, int64_t endTime);
void deleteData(const std::vector<std::string> &paths, int64_t startTime, int64_t endTime);

3.4 IoTDB-SQL 接口

  • 执行查询语句
unique_ptr<SessionDataSet> executeQueryStatement(const std::string &sql);
  • 执行非查询语句
void executeNonQueryStatement(const std::string &sql);

4. 示例代码

示例工程源代码：

编译成功后，示例代码工程位于 example/client-cpp-example/target

5. FAQ

5.1 Thrift 编译相关问题

  1. MAC：本地 Maven 编译 Thrift 时如出现以下链接的问题，可以尝试将 xcode-commandline 版本从 12 降低到 11.5 https://stackoverflow.com/questions/63592445/ld-unsupported-tapi-file-type-tapi-tbd-in-yaml-file/65518087#65518087

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

    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>”