| import{_ as s,c as a,b as e,o as t}from"./app-Bhq43HqP.js";const p={};function o(l,n){return t(),a("div",null,n[0]||(n[0]=[e(`<h1 id="c-native-api" tabindex="-1"><a class="header-anchor" href="#c-native-api"><span>C++ Native API</span></a></h1><h2 id="dependencies" tabindex="-1"><a class="header-anchor" href="#dependencies"><span>Dependencies</span></a></h2><ul><li>Java 8+</li><li>Maven 3.5+</li><li>Flex</li><li>Bison 2.7+</li><li>Boost 1.56+</li><li>OpenSSL 1.0+</li><li>GCC 5.5.0+</li></ul><h2 id="installation-from-source-code" tabindex="-1"><a class="header-anchor" href="#installation-from-source-code"><span>Installation From Source Code</span></a></h2><h3 id="install-cpp-dependencies" tabindex="-1"><a class="header-anchor" href="#install-cpp-dependencies"><span>Install CPP Dependencies</span></a></h3><ul><li><p><strong>MAC</strong></p><ol><li><p>Install Bison ：Bison 2.3 is preinstalled on OSX, but this version is outdated, and we need a newer version.</p><p>When building Thrift with Bison 2.3, the following error would be shown in the build output:<br><code>invalid directive: '%code'</code></p><p>In such a case, please update <code>Bison</code>:</p><div class="language-bash line-numbers-mode" data-highlighter="prismjs" data-ext="sh" data-title="sh"><pre><code><span class="line">brew <span class="token function">install</span> bison</span> |
| <span class="line">brew <span class="token function">link</span> bison <span class="token parameter variable">--force</span></span> |
| <span class="line"></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><p>Then, you need to tell the OS where the new bison is.</p><p>For Bash users:</p><div class="language-bash line-numbers-mode" data-highlighter="prismjs" data-ext="sh" data-title="sh"><pre><code><span class="line"><span class="token builtin class-name">echo</span> <span class="token string">'export PATH="/usr/local/opt/bison/bin:$PATH"'</span> <span class="token operator">>></span> ~/.bash_profile</span> |
| <span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>For zsh users:</p><div class="language-bash line-numbers-mode" data-highlighter="prismjs" data-ext="sh" data-title="sh"><pre><code><span class="line"><span class="token builtin class-name">echo</span> <span class="token string">'export PATH="/usr/local/opt/bison/bin:$PATH"'</span> <span class="token operator">>></span> ~/.zshrc</span> |
| <span class="line"></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>Install Boost ：Please make sure a relative new version of Boost is ready on your machine.<br> If no Boost available, install the latest version of Boost:</p><div class="language-bash line-numbers-mode" data-highlighter="prismjs" data-ext="sh" data-title="sh"><pre><code><span class="line">brew <span class="token function">install</span> boost</span> |
| <span class="line">brew <span class="token function">link</span> boost</span> |
| <span class="line"></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>OpenSSL ：Make sure the Openssl libraries has been installed on your Mac. The default Openssl include file search path is "/usr/local/opt/openssl/include".</p><p>If Openssl header files can not be found when building Thrift, please add option<code>-Dopenssl.include.dir=""</code>.</p></li></ol></li><li><p><strong>Ubuntu 20</strong></p><p>To install all dependencies, run:</p><div class="language-bash line-numbers-mode" data-highlighter="prismjs" data-ext="sh" data-title="sh"><pre><code><span class="line"><span class="token function">sudo</span> <span class="token function">apt-get</span> <span class="token function">install</span> gcc-9 g++-9 libstdc++-9-dev bison flex libboost-all-dev libssl-dev zlib1g-dev</span> |
| <span class="line"></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><strong>CentOS 7.x</strong></p><p>Some packages can be installed using Yum:</p><div class="language-bash line-numbers-mode" data-highlighter="prismjs" data-ext="sh" data-title="sh"><pre><code><span class="line"><span class="token function">sudo</span> yum <span class="token function">install</span> bison flex openssl-devel</span> |
| <span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>The version of gcc and boost installed by yum is too low, therefore you should compile or download these binary packages by yourself.</p></li><li><p><strong>Windows</strong></p><ol><li><p>Building environment</p><ul><li>Install <code>MS Visual Studio</code>(recommend 2019 version): remember to install Visual Studio C/C++ IDE and compiler(supporting CMake, Clang, MinGW).</li><li>Download and install <a href="https://cmake.org/download/" target="_blank" rel="noopener noreferrer">CMake</a> .</li></ul></li><li><p>Download and install <code>Flex</code> & <code>Bison</code></p><ul><li>Download <a href="https://sourceforge.net/projects/winflexbison/" target="_blank" rel="noopener noreferrer">Win_Flex_Bison</a> .</li><li>After downloading, please rename the executables to <code>flex.exe</code> and <code>bison.exe</code> and add the directory containing them to the <code>PATH</code> environment variable.</li></ul></li><li><p>Install <code>Boost</code></p><ul><li>Download <a href="https://www.boost.org/users/download/" target="_blank" rel="noopener noreferrer">Boost</a> .</li><li>Then build <code>Boost</code> by executing <code>bootstrap.bat</code> and <code>b2.exe</code>.</li></ul></li><li><p>Install <code>OpenSSL</code></p><ul><li>Download and install <a href="http://slproweb.com/products/Win32OpenSSL.html" target="_blank" rel="noopener noreferrer">OpenSSL</a> .</li></ul></li></ol></li></ul><h3 id="compile" tabindex="-1"><a class="header-anchor" href="#compile"><span>Compile</span></a></h3><p>You can download the source code from the <a href="https://iotdb.apache.org/Download/" target="_blank" rel="noopener noreferrer">IoTDB Website</a> or clone the GIT repository:</p><div class="language-bash line-numbers-mode" data-highlighter="prismjs" data-ext="sh" data-title="sh"><pre><code><span class="line"><span class="token function">git</span> clone https://github.com/apache/iotdb.git</span> |
| <span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>The default dev branch is the master branch, If you want to use a released version (e.g. <code>0.13.3</code> or <code>1.2.0</code>), be sure to check out the corresponding tag:</p><div class="language-bash line-numbers-mode" data-highlighter="prismjs" data-ext="sh" data-title="sh"><pre><code><span class="line"><span class="token function">git</span> checkout v0.13.3</span> |
| <span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>(Please note that we are using a <code>Go</code> compatible naming schema for our release tags, which prefixes the version by a <code>v</code>)</p><p>Under the root path of iotdb:</p><ul><li><p>Mac & Linux:</p><div class="language-bash line-numbers-mode" data-highlighter="prismjs" data-ext="sh" data-title="sh"><pre><code><span class="line">mvn package <span class="token parameter variable">-P</span> compile-cpp <span class="token parameter variable">-pl</span> example/client-cpp-example <span class="token parameter variable">-am</span> <span class="token parameter variable">-DskipTest</span></span> |
| <span class="line"></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>Windows:</p><div class="language-bash line-numbers-mode" data-highlighter="prismjs" data-ext="sh" data-title="sh"><pre><code><span class="line">mvn package <span class="token parameter variable">-P</span> compile-cpp <span class="token parameter variable">-pl</span> iotdb-client/client-cpp,iotdb-core/datanode,example/client-cpp-example <span class="token parameter variable">-am</span> <span class="token parameter variable">-Dcmake.generator</span><span class="token operator">=</span><span class="token string">"your cmake generator"</span> <span class="token parameter variable">-Dboost.include.dir</span><span class="token operator">=</span><span class="token variable">\${your boost header folder}</span> <span class="token parameter variable">-Dboost.library.dir</span><span class="token operator">=</span><span class="token variable">\${your boost lib (stage) folder}</span> <span class="token parameter variable">-DskipTests</span></span> |
| <span class="line"></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>When building the client-cpp project, use the <code>-Dcmake.generator=""</code> option to specify a Cmake generator. E.g. <code>-Dcmake.generator="Visual Studio 16 2019"</code> (<code>cmake --help</code> shows a long list of supported Cmake generators.)</li><li>To help CMake find your Boost libraries on windows, you should also append <code>-DboostIncludeDir="C:\\Program Files (x86)\\boost_1_78_0" -DboostLibraryDir="C:\\Program Files (x86)\\boost_1_78_0\\stage\\lib"</code> to your mvn build command.<br> \`\`</li></ul></li></ul><p>As soon as the compilation finishes successfully, the packaged zip file will be placed under <code>client-cpp/target/client-cpp-1.3.0-SNAPSHOT-cpp-\${os}.zip</code></p><h2 id="native-apis" tabindex="-1"><a class="header-anchor" href="#native-apis"><span>Native APIs</span></a></h2><p>Here we demonstrate the most commonly used interfaces and their parameters in the Native API:</p><h3 id="initialization" tabindex="-1"><a class="header-anchor" href="#initialization"><span>Initialization</span></a></h3><ul><li><p>Open a Session:</p><div class="language-cpp line-numbers-mode" data-highlighter="prismjs" data-ext="cpp" data-title="cpp"><pre><code><span class="line"><span class="token keyword">void</span> <span class="token function">open</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> </span> |
| <span class="line"></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>Open a session, with a parameter controlling if RPC compression should be used:</p><div class="language-cpp line-numbers-mode" data-highlighter="prismjs" data-ext="cpp" data-title="cpp"><pre><code><span class="line"><span class="token keyword">void</span> <span class="token function">open</span><span class="token punctuation">(</span><span class="token keyword">bool</span> enableRPCCompression<span class="token punctuation">)</span><span class="token punctuation">;</span> </span> |
| <span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>Notice: The RPC compression setting of the client is required to match that of the IoTDB server</p></li><li><p>Close a session:</p><div class="language-cpp line-numbers-mode" data-highlighter="prismjs" data-ext="cpp" data-title="cpp"><pre><code><span class="line"><span class="token keyword">void</span> <span class="token function">close</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> </span> |
| <span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div></li></ul><h3 id="data-definition-interface-ddl" tabindex="-1"><a class="header-anchor" href="#data-definition-interface-ddl"><span>Data Definition Interface (DDL)</span></a></h3><h4 id="database-management" tabindex="-1"><a class="header-anchor" href="#database-management"><span>Database Management</span></a></h4><ul><li>Create database:</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="prismjs" data-ext="cpp" data-title="cpp"><pre><code><span class="line"><span class="token keyword">void</span> <span class="token function">setStorageGroup</span><span class="token punctuation">(</span><span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>string <span class="token operator">&</span>storageGroupId<span class="token punctuation">)</span><span class="token punctuation">;</span></span> |
| <span class="line"></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>Delete one or several databases:</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="prismjs" data-ext="cpp" data-title="cpp"><pre><code><span class="line"><span class="token keyword">void</span> <span class="token function">deleteStorageGroup</span><span class="token punctuation">(</span><span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>string <span class="token operator">&</span>storageGroup<span class="token punctuation">)</span><span class="token punctuation">;</span></span> |
| <span class="line"><span class="token keyword">void</span> <span class="token function">deleteStorageGroups</span><span class="token punctuation">(</span><span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>string<span class="token operator">></span> <span class="token operator">&</span>storageGroups<span class="token punctuation">)</span><span class="token punctuation">;</span></span> |
| <span class="line"></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="timeseries-management" tabindex="-1"><a class="header-anchor" href="#timeseries-management"><span>Timeseries Management</span></a></h4><ul><li>Create one or multiple timeseries:</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="prismjs" data-ext="cpp" data-title="cpp"><pre><code><span class="line"><span class="token keyword">void</span> <span class="token function">createTimeseries</span><span class="token punctuation">(</span><span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>string <span class="token operator">&</span>path<span class="token punctuation">,</span> TSDataType<span class="token double-colon punctuation">::</span>TSDataType dataType<span class="token punctuation">,</span> TSEncoding<span class="token double-colon punctuation">::</span>TSEncoding encoding<span class="token punctuation">,</span></span> |
| <span class="line"> CompressionType<span class="token double-colon punctuation">::</span>CompressionType compressor<span class="token punctuation">)</span><span class="token punctuation">;</span></span> |
| <span class="line"> </span> |
| <span class="line"><span class="token keyword">void</span> <span class="token function">createMultiTimeseries</span><span class="token punctuation">(</span><span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>string<span class="token operator">></span> <span class="token operator">&</span>paths<span class="token punctuation">,</span></span> |
| <span class="line"> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>TSDataType<span class="token double-colon punctuation">::</span>TSDataType<span class="token operator">></span> <span class="token operator">&</span>dataTypes<span class="token punctuation">,</span></span> |
| <span class="line"> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>TSEncoding<span class="token double-colon punctuation">::</span>TSEncoding<span class="token operator">></span> <span class="token operator">&</span>encodings<span class="token punctuation">,</span></span> |
| <span class="line"> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>CompressionType<span class="token double-colon punctuation">::</span>CompressionType<span class="token operator">></span> <span class="token operator">&</span>compressors<span class="token punctuation">,</span></span> |
| <span class="line"> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>map<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>string<span class="token punctuation">,</span> std<span class="token double-colon punctuation">::</span>string<span class="token operator">>></span> <span class="token operator">*</span>propsList<span class="token punctuation">,</span></span> |
| <span class="line"> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>map<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>string<span class="token punctuation">,</span> std<span class="token double-colon punctuation">::</span>string<span class="token operator">>></span> <span class="token operator">*</span>tagsList<span class="token punctuation">,</span></span> |
| <span class="line"> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>map<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>string<span class="token punctuation">,</span> std<span class="token double-colon punctuation">::</span>string<span class="token operator">>></span> <span class="token operator">*</span>attributesList<span class="token punctuation">,</span></span> |
| <span class="line"> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>string<span class="token operator">></span> <span class="token operator">*</span>measurementAliasList<span class="token punctuation">)</span><span class="token punctuation">;</span></span> |
| <span class="line"></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>Create aligned timeseries:</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="prismjs" data-ext="cpp" data-title="cpp"><pre><code><span class="line"><span class="token keyword">void</span> <span class="token function">createAlignedTimeseries</span><span class="token punctuation">(</span><span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>string <span class="token operator">&</span>deviceId<span class="token punctuation">,</span></span> |
| <span class="line"> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>string<span class="token operator">></span> <span class="token operator">&</span>measurements<span class="token punctuation">,</span></span> |
| <span class="line"> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>TSDataType<span class="token double-colon punctuation">::</span>TSDataType<span class="token operator">></span> <span class="token operator">&</span>dataTypes<span class="token punctuation">,</span></span> |
| <span class="line"> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>TSEncoding<span class="token double-colon punctuation">::</span>TSEncoding<span class="token operator">></span> <span class="token operator">&</span>encodings<span class="token punctuation">,</span></span> |
| <span class="line"> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>CompressionType<span class="token double-colon punctuation">::</span>CompressionType<span class="token operator">></span> <span class="token operator">&</span>compressors<span class="token punctuation">)</span><span class="token punctuation">;</span></span> |
| <span class="line"></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>Delete one or several timeseries:</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="prismjs" data-ext="cpp" data-title="cpp"><pre><code><span class="line"><span class="token keyword">void</span> <span class="token function">deleteTimeseries</span><span class="token punctuation">(</span><span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>string <span class="token operator">&</span>path<span class="token punctuation">)</span><span class="token punctuation">;</span></span> |
| <span class="line"><span class="token keyword">void</span> <span class="token function">deleteTimeseries</span><span class="token punctuation">(</span><span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>string<span class="token operator">></span> <span class="token operator">&</span>paths<span class="token punctuation">)</span><span class="token punctuation">;</span></span> |
| <span class="line"></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>Check whether a specific timeseries exists:</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="prismjs" data-ext="cpp" data-title="cpp"><pre><code><span class="line"><span class="token keyword">bool</span> <span class="token function">checkTimeseriesExists</span><span class="token punctuation">(</span><span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>string <span class="token operator">&</span>path<span class="token punctuation">)</span><span class="token punctuation">;</span></span> |
| <span class="line"></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="schema-template" tabindex="-1"><a class="header-anchor" href="#schema-template"><span>Schema Template</span></a></h4><ul><li>Create a schema template:</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="prismjs" data-ext="cpp" data-title="cpp"><pre><code><span class="line"><span class="token keyword">void</span> <span class="token function">createSchemaTemplate</span><span class="token punctuation">(</span><span class="token keyword">const</span> Template <span class="token operator">&</span>templ<span class="token punctuation">)</span><span class="token punctuation">;</span></span> |
| <span class="line"></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>Set the schema template named <code>templateName</code> at path <code>prefixPath</code>:</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="prismjs" data-ext="cpp" data-title="cpp"><pre><code><span class="line"><span class="token keyword">void</span> <span class="token function">setSchemaTemplate</span><span class="token punctuation">(</span><span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>string <span class="token operator">&</span>template_name<span class="token punctuation">,</span> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>string <span class="token operator">&</span>prefix_path<span class="token punctuation">)</span><span class="token punctuation">;</span></span> |
| <span class="line"></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>Unset the schema template:</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="prismjs" data-ext="cpp" data-title="cpp"><pre><code><span class="line"><span class="token keyword">void</span> <span class="token function">unsetSchemaTemplate</span><span class="token punctuation">(</span><span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>string <span class="token operator">&</span>prefix_path<span class="token punctuation">,</span> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>string <span class="token operator">&</span>template_name<span class="token punctuation">)</span><span class="token punctuation">;</span></span> |
| <span class="line"></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>After a schema template was created, you can edit the template with following functions:</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="prismjs" data-ext="cpp" data-title="cpp"><pre><code><span class="line"><span class="token comment">// Add aligned measurements to a template</span></span> |
| <span class="line"><span class="token keyword">void</span> <span class="token function">addAlignedMeasurementsInTemplate</span><span class="token punctuation">(</span><span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>string <span class="token operator">&</span>template_name<span class="token punctuation">,</span></span> |
| <span class="line"> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>string<span class="token operator">></span> <span class="token operator">&</span>measurements<span class="token punctuation">,</span></span> |
| <span class="line"> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>TSDataType<span class="token double-colon punctuation">::</span>TSDataType<span class="token operator">></span> <span class="token operator">&</span>dataTypes<span class="token punctuation">,</span></span> |
| <span class="line"> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>TSEncoding<span class="token double-colon punctuation">::</span>TSEncoding<span class="token operator">></span> <span class="token operator">&</span>encodings<span class="token punctuation">,</span></span> |
| <span class="line"> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>CompressionType<span class="token double-colon punctuation">::</span>CompressionType<span class="token operator">></span> <span class="token operator">&</span>compressors<span class="token punctuation">)</span><span class="token punctuation">;</span></span> |
| <span class="line"></span> |
| <span class="line"><span class="token comment">// Add one aligned measurement to a template</span></span> |
| <span class="line"><span class="token keyword">void</span> <span class="token function">addAlignedMeasurementsInTemplate</span><span class="token punctuation">(</span><span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>string <span class="token operator">&</span>template_name<span class="token punctuation">,</span></span> |
| <span class="line"> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>string <span class="token operator">&</span>measurement<span class="token punctuation">,</span></span> |
| <span class="line"> TSDataType<span class="token double-colon punctuation">::</span>TSDataType dataType<span class="token punctuation">,</span></span> |
| <span class="line"> TSEncoding<span class="token double-colon punctuation">::</span>TSEncoding encoding<span class="token punctuation">,</span></span> |
| <span class="line"> CompressionType<span class="token double-colon punctuation">::</span>CompressionType compressor<span class="token punctuation">)</span><span class="token punctuation">;</span></span> |
| <span class="line"></span> |
| <span class="line"><span class="token comment">// Add unaligned measurements to a template</span></span> |
| <span class="line"><span class="token keyword">void</span> <span class="token function">addUnalignedMeasurementsInTemplate</span><span class="token punctuation">(</span><span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>string <span class="token operator">&</span>template_name<span class="token punctuation">,</span></span> |
| <span class="line"> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>string<span class="token operator">></span> <span class="token operator">&</span>measurements<span class="token punctuation">,</span></span> |
| <span class="line"> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>TSDataType<span class="token double-colon punctuation">::</span>TSDataType<span class="token operator">></span> <span class="token operator">&</span>dataTypes<span class="token punctuation">,</span></span> |
| <span class="line"> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>TSEncoding<span class="token double-colon punctuation">::</span>TSEncoding<span class="token operator">></span> <span class="token operator">&</span>encodings<span class="token punctuation">,</span></span> |
| <span class="line"> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>CompressionType<span class="token double-colon punctuation">::</span>CompressionType<span class="token operator">></span> <span class="token operator">&</span>compressors<span class="token punctuation">)</span><span class="token punctuation">;</span></span> |
| <span class="line"></span> |
| <span class="line"><span class="token comment">// Add one unaligned measurement to a template</span></span> |
| <span class="line"><span class="token keyword">void</span> <span class="token function">addUnalignedMeasurementsInTemplate</span><span class="token punctuation">(</span><span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>string <span class="token operator">&</span>template_name<span class="token punctuation">,</span></span> |
| <span class="line"> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>string <span class="token operator">&</span>measurement<span class="token punctuation">,</span></span> |
| <span class="line"> TSDataType<span class="token double-colon punctuation">::</span>TSDataType dataType<span class="token punctuation">,</span></span> |
| <span class="line"> TSEncoding<span class="token double-colon punctuation">::</span>TSEncoding encoding<span class="token punctuation">,</span></span> |
| <span class="line"> CompressionType<span class="token double-colon punctuation">::</span>CompressionType compressor<span class="token punctuation">)</span><span class="token punctuation">;</span></span> |
| <span class="line"></span> |
| <span class="line"><span class="token comment">// Delete a node in template and its children</span></span> |
| <span class="line"><span class="token keyword">void</span> <span class="token function">deleteNodeInTemplate</span><span class="token punctuation">(</span><span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>string <span class="token operator">&</span>template_name<span class="token punctuation">,</span> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>string <span class="token operator">&</span>path<span class="token punctuation">)</span><span class="token punctuation">;</span></span> |
| <span class="line"></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>You can query schema templates with these APIs:</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="prismjs" data-ext="cpp" data-title="cpp"><pre><code><span class="line"><span class="token comment">// Return the amount of measurements inside a template</span></span> |
| <span class="line"><span class="token keyword">int</span> <span class="token function">countMeasurementsInTemplate</span><span class="token punctuation">(</span><span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>string <span class="token operator">&</span>template_name<span class="token punctuation">)</span><span class="token punctuation">;</span></span> |
| <span class="line"></span> |
| <span class="line"><span class="token comment">// Return true if path points to a measurement, otherwise returne false</span></span> |
| <span class="line"><span class="token keyword">bool</span> <span class="token function">isMeasurementInTemplate</span><span class="token punctuation">(</span><span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>string <span class="token operator">&</span>template_name<span class="token punctuation">,</span> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>string <span class="token operator">&</span>path<span class="token punctuation">)</span><span class="token punctuation">;</span></span> |
| <span class="line"></span> |
| <span class="line"><span class="token comment">// Return true if path exists in template, otherwise return false</span></span> |
| <span class="line"><span class="token keyword">bool</span> <span class="token function">isPathExistInTemplate</span><span class="token punctuation">(</span><span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>string <span class="token operator">&</span>template_name<span class="token punctuation">,</span> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>string <span class="token operator">&</span>path<span class="token punctuation">)</span><span class="token punctuation">;</span></span> |
| <span class="line"></span> |
| <span class="line"><span class="token comment">// Return all measurements paths inside template</span></span> |
| <span class="line">std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>string<span class="token operator">></span> <span class="token function">showMeasurementsInTemplate</span><span class="token punctuation">(</span><span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>string <span class="token operator">&</span>template_name<span class="token punctuation">)</span><span class="token punctuation">;</span></span> |
| <span class="line"></span> |
| <span class="line"><span class="token comment">// Return all measurements paths under the designated patter inside template</span></span> |
| <span class="line">std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>string<span class="token operator">></span> <span class="token function">showMeasurementsInTemplate</span><span class="token punctuation">(</span><span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>string <span class="token operator">&</span>template_name<span class="token punctuation">,</span> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>string <span class="token operator">&</span>pattern<span class="token punctuation">)</span><span class="token punctuation">;</span></span> |
| <span class="line"></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="data-manipulation-interface-dmi" tabindex="-1"><a class="header-anchor" href="#data-manipulation-interface-dmi"><span>Data Manipulation Interface (DMI)</span></a></h3><h4 id="insert" tabindex="-1"><a class="header-anchor" href="#insert"><span>Insert</span></a></h4><ul><li>Insert one record, which contains multiple measurement value of a given device and timestamp:</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="prismjs" data-ext="cpp" data-title="cpp"><pre><code><span class="line"><span class="token keyword">void</span> <span class="token function">insertRecord</span><span class="token punctuation">(</span><span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>string <span class="token operator">&</span>deviceId<span class="token punctuation">,</span> </span> |
| <span class="line"> <span class="token keyword">int64_t</span> time<span class="token punctuation">,</span> </span> |
| <span class="line"> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>string<span class="token operator">></span> <span class="token operator">&</span>measurements<span class="token punctuation">,</span></span> |
| <span class="line"> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span><span class="token keyword">char</span> <span class="token operator">*</span><span class="token operator">></span> <span class="token operator">&</span>values<span class="token punctuation">)</span><span class="token punctuation">;</span></span> |
| <span class="line"></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></div><ul><li>Insert multiple Records for multiple devices (With type info in the <code>typesList</code> parameter the server doesn't need to do type inference, which results in better performance):</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="prismjs" data-ext="cpp" data-title="cpp"><pre><code><span class="line"><span class="token keyword">void</span> <span class="token function">insertRecords</span><span class="token punctuation">(</span><span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>string<span class="token operator">></span> <span class="token operator">&</span>deviceIds<span class="token punctuation">,</span></span> |
| <span class="line"> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span><span class="token keyword">int64_t</span><span class="token operator">></span> <span class="token operator">&</span>times<span class="token punctuation">,</span></span> |
| <span class="line"> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>string<span class="token operator">>></span> <span class="token operator">&</span>measurementsList<span class="token punctuation">,</span></span> |
| <span class="line"> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span><span class="token keyword">char</span> <span class="token operator">*</span><span class="token operator">>></span> <span class="token operator">&</span>valuesList<span class="token punctuation">)</span><span class="token punctuation">;</span></span> |
| <span class="line"></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></div><ul><li>Insert multiple Records for the same device:</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="prismjs" data-ext="cpp" data-title="cpp"><pre><code><span class="line"><span class="token keyword">void</span> <span class="token function">insertRecordsOfOneDevice</span><span class="token punctuation">(</span><span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>string <span class="token operator">&</span>deviceId<span class="token punctuation">,</span></span> |
| <span class="line"> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span><span class="token keyword">int64_t</span><span class="token operator">></span> <span class="token operator">&</span>times<span class="token punctuation">,</span></span> |
| <span class="line"> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>string<span class="token operator">>></span> <span class="token operator">&</span>measurementsList<span class="token punctuation">,</span></span> |
| <span class="line"> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span><span class="token keyword">char</span> <span class="token operator">*</span><span class="token operator">>></span> <span class="token operator">&</span>valuesList<span class="token punctuation">)</span><span class="token punctuation">;</span></span> |
| <span class="line"></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></div><p>All of the above versions require the server to figure out the data-types of each value, which comes with quite a performance-cost, therefore all of the above are also available in a version without type-inference:</p><div class="language-cpp line-numbers-mode" data-highlighter="prismjs" data-ext="cpp" data-title="cpp"><pre><code><span class="line"><span class="token keyword">void</span> <span class="token function">insertRecord</span><span class="token punctuation">(</span><span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>string <span class="token operator">&</span>deviceId<span class="token punctuation">,</span> </span> |
| <span class="line"> <span class="token keyword">int64_t</span> time<span class="token punctuation">,</span> </span> |
| <span class="line"> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>string<span class="token operator">></span> <span class="token operator">&</span>measurements<span class="token punctuation">,</span></span> |
| <span class="line"> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>TSDataType<span class="token double-colon punctuation">::</span>TSDataType<span class="token operator">></span> <span class="token operator">&</span>types<span class="token punctuation">,</span></span> |
| <span class="line"> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>string<span class="token operator">></span> <span class="token operator">&</span>values<span class="token punctuation">)</span><span class="token punctuation">;</span></span> |
| <span class="line"></span> |
| <span class="line"></span> |
| <span class="line"><span class="token keyword">void</span> <span class="token function">insertRecords</span><span class="token punctuation">(</span><span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>string<span class="token operator">></span> <span class="token operator">&</span>deviceIds<span class="token punctuation">,</span></span> |
| <span class="line"> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span><span class="token keyword">int64_t</span><span class="token operator">></span> <span class="token operator">&</span>times<span class="token punctuation">,</span></span> |
| <span class="line"> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>string<span class="token operator">>></span> <span class="token operator">&</span>measurementsList<span class="token punctuation">,</span></span> |
| <span class="line"> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>TSDataType<span class="token double-colon punctuation">::</span>TSDataType<span class="token operator">>></span> <span class="token operator">&</span>typesList<span class="token punctuation">,</span></span> |
| <span class="line"> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>string<span class="token operator">>></span> <span class="token operator">&</span>valuesList<span class="token punctuation">)</span><span class="token punctuation">;</span></span> |
| <span class="line"></span> |
| <span class="line"></span> |
| <span class="line"><span class="token keyword">void</span> <span class="token function">insertRecordsOfOneDevice</span><span class="token punctuation">(</span><span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>string <span class="token operator">&</span>deviceId<span class="token punctuation">,</span></span> |
| <span class="line"> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span><span class="token keyword">int64_t</span><span class="token operator">></span> <span class="token operator">&</span>times<span class="token punctuation">,</span></span> |
| <span class="line"> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>string<span class="token operator">>></span> <span class="token operator">&</span>measurementsList<span class="token punctuation">,</span></span> |
| <span class="line"> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>TSDataType<span class="token double-colon punctuation">::</span>TSDataType<span class="token operator">>></span> <span class="token operator">&</span>typesList<span class="token punctuation">,</span></span> |
| <span class="line"> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>string<span class="token operator">>></span> <span class="token operator">&</span>valuesList<span class="token punctuation">)</span><span class="token punctuation">;</span></span> |
| <span class="line"></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></div><p>For even better performance, it is recommended to use Tablets to help improve write efficiency.</p><ul><li>Insert a Tablet，which inserts multiple rows of data for a given device. Each row has the same structure: <ul><li>Better write performance</li><li>Support null values: Fill the null value with any value, and then mark the null value via BitMap</li></ul></li></ul><div class="language-cpp line-numbers-mode" data-highlighter="prismjs" data-ext="cpp" data-title="cpp"><pre><code><span class="line"><span class="token keyword">void</span> <span class="token function">insertTablet</span><span class="token punctuation">(</span>Tablet <span class="token operator">&</span>tablet<span class="token punctuation">)</span><span class="token punctuation">;</span></span> |
| <span class="line"></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>Insert multiple Tablets</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="prismjs" data-ext="cpp" data-title="cpp"><pre><code><span class="line"><span class="token keyword">void</span> <span class="token function">insertTablets</span><span class="token punctuation">(</span>std<span class="token double-colon punctuation">::</span>unordered_map<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>string<span class="token punctuation">,</span> Tablet <span class="token operator">*</span><span class="token operator">></span> <span class="token operator">&</span>tablets<span class="token punctuation">)</span><span class="token punctuation">;</span></span> |
| <span class="line"></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="insert-data-into-aligned-timeseries" tabindex="-1"><a class="header-anchor" href="#insert-data-into-aligned-timeseries"><span>Insert data into Aligned Timeseries</span></a></h4><p>The insertion of aligned timeseries is performed by functions such as <code>insertAlignedXXX</code> however semantically they align to the non-aligned versions of the previous chapter:</p><div class="language-cpp line-numbers-mode" data-highlighter="prismjs" data-ext="cpp" data-title="cpp"><pre><code><span class="line"> <span class="token keyword">void</span> <span class="token function">insertAlignedRecord</span><span class="token punctuation">(</span><span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>string <span class="token operator">&</span>deviceId<span class="token punctuation">,</span></span> |
| <span class="line"> <span class="token keyword">int64_t</span> time<span class="token punctuation">,</span> </span> |
| <span class="line"> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>string<span class="token operator">></span> <span class="token operator">&</span>measurements<span class="token punctuation">,</span></span> |
| <span class="line"> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>string<span class="token operator">></span> <span class="token operator">&</span>values<span class="token punctuation">)</span><span class="token punctuation">;</span></span> |
| <span class="line"></span> |
| <span class="line"> <span class="token keyword">void</span> <span class="token function">insertAlignedRecord</span><span class="token punctuation">(</span><span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>string <span class="token operator">&</span>deviceId<span class="token punctuation">,</span> </span> |
| <span class="line"> <span class="token keyword">int64_t</span> time<span class="token punctuation">,</span> </span> |
| <span class="line"> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>string<span class="token operator">></span> <span class="token operator">&</span>measurements<span class="token punctuation">,</span></span> |
| <span class="line"> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>TSDataType<span class="token double-colon punctuation">::</span>TSDataType<span class="token operator">></span> <span class="token operator">&</span>types<span class="token punctuation">,</span></span> |
| <span class="line"> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span><span class="token keyword">char</span> <span class="token operator">*</span><span class="token operator">></span> <span class="token operator">&</span>values<span class="token punctuation">)</span><span class="token punctuation">;</span></span> |
| <span class="line"></span> |
| <span class="line"> <span class="token keyword">void</span> <span class="token function">insertAlignedRecords</span><span class="token punctuation">(</span><span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>string<span class="token operator">></span> <span class="token operator">&</span>deviceIds<span class="token punctuation">,</span></span> |
| <span class="line"> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span><span class="token keyword">int64_t</span><span class="token operator">></span> <span class="token operator">&</span>times<span class="token punctuation">,</span></span> |
| <span class="line"> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>string<span class="token operator">>></span> <span class="token operator">&</span>measurementsList<span class="token punctuation">,</span></span> |
| <span class="line"> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>string<span class="token operator">>></span> <span class="token operator">&</span>valuesList<span class="token punctuation">)</span><span class="token punctuation">;</span></span> |
| <span class="line"></span> |
| <span class="line"> <span class="token keyword">void</span> <span class="token function">insertAlignedRecords</span><span class="token punctuation">(</span><span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>string<span class="token operator">></span> <span class="token operator">&</span>deviceIds<span class="token punctuation">,</span></span> |
| <span class="line"> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span><span class="token keyword">int64_t</span><span class="token operator">></span> <span class="token operator">&</span>times<span class="token punctuation">,</span></span> |
| <span class="line"> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>string<span class="token operator">>></span> <span class="token operator">&</span>measurementsList<span class="token punctuation">,</span></span> |
| <span class="line"> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>TSDataType<span class="token double-colon punctuation">::</span>TSDataType<span class="token operator">>></span> <span class="token operator">&</span>typesList<span class="token punctuation">,</span></span> |
| <span class="line"> <span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span><span class="token keyword">char</span> <span class="token operator">*</span><span class="token operator">>></span> <span class="token operator">&</span>valuesList<span class="token punctuation">)</span><span class="token punctuation">;</span></span> |
| <span class="line"></span> |
| <span class="line"> <span class="token keyword">void</span> <span class="token function">insertAlignedRecordsOfOneDevice</span><span class="token punctuation">(</span><span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>string <span class="token operator">&</span>deviceId<span class="token punctuation">,</span></span> |
| <span class="line"> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span><span class="token keyword">int64_t</span><span class="token operator">></span> <span class="token operator">&</span>times<span class="token punctuation">,</span></span> |
| <span class="line"> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>string<span class="token operator">>></span> <span class="token operator">&</span>measurementsList<span class="token punctuation">,</span></span> |
| <span class="line"> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>TSDataType<span class="token double-colon punctuation">::</span>TSDataType<span class="token operator">>></span> <span class="token operator">&</span>typesList<span class="token punctuation">,</span></span> |
| <span class="line"> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span><span class="token keyword">char</span> <span class="token operator">*</span><span class="token operator">>></span> <span class="token operator">&</span>valuesList<span class="token punctuation">)</span><span class="token punctuation">;</span></span> |
| <span class="line"></span> |
| <span class="line"> <span class="token keyword">void</span> <span class="token function">insertAlignedRecordsOfOneDevice</span><span class="token punctuation">(</span><span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>string <span class="token operator">&</span>deviceId<span class="token punctuation">,</span></span> |
| <span class="line"> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span><span class="token keyword">int64_t</span><span class="token operator">></span> <span class="token operator">&</span>times<span class="token punctuation">,</span></span> |
| <span class="line"> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>string<span class="token operator">>></span> <span class="token operator">&</span>measurementsList<span class="token punctuation">,</span></span> |
| <span class="line"> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>TSDataType<span class="token double-colon punctuation">::</span>TSDataType<span class="token operator">>></span> <span class="token operator">&</span>typesList<span class="token punctuation">,</span></span> |
| <span class="line"> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span><span class="token keyword">char</span> <span class="token operator">*</span><span class="token operator">>></span> <span class="token operator">&</span>valuesList<span class="token punctuation">,</span></span> |
| <span class="line"> <span class="token keyword">bool</span> sorted<span class="token punctuation">)</span><span class="token punctuation">;</span></span> |
| <span class="line"></span> |
| <span class="line"> <span class="token keyword">void</span> <span class="token function">insertAlignedTablet</span><span class="token punctuation">(</span>Tablet <span class="token operator">&</span>tablet<span class="token punctuation">)</span><span class="token punctuation">;</span></span> |
| <span class="line"></span> |
| <span class="line"> <span class="token keyword">void</span> <span class="token function">insertAlignedTablet</span><span class="token punctuation">(</span>Tablet <span class="token operator">&</span>tablet<span class="token punctuation">,</span> </span> |
| <span class="line"> <span class="token keyword">bool</span> sorted<span class="token punctuation">)</span><span class="token punctuation">;</span></span> |
| <span class="line"></span> |
| <span class="line"> <span class="token keyword">void</span> <span class="token function">insertAlignedTablets</span><span class="token punctuation">(</span>std<span class="token double-colon punctuation">::</span>unordered_map<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>string<span class="token punctuation">,</span> Tablet <span class="token operator">*</span><span class="token operator">></span> <span class="token operator">&</span>tablets<span class="token punctuation">,</span> </span> |
| <span class="line"> <span class="token keyword">bool</span> sorted <span class="token operator">=</span> <span class="token boolean">false</span><span class="token punctuation">)</span><span class="token punctuation">;</span></span> |
| <span class="line"></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 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="delete" tabindex="-1"><a class="header-anchor" href="#delete"><span>Delete</span></a></h4><ul><li>Delete data with timestamps before or equal to a given timestamp of one or several timeseries:</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="prismjs" data-ext="cpp" data-title="cpp"><pre><code><span class="line"><span class="token keyword">void</span> <span class="token function">deleteData</span><span class="token punctuation">(</span><span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>string <span class="token operator">&</span>path<span class="token punctuation">,</span> <span class="token keyword">int64_t</span> time<span class="token punctuation">)</span><span class="token punctuation">;</span></span> |
| <span class="line"><span class="token keyword">void</span> <span class="token function">deleteData</span><span class="token punctuation">(</span><span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>vector<span class="token operator"><</span>std<span class="token double-colon punctuation">::</span>string<span class="token operator">></span> <span class="token operator">&</span>deviceId<span class="token punctuation">,</span> <span class="token keyword">int64_t</span> time<span class="token punctuation">)</span><span class="token punctuation">;</span></span> |
| <span class="line"></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><h3 id="iotdb-sql-interface" tabindex="-1"><a class="header-anchor" href="#iotdb-sql-interface"><span>IoTDB-SQL Interface</span></a></h3><ul><li>Execute query statement</li></ul><p>Query statements return data.</p><div class="language-cpp line-numbers-mode" data-highlighter="prismjs" data-ext="cpp" data-title="cpp"><pre><code><span class="line">unique_ptr<span class="token operator"><</span>SessionDataSet<span class="token operator">></span> <span class="token function">executeQueryStatement</span><span class="token punctuation">(</span><span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>string <span class="token operator">&</span>sql<span class="token punctuation">)</span><span class="token punctuation">;</span></span> |
| <span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>Non-Query statements don't return data (Delete, Create, ... statements)</p><ul><li>Execute non query statement</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="prismjs" data-ext="cpp" data-title="cpp"><pre><code><span class="line"><span class="token keyword">void</span> <span class="token function">executeNonQueryStatement</span><span class="token punctuation">(</span><span class="token keyword">const</span> std<span class="token double-colon punctuation">::</span>string <span class="token operator">&</span>sql<span class="token punctuation">)</span><span class="token punctuation">;</span></span> |
| <span class="line"></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="examples" tabindex="-1"><a class="header-anchor" href="#examples"><span>Examples</span></a></h2><p>The sample code for using these interfaces is located in:</p><ul><li><code>example/client-cpp-example/src/SessionExample.cpp</code></li><li><code>example/client-cpp-example/src/AlignedTimeseriesSessionExample.cpp</code></li></ul><p>As soon as the compilation finishes, the example project will be located at <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="on-mac" tabindex="-1"><a class="header-anchor" href="#on-mac"><span>on Mac</span></a></h3><p>If errors occur when compiling thrift source code, try to downgrade your xcode-commandline from 12 to 11.5</p><p>see <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><h3 id="on-windows" tabindex="-1"><a class="header-anchor" href="#on-windows"><span>on Windows</span></a></h3><p>When Building Thrift and downloading packages via "wget", a possible annoying issue may occur with<br> error message looks like:</p><div class="language-bash line-numbers-mode" data-highlighter="prismjs" data-ext="sh" data-title="sh"><pre><code><span class="line">Failed to delete cached <span class="token function">file</span> C:<span class="token punctuation">\\</span>Users<span class="token punctuation">\\</span>Administrator<span class="token punctuation">\\</span>.m2<span class="token punctuation">\\</span>repository<span class="token punctuation">\\</span>.cache<span class="token punctuation">\\</span>download-maven-plugin<span class="token punctuation">\\</span>index.ser</span> |
| <span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>Possible fixes:</p><ul><li>Try to delete the ".m2\\repository.cache" directory and try again.</li><li>Add "<skipCache>true</skipCache>" configuration to the download-maven-plugin maven phase that complains this error.</li></ul>`,86)]))}const i=s(p,[["render",o],["__file","Programming-Cpp-Native-API.html.vue"]]),r=JSON.parse('{"path":"/UserGuide/V1.2.x/API/Programming-Cpp-Native-API.html","title":"C++ Native API","lang":"en-US","frontmatter":{"description":"C++ Native API Dependencies Java 8+ Maven 3.5+ Flex Bison 2.7+ Boost 1.56+ OpenSSL 1.0+ GCC 5.5.0+ Installation From Source Code Install CPP Dependencies MAC Install Bison ：Biso...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://iotdb.apache.org/zh/UserGuide/V1.2.x/API/Programming-Cpp-Native-API.html"}],["meta",{"property":"og:url","content":"https://iotdb.apache.org/UserGuide/V1.2.x/API/Programming-Cpp-Native-API.html"}],["meta",{"property":"og:site_name","content":"IoTDB Website"}],["meta",{"property":"og:title","content":"C++ Native API"}],["meta",{"property":"og:description","content":"C++ Native API Dependencies Java 8+ Maven 3.5+ Flex Bison 2.7+ Boost 1.56+ OpenSSL 1.0+ GCC 5.5.0+ Installation From Source Code Install CPP Dependencies MAC Install Bison ：Biso..."}],["meta",{"property":"og:type","content":"article"}],["meta",{"property":"og:locale","content":"en-US"}],["meta",{"property":"og:locale:alternate","content":"zh-CN"}],["meta",{"property":"og:updated_time","content":"2023-12-15T13:16:16.000Z"}],["meta",{"property":"article:modified_time","content":"2023-12-15T13:16:16.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"C++ Native API\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-12-15T13:16:16.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"Dependencies","slug":"dependencies","link":"#dependencies","children":[]},{"level":2,"title":"Installation From Source Code","slug":"installation-from-source-code","link":"#installation-from-source-code","children":[{"level":3,"title":"Install CPP Dependencies","slug":"install-cpp-dependencies","link":"#install-cpp-dependencies","children":[]},{"level":3,"title":"Compile","slug":"compile","link":"#compile","children":[]}]},{"level":2,"title":"Native APIs","slug":"native-apis","link":"#native-apis","children":[{"level":3,"title":"Initialization","slug":"initialization","link":"#initialization","children":[]},{"level":3,"title":"Data Definition Interface (DDL)","slug":"data-definition-interface-ddl","link":"#data-definition-interface-ddl","children":[]},{"level":3,"title":"Data Manipulation Interface (DMI)","slug":"data-manipulation-interface-dmi","link":"#data-manipulation-interface-dmi","children":[]},{"level":3,"title":"IoTDB-SQL Interface","slug":"iotdb-sql-interface","link":"#iotdb-sql-interface","children":[]}]},{"level":2,"title":"Examples","slug":"examples","link":"#examples","children":[]},{"level":2,"title":"FAQ","slug":"faq","link":"#faq","children":[{"level":3,"title":"on Mac","slug":"on-mac","link":"#on-mac","children":[]},{"level":3,"title":"on Windows","slug":"on-windows","link":"#on-windows","children":[]}]}],"git":{"createdTime":1688958677000,"updatedTime":1702646176000,"contributors":[{"name":"Christofer Dutz","email":"christofer.dutz@c-ware.de","commits":1},{"name":"CritasWang","email":"critas@outlook.com","commits":1},{"name":"Lei","email":"33376433+LeiRui@users.noreply.github.com","commits":1}]},"readingTime":{"minutes":6.67,"words":2002},"filePathRelative":"UserGuide/V1.2.x/API/Programming-Cpp-Native-API.md","localizedDate":"July 10, 2023","autoDesc":true}');export{i as comp,r as data}; |
