| <!doctype html> |
| <html lang="en-US" data-theme="light"> |
| <head> |
| <meta charset="utf-8" /> |
| <meta name="viewport" content="width=device-width,initial-scale=1" /> |
| <meta name="generator" content="VuePress 2.0.0-rc.19" /> |
| <meta name="theme" content="VuePress Theme Hope 2.0.0-rc.71" /> |
| <style> |
| :root { |
| --vp-c-bg: #fff; |
| } |
| |
| [data-theme="dark"] { |
| --vp-c-bg: #1b1b1f; |
| } |
| |
| html, |
| body { |
| background: var(--vp-c-bg); |
| } |
| </style> |
| <script> |
| const userMode = localStorage.getItem("vuepress-theme-hope-scheme"); |
| const systemDarkMode = |
| window.matchMedia && |
| window.matchMedia("(prefers-color-scheme: dark)").matches; |
| |
| if (userMode === "dark" || (userMode !== "light" && systemDarkMode)) { |
| document.documentElement.setAttribute("data-theme", "dark"); |
| } |
| </script> |
| <link rel="alternate" hreflang="zh-cn" href="https://iotdb.apache.org/zh/UserGuide/latest/API/Programming-Cpp-Native-API.html"><meta property="og:url" content="https://iotdb.apache.org/UserGuide/latest/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 1. Dependencies Java 8+ Flex Bison 2.7+ Boost 1.56+ OpenSSL 1.0+ GCC 5.5.0+ 2. Installation 2.1 Install Required Dependencies MAC Install Bison: Use the following..."><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="2025-03-05T10:17:06.000Z"><meta property="article:modified_time" content="2025-03-05T10:17:06.000Z"><script type="application/ld+json">{"@context":"https://schema.org","@type":"Article","headline":"C++ Native API","image":[""],"dateModified":"2025-03-05T10:17:06.000Z","author":[]}</script><link rel="icon" href="/favicon.ico"><meta name="Description" content="Apache IoTDB: Time Series Database for IoT"><meta name="Keywords" content="TSDB, time series, time series database, IoTDB, IoT database, IoT data management, 时序数据库, 时间序列管理, IoTDB, 物联网数据库, 实时数据库, 物联网数据管理, 物联网数据"><meta name="baidu-site-verification" content="wfKETzB3OT"><meta name="google-site-verification" content="mZWAoRY0yj_HAr-s47zHCGHzx5Ju-RVm5wDbPnwQYFo"><script type="text/javascript">var _paq = window._paq = window._paq || []; |
| /* tracker methods like "setCustomDimension" should be called before "trackPageView" */ |
| _paq.push(["setDoNotTrack", true]); |
| _paq.push(["disableCookies"]); |
| _paq.push(['trackPageView']); |
| _paq.push(['enableLinkTracking']); |
| (function() { |
| var u="https://analytics.apache.org/"; |
| _paq.push(['setTrackerUrl', u+'matomo.php']); |
| _paq.push(['setSiteId', '56']); |
| var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; |
| g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s); |
| })(); |
| </script><title>C++ Native API | IoTDB Website</title><meta name="description" content="C++ Native API 1. Dependencies Java 8+ Flex Bison 2.7+ Boost 1.56+ OpenSSL 1.0+ GCC 5.5.0+ 2. Installation 2.1 Install Required Dependencies MAC Install Bison: Use the following..."> |
| <link rel="preload" href="/assets/style-CI4qIzxp.css" as="style"><link rel="stylesheet" href="/assets/style-CI4qIzxp.css"> |
| <link rel="modulepreload" href="/assets/app-C-fAkKj6.js"><link rel="modulepreload" href="/assets/Programming-Cpp-Native-API.html-DVGsl7lz.js"> |
| |
| </head> |
| <body> |
| <div id="app"><!--[--><!--[--><!--[--><span tabindex="-1"></span><a href="#main-content" class="vp-skip-link sr-only">Skip to main content</a><!--]--><!--[--><div class="theme-container external-link-icon has-toc" vp-container><!--[--><header id="navbar" class="vp-navbar" vp-navbar><div class="vp-navbar-start"><button type="button" class="vp-toggle-sidebar-button" title="Toggle Sidebar"><span class="icon"></span></button><!--[--><a class="route-link vp-brand" href="/" aria-label="Take me home"><img class="vp-nav-logo" src="/logo.png" alt><!----><!----></a><!--]--></div><div class="vp-navbar-center"><!--[--><!--]--></div><div class="vp-navbar-end"><!--[--><!--[--><div id="docsearch-container" style="display:none;"></div><div><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"><kbd class="DocSearch-Button-Key"><svg width="15" height="15" class="DocSearch-Control-Key-Icon"><path d="M4.505 4.496h2M5.505 5.496v5M8.216 4.496l.055 5.993M10 7.5c.333.333.5.667.5 1v2M12.326 4.5v5.996M8.384 4.496c1.674 0 2.116 0 2.116 1.5s-.442 1.5-2.116 1.5M3.205 9.303c-.09.448-.277 1.21-1.241 1.203C1 10.5.5 9.513.5 8V7c0-1.57.5-2.5 1.464-2.494.964.006 1.134.598 1.24 1.342M12.553 10.5h1.953" stroke-width="1.2" stroke="currentColor" fill="none" stroke-linecap="square"></path></svg></kbd><kbd class="DocSearch-Button-Key">K</kbd></span></button></div><!--]--><nav class="vp-nav-links"><div class="vp-nav-item hide-in-mobile"><div class="vp-dropdown-wrapper"><button type="button" class="vp-dropdown-title" aria-label="Documentation"><!--[--><!---->Documentation<!--]--><span class="arrow"></span><ul class="vp-dropdown"><li class="vp-dropdown-item"><a class="route-link auto-link" href="/UserGuide/latest/QuickStart/QuickStart_apache.html" aria-label="v2.0.x" iconsizing="both"><!---->v2.0.x<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/UserGuide/V1.3.x/QuickStart/QuickStart_apache.html" aria-label="v1.3.x" iconsizing="both"><!---->v1.3.x<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/UserGuide/V1.2.x/QuickStart/QuickStart.html" aria-label="v1.2.x" iconsizing="both"><!---->v1.2.x<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/UserGuide/V0.13.x/QuickStart/QuickStart.html" aria-label="v0.13.x" iconsizing="both"><!---->v0.13.x<!----></a></li></ul></button></div></div><div class="vp-nav-item hide-in-mobile"><a class="auto-link external-link" href="https://cwiki.apache.org/confluence/display/IOTDB/System+Design" aria-label="Design" rel="noopener noreferrer" target="_blank" iconsizing="height"><!---->Design<!----></a></div><div class="vp-nav-item hide-in-mobile"><a class="route-link auto-link" href="/Download/" aria-label="Download" iconsizing="height"><!---->Download<!----></a></div><div class="vp-nav-item hide-in-mobile"><div class="vp-dropdown-wrapper"><button type="button" class="vp-dropdown-title" aria-label="Community"><!--[--><!---->Community<!--]--><span class="arrow"></span><ul class="vp-dropdown"><li class="vp-dropdown-item"><a class="route-link auto-link" href="/Community/About-the-Community.html" aria-label="About the Community" iconsizing="both"><!---->About the Community<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/Community/Development-Guide.html" aria-label="Development Guide" iconsizing="both"><!---->Development Guide<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/Community/Community-Partners.html" aria-label="Community Partners" iconsizing="both"><!---->Community Partners<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/Community/Communication-Channels.html" aria-label="Communication Channels" iconsizing="both"><!---->Communication Channels<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/Community/Events-and-Reports.html" aria-label="Events and Reports" iconsizing="both"><!---->Events and Reports<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/Community/Committers.html" aria-label="Committers" iconsizing="both"><!---->Committers<!----></a></li></ul></button></div></div><div class="vp-nav-item hide-in-mobile"><div class="vp-dropdown-wrapper"><button type="button" class="vp-dropdown-title" aria-label="ASF"><!--[--><!---->ASF<!--]--><span class="arrow"></span><ul class="vp-dropdown"><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/" aria-label="Foundation" rel="noopener noreferrer" target="_blank" iconsizing="both"><!---->Foundation<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/licenses/" aria-label="License" rel="noopener noreferrer" target="_blank" iconsizing="both"><!---->License<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/security/" aria-label="Security" rel="noopener noreferrer" target="_blank" iconsizing="both"><!---->Security<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/foundation/sponsorship.html" aria-label="Sponsorship" rel="noopener noreferrer" target="_blank" iconsizing="both"><!---->Sponsorship<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/foundation/thanks.html" aria-label="Thanks" rel="noopener noreferrer" target="_blank" iconsizing="both"><!---->Thanks<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/events/current-event" aria-label="Current Events" rel="noopener noreferrer" target="_blank" iconsizing="both"><!---->Current Events<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://privacy.apache.org/policies/privacy-policy-public.html" aria-label="Privacy" rel="noopener noreferrer" target="_blank" iconsizing="both"><!---->Privacy<!----></a></li></ul></button></div></div></nav><div class="vp-nav-item"><div class="vp-dropdown-wrapper"><button type="button" class="vp-dropdown-title" aria-label="Select language"><!--[--><svg xmlns="http://www.w3.org/2000/svg" class="icon i18n-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="i18n icon" name="i18n" style="width:1rem;height:1rem;vertical-align:middle;"><path d="M379.392 460.8 494.08 575.488l-42.496 102.4L307.2 532.48 138.24 701.44l-71.68-72.704L234.496 460.8l-45.056-45.056c-27.136-27.136-51.2-66.56-66.56-108.544h112.64c7.68 14.336 16.896 27.136 26.112 35.84l45.568 46.08 45.056-45.056C382.976 312.32 409.6 247.808 409.6 204.8H0V102.4h256V0h102.4v102.4h256v102.4H512c0 70.144-37.888 161.28-87.04 210.944L378.88 460.8zM576 870.4 512 1024H409.6l256-614.4H768l256 614.4H921.6l-64-153.6H576zM618.496 768h196.608L716.8 532.48 618.496 768z"></path></svg><!--]--><span class="arrow"></span><ul class="vp-dropdown"><li class="vp-dropdown-item"><a class="route-link route-link-active auto-link" href="/UserGuide/latest/API/Programming-Cpp-Native-API.html" aria-label="English" iconsizing="both"><!---->English<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/zh/UserGuide/latest/API/Programming-Cpp-Native-API.html" aria-label="简体中文" iconsizing="both"><!---->简体中文<!----></a></li></ul></button></div></div><div class="vp-nav-item hide-in-mobile"><button type="button" class="vp-color-mode-switch" id="color-mode-switch"><svg xmlns="http://www.w3.org/2000/svg" class="icon auto-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="auto icon" name="auto" style="display:none;"><path d="M512 992C246.92 992 32 777.08 32 512S246.92 32 512 32s480 214.92 480 480-214.92 480-480 480zm0-840c-198.78 0-360 161.22-360 360 0 198.84 161.22 360 360 360s360-161.16 360-360c0-198.78-161.22-360-360-360zm0 660V212c165.72 0 300 134.34 300 300 0 165.72-134.28 300-300 300z"></path></svg><svg xmlns="http://www.w3.org/2000/svg" class="icon dark-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="dark icon" name="dark" style="display:none;"><path d="M524.8 938.667h-4.267a439.893 439.893 0 0 1-313.173-134.4 446.293 446.293 0 0 1-11.093-597.334A432.213 432.213 0 0 1 366.933 90.027a42.667 42.667 0 0 1 45.227 9.386 42.667 42.667 0 0 1 10.24 42.667 358.4 358.4 0 0 0 82.773 375.893 361.387 361.387 0 0 0 376.747 82.774 42.667 42.667 0 0 1 54.187 55.04 433.493 433.493 0 0 1-99.84 154.88 438.613 438.613 0 0 1-311.467 128z"></path></svg><svg xmlns="http://www.w3.org/2000/svg" class="icon light-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="light icon" name="light" style="display:block;"><path d="M952 552h-80a40 40 0 0 1 0-80h80a40 40 0 0 1 0 80zM801.88 280.08a41 41 0 0 1-57.96-57.96l57.96-58a41.04 41.04 0 0 1 58 58l-58 57.96zM512 752a240 240 0 1 1 0-480 240 240 0 0 1 0 480zm0-560a40 40 0 0 1-40-40V72a40 40 0 0 1 80 0v80a40 40 0 0 1-40 40zm-289.88 88.08-58-57.96a41.04 41.04 0 0 1 58-58l57.96 58a41 41 0 0 1-57.96 57.96zM192 512a40 40 0 0 1-40 40H72a40 40 0 0 1 0-80h80a40 40 0 0 1 40 40zm30.12 231.92a41 41 0 0 1 57.96 57.96l-57.96 58a41.04 41.04 0 0 1-58-58l58-57.96zM512 832a40 40 0 0 1 40 40v80a40 40 0 0 1-80 0v-80a40 40 0 0 1 40-40zm289.88-88.08 58 57.96a41.04 41.04 0 0 1-58 58l-57.96-58a41 41 0 0 1 57.96-57.96z"></path></svg></button></div><div class="vp-nav-item vp-action"><a class="vp-action-link" href="https://github.com/apache/iotdb" target="_blank" rel="noopener noreferrer" aria-label="GitHub"><svg xmlns="http://www.w3.org/2000/svg" class="icon github-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="github icon" name="github" style="width:1.25rem;height:1.25rem;vertical-align:middle;"><path d="M511.957 21.333C241.024 21.333 21.333 240.981 21.333 512c0 216.832 140.544 400.725 335.574 465.664 24.49 4.395 32.256-10.07 32.256-23.083 0-11.69.256-44.245 0-85.205-136.448 29.61-164.736-64.64-164.736-64.64-22.315-56.704-54.4-71.765-54.4-71.765-44.587-30.464 3.285-29.824 3.285-29.824 49.195 3.413 75.179 50.517 75.179 50.517 43.776 75.008 114.816 53.333 142.762 40.79 4.523-31.66 17.152-53.377 31.19-65.537-108.971-12.458-223.488-54.485-223.488-242.602 0-53.547 19.114-97.323 50.517-131.67-5.035-12.33-21.93-62.293 4.779-129.834 0 0 41.258-13.184 134.912 50.346a469.803 469.803 0 0 1 122.88-16.554c41.642.213 83.626 5.632 122.88 16.554 93.653-63.488 134.784-50.346 134.784-50.346 26.752 67.541 9.898 117.504 4.864 129.834 31.402 34.347 50.474 78.123 50.474 131.67 0 188.586-114.73 230.016-224.042 242.09 17.578 15.232 33.578 44.672 33.578 90.454v135.85c0 13.142 7.936 27.606 32.854 22.87C862.25 912.597 1002.667 728.747 1002.667 512c0-271.019-219.648-490.667-490.71-490.667z"></path></svg></a></div><!--]--><button type="button" class="vp-toggle-navbar-button" aria-label="Toggle Navbar" aria-expanded="false" aria-controls="nav-screen"><span><span class="vp-top"></span><span class="vp-middle"></span><span class="vp-bottom"></span></span></button></div></header><!----><!--]--><!----><div class="toggle-sidebar-wrapper"><span class="arrow start"></span></div><aside id="sidebar" class="vp-sidebar iotdb-sidebar" vp-sidebar><!--[--><p class="vp-sidebar-header iotdb-sidebar-header"><span class="vp-sidebar-title">IoTDB User Guide (V2.0.x)</span></p><div class="sidebar-top-wrapper"><ul class="switch-list"><li class="switch-type switch-active">Tree</li><li class="switch-type">Table</li></ul></div><!--]--><ul class="vp-sidebar-links"><li><section class="vp-sidebar-group"><p class="vp-sidebar-header"><!----><span class="vp-sidebar-title">IoTDB User Guide (V2.0.x)</span><!----></p><ul class="vp-sidebar-links"></ul></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">About IoTDB</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Background knowledge</span><span class="vp-arrow end"></span></button><!----></section></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/latest/QuickStart/QuickStart_apache.html" aria-label="Quick Start" iconsizing="both"><!---->Quick Start<!----></a></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Deployment & Maintenance</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Basic Functions</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Advanced Features</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">AI capability</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Tools System</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable active" type="button"><!----><span class="vp-sidebar-title">API</span><span class="vp-arrow down"></span></button><ul class="vp-sidebar-links"><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Java Native Interface</span><span class="vp-arrow end"></span></button><!----></section></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/latest/API/Programming-Python-Native-API.html" aria-label="Python Native API" iconsizing="both"><!---->Python Native API<!----></a></li><li><a class="route-link route-link-active auto-link vp-sidebar-link active" href="/UserGuide/latest/API/Programming-Cpp-Native-API.html" aria-label="C++ Native API" iconsizing="both"><!---->C++ Native API<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/latest/API/Programming-Go-Native-API.html" aria-label="Go Native API" iconsizing="both"><!---->Go Native API<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/latest/API/Programming-CSharp-Native-API.html" aria-label="C# Native API" iconsizing="both"><!---->C# Native API<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/latest/API/Programming-NodeJS-Native-API.html" aria-label="Node.js Native API" iconsizing="both"><!---->Node.js Native API<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/latest/API/Programming-Rust-Native-API.html" aria-label="Rust Native API" iconsizing="both"><!---->Rust Native API<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/latest/API/Programming-JDBC.html" aria-label="JDBC (Not Recommend)" iconsizing="both"><!---->JDBC (Not Recommend)<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/latest/API/Programming-MQTT.html" aria-label="MQTT Protocol" iconsizing="both"><!---->MQTT Protocol<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/latest/API/Programming-Kafka.html" aria-label="Kafka" iconsizing="both"><!---->Kafka<!----></a></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">REST API</span><span class="vp-arrow end"></span></button><!----></section></li></ul></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Ecosystem Integration</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">SQL Manual</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Technical Insider</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Reference</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">FAQ</span><span class="vp-arrow end"></span></button><!----></section></li></ul><!----></aside><!--[--><main id="main-content" class="vp-page"><!--[--><!----><!----><nav class="vp-breadcrumb disable"></nav><div class="vp-page-title"><h1><!---->C++ Native API</h1><div class="page-info"><!----><!----><span class="page-date-info" aria-label="Writing Date📅" data-balloon-pos="up"><svg xmlns="http://www.w3.org/2000/svg" class="icon calendar-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="calendar icon" name="calendar"><path d="M716.4 110.137c0-18.753-14.72-33.473-33.472-33.473-18.753 0-33.473 14.72-33.473 33.473v33.473h66.993v-33.473zm-334.87 0c0-18.753-14.72-33.473-33.473-33.473s-33.52 14.72-33.52 33.473v33.473h66.993v-33.473zm468.81 33.52H716.4v100.465c0 18.753-14.72 33.473-33.472 33.473a33.145 33.145 0 01-33.473-33.473V143.657H381.53v100.465c0 18.753-14.72 33.473-33.473 33.473a33.145 33.145 0 01-33.473-33.473V143.657H180.6A134.314 134.314 0 0046.66 277.595v535.756A134.314 134.314 0 00180.6 947.289h669.74a134.36 134.36 0 00133.94-133.938V277.595a134.314 134.314 0 00-133.94-133.938zm33.473 267.877H147.126a33.145 33.145 0 01-33.473-33.473c0-18.752 14.72-33.473 33.473-33.473h736.687c18.752 0 33.472 14.72 33.472 33.473a33.145 33.145 0 01-33.472 33.473z"></path></svg><span data-allow-mismatch="text">July 10, 2023</span><meta property="datePublished" content="2023-07-10T03:11:17.000Z"></span><!----><span class="page-reading-time-info" aria-label="Reading Time⌛" data-balloon-pos="up"><svg xmlns="http://www.w3.org/2000/svg" class="icon timer-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="timer icon" name="timer"><path d="M799.387 122.15c4.402-2.978 7.38-7.897 7.38-13.463v-1.165c0-8.933-7.38-16.312-16.312-16.312H256.33c-8.933 0-16.311 7.38-16.311 16.312v1.165c0 5.825 2.977 10.874 7.637 13.592 4.143 194.44 97.22 354.963 220.201 392.763-122.204 37.542-214.893 196.511-220.2 389.397-4.661 5.049-7.638 11.651-7.638 19.03v5.825h566.49v-5.825c0-7.379-2.849-13.981-7.509-18.9-5.049-193.016-97.867-351.985-220.2-389.527 123.24-37.67 216.446-198.453 220.588-392.892zM531.16 450.445v352.632c117.674 1.553 211.787 40.778 211.787 88.676H304.097c0-48.286 95.149-87.382 213.728-88.676V450.445c-93.077-3.107-167.901-81.297-167.901-177.093 0-8.803 6.99-15.793 15.793-15.793 8.803 0 15.794 6.99 15.794 15.793 0 80.261 63.69 145.635 142.01 145.635s142.011-65.374 142.011-145.635c0-8.803 6.99-15.793 15.794-15.793s15.793 6.99 15.793 15.793c0 95.019-73.789 172.82-165.96 177.093z"></path></svg><span>About 7 min</span><meta property="timeRequired" content="PT7M"></span><!----><!----></div><hr></div><div class="vp-toc-placeholder"><aside id="toc" vp-toc><!----><!--[--><div class="vp-toc-header">On This Page<button type="button" class="print-button" title="Print"><svg xmlns="http://www.w3.org/2000/svg" class="icon print-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="print icon" name="print"><path d="M819.2 364.8h-44.8V128c0-17.067-14.933-32-32-32H281.6c-17.067 0-32 14.933-32 32v236.8h-44.8C145.067 364.8 96 413.867 96 473.6v192c0 59.733 49.067 108.8 108.8 108.8h44.8V896c0 17.067 14.933 32 32 32h460.8c17.067 0 32-14.933 32-32V774.4h44.8c59.733 0 108.8-49.067 108.8-108.8v-192c0-59.733-49.067-108.8-108.8-108.8zM313.6 160h396.8v204.8H313.6V160zm396.8 704H313.6V620.8h396.8V864zM864 665.6c0 25.6-19.2 44.8-44.8 44.8h-44.8V588.8c0-17.067-14.933-32-32-32H281.6c-17.067 0-32 14.933-32 32v121.6h-44.8c-25.6 0-44.8-19.2-44.8-44.8v-192c0-25.6 19.2-44.8 44.8-44.8h614.4c25.6 0 44.8 19.2 44.8 44.8v192z"></path></svg></button><div class="arrow end"></div></div><div class="vp-toc-wrapper"><ul class="vp-toc-list"><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level2" href="#_1-dependencies">1. Dependencies</a></li><!----><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level2" href="#_2-installation">2. Installation</a></li><li><ul class="vp-toc-list"><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level3" href="#_2-1-install-required-dependencies">2.1 Install Required Dependencies</a></li><!----><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level3" href="#_2-2-compilation">2.2 Compilation</a></li><!----><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level3" href="#_2-3-compilation-q-a">2.3 Compilation Q&A</a></li><!----><!--]--></ul></li><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level2" href="#_3-native-apis">3. Native APIs</a></li><li><ul class="vp-toc-list"><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level3" href="#_3-1-initialization">3.1 Initialization</a></li><!----><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level3" href="#_3-2-data-definition-interface-ddl">3.2 Data Definition Interface (DDL)</a></li><!----><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level3" href="#_3-3-data-manipulation-interface-dml">3.3 Data Manipulation Interface (DML)</a></li><!----><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level3" href="#_3-4-iotdb-sql-interface">3.4 IoTDB-SQL Interface</a></li><!----><!--]--></ul></li><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level2" href="#_4-examples">4. Examples</a></li><!----><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level2" href="#_5-faq">5. FAQ</a></li><li><ul class="vp-toc-list"><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level3" href="#_5-1-on-mac">5.1 on Mac</a></li><!----><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level3" href="#_5-2-on-windows">5.2 on Windows</a></li><!----><!--]--></ul></li><!--]--></ul><div class="vp-toc-marker" style="top:-1.7rem;"></div></div><!--]--><!----></aside></div><!----><div class="theme-hope-content" vp-content><h1 id="c-native-api" tabindex="-1"><a class="header-anchor" href="#c-native-api"><span>C++ Native API</span></a></h1><h2 id="_1-dependencies" tabindex="-1"><a class="header-anchor" href="#_1-dependencies"><span>1. Dependencies</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 5.5.0+</li></ul><h2 id="_2-installation" tabindex="-1"><a class="header-anchor" href="#_2-installation"><span>2. Installation</span></a></h2><h3 id="_2-1-install-required-dependencies" tabindex="-1"><a class="header-anchor" href="#_2-1-install-required-dependencies"><span>2.1 Install Required Dependencies</span></a></h3><ul><li><p><strong>MAC</strong></p><ol><li><p>Install Bison:</p><p>Use the following brew command to install the Bison version:</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><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>Install Boost: Make sure to install the latest version of Boost.</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><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>Check OpenSSL: Make sure the OpenSSL library is installed. The default OpenSSL header file path is "/usr/local/opt/openssl/include".</p><p>If you encounter errors related to OpenSSL not being found during compilation, try adding <code>-Dopenssl.include.dir=""</code>.</p></li></ol></li><li><p><strong>Ubuntu 16.04+ or Other Debian-based Systems</strong></p><p>Use the following commands to install dependencies:</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><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 or Other Red Hat-based Systems</strong></p><p>Use the yum command to install dependencies:</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><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><ol><li><p>Set Up the Build Environment</p><ul><li>Install MS Visual Studio (version 2019+ recommended): Make sure to select Visual Studio C/C++ IDE and compiler (supporting CMake, Clang, MinGW) during installation.</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 Flex, Bison</p><ul><li>Download <a href="https://sourceforge.net/projects/winflexbison/" target="_blank" rel="noopener noreferrer">Win_Flex_Bison</a>.</li><li>After downloading, rename the executables to flex.exe and bison.exe to ensure they can be found during compilation, and add the directory of these executables to the PATH environment variable.</li></ul></li><li><p>Install Boost Library</p><ul><li>Download <a href="https://www.boost.org/users/download/" target="_blank" rel="noopener noreferrer">Boost</a>.</li><li>Compile Boost locally: Run <code>bootstrap.bat</code> and <code>b2.exe</code> in sequence.</li><li>Add the Boost installation directory to the PATH environment variable, e.g., <code>C:\Program Files (x86)\boost_1_78_0</code>.</li></ul></li><li><p>Install OpenSSL</p><ul><li>Download and install <a href="http://slproweb.com/products/Win32OpenSSL.html" target="_blank" rel="noopener noreferrer">OpenSSL</a>.</li><li>Add the include directory under the installation directory to the PATH environment variable.</li></ul></li></ol></li></ul><h3 id="_2-2-compilation" tabindex="-1"><a class="header-anchor" href="#_2-2-compilation"><span>2.2 Compilation</span></a></h3><p>Clone the source code from git:</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><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>The default main branch is the master branch. If you want to use a specific release version, switch to that branch (e.g., version 1.3.2):</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><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>Run Maven to compile in the IoTDB root directory:</p><ul><li><p>Mac or Linux with glibc version >= 2.32</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><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>Linux with glibc version >= 2.31</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><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>Linux with glibc version >= 2.17</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><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>Windows using Visual Studio 2022</p><div class="language-batch line-numbers-mode" data-highlighter="shiki" data-ext="batch" data-title="batch" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><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>Windows using Visual Studio 2019</p><div class="language-batch line-numbers-mode" data-highlighter="shiki" data-ext="batch" data-title="batch" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><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;">"Visual Studio 16 2019"</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>If you haven't added the Boost library path to the PATH environment variable, you need to add the relevant parameters to the compile command, e.g., <code>-DboostIncludeDir="C:\Program Files (x86)\boost_1_78_0" -DboostLibraryDir="C:\Program Files (x86)\boost_1_78_0\stage\lib"</code>.</li></ul></li></ul><p>After successful compilation, the packaged library files will be located in <code>iotdb-client/client-cpp/target</code>, and you can find the compiled example program under <code>example/client-cpp-example/target</code>.</p><h3 id="_2-3-compilation-q-a" tabindex="-1"><a class="header-anchor" href="#_2-3-compilation-q-a"><span>2.3 Compilation Q&A</span></a></h3><p>Q: What are the requirements for the environment on Linux?</p><p>A:</p><ul><li>The known minimum version requirement for glibc (x86_64 version) is 2.17, and the minimum version for GCC is 5.5.</li><li>The known minimum version requirement for glibc (ARM version) is 2.31, and the minimum version for GCC is 10.2.</li><li>If the above requirements are not met, you can try compiling Thrift locally: <ul><li>Download the code from <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>Run <code>./mvnw clean install</code>.</li><li>Go back to the IoTDB code directory and run <code>./mvnw clean package -pl example/client-cpp-example -am -DskipTests -P with-cpp</code>.</li></ul></li></ul><p>Q: How to resolve the <code>undefined reference to '_libc_single_thread'</code> error during Linux compilation?</p><p>A:</p><ul><li>This issue is caused by the precompiled Thrift dependencies requiring a higher version of glibc.</li><li>You can try adding <code>-Diotdb-tools-thrift.version=0.14.1.1-glibc223-SNAPSHOT</code> or <code>-Diotdb-tools-thrift.version=0.14.1.1-old-glibc-SNAPSHOT</code> to the Maven compile command.</li></ul><p>Q: What if I need to compile using Visual Studio 2017 or earlier on Windows?</p><p>A:</p><ul><li>You can try compiling Thrift locally before compiling the client: <ul><li>Download the code from <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>Run <code>.\mvnw.cmd clean install</code>.</li><li>Go back to the IoTDB code directory and run <code>.\mvnw.cmd clean package -pl example/client-cpp-example -am -DskipTests -P with-cpp -Dcmake.generator="Visual Studio 15 2017"</code>.</li></ul></li></ul><h2 id="_3-native-apis" tabindex="-1"><a class="header-anchor" href="#_3-native-apis"><span>3. Native APIs</span></a></h2><p>Here we show the commonly used interfaces and their parameters in the Native API:</p><h3 id="_3-1-initialization" tabindex="-1"><a class="header-anchor" href="#_3-1-initialization"><span>3.1 Initialization</span></a></h3><ul><li>Open a Session</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="shiki" data-ext="cpp" data-title="cpp" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><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>Open a session, with a parameter to specify whether to enable RPC compression</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="shiki" data-ext="cpp" data-title="cpp" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><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>Notice: this RPC compression status of client must comply with that of IoTDB server</p><ul><li>Close a Session</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="shiki" data-ext="cpp" data-title="cpp" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><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="_3-2-data-definition-interface-ddl" tabindex="-1"><a class="header-anchor" href="#_3-2-data-definition-interface-ddl"><span>3.2 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="shiki" data-ext="cpp" data-title="cpp" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><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;"> &</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>Delete one or several databases</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="shiki" data-ext="cpp" data-title="cpp" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><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;"> &</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;"><std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">> </span><span style="color:#C678DD;">&</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="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="shiki" data-ext="cpp" data-title="cpp" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><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;"> &</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;"><std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">> </span><span style="color:#C678DD;">&</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;"><TSDataType::</span><span style="color:#E5C07B;">TSDataType</span><span style="color:#ABB2BF;">> </span><span style="color:#C678DD;">&</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;"><TSEncoding::</span><span style="color:#E5C07B;">TSEncoding</span><span style="color:#ABB2BF;">> </span><span style="color:#C678DD;">&</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;"><CompressionType::</span><span style="color:#E5C07B;">CompressionType</span><span style="color:#ABB2BF;">> </span><span style="color:#C678DD;">&</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;"><std::</span><span style="color:#E5C07B;">map</span><span style="color:#ABB2BF;"><std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">, std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">>> </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;"><std::</span><span style="color:#E5C07B;">map</span><span style="color:#ABB2BF;"><std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">, std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">>> </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;"><std::</span><span style="color:#E5C07B;">map</span><span style="color:#ABB2BF;"><std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">, std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">>> </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;"><std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">> </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>Create aligned timeseries</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="shiki" data-ext="cpp" data-title="cpp" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><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;"> &</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;"><std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">> </span><span style="color:#C678DD;">&</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;"><TSDataType::</span><span style="color:#E5C07B;">TSDataType</span><span style="color:#ABB2BF;">> </span><span style="color:#C678DD;">&</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;"><TSEncoding::</span><span style="color:#E5C07B;">TSEncoding</span><span style="color:#ABB2BF;">> </span><span style="color:#C678DD;">&</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;"><CompressionType::</span><span style="color:#E5C07B;">CompressionType</span><span style="color:#ABB2BF;">> </span><span style="color:#C678DD;">&</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>Delete one or several timeseries</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="shiki" data-ext="cpp" data-title="cpp" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><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;"> &</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;"><std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">> </span><span style="color:#C678DD;">&</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>Check whether the specific timeseries exists.</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="shiki" data-ext="cpp" data-title="cpp" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><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;"> &</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="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="shiki" data-ext="cpp" data-title="cpp" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><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;"> &</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>Set the schema template named <code>templateName</code> at path <code>prefixPath</code>.</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="shiki" data-ext="cpp" data-title="cpp" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><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;"> &</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;"> &</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><ul><li>Unset the schema template</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="shiki" data-ext="cpp" data-title="cpp" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><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;"> &</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;"> &</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><ul><li>After measurement template created, you can edit the template with belowed APIs.</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="shiki" data-ext="cpp" data-title="cpp" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#7F848E;font-style:italic;">// Add aligned measurements to a template</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;"> &</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;"><std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">> </span><span style="color:#C678DD;">&</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;"><TSDataType::</span><span style="color:#E5C07B;">TSDataType</span><span style="color:#ABB2BF;">> </span><span style="color:#C678DD;">&</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;"><TSEncoding::</span><span style="color:#E5C07B;">TSEncoding</span><span style="color:#ABB2BF;">> </span><span style="color:#C678DD;">&</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;"><CompressionType::</span><span style="color:#E5C07B;">CompressionType</span><span style="color:#ABB2BF;">> </span><span style="color:#C678DD;">&</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;">// Add one aligned measurement to a template</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;"> &</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;"> &</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;">// Add unaligned measurements to a template</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;"> &</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;"><std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">> </span><span style="color:#C678DD;">&</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;"><TSDataType::</span><span style="color:#E5C07B;">TSDataType</span><span style="color:#ABB2BF;">> </span><span style="color:#C678DD;">&</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;"><TSEncoding::</span><span style="color:#E5C07B;">TSEncoding</span><span style="color:#ABB2BF;">> </span><span style="color:#C678DD;">&</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;"><CompressionType::</span><span style="color:#E5C07B;">CompressionType</span><span style="color:#ABB2BF;">> </span><span style="color:#C678DD;">&</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;">// Add one unaligned measurement to a template</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;"> &</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;"> &</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;">// Delete a node in template and its children</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;"> &</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;"> &</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>You can query measurement templates with these APIS:</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="shiki" data-ext="cpp" data-title="cpp" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#7F848E;font-style:italic;">// Return the amount of measurements inside a template</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;"> &</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;">// Return true if path points to a measurement, otherwise returne false</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;"> &</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;"> &</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;">// Return true if path exists in template, otherwise return false</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;"> &</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;"> &</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;">// Return all measurements paths inside template</span></span> |
| <span class="line"><span style="color:#ABB2BF;">std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;"><std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">> </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;"> &</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;">// Return all measurements paths under the designated patter inside template</span></span> |
| <span class="line"><span style="color:#ABB2BF;">std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;"><std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">> </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;"> &</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;"> &</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="_3-3-data-manipulation-interface-dml" tabindex="-1"><a class="header-anchor" href="#_3-3-data-manipulation-interface-dml"><span>3.3 Data Manipulation Interface (DML)</span></a></h3><h4 id="insert" tabindex="-1"><a class="header-anchor" href="#insert"><span>Insert</span></a></h4><blockquote><p>It is recommended to use insertTablet to help improve write efficiency.</p></blockquote><ul><li>Insert a Tablet，which is multiple rows of a device, each row has the same measurements <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="shiki" data-ext="cpp" data-title="cpp" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><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;"> &</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>Insert multiple Tablets</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="shiki" data-ext="cpp" data-title="cpp" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><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;"><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;">> </span><span style="color:#C678DD;">&</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>Insert a Record, which contains multiple measurement value of a device at a timestamp</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="shiki" data-ext="cpp" data-title="cpp" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><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;"> &</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;"><std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">> </span><span style="color:#C678DD;">&</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;"><TSDataType::</span><span style="color:#E5C07B;">TSDataType</span><span style="color:#ABB2BF;">> </span><span style="color:#C678DD;">&</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;"><</span><span style="color:#C678DD;">char</span><span style="color:#C678DD;"> *</span><span style="color:#ABB2BF;">> </span><span style="color:#C678DD;">&</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>Insert multiple Records</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="shiki" data-ext="cpp" data-title="cpp" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><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;"><std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">> </span><span style="color:#C678DD;">&</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;"><</span><span style="color:#C678DD;">int64_t</span><span style="color:#ABB2BF;">> </span><span style="color:#C678DD;">&</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;"><std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;"><std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">>> </span><span style="color:#C678DD;">&</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;"><std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;"><TSDataType::</span><span style="color:#E5C07B;">TSDataType</span><span style="color:#ABB2BF;">>> </span><span style="color:#C678DD;">&</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;"><std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;"><</span><span style="color:#C678DD;">char</span><span style="color:#C678DD;"> *</span><span style="color:#ABB2BF;">>> </span><span style="color:#C678DD;">&</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>Insert multiple Records that belong to the same device. With type info the server has no need to do type inference, which leads a better performance</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="shiki" data-ext="cpp" data-title="cpp" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><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;"> &</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;"><</span><span style="color:#C678DD;">int64_t</span><span style="color:#ABB2BF;">> </span><span style="color:#C678DD;">&</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;"><std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;"><std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">>> </span><span style="color:#C678DD;">&</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;"><std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;"><TSDataType::</span><span style="color:#E5C07B;">TSDataType</span><span style="color:#ABB2BF;">>> </span><span style="color:#C678DD;">&</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;"><std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;"><</span><span style="color:#C678DD;">char</span><span style="color:#C678DD;"> *</span><span style="color:#ABB2BF;">>> </span><span style="color:#C678DD;">&</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="insert-with-type-inference" tabindex="-1"><a class="header-anchor" href="#insert-with-type-inference"><span>Insert with type inference</span></a></h4><p>Without type information, server has to do type inference, which may cost some time.</p><div class="language-cpp line-numbers-mode" data-highlighter="shiki" data-ext="cpp" data-title="cpp" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><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;"> &</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;"><std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">> </span><span style="color:#C678DD;">&</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;"><std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">> </span><span style="color:#C678DD;">&</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;"><std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">> </span><span style="color:#C678DD;">&</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;"><</span><span style="color:#C678DD;">int64_t</span><span style="color:#ABB2BF;">> </span><span style="color:#C678DD;">&</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;"><std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;"><std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">>> </span><span style="color:#C678DD;">&</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;"><std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;"><std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">>> </span><span style="color:#C678DD;">&</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;"> &</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;"><</span><span style="color:#C678DD;">int64_t</span><span style="color:#ABB2BF;">> </span><span style="color:#C678DD;">&</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;"><std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;"><std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">>> </span><span style="color:#C678DD;">&</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;"><std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;"><std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">>> </span><span style="color:#C678DD;">&</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="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 Insert of aligned timeseries uses interfaces like <code>insertAlignedXXX</code>, and others are similar to the above interfaces:</p><ul><li>insertAlignedRecord</li><li>insertAlignedRecords</li><li>insertAlignedRecordsOfOneDevice</li><li>insertAlignedTablet</li><li>insertAlignedTablets</li></ul><h4 id="delete" tabindex="-1"><a class="header-anchor" href="#delete"><span>Delete</span></a></h4><ul><li>Delete data in a time range of one or several timeseries</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="shiki" data-ext="cpp" data-title="cpp" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><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;"> &</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;"><std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">> </span><span style="color:#C678DD;">&</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;"><std::</span><span style="color:#E5C07B;">string</span><span style="color:#ABB2BF;">> </span><span style="color:#C678DD;">&</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="_3-4-iotdb-sql-interface" tabindex="-1"><a class="header-anchor" href="#_3-4-iotdb-sql-interface"><span>3.4 IoTDB-SQL Interface</span></a></h3><ul><li>Execute query statement</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="shiki" data-ext="cpp" data-title="cpp" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#E5C07B;">unique_ptr</span><span style="color:#ABB2BF;"><</span><span style="color:#E5C07B;">SessionDataSet</span><span style="color:#ABB2BF;">> </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;"> &</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><ul><li>Execute non query statement</li></ul><div class="language-cpp line-numbers-mode" data-highlighter="shiki" data-ext="cpp" data-title="cpp" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><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;"> &</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="_4-examples" tabindex="-1"><a class="header-anchor" href="#_4-examples"><span>4. Examples</span></a></h2><p>The sample code of using these interfaces is in:</p><ul><li><code>example/client-cpp-example/src/SessionExample.cpp</code>: <a href="https://github.com/apache/iotdb/tree/rc/2.0.1/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> (Aligned Timeseries) : <a href="https://github.com/apache/iotdb/tree/rc/2.0.1/example/client-cpp-example/src/AlignedTimeseriesSessionExample.cpp" target="_blank" rel="noopener noreferrer">AlignedTimeseriesSessionExample</a></li></ul><p>If the compilation finishes successfully, the example project will be placed under <code>example/client-cpp-example/target</code></p><h2 id="_5-faq" tabindex="-1"><a class="header-anchor" href="#_5-faq"><span>5. FAQ</span></a></h2><h3 id="_5-1-on-mac" tabindex="-1"><a class="header-anchor" href="#_5-1-on-mac"><span>5.1 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="_5-2-on-windows" tabindex="-1"><a class="header-anchor" href="#_5-2-on-windows"><span>5.2 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-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">Failed</span><span style="color:#98C379;"> to</span><span style="color:#98C379;"> delete</span><span style="color:#98C379;"> cached</span><span style="color:#98C379;"> file</span><span style="color:#98C379;"> C:</span><span style="color:#56B6C2;">\U</span><span style="color:#98C379;">sers</span><span style="color:#56B6C2;">\A</span><span style="color:#98C379;">dministrator</span><span style="color:#56B6C2;">\.</span><span style="color:#98C379;">m2</span><span style="color:#56B6C2;">\r</span><span style="color:#98C379;">epository</span><span style="color:#56B6C2;">\.</span><span style="color:#98C379;">cache</span><span style="color:#56B6C2;">\d</span><span style="color:#98C379;">ownload-maven-plugin</span><span style="color:#56B6C2;">\i</span><span style="color:#98C379;">ndex.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>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></div><!----><footer class="vp-page-meta"><div class="vp-meta-item edit-link"><a class="auto-link external-link vp-meta-label" href="https://github.com/apache/iotdb-docs/edit/main/src/UserGuide/latest/API/Programming-Cpp-Native-API.md" aria-label="Found Error? Edit this page on GitHub" rel="noopener noreferrer" target="_blank" iconsizing="both"><!--[--><svg xmlns="http://www.w3.org/2000/svg" class="icon edit-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="edit icon" name="edit"><path d="M430.818 653.65a60.46 60.46 0 0 1-50.96-93.281l71.69-114.012 7.773-10.365L816.038 80.138A60.46 60.46 0 0 1 859.225 62a60.46 60.46 0 0 1 43.186 18.138l43.186 43.186a60.46 60.46 0 0 1 0 86.373L588.879 565.55l-8.637 8.637-117.466 68.234a60.46 60.46 0 0 1-31.958 11.229z"></path><path d="M728.802 962H252.891A190.883 190.883 0 0 1 62.008 771.98V296.934a190.883 190.883 0 0 1 190.883-192.61h267.754a60.46 60.46 0 0 1 0 120.92H252.891a69.962 69.962 0 0 0-69.098 69.099V771.98a69.962 69.962 0 0 0 69.098 69.098h475.911A69.962 69.962 0 0 0 797.9 771.98V503.363a60.46 60.46 0 1 1 120.922 0V771.98A190.883 190.883 0 0 1 728.802 962z"></path></svg><!--]-->Found Error? Edit this page on GitHub<!----></a></div><div class="vp-meta-item git-info"><div class="update-time"><span class="vp-meta-label">Last update: </span><span class="vp-meta-info" data-allow-mismatch="text">3/5/2025, 10:17:06 AM</span></div><!----></div></footer><nav class="vp-page-nav"><a class="route-link auto-link prev" href="/UserGuide/latest/API/Programming-Python-Native-API.html" aria-label="Python Native API" iconsizing="both"><div class="hint"><span class="arrow start"></span>Prev</div><div class="link"><!---->Python Native API</div></a><a class="route-link auto-link next" href="/UserGuide/latest/API/Programming-Go-Native-API.html" aria-label="Go Native API" iconsizing="both"><div class="hint">Next<span class="arrow end"></span></div><div class="link">Go Native API<!----></div></a></nav><!----><!----><!--]--></main><!--]--><footer class="site-footer"><span id="doc-version" style="display:none;">latest</span><p class="copyright-text">Copyright © 2025 The Apache Software Foundation. |
| Apache IoTDB, IoTDB, Apache, the Apache feather logo, and the Apache IoTDB project logo are either registered trademarks or trademarks of The Apache Software Foundation in all countries</p><p style="text-align:center;margin-top:10px;color:#909399;font-size:12px;margin:0 30px;"><strong>Having questions?</strong> Connect with us on QQ, WeChat, or Slack. <a href="https://github.com/apache/iotdb/issues/1995">Join the community</a></p></footer></div><!--]--><!--]--><!--[--><!----><!--]--><!--]--></div> |
| <script type="module" src="/assets/app-C-fAkKj6.js" defer></script> |
| </body> |
| </html> |
