blob: fd8ad086e651ab1df0e9acac06f91a56dcd0c94b [file]
import{_ as l,c as a,b as n,o as e}from"./app-pmkzp6TS.js";const o={};function t(p,s){return e(),a("div",null,[...s[0]||(s[0]=[n(`<h1 id="c-原生接口" tabindex="-1"><a class="header-anchor" href="#c-原生接口"><span>C++ 原生接口</span></a></h1><h2 id="依赖" tabindex="-1"><a class="header-anchor" href="#依赖"><span>依赖</span></a></h2><ul><li>Java 8+</li><li>Flex</li><li>Bison 2.7+</li><li>Boost 1.56+</li><li>OpenSSL 1.0+</li><li>GCC 4.8.5+</li></ul><h2 id="安装" tabindex="-1"><a class="header-anchor" href="#安装"><span>安装</span></a></h2><h3 id="安装相关依赖" tabindex="-1"><a class="header-anchor" href="#安装相关依赖"><span>安装相关依赖</span></a></h3><ul><li><strong>MAC</strong></li></ul><ol><li><p>安装 Bison :</p><p>使用下面 brew 命令安装 bison 版本:</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-shell"><span class="line"><span style="color:#61AFEF;">brew</span><span style="color:#98C379;"> install</span><span style="color:#98C379;"> bison</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div></li><li><p>安装 Boost :确保安装最新的 Boost 版本。</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-shell"><span class="line"><span style="color:#61AFEF;">brew</span><span style="color:#98C379;"> install</span><span style="color:#98C379;"> boost</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div></li><li><p>检查 OpenSSL :确保 openssl 库已安装,默认的 openssl 头文件路径为&quot;/usr/local/opt/openssl/include&quot;</p><p>如果在编译过程中出现找不到 openssl 的错误,尝试添加<code>-Dopenssl.include.dir=&quot;&quot;</code></p></li></ol><ul><li><p><strong>Ubuntu 16.04+ 或其他 Debian 系列</strong></p><p>使用以下命令安装所赖:</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-shell"><span class="line"><span style="color:#61AFEF;">sudo</span><span style="color:#98C379;"> apt-get</span><span style="color:#98C379;"> update</span></span>
<span class="line"><span style="color:#61AFEF;">sudo</span><span style="color:#98C379;"> apt-get</span><span style="color:#98C379;"> install</span><span style="color:#98C379;"> gcc</span><span style="color:#98C379;"> g++</span><span style="color:#98C379;"> bison</span><span style="color:#98C379;"> flex</span><span style="color:#98C379;"> libboost-all-dev</span><span style="color:#98C379;"> libssl-dev</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div></div></div></li><li><p><strong>CentOS 7.7+/Fedora/Rocky Linux 或其他 Red-hat 系列</strong></p><p>使用 yum 命令安装依赖:</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-shell"><span class="line"><span style="color:#61AFEF;">sudo</span><span style="color:#98C379;"> yum</span><span style="color:#98C379;"> update</span></span>
<span class="line"><span style="color:#61AFEF;">sudo</span><span style="color:#98C379;"> yum</span><span style="color:#98C379;"> install</span><span style="color:#98C379;"> gcc</span><span style="color:#98C379;"> gcc-c++</span><span style="color:#98C379;"> boost-devel</span><span style="color:#98C379;"> bison</span><span style="color:#98C379;"> flex</span><span style="color:#98C379;"> openssl-devel</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div></div></div></li><li><p><strong>Windows</strong></p></li></ul><ol><li><p>构建编译环境</p><ul><li>安装 MS Visual Studio(推荐安装 2019+ 版本):安装时需要勾选 Visual Studio C/C++ IDE and compiler(supporting CMake, Clang, MinGW)</li><li>下载安装 <a href="https://cmake.org/download/" target="_blank" rel="noopener noreferrer">CMake</a> 。</li></ul></li><li><p>下载安装 Flex、Bison</p><ul><li>下载 <a href="https://sourceforge.net/projects/winflexbison/" target="_blank" rel="noopener noreferrer">Win_Flex_Bison</a></li><li>下载后需要将可执行文件重命名为 flex.exe 和 bison.exe 以保证编译时能够被找到,添加可执行文件的目录到 PATH 环境变量中</li></ul></li><li><p>安装 Boost 库</p><ul><li>下载 <a href="https://www.boost.org/users/download/" target="_blank" rel="noopener noreferrer">Boost</a></li><li>本地编译 Boost :依次执行 bootstrap.bat 和 b2.exe</li><li>添加 Boost 安装目录到 PATH 环境变量中,例如 <code>C:\\Program Files (x86)\\boost_1_78_0</code></li></ul></li><li><p>安装 OpenSSL</p><ul><li>下载安装 <a href="http://slproweb.com/products/Win32OpenSSL.html" target="_blank" rel="noopener noreferrer">OpenSSL</a></li><li>添加 OpenSSL 下的 include 目录到 PATH 环境变量中</li></ul></li></ol><h3 id="执行编译" tabindex="-1"><a class="header-anchor" href="#执行编译"><span>执行编译</span></a></h3><p>从 git 克隆源代码:</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-shell"><span class="line"><span style="color:#61AFEF;">git</span><span style="color:#98C379;"> clone</span><span style="color:#98C379;"> https://github.com/apache/iotdb.git</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>默认的主分支是 master 分支,如果你想使用某个发布版本,请切换分支 (如 1.3.2 版本):</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-shell"><span class="line"><span style="color:#61AFEF;">git</span><span style="color:#98C379;"> checkout</span><span style="color:#98C379;"> rc/1.3.2</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>在 IoTDB 根目录下执行 maven 编译:</p><ul><li><p>Mac 或 glibc 版本 &gt;= 2.32 的 Linux</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-shell"><span class="line"><span style="color:#61AFEF;">./mvnw</span><span style="color:#98C379;"> clean</span><span style="color:#98C379;"> package</span><span style="color:#D19A66;"> -pl</span><span style="color:#98C379;"> example/client-cpp-example</span><span style="color:#D19A66;"> -am</span><span style="color:#D19A66;"> -DskipTests</span><span style="color:#D19A66;"> -P</span><span style="color:#98C379;"> with-cpp</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div></li><li><p>glibc 版本 &gt;= 2.31 的 Linux</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-shell"><span class="line"><span style="color:#61AFEF;">./mvnw</span><span style="color:#98C379;"> clean</span><span style="color:#98C379;"> package</span><span style="color:#D19A66;"> -pl</span><span style="color:#98C379;"> example/client-cpp-example</span><span style="color:#D19A66;"> -am</span><span style="color:#D19A66;"> -DskipTests</span><span style="color:#D19A66;"> -P</span><span style="color:#98C379;"> with-cpp</span><span style="color:#D19A66;"> -Diotdb-tools-thrift.version=0.14.1.1-old-glibc-SNAPSHOT</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div></li><li><p>glibc 版本 &gt;= 2.23 的 Linux</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-shell"><span class="line"><span style="color:#61AFEF;">./mvnw</span><span style="color:#98C379;"> clean</span><span style="color:#98C379;"> package</span><span style="color:#D19A66;"> -pl</span><span style="color:#98C379;"> example/client-cpp-example</span><span style="color:#D19A66;"> -am</span><span style="color:#D19A66;"> -DskipTests</span><span style="color:#D19A66;"> -P</span><span style="color:#98C379;"> with-cpp</span><span style="color:#D19A66;"> -Diotdb-tools-thrift.version=0.14.1.1-glibc223-SNAPSHOT</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div></li><li><p>glibc 版本 &gt;= 2.17 的 Linux</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-shell"><span class="line"><span style="color:#61AFEF;">./mvnw</span><span style="color:#98C379;"> clean</span><span style="color:#98C379;"> package</span><span style="color:#D19A66;"> -pl</span><span style="color:#98C379;"> example/client-cpp-example</span><span style="color:#D19A66;"> -am</span><span style="color:#D19A66;"> -DskipTests</span><span style="color:#D19A66;"> -P</span><span style="color:#98C379;"> with-cpp</span><span style="color:#D19A66;"> -Diotdb-tools-thrift.version=0.14.1.1-gcc4-SNAPSHOT</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div></li><li><p>使用 Visual Studio 2022 的 Windows</p><div class="language-batch line-numbers-mode" data-highlighter="shiki" data-ext="batch" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-batch"><span class="line"><span style="color:#ABB2BF;">.\\mvnw.cmd clean package -pl example/client-cpp-example -am -DskipTests -P with-cpp</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div></li><li><p>使用 Visual Studio 2019 的 Windows</p><div class="language-batch line-numbers-mode" data-highlighter="shiki" data-ext="batch" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-batch"><span class="line"><span style="color:#ABB2BF;">.\\mvnw.cmd clean package -pl example/client-cpp-example -am -DskipTests -P with-cpp -Dcmake.generator=</span><span style="color:#98C379;">&quot;Visual Studio 16 2019&quot;</span><span style="color:#ABB2BF;"> -Diotdb-tools-thrift.version=0.14.1.1-msvc142-SNAPSHOT</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>如果没有将 Boost 库地址加入 PATH 环境变量,在编译命令中还需添加相关参数,例如:<code>-DboostIncludeDir=&quot;C:\\Program Files (x86)\\boost_1_78_0&quot; -DboostLibraryDir=&quot;C:\\Program Files (x86)\\boost_1_78_0\\stage\\lib&quot;</code></li></ul></li></ul><p>编译成功后,打包好的库文件位于 <code>iotdb-client/client-cpp/target</code> 中,同时可以在 <code>example/client-cpp-example/target</code> 下找到编译好的示例程序。</p><h3 id="编译-q-a" tabindex="-1"><a class="header-anchor" href="#编译-q-a"><span>编译 Q&amp;A</span></a></h3><p>Q:Linux 上的环境有哪些要求呢?</p><p>A:</p><ul><li>已知依赖的 glibc (x86_64 版本) 最低版本要求为 2.17,GCC 最低版本为 5.5</li><li>已知依赖的 glibc (ARM 版本) 最低版本要求为 2.31,GCC 最低版本为 10.2</li><li>如果不满足上面的要求,可以尝试自己本地编译 Thrift <ul><li>下载 <a href="https://github.com/apache/iotdb-bin-resources/tree/iotdb-tools-thrift-v0.14.1.0/iotdb-tools-thrift" target="_blank" rel="noopener noreferrer">https://github.com/apache/iotdb-bin-resources/tree/iotdb-tools-thrift-v0.14.1.0/iotdb-tools-thrift</a> 这里的代码</li><li>执行 <code>./mvnw clean install</code></li><li>回到 iotdb 代码目录执行 <code>./mvnw clean package -pl example/client-cpp-example -am -DskipTests -P with-cpp</code></li></ul></li></ul><p>Q:Linux 编译报错<code>undefined reference to &#39;_libc_sinle_thread&#39;</code>如何处理?</p><p>A:</p><ul><li>该问题是用于默认的预编译 Thrift 依赖了过高的 glibc 版本导致的</li><li>可以尝试在编译的 maven 命令中增加 <code>-Diotdb-tools-thrift.version=0.14.1.1-glibc223-SNAPSHOT</code> 或者 <code>-Diotdb-tools-thrift.version=0.14.1.1-old-glibc-SNAPSHOT</code></li></ul><p>Q:如果在 Windows 上需要使用 Visual Studio 2017 或更早版本进行编译,要怎么做?</p><p>A:</p><ul><li>可以尝试自己本地编译 Thrift 后再进行客户端的编译 <ul><li>下载 <a href="https://github.com/apache/iotdb-bin-resources/tree/iotdb-tools-thrift-v0.14.1.0/iotdb-tools-thrift" target="_blank" rel="noopener noreferrer">https://github.com/apache/iotdb-bin-resources/tree/iotdb-tools-thrift-v0.14.1.0/iotdb-tools-thrift</a> 这里的代码</li><li>执行 <code>.\\mvnw.cmd clean install</code></li><li>回到 iotdb 代码目录执行 <code>.\\mvnw.cmd clean package -pl example/client-cpp-example -am -DskipTests -P with-cpp -Dcmake.generator=&quot;Visual Studio 15 2017&quot;</code></li></ul></li></ul><h2 id="基本接口说明" tabindex="-1"><a class="header-anchor" href="#基本接口说明"><span>基本接口说明</span></a></h2><p>下面将给出 Session 接口的简要介绍和原型定义:</p><h3 id="初始化" tabindex="-1"><a class="header-anchor" href="#初始化"><span>初始化</span></a></h3><ul><li>开启 Session</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="shiki" data-ext="cpp" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-cpp"><span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> open</span><span style="color:#ABB2BF;">();</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>开启 Session,并决定是否开启 RPC 压缩</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="shiki" data-ext="cpp" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-cpp"><span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> open</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">bool</span><span style="color:#E06C75;font-style:italic;"> enableRPCCompression</span><span style="color:#ABB2BF;">);</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>注意: 客户端的 RPC 压缩开启状态需和服务端一致。</p><ul><li>关闭 Session</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="shiki" data-ext="cpp" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-cpp"><span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> close</span><span style="color:#ABB2BF;">();</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><h3 id="数据定义接口-ddl" tabindex="-1"><a class="header-anchor" href="#数据定义接口-ddl"><span>数据定义接口(DDL)</span></a></h3><h4 id="database-管理" tabindex="-1"><a class="header-anchor" href="#database-管理"><span>Database 管理</span></a></h4><ul><li>设置 database</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="shiki" data-ext="cpp" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-cpp"><span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> setStorageGroup</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">string</span><span style="color:#C678DD;"> &amp;</span><span style="color:#E06C75;font-style:italic;">storageGroupId</span><span style="color:#ABB2BF;">);</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>删除单个或多个 database</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="shiki" data-ext="cpp" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-cpp"><span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> deleteStorageGroup</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">string</span><span style="color:#C678DD;"> &amp;</span><span style="color:#E06C75;font-style:italic;">storageGroup</span><span style="color:#ABB2BF;">);</span></span>
<span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> deleteStorageGroups</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">&gt; </span><span style="color:#C678DD;">&amp;</span><span style="color:#E06C75;font-style:italic;">storageGroups</span><span style="color:#ABB2BF;">);</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div></div></div><h4 id="时间序列管理" tabindex="-1"><a class="header-anchor" href="#时间序列管理"><span>时间序列管理</span></a></h4><ul><li>创建单个或多个非对齐时间序列</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="shiki" data-ext="cpp" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-cpp"><span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> createTimeseries</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">string</span><span style="color:#C678DD;"> &amp;</span><span style="color:#E06C75;font-style:italic;">path</span><span style="color:#ABB2BF;">, TSDataType::</span><span style="color:#E5C07B;">TSDataType</span><span style="color:#E06C75;font-style:italic;"> dataType</span><span style="color:#ABB2BF;">, TSEncoding::</span><span style="color:#E5C07B;">TSEncoding</span><span style="color:#E06C75;font-style:italic;"> encoding</span><span style="color:#ABB2BF;">,</span></span>
<span class="line"><span style="color:#ABB2BF;"> CompressionType::</span><span style="color:#E5C07B;">CompressionType</span><span style="color:#E06C75;font-style:italic;"> compressor</span><span style="color:#ABB2BF;">);</span></span>
<span class="line"><span style="color:#ABB2BF;"> </span></span>
<span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> createMultiTimeseries</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">&gt; </span><span style="color:#C678DD;">&amp;</span><span style="color:#E06C75;font-style:italic;">paths</span><span style="color:#ABB2BF;">,</span></span>
<span class="line"><span style="color:#C678DD;"> const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;TSDataType::</span><span style="color:#E5C07B;">TSDataType</span><span style="color:#ABB2BF;">&gt; </span><span style="color:#C678DD;">&amp;</span><span style="color:#E06C75;font-style:italic;">dataTypes</span><span style="color:#ABB2BF;">,</span></span>
<span class="line"><span style="color:#C678DD;"> const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;TSEncoding::</span><span style="color:#E5C07B;">TSEncoding</span><span style="color:#ABB2BF;">&gt; </span><span style="color:#C678DD;">&amp;</span><span style="color:#E06C75;font-style:italic;">encodings</span><span style="color:#ABB2BF;">,</span></span>
<span class="line"><span style="color:#C678DD;"> const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;CompressionType::</span><span style="color:#E5C07B;">CompressionType</span><span style="color:#ABB2BF;">&gt; </span><span style="color:#C678DD;">&amp;</span><span style="color:#E06C75;font-style:italic;">compressors</span><span style="color:#ABB2BF;">,</span></span>
<span class="line"><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;std::</span><span style="color:#E5C07B;">map</span><span style="color:#ABB2BF;">&lt;std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">, std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">&gt;&gt; </span><span style="color:#C678DD;">*</span><span style="color:#E06C75;font-style:italic;">propsList</span><span style="color:#ABB2BF;">,</span></span>
<span class="line"><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;std::</span><span style="color:#E5C07B;">map</span><span style="color:#ABB2BF;">&lt;std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">, std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">&gt;&gt; </span><span style="color:#C678DD;">*</span><span style="color:#E06C75;font-style:italic;">tagsList</span><span style="color:#ABB2BF;">,</span></span>
<span class="line"><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;std::</span><span style="color:#E5C07B;">map</span><span style="color:#ABB2BF;">&lt;std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">, std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">&gt;&gt; </span><span style="color:#C678DD;">*</span><span style="color:#E06C75;font-style:italic;">attributesList</span><span style="color:#ABB2BF;">,</span></span>
<span class="line"><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">&gt; </span><span style="color:#C678DD;">*</span><span style="color:#E06C75;font-style:italic;">measurementAliasList</span><span style="color:#ABB2BF;">);</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>创建对齐时间序列</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="shiki" data-ext="cpp" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-cpp"><span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> createAlignedTimeseries</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">string</span><span style="color:#C678DD;"> &amp;</span><span style="color:#E06C75;font-style:italic;">deviceId</span><span style="color:#ABB2BF;">,</span></span>
<span class="line"><span style="color:#C678DD;"> const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">&gt; </span><span style="color:#C678DD;">&amp;</span><span style="color:#E06C75;font-style:italic;">measurements</span><span style="color:#ABB2BF;">,</span></span>
<span class="line"><span style="color:#C678DD;"> const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;TSDataType::</span><span style="color:#E5C07B;">TSDataType</span><span style="color:#ABB2BF;">&gt; </span><span style="color:#C678DD;">&amp;</span><span style="color:#E06C75;font-style:italic;">dataTypes</span><span style="color:#ABB2BF;">,</span></span>
<span class="line"><span style="color:#C678DD;"> const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;TSEncoding::</span><span style="color:#E5C07B;">TSEncoding</span><span style="color:#ABB2BF;">&gt; </span><span style="color:#C678DD;">&amp;</span><span style="color:#E06C75;font-style:italic;">encodings</span><span style="color:#ABB2BF;">,</span></span>
<span class="line"><span style="color:#C678DD;"> const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;CompressionType::</span><span style="color:#E5C07B;">CompressionType</span><span style="color:#ABB2BF;">&gt; </span><span style="color:#C678DD;">&amp;</span><span style="color:#E06C75;font-style:italic;">compressors</span><span style="color:#ABB2BF;">);</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>删除一个或多个时间序列</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="shiki" data-ext="cpp" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-cpp"><span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> deleteTimeseries</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">string</span><span style="color:#C678DD;"> &amp;</span><span style="color:#E06C75;font-style:italic;">path</span><span style="color:#ABB2BF;">);</span></span>
<span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> deleteTimeseries</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">&gt; </span><span style="color:#C678DD;">&amp;</span><span style="color:#E06C75;font-style:italic;">paths</span><span style="color:#ABB2BF;">);</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>检查时间序列是否存在</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="shiki" data-ext="cpp" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-cpp"><span class="line"><span style="color:#C678DD;">bool</span><span style="color:#61AFEF;"> checkTimeseriesExists</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">string</span><span style="color:#C678DD;"> &amp;</span><span style="color:#E06C75;font-style:italic;">path</span><span style="color:#ABB2BF;">);</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><h4 id="元数据模版" tabindex="-1"><a class="header-anchor" href="#元数据模版"><span>元数据模版</span></a></h4><ul><li>创建元数据模板</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="shiki" data-ext="cpp" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-cpp"><span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> createSchemaTemplate</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">const</span><span style="color:#E5C07B;"> Template</span><span style="color:#C678DD;"> &amp;</span><span style="color:#E06C75;font-style:italic;">templ</span><span style="color:#ABB2BF;">);</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>挂载元数据模板</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="shiki" data-ext="cpp" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-cpp"><span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> setSchemaTemplate</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">string</span><span style="color:#C678DD;"> &amp;</span><span style="color:#E06C75;font-style:italic;">template_name</span><span style="color:#ABB2BF;">, </span><span style="color:#C678DD;">const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">string</span><span style="color:#C678DD;"> &amp;</span><span style="color:#E06C75;font-style:italic;">prefix_path</span><span style="color:#ABB2BF;">);</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>请注意,如果一个子树中有多个孩子节点需要使用模板,可以在其共同父母节点上使用 setSchemaTemplate 。而只有在已有数据点插入模板对应的物理量时,模板才会被设置为激活状态,进而被 show timeseries 等查询检测到。</p><ul><li>卸载元数据模板</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="shiki" data-ext="cpp" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-cpp"><span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> unsetSchemaTemplate</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">string</span><span style="color:#C678DD;"> &amp;</span><span style="color:#E06C75;font-style:italic;">prefix_path</span><span style="color:#ABB2BF;">, </span><span style="color:#C678DD;">const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">string</span><span style="color:#C678DD;"> &amp;</span><span style="color:#E06C75;font-style:italic;">template_name</span><span style="color:#ABB2BF;">);</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>注意:目前不支持从曾经在<code>prefixPath</code>路径及其后代节点使用模板插入数据后(即使数据已被删除)卸载模板。</p><ul><li>在创建概念元数据模板以后,还可以通过以下接口增加或删除模板内的物理量。请注意,已经挂载的模板不能删除内部的物理量。</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="shiki" data-ext="cpp" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-cpp"><span class="line"><span style="color:#7F848E;font-style:italic;">// 为指定模板新增一组对齐的物理量,若其父节点在模板中已经存在,且不要求对齐,则报错</span></span>
<span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> addAlignedMeasurementsInTemplate</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">string</span><span style="color:#C678DD;"> &amp;</span><span style="color:#E06C75;font-style:italic;">template_name</span><span style="color:#ABB2BF;">,</span></span>
<span class="line"><span style="color:#C678DD;"> const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">&gt; </span><span style="color:#C678DD;">&amp;</span><span style="color:#E06C75;font-style:italic;">measurements</span><span style="color:#ABB2BF;">,</span></span>
<span class="line"><span style="color:#C678DD;"> const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;TSDataType::</span><span style="color:#E5C07B;">TSDataType</span><span style="color:#ABB2BF;">&gt; </span><span style="color:#C678DD;">&amp;</span><span style="color:#E06C75;font-style:italic;">dataTypes</span><span style="color:#ABB2BF;">,</span></span>
<span class="line"><span style="color:#C678DD;"> const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;TSEncoding::</span><span style="color:#E5C07B;">TSEncoding</span><span style="color:#ABB2BF;">&gt; </span><span style="color:#C678DD;">&amp;</span><span style="color:#E06C75;font-style:italic;">encodings</span><span style="color:#ABB2BF;">,</span></span>
<span class="line"><span style="color:#C678DD;"> const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;CompressionType::</span><span style="color:#E5C07B;">CompressionType</span><span style="color:#ABB2BF;">&gt; </span><span style="color:#C678DD;">&amp;</span><span style="color:#E06C75;font-style:italic;">compressors</span><span style="color:#ABB2BF;">);</span></span>
<span class="line"></span>
<span class="line"><span style="color:#7F848E;font-style:italic;">// 为指定模板新增一个对齐物理量, 若其父节点在模板中已经存在,且不要求对齐,则报错</span></span>
<span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> addAlignedMeasurementsInTemplate</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">string</span><span style="color:#C678DD;"> &amp;</span><span style="color:#E06C75;font-style:italic;">template_name</span><span style="color:#ABB2BF;">,</span></span>
<span class="line"><span style="color:#C678DD;"> const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">string</span><span style="color:#C678DD;"> &amp;</span><span style="color:#E06C75;font-style:italic;">measurement</span><span style="color:#ABB2BF;">,</span></span>
<span class="line"><span style="color:#ABB2BF;"> TSDataType::</span><span style="color:#E5C07B;">TSDataType</span><span style="color:#E06C75;font-style:italic;"> dataType</span><span style="color:#ABB2BF;">,</span></span>
<span class="line"><span style="color:#ABB2BF;"> TSEncoding::</span><span style="color:#E5C07B;">TSEncoding</span><span style="color:#E06C75;font-style:italic;"> encoding</span><span style="color:#ABB2BF;">,</span></span>
<span class="line"><span style="color:#ABB2BF;"> CompressionType::</span><span style="color:#E5C07B;">CompressionType</span><span style="color:#E06C75;font-style:italic;"> compressor</span><span style="color:#ABB2BF;">);</span></span>
<span class="line"></span>
<span class="line"><span style="color:#7F848E;font-style:italic;">// 为指定模板新增一个不对齐物理量, 若其父节在模板中已经存在,且要求对齐,则报错</span></span>
<span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> addUnalignedMeasurementsInTemplate</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">string</span><span style="color:#C678DD;"> &amp;</span><span style="color:#E06C75;font-style:italic;">template_name</span><span style="color:#ABB2BF;">,</span></span>
<span class="line"><span style="color:#C678DD;"> const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">&gt; </span><span style="color:#C678DD;">&amp;</span><span style="color:#E06C75;font-style:italic;">measurements</span><span style="color:#ABB2BF;">,</span></span>
<span class="line"><span style="color:#C678DD;"> const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;TSDataType::</span><span style="color:#E5C07B;">TSDataType</span><span style="color:#ABB2BF;">&gt; </span><span style="color:#C678DD;">&amp;</span><span style="color:#E06C75;font-style:italic;">dataTypes</span><span style="color:#ABB2BF;">,</span></span>
<span class="line"><span style="color:#C678DD;"> const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;TSEncoding::</span><span style="color:#E5C07B;">TSEncoding</span><span style="color:#ABB2BF;">&gt; </span><span style="color:#C678DD;">&amp;</span><span style="color:#E06C75;font-style:italic;">encodings</span><span style="color:#ABB2BF;">,</span></span>
<span class="line"><span style="color:#C678DD;"> const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;CompressionType::</span><span style="color:#E5C07B;">CompressionType</span><span style="color:#ABB2BF;">&gt; </span><span style="color:#C678DD;">&amp;</span><span style="color:#E06C75;font-style:italic;">compressors</span><span style="color:#ABB2BF;">);</span></span>
<span class="line"></span>
<span class="line"><span style="color:#7F848E;font-style:italic;">// 为指定模板新增一组不对齐的物理量, 若其父节在模板中已经存在,且要求对齐,则报错</span></span>
<span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> addUnalignedMeasurementsInTemplate</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">string</span><span style="color:#C678DD;"> &amp;</span><span style="color:#E06C75;font-style:italic;">template_name</span><span style="color:#ABB2BF;">,</span></span>
<span class="line"><span style="color:#C678DD;"> const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">string</span><span style="color:#C678DD;"> &amp;</span><span style="color:#E06C75;font-style:italic;">measurement</span><span style="color:#ABB2BF;">,</span></span>
<span class="line"><span style="color:#ABB2BF;"> TSDataType::</span><span style="color:#E5C07B;">TSDataType</span><span style="color:#E06C75;font-style:italic;"> dataType</span><span style="color:#ABB2BF;">,</span></span>
<span class="line"><span style="color:#ABB2BF;"> TSEncoding::</span><span style="color:#E5C07B;">TSEncoding</span><span style="color:#E06C75;font-style:italic;"> encoding</span><span style="color:#ABB2BF;">,</span></span>
<span class="line"><span style="color:#ABB2BF;"> CompressionType::</span><span style="color:#E5C07B;">CompressionType</span><span style="color:#E06C75;font-style:italic;"> compressor</span><span style="color:#ABB2BF;">);</span></span>
<span class="line"></span>
<span class="line"><span style="color:#7F848E;font-style:italic;">// 从指定模板中删除一个节点及其子树</span></span>
<span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> deleteNodeInTemplate</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">string</span><span style="color:#C678DD;"> &amp;</span><span style="color:#E06C75;font-style:italic;">template_name</span><span style="color:#ABB2BF;">, </span><span style="color:#C678DD;">const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">string</span><span style="color:#C678DD;"> &amp;</span><span style="color:#E06C75;font-style:italic;">path</span><span style="color:#ABB2BF;">);</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>对于已经创建的元数据模板,还可以通过以下接口查询模板信息:</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="shiki" data-ext="cpp" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-cpp"><span class="line"><span style="color:#7F848E;font-style:italic;">// 查询返回目前模板中所有物理量的数量</span></span>
<span class="line"><span style="color:#C678DD;">int</span><span style="color:#61AFEF;"> countMeasurementsInTemplate</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">string</span><span style="color:#C678DD;"> &amp;</span><span style="color:#E06C75;font-style:italic;">template_name</span><span style="color:#ABB2BF;">);</span></span>
<span class="line"></span>
<span class="line"><span style="color:#7F848E;font-style:italic;">// 检查模板内指定路径是否为物理量</span></span>
<span class="line"><span style="color:#C678DD;">bool</span><span style="color:#61AFEF;"> isMeasurementInTemplate</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">string</span><span style="color:#C678DD;"> &amp;</span><span style="color:#E06C75;font-style:italic;">template_name</span><span style="color:#ABB2BF;">, </span><span style="color:#C678DD;">const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">string</span><span style="color:#C678DD;"> &amp;</span><span style="color:#E06C75;font-style:italic;">path</span><span style="color:#ABB2BF;">);</span></span>
<span class="line"></span>
<span class="line"><span style="color:#7F848E;font-style:italic;">// 检查在指定模板内是否存在某路径</span></span>
<span class="line"><span style="color:#C678DD;">bool</span><span style="color:#61AFEF;"> isPathExistInTemplate</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">string</span><span style="color:#C678DD;"> &amp;</span><span style="color:#E06C75;font-style:italic;">template_name</span><span style="color:#ABB2BF;">, </span><span style="color:#C678DD;">const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">string</span><span style="color:#C678DD;"> &amp;</span><span style="color:#E06C75;font-style:italic;">path</span><span style="color:#ABB2BF;">);</span></span>
<span class="line"></span>
<span class="line"><span style="color:#7F848E;font-style:italic;">// 返回指定模板内所有物理量的路径</span></span>
<span class="line"><span style="color:#ABB2BF;">std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">&gt; </span><span style="color:#61AFEF;">showMeasurementsInTemplate</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">string</span><span style="color:#C678DD;"> &amp;</span><span style="color:#E06C75;font-style:italic;">template_name</span><span style="color:#ABB2BF;">);</span></span>
<span class="line"></span>
<span class="line"><span style="color:#7F848E;font-style:italic;">// 返回指定模板内某前缀路径下的所有物理量的路径</span></span>
<span class="line"><span style="color:#ABB2BF;">std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">&gt; </span><span style="color:#61AFEF;">showMeasurementsInTemplate</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">string</span><span style="color:#C678DD;"> &amp;</span><span style="color:#E06C75;font-style:italic;">template_name</span><span style="color:#ABB2BF;">, </span><span style="color:#C678DD;">const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">string</span><span style="color:#C678DD;"> &amp;</span><span style="color:#E06C75;font-style:italic;">pattern</span><span style="color:#ABB2BF;">);</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h3 id="数据操作接口-dml" tabindex="-1"><a class="header-anchor" href="#数据操作接口-dml"><span>数据操作接口(DML)</span></a></h3><h4 id="数据写入" tabindex="-1"><a class="header-anchor" href="#数据写入"><span>数据写入</span></a></h4><blockquote><p>推荐使用 insertTablet 帮助提高写入效率。</p></blockquote><ul><li>插入一个 TabletTablet 是一个设备若干行数据块,每一行的列都相同。 <ul><li>写入效率高。</li><li>支持写入空值:空值处可以填入任意值,然后通过 BitMap 标记空值。</li></ul></li></ul><div class="language-cpp line-numbers-mode" data-highlighter="shiki" data-ext="cpp" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-cpp"><span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> insertTablet</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">Tablet</span><span style="color:#C678DD;"> &amp;</span><span style="color:#E06C75;font-style:italic;">tablet</span><span style="color:#ABB2BF;">);</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>插入多个 Tablet</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="shiki" data-ext="cpp" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-cpp"><span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> insertTablets</span><span style="color:#ABB2BF;">(std::</span><span style="color:#E5C07B;">unordered_map</span><span style="color:#ABB2BF;">&lt;std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">, </span><span style="color:#E5C07B;">Tablet</span><span style="color:#C678DD;"> *</span><span style="color:#ABB2BF;">&gt; </span><span style="color:#C678DD;">&amp;</span><span style="color:#E06C75;font-style:italic;">tablets</span><span style="color:#ABB2BF;">);</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>插入一个 Record,一个 Record 是一个设备一个时间戳下多个测点的数据</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="shiki" data-ext="cpp" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-cpp"><span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> insertRecord</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">string</span><span style="color:#C678DD;"> &amp;</span><span style="color:#E06C75;font-style:italic;">deviceId</span><span style="color:#ABB2BF;">, </span><span style="color:#C678DD;">int64_t</span><span style="color:#E06C75;font-style:italic;"> time</span><span style="color:#ABB2BF;">, </span><span style="color:#C678DD;">const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">&gt; </span><span style="color:#C678DD;">&amp;</span><span style="color:#E06C75;font-style:italic;">measurements</span><span style="color:#ABB2BF;">,</span></span>
<span class="line"><span style="color:#C678DD;"> const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;TSDataType::</span><span style="color:#E5C07B;">TSDataType</span><span style="color:#ABB2BF;">&gt; </span><span style="color:#C678DD;">&amp;</span><span style="color:#E06C75;font-style:italic;">types</span><span style="color:#ABB2BF;">, </span><span style="color:#C678DD;">const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;</span><span style="color:#C678DD;">char</span><span style="color:#C678DD;"> *</span><span style="color:#ABB2BF;">&gt; </span><span style="color:#C678DD;">&amp;</span><span style="color:#E06C75;font-style:italic;">values</span><span style="color:#ABB2BF;">);</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>插入多个 Record</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="shiki" data-ext="cpp" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-cpp"><span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> insertRecords</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">&gt; </span><span style="color:#C678DD;">&amp;</span><span style="color:#E06C75;font-style:italic;">deviceIds</span><span style="color:#ABB2BF;">,</span></span>
<span class="line"><span style="color:#C678DD;"> const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;</span><span style="color:#C678DD;">int64_t</span><span style="color:#ABB2BF;">&gt; </span><span style="color:#C678DD;">&amp;</span><span style="color:#E06C75;font-style:italic;">times</span><span style="color:#ABB2BF;">,</span></span>
<span class="line"><span style="color:#C678DD;"> const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">&gt;&gt; </span><span style="color:#C678DD;">&amp;</span><span style="color:#E06C75;font-style:italic;">measurementsList</span><span style="color:#ABB2BF;">,</span></span>
<span class="line"><span style="color:#C678DD;"> const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;TSDataType::</span><span style="color:#E5C07B;">TSDataType</span><span style="color:#ABB2BF;">&gt;&gt; </span><span style="color:#C678DD;">&amp;</span><span style="color:#E06C75;font-style:italic;">typesList</span><span style="color:#ABB2BF;">,</span></span>
<span class="line"><span style="color:#C678DD;"> const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;</span><span style="color:#C678DD;">char</span><span style="color:#C678DD;"> *</span><span style="color:#ABB2BF;">&gt;&gt; </span><span style="color:#C678DD;">&amp;</span><span style="color:#E06C75;font-style:italic;">valuesList</span><span style="color:#ABB2BF;">);</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>插入同属于一个 device 的多个 Record</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="shiki" data-ext="cpp" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-cpp"><span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> insertRecordsOfOneDevice</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">string</span><span style="color:#C678DD;"> &amp;</span><span style="color:#E06C75;font-style:italic;">deviceId</span><span style="color:#ABB2BF;">,</span></span>
<span class="line"><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;</span><span style="color:#C678DD;">int64_t</span><span style="color:#ABB2BF;">&gt; </span><span style="color:#C678DD;">&amp;</span><span style="color:#E06C75;font-style:italic;">times</span><span style="color:#ABB2BF;">,</span></span>
<span class="line"><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">&gt;&gt; </span><span style="color:#C678DD;">&amp;</span><span style="color:#E06C75;font-style:italic;">measurementsList</span><span style="color:#ABB2BF;">,</span></span>
<span class="line"><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;TSDataType::</span><span style="color:#E5C07B;">TSDataType</span><span style="color:#ABB2BF;">&gt;&gt; </span><span style="color:#C678DD;">&amp;</span><span style="color:#E06C75;font-style:italic;">typesList</span><span style="color:#ABB2BF;">,</span></span>
<span class="line"><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;</span><span style="color:#C678DD;">char</span><span style="color:#C678DD;"> *</span><span style="color:#ABB2BF;">&gt;&gt; </span><span style="color:#C678DD;">&amp;</span><span style="color:#E06C75;font-style:italic;">valuesList</span><span style="color:#ABB2BF;">);</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h4 id="带有类型推断的写入" tabindex="-1"><a class="header-anchor" href="#带有类型推断的写入"><span>带有类型推断的写入</span></a></h4><p>服务器需要做类型推断,可能会有额外耗时,速度较无需类型推断的写入慢。</p><div class="language-cpp line-numbers-mode" data-highlighter="shiki" data-ext="cpp" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-cpp"><span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> insertRecord</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">string</span><span style="color:#C678DD;"> &amp;</span><span style="color:#E06C75;font-style:italic;">deviceId</span><span style="color:#ABB2BF;">, </span><span style="color:#C678DD;">int64_t</span><span style="color:#E06C75;font-style:italic;"> time</span><span style="color:#ABB2BF;">, </span><span style="color:#C678DD;">const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">&gt; </span><span style="color:#C678DD;">&amp;</span><span style="color:#E06C75;font-style:italic;">measurements</span><span style="color:#ABB2BF;">,</span></span>
<span class="line"><span style="color:#C678DD;"> const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">&gt; </span><span style="color:#C678DD;">&amp;</span><span style="color:#E06C75;font-style:italic;">values</span><span style="color:#ABB2BF;">);</span></span>
<span class="line"></span>
<span class="line"></span>
<span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> insertRecords</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">&gt; </span><span style="color:#C678DD;">&amp;</span><span style="color:#E06C75;font-style:italic;">deviceIds</span><span style="color:#ABB2BF;">,</span></span>
<span class="line"><span style="color:#C678DD;"> const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;</span><span style="color:#C678DD;">int64_t</span><span style="color:#ABB2BF;">&gt; </span><span style="color:#C678DD;">&amp;</span><span style="color:#E06C75;font-style:italic;">times</span><span style="color:#ABB2BF;">,</span></span>
<span class="line"><span style="color:#C678DD;"> const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">&gt;&gt; </span><span style="color:#C678DD;">&amp;</span><span style="color:#E06C75;font-style:italic;">measurementsList</span><span style="color:#ABB2BF;">,</span></span>
<span class="line"><span style="color:#C678DD;"> const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">&gt;&gt; </span><span style="color:#C678DD;">&amp;</span><span style="color:#E06C75;font-style:italic;">valuesList</span><span style="color:#ABB2BF;">);</span></span>
<span class="line"></span>
<span class="line"></span>
<span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> insertRecordsOfOneDevice</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">string</span><span style="color:#C678DD;"> &amp;</span><span style="color:#E06C75;font-style:italic;">deviceId</span><span style="color:#ABB2BF;">,</span></span>
<span class="line"><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;</span><span style="color:#C678DD;">int64_t</span><span style="color:#ABB2BF;">&gt; </span><span style="color:#C678DD;">&amp;</span><span style="color:#E06C75;font-style:italic;">times</span><span style="color:#ABB2BF;">,</span></span>
<span class="line"><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">&gt;&gt; </span><span style="color:#C678DD;">&amp;</span><span style="color:#E06C75;font-style:italic;">measurementsList</span><span style="color:#ABB2BF;">,</span></span>
<span class="line"><span style="color:#C678DD;"> const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">&gt;&gt; </span><span style="color:#C678DD;">&amp;</span><span style="color:#E06C75;font-style:italic;">valuesList</span><span style="color:#ABB2BF;">);</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h4 id="对齐时间序列写入" tabindex="-1"><a class="header-anchor" href="#对齐时间序列写入"><span>对齐时间序列写入</span></a></h4><p>对齐时间序列的写入使用 insertAlignedXXX 接口,其余与上述接口类似:</p><ul><li>insertAlignedRecord</li><li>insertAlignedRecords</li><li>insertAlignedRecordsOfOneDevice</li><li>insertAlignedTablet</li><li>insertAlignedTablets</li></ul><h4 id="数据删除" tabindex="-1"><a class="header-anchor" href="#数据删除"><span>数据删除</span></a></h4><ul><li>删除一个或多个时间序列在某个时间范围的数据</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="shiki" data-ext="cpp" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-cpp"><span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> deleteData</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">string</span><span style="color:#C678DD;"> &amp;</span><span style="color:#E06C75;font-style:italic;">path</span><span style="color:#ABB2BF;">, </span><span style="color:#C678DD;">int64_t</span><span style="color:#E06C75;font-style:italic;"> endTime</span><span style="color:#ABB2BF;">);</span></span>
<span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> deleteData</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">&gt; </span><span style="color:#C678DD;">&amp;</span><span style="color:#E06C75;font-style:italic;">paths</span><span style="color:#ABB2BF;">, </span><span style="color:#C678DD;">int64_t</span><span style="color:#E06C75;font-style:italic;"> endTime</span><span style="color:#ABB2BF;">);</span></span>
<span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> deleteData</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;">&lt;std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">&gt; </span><span style="color:#C678DD;">&amp;</span><span style="color:#E06C75;font-style:italic;">paths</span><span style="color:#ABB2BF;">, </span><span style="color:#C678DD;">int64_t</span><span style="color:#E06C75;font-style:italic;"> startTime</span><span style="color:#ABB2BF;">, </span><span style="color:#C678DD;">int64_t</span><span style="color:#E06C75;font-style:italic;"> endTime</span><span style="color:#ABB2BF;">);</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h3 id="iotdb-sql-接口" tabindex="-1"><a class="header-anchor" href="#iotdb-sql-接口"><span>IoTDB-SQL 接口</span></a></h3><ul><li>执行查询语句</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="shiki" data-ext="cpp" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-cpp"><span class="line"><span style="color:#E5C07B;">unique_ptr</span><span style="color:#ABB2BF;">&lt;</span><span style="color:#E5C07B;">SessionDataSet</span><span style="color:#ABB2BF;">&gt; </span><span style="color:#61AFEF;">executeQueryStatement</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">string</span><span style="color:#C678DD;"> &amp;</span><span style="color:#E06C75;font-style:italic;">sql</span><span style="color:#ABB2BF;">);</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>返回值 <code>SessionDataSet</code> 类主要提供如下方法:</p><table><thead><tr><th style="text-align:left;">方法名</th><th style="text-align:left;">描述</th><th style="text-align:left;">参数</th><th style="text-align:left;">返回值</th></tr></thead><tbody><tr><td style="text-align:left;"><strong>hasNext()</strong></td><td style="text-align:left;">判断结果集中是否还有更多数据行。</td><td style="text-align:left;">-</td><td style="text-align:left;"><code>bool</code></td></tr><tr><td style="text-align:left;"><strong>next()</strong></td><td style="text-align:left;">获取结果集中的下一行数据,封装为一个 <code>RowRecord</code> 对象。</td><td style="text-align:left;">-</td><td style="text-align:left;"><code>std::shared_ptr</code></td></tr><tr><td style="text-align:left;"><strong>getIterator()</strong></td><td style="text-align:left;">获取一个 <code>DataIterator</code> 迭代器,用于以更灵活的方式(按列)遍历数据。</td><td style="text-align:left;">-</td><td style="text-align:left;"><code>SessionDataSet::DataIterator</code></td></tr><tr><td style="text-align:left;"><strong>getColumnNames()</strong></td><td style="text-align:left;">获取结果集中所有列的名称列表。</td><td style="text-align:left;">-</td><td style="text-align:left;"><code>const std::vector&amp;</code></td></tr><tr><td style="text-align:left;"><strong>getColumnTypeList()</strong></td><td style="text-align:left;">获取结果集中所有列的数据类型列表。</td><td style="text-align:left;">-</td><td style="text-align:left;"><code>const std::vector&amp;</code></td></tr><tr><td style="text-align:left;"><strong>getFetchSize()</strong></td><td style="text-align:left;">获取当前每次从服务器批量抓取数据的行数。</td><td style="text-align:left;">-</td><td style="text-align:left;"><code>int</code></td></tr><tr><td style="text-align:left;"><strong>setFetchSize(int fetchSize)</strong></td><td style="text-align:left;">设置每次从服务器批量抓取数据的行数。</td><td style="text-align:left;"><code>fetchSize</code>: 批量抓取数据的行数</td><td style="text-align:left;"><code>void</code></td></tr><tr><td style="text-align:left;"><strong>closeOperationHandle(bool forceClose)</strong></td><td style="text-align:left;">关闭服务器端的查询句柄,释放资源。建议在数据集使用完毕后调用。</td><td style="text-align:left;"><code>forceClose</code>: 是否强制关闭(默认为 <code>false</code>)</td><td style="text-align:left;"><code>void</code></td></tr></tbody></table><ul><li>执行非查询语句</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="shiki" data-ext="cpp" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-cpp"><span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> executeNonQueryStatement</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">const</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">string</span><span style="color:#C678DD;"> &amp;</span><span style="color:#E06C75;font-style:italic;">sql</span><span style="color:#ABB2BF;">);</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><h2 id="示例代码" tabindex="-1"><a class="header-anchor" href="#示例代码"><span>示例代码</span></a></h2><p>示例工程源代码:</p><ul><li><code>example/client-cpp-example/src/SessionExample.cpp</code>: <a href="https://github.com/apache/iotdb/tree/rc/1.3.3/example/client-cpp-example/src/SessionExample.cpp" target="_blank" rel="noopener noreferrer">SessionExample</a></li><li><code>example/client-cpp-example/src/AlignedTimeseriesSessionExample.cpp</code> (使用对齐时间序列): <a href="https://github.com/apache/iotdb/tree/rc/1.3.3/example/client-cpp-example/src/AlignedTimeseriesSessionExample.cpp" target="_blank" rel="noopener noreferrer">AlignedTimeseriesSessionExample</a></li></ul><p>编译成功后,示例代码工程位于 <code>example/client-cpp-example/target</code></p><h2 id="faq" tabindex="-1"><a class="header-anchor" href="#faq"><span>FAQ</span></a></h2><h3 id="thrift-编译相关问题" tabindex="-1"><a class="header-anchor" href="#thrift-编译相关问题"><span>Thrift 编译相关问题</span></a></h3><ol><li><p>MAC:本地 Maven 编译 Thrift 时如出现以下链接的问题,可以尝试将 xcode-commandline 版本从 12 降低到 11.5<br><a href="https://stackoverflow.com/questions/63592445/ld-unsupported-tapi-file-type-tapi-tbd-in-yaml-file/65518087#65518087" target="_blank" rel="noopener noreferrer">https://stackoverflow.com/questions/63592445/ld-unsupported-tapi-file-type-tapi-tbd-in-yaml-file/65518087#65518087</a></p></li><li><p>Windows:Maven 编译 Thrift 时需要使用 wget 下载远端文件,可能出现以下报错:</p><div class="language- line-numbers-mode" data-highlighter="shiki" data-ext="" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-"><span class="line"><span>Failed to delete cached file C:\\Users\\Administrator\\.m2\\repository\\.cache\\download-maven-plugin\\index.ser</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>解决方法:</p><ul><li>尝试删除 &quot;.m2\\repository\\.cache&quot; 目录并重试。</li><li>在添加 pom 文件对应的 download-maven-plugin 中添加 &quot;&lt;skipCache&gt;true&lt;/skipCache&gt;&quot;</li></ul></li></ol>`,101)])])}const r=l(o,[["render",t]]),i=JSON.parse('{"path":"/zh/UserGuide/V1.3.x/API/Programming-Cpp-Native-API.html","title":"C++ 原生接口","lang":"zh-CN","frontmatter":{"description":"C++ 原生接口 依赖 Java 8+ Flex Bison 2.7+ Boost 1.56+ OpenSSL 1.0+ GCC 4.8.5+ 安装 安装相关依赖 MAC 安装 Bison : 使用下面 brew 命令安装 bison 版本: 安装 Boost :确保安装最新的 Boost 版本。 检查 OpenSSL :确保 openssl 库已安装...","head":[["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"C++ 原生接口\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2026-03-06T10:29:45.000Z\\",\\"author\\":[]}"],["meta",{"property":"og:url","content":"https://iotdb.apache.org/zh/UserGuide/V1.3.x/API/Programming-Cpp-Native-API.html"}],["meta",{"property":"og:site_name","content":"IoTDB Website"}],["meta",{"property":"og:title","content":"C++ 原生接口"}],["meta",{"property":"og:description","content":"C++ 原生接口 依赖 Java 8+ Flex Bison 2.7+ Boost 1.56+ OpenSSL 1.0+ GCC 4.8.5+ 安装 安装相关依赖 MAC 安装 Bison : 使用下面 brew 命令安装 bison 版本: 安装 Boost :确保安装最新的 Boost 版本。 检查 OpenSSL :确保 openssl 库已安装..."}],["meta",{"property":"og:type","content":"article"}],["meta",{"property":"og:locale","content":"zh-CN"}],["meta",{"property":"og:locale:alternate","content":"en-US"}],["meta",{"property":"og:updated_time","content":"2026-03-06T10:29:45.000Z"}],["meta",{"property":"article:modified_time","content":"2026-03-06T10:29:45.000Z"}],["link",{"rel":"alternate","hreflang":"en-us","href":"https://iotdb.apache.org/UserGuide/V1.3.x/API/Programming-Cpp-Native-API.html"}]]},"git":{"createdTime":1688958677000,"updatedTime":1772792985000,"contributors":[{"name":"CritasWang","username":"CritasWang","email":"critas@outlook.com","commits":3,"url":"https://github.com/CritasWang"},{"name":"LeiRui","username":"LeiRui","email":"33376433+LeiRui@users.noreply.github.com","commits":1,"url":"https://github.com/LeiRui"},{"name":"Christofer Dutz","username":"","email":"christofer.dutz@c-ware.de","commits":1},{"name":"wanghui42","username":"wanghui42","email":"105700158+wanghui42@users.noreply.github.com","commits":1,"url":"https://github.com/wanghui42"},{"name":"mal117","username":"mal117","email":"107627937+mal117@users.noreply.github.com","commits":2,"url":"https://github.com/mal117"},{"name":"Haonan","username":"Haonan","email":"hhaonan@outlook.com","commits":2,"url":"https://github.com/Haonan"},{"name":"W1y1r","username":"W1y1r","email":"150988475+W1y1r@users.noreply.github.com","commits":3,"url":"https://github.com/W1y1r"},{"name":"Mister-Hope","username":"Mister-Hope","email":"mister-hope@outlook.com","commits":1,"url":"https://github.com/Mister-Hope"},{"name":"leto-b","username":"leto-b","email":"bingqian.bai@timecho.com","commits":2,"url":"https://github.com/leto-b"}]},"readingTime":{"minutes":9.65,"words":2894},"filePathRelative":"zh/UserGuide/V1.3.x/API/Programming-Cpp-Native-API.md","autoDesc":true}');export{r as comp,i as data};