| <!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://tsfile.apache.org/zh/UserGuide/develop/QuickStart/InterfaceDefinition/InterfaceDefinition-CPP.html"><meta property="og:url" content="https://tsfile.apache.org/UserGuide/develop/QuickStart/InterfaceDefinition/InterfaceDefinition-CPP.html"><meta property="og:site_name" content="Apache TsFile"><meta property="og:title" content="Interface Definitions - C++"><meta property="og:description" content="Interface Definitions - C++ Write Interface TsFileTableWriter Used to write data to tsfile TableSchema Describe the data structure of the table schema Tablet Write column memory..."><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="2026-01-09T01:45:21.000Z"><meta property="article:modified_time" content="2026-01-09T01:45:21.000Z"><script type="application/ld+json">{"@context":"https://schema.org","@type":"Article","headline":"Interface Definitions - C++","image":[""],"dateModified":"2026-01-09T01:45:21.000Z","author":[]}</script><link rel="icon" href="/favicon.ico"><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', '53']); |
| 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>Interface Definitions - C++ | Apache TsFile</title><meta name="description" content="Interface Definitions - C++ Write Interface TsFileTableWriter Used to write data to tsfile TableSchema Describe the data structure of the table schema Tablet Write column memory..."> |
| <link rel="preload" href="/assets/style-Dd4ncJh2.css" as="style"><link rel="stylesheet" href="/assets/style-Dd4ncJh2.css"> |
| <link rel="modulepreload" href="/assets/app-xkEPX-KM.js"><link rel="modulepreload" href="/assets/InterfaceDefinition-CPP.html-Seu5NrWI.js"><link rel="modulepreload" href="/assets/plugin-vue_export-helper-DlAUqK2U.js"> |
| <link rel="prefetch" href="/assets/index.html-BNt1R0c4.js" as="script"><link rel="prefetch" href="/assets/About.html-BD5Xn-2S.js" as="script"><link rel="prefetch" href="/assets/Feedback.html-D6xFPblF.js" as="script"><link rel="prefetch" href="/assets/Community-Project-Committers.html-Y5k43dcR.js" as="script"><link rel="prefetch" href="/assets/Powered-By.html-Do30EfUo.js" as="script"><link rel="prefetch" href="/assets/index.html-CNjFdSPm.js" as="script"><link rel="prefetch" href="/assets/QuickStart.html-wv_mNIYi.js" as="script"><link rel="prefetch" href="/assets/index.html-D4XiHtaH.js" as="script"><link rel="prefetch" href="/assets/About.html-A2IvDDuk.js" as="script"><link rel="prefetch" href="/assets/Feedback.html-5hMaMH-i.js" as="script"><link rel="prefetch" href="/assets/Community-Project-Committers.html-BqILOhmh.js" as="script"><link rel="prefetch" href="/assets/Powered-By.html-DZsZwSA6.js" as="script"><link rel="prefetch" href="/assets/index.html-B3ItSg-m.js" as="script"><link rel="prefetch" href="/assets/QuickStart.html-B9DNKhFO.js" as="script"><link rel="prefetch" href="/assets/Flink-TsFile.html-DhSTIFbn.js" as="script"><link rel="prefetch" href="/assets/Hive-TsFile.html-BtaOrkLD.js" as="script"><link rel="prefetch" href="/assets/Spark-TsFile.html-BnDzg9-u.js" as="script"><link rel="prefetch" href="/assets/Data-Model.html-9sOs0AQV.js" as="script"><link rel="prefetch" href="/assets/Navigating_Time_Series_Data.html-BPv6PFAC.js" as="script"><link rel="prefetch" href="/assets/QuickStart-C.html-Dk1i-YrW.js" as="script"><link rel="prefetch" href="/assets/QuickStart-CPP.html-D8DMF5fM.js" as="script"><link rel="prefetch" href="/assets/QuickStart-JAVA.html-D5FbnQvR.js" as="script"><link rel="prefetch" href="/assets/QuickStart-PYTHON.html-D2mIM4nb.js" as="script"><link rel="prefetch" href="/assets/Flink-TsFile.html-C1OBrb5r.js" as="script"><link rel="prefetch" href="/assets/Hive-TsFile.html-B2QIZtj0.js" as="script"><link rel="prefetch" href="/assets/Spark-TsFile.html-CtdXfjnj.js" as="script"><link rel="prefetch" href="/assets/Data-Model.html-BHrJRDIc.js" as="script"><link rel="prefetch" href="/assets/Navigating_Time_Series_Data.html-BNUiQvac.js" as="script"><link rel="prefetch" href="/assets/QuickStart-C.html-CSASFgfz.js" as="script"><link rel="prefetch" href="/assets/QuickStart-CPP.html-BFvKFtbV.js" as="script"><link rel="prefetch" href="/assets/QuickStart-PYTHON.html-CtQqT8FH.js" as="script"><link rel="prefetch" href="/assets/QuickStart.html-BS3WuLD_.js" as="script"><link rel="prefetch" href="/assets/Flink-TsFile.html-DqPIPliD.js" as="script"><link rel="prefetch" href="/assets/Hive-TsFile.html-Bj4_bpgF.js" as="script"><link rel="prefetch" href="/assets/Spark-TsFile.html-SkmeBp6j.js" as="script"><link rel="prefetch" href="/assets/Data-Model.html-d-kwUPJa.js" as="script"><link rel="prefetch" href="/assets/Navigating_Time_Series_Data.html-DmSCcRnW.js" as="script"><link rel="prefetch" href="/assets/QuickStart.html-CXlxWkMY.js" as="script"><link rel="prefetch" href="/assets/InterfaceDefinition-C.html-D4bSEk30.js" as="script"><link rel="prefetch" href="/assets/InterfaceDefinition-Java.html-BdzkS0C_.js" as="script"><link rel="prefetch" href="/assets/InterfaceDefinition-Python.html-D-j2TZUr.js" as="script"><link rel="prefetch" href="/assets/InterfaceDefinition-C.html-LYCJRnz3.js" as="script"><link rel="prefetch" href="/assets/InterfaceDefinition-CPP.html-D4OzBZK8.js" as="script"><link rel="prefetch" href="/assets/InterfaceDefinition-Java.html-Cj7hOBYz.js" as="script"><link rel="prefetch" href="/assets/InterfaceDefinition-Python.html-BOGiLSNG.js" as="script"><link rel="prefetch" href="/assets/Flink-TsFile.html-BOz-hO5l.js" as="script"><link rel="prefetch" href="/assets/Hive-TsFile.html-DLYO23Rf.js" as="script"><link rel="prefetch" href="/assets/Spark-TsFile.html-BVwTB-cD.js" as="script"><link rel="prefetch" href="/assets/Data-Model.html-Cabjsxso.js" as="script"><link rel="prefetch" href="/assets/Interface-Definitions.html-Bu8DT5C2.js" as="script"><link rel="prefetch" href="/assets/Navigating_Time_Series_Data.html--Q5BRSgU.js" as="script"><link rel="prefetch" href="/assets/QuickStart-C.html-lOFD7y3S.js" as="script"><link rel="prefetch" href="/assets/QuickStart-CPP.html-DKi7U2zk.js" as="script"><link rel="prefetch" href="/assets/QuickStart-JAVA.html-CC8eT17U.js" as="script"><link rel="prefetch" href="/assets/QuickStart-PYTHON.html-C2cUQwqM.js" as="script"><link rel="prefetch" href="/assets/Flink-TsFile.html-D-rswstp.js" as="script"><link rel="prefetch" href="/assets/Hive-TsFile.html-DsQu-Zzb.js" as="script"><link rel="prefetch" href="/assets/Spark-TsFile.html-BE9QQEFa.js" as="script"><link rel="prefetch" href="/assets/Data-Model.html-CXznTKHD.js" as="script"><link rel="prefetch" href="/assets/Navigating_Time_Series_Data.html-BkX4a0PV.js" as="script"><link rel="prefetch" href="/assets/QuickStart-C.html-D26Xldk2.js" as="script"><link rel="prefetch" href="/assets/QuickStart-CPP.html-CSIELe9f.js" as="script"><link rel="prefetch" href="/assets/QuickStart-PYTHON.html-CzrUEBTq.js" as="script"><link rel="prefetch" href="/assets/QuickStart.html-PsS3BCLL.js" as="script"><link rel="prefetch" href="/assets/Flink-TsFile.html-DM1dVcMK.js" as="script"><link rel="prefetch" href="/assets/Hive-TsFile.html-BJYOGAOM.js" as="script"><link rel="prefetch" href="/assets/Spark-TsFile.html-zVdSfrUE.js" as="script"><link rel="prefetch" href="/assets/Data-Model.html-BENOuhFf.js" as="script"><link rel="prefetch" href="/assets/Navigating_Time_Series_Data.html-CzheQEWE.js" as="script"><link rel="prefetch" href="/assets/QuickStart.html-BLHtHVlV.js" as="script"><link rel="prefetch" href="/assets/InterfaceDefinition-C.html-Cwi9sOaR.js" as="script"><link rel="prefetch" href="/assets/InterfaceDefinition-CPP.html-DHEA5VZw.js" as="script"><link rel="prefetch" href="/assets/InterfaceDefinition-Java.html-CJIV4pOA.js" as="script"><link rel="prefetch" href="/assets/InterfaceDefinition-Python.html-BtZDeLko.js" as="script"><link rel="prefetch" href="/assets/InterfaceDefinition-C.html-Cy9uo5Av.js" as="script"><link rel="prefetch" href="/assets/InterfaceDefinition-CPP.html-BoFXDO0M.js" as="script"><link rel="prefetch" href="/assets/InterfaceDefinition-Java.html-WuQwm18H.js" as="script"><link rel="prefetch" href="/assets/InterfaceDefinition-Python.html-rOQV0ZE9.js" as="script"><link rel="prefetch" href="/assets/404.html-Dm_tXVhA.js" as="script"><link rel="prefetch" href="/assets/index.html-BsKR84Ii.js" as="script"><link rel="prefetch" href="/assets/index.html-kFrGfzKg.js" as="script"><link rel="prefetch" href="/assets/index.html-CzhahM1e.js" as="script"><link rel="prefetch" href="/assets/index.html-MjCYCMgq.js" as="script"><link rel="prefetch" href="/assets/index.html-Dpvs137D.js" as="script"><link rel="prefetch" href="/assets/index.html-D_rKWzHT.js" as="script"><link rel="prefetch" href="/assets/index.html-DsrRECyO.js" as="script"><link rel="prefetch" href="/assets/index.html-D0RTm790.js" as="script"><link rel="prefetch" href="/assets/index.html-BVC1DDDF.js" as="script"><link rel="prefetch" href="/assets/index.html-BhWyvNuE.js" as="script"><link rel="prefetch" href="/assets/index.html-CioUjQdX.js" as="script"><link rel="prefetch" href="/assets/index.html-CPEUPb8h.js" as="script"><link rel="prefetch" href="/assets/index.html-CCOaUWFW.js" as="script"><link rel="prefetch" href="/assets/index.html-Bg85yN51.js" as="script"><link rel="prefetch" href="/assets/index.html-DpQ5tMas.js" as="script"><link rel="prefetch" href="/assets/index.html-DCJ6_uuw.js" as="script"><link rel="prefetch" href="/assets/index.html-CZMRX_Yj.js" as="script"><link rel="prefetch" href="/assets/index.html-BfRJtATW.js" as="script"><link rel="prefetch" href="/assets/index.html-DBwdcgFo.js" as="script"><link rel="prefetch" href="/assets/index.html-8RODoIcR.js" as="script"><link rel="prefetch" href="/assets/index.html-S0jtRI54.js" as="script"><link rel="prefetch" href="/assets/index.html-Cg8UTss7.js" as="script"><link rel="prefetch" href="/assets/index.html-DJWOFtbG.js" as="script"><link rel="prefetch" href="/assets/index.html-CE2txRHu.js" as="script"><link rel="prefetch" href="/assets/index.html-DWgr8Lgn.js" as="script"><link rel="prefetch" href="/assets/index.html-CsReJJpd.js" as="script"><link rel="prefetch" href="/assets/index.html-D0lQkvA_.js" as="script"><link rel="prefetch" href="/assets/index.html-uYzqcPpw.js" as="script"><link rel="prefetch" href="/assets/index.html-BVFOgC0n.js" as="script"><link rel="prefetch" href="/assets/index.html-Ddid15cF.js" as="script"><link rel="prefetch" href="/assets/photoswipe.esm-D2Nf-uDI.js" as="script"><link rel="prefetch" href="/assets/index-B-M8YVCw.js" as="script"> |
| </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 no-sidebar 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.svg" alt><!----><span class="vp-site-name hide-in-pad">Apache TsFile</span></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.html" aria-label="v2.x" iconsizing="both"><!---->v2.x<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/UserGuide/v1.x/QuickStart/QuickStart.html" aria-label="v1.x" iconsizing="both"><!---->v1.x<!----></a></li></ul></button></div></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="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" target="_self" 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" target="_self" 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" target="_self" 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/develop/QuickStart/InterfaceDefinition/InterfaceDefinition-CPP.html" aria-label="English" iconsizing="both"><!---->English<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/zh/UserGuide/develop/QuickStart/InterfaceDefinition/InterfaceDefinition-CPP.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/tsfile" 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" vp-sidebar><!----><ul class="vp-sidebar-links"></ul><!----></aside><!--[--><main id="main-content" class="vp-page"><!--[--><!----><!----><nav class="vp-breadcrumb disable"></nav><div class="vp-page-title"><h1><!---->Interface Definitions - C++</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">January 9, 2026</span><meta property="datePublished" content="2026-01-09T01:45:21.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 8 min</span><meta property="timeRequired" content="PT8M"></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="#write-interface">Write Interface</a></li><li><ul class="vp-toc-list"><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level3" href="#tsfiletablewriter">TsFileTableWriter</a></li><!----><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level3" href="#tableschema">TableSchema</a></li><!----><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level3" href="#tablet">Tablet</a></li><!----><!--]--></ul></li><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level2" href="#read-interface">Read Interface</a></li><li><ul class="vp-toc-list"><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level3" href="#tsfile-reader">Tsfile Reader</a></li><!----><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level3" href="#resultset">ResultSet</a></li><!----><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level3" href="#resultmeta">ResultMeta</a></li><!----><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level3" href="#filter">Filter</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="interface-definitions-c" tabindex="-1"><a class="header-anchor" href="#interface-definitions-c"><span>Interface Definitions - C++</span></a></h1><h2 id="write-interface" tabindex="-1"><a class="header-anchor" href="#write-interface"><span>Write Interface</span></a></h2><h3 id="tsfiletablewriter" tabindex="-1"><a class="header-anchor" href="#tsfiletablewriter"><span>TsFileTableWriter</span></a></h3><p>Used to write data to tsfile</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:#7F848E;font-style:italic;">/**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@brief</span><span style="color:#7F848E;font-style:italic;"> Facilitates writing structured table data into a TsFile with a specified schema.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> *</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * The TsFileTableWriter class is designed to write structured data, particularly suitable for time-series data,</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * into a file optimized for efficient storage and retrieval (referred to as TsFile here). It allows users to define</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * the schema of the tables they want to write, add rows of data according to that schema, and serialize this data</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * into a TsFile. Additionally, it provides options to limit memory usage during the writing process.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> */</span></span> |
| <span class="line"><span style="color:#C678DD;">class</span><span style="color:#E5C07B;"> TsFileTableWriter</span><span style="color:#ABB2BF;"> {</span></span> |
| <span class="line"><span style="color:#C678DD;"> public:</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> /**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * TsFileTableWriter is used to write table data into a target file with the given schema,</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * optionally limiting the memory usage.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> *</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#E06C75;font-style:italic;"> writer_file</span><span style="color:#7F848E;font-style:italic;"> Target file where the table data will be written. Must not be null.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#E06C75;font-style:italic;"> table_schema</span><span style="color:#7F848E;font-style:italic;"> Used to construct table structures. Defines the schema of the table</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * being written.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#E06C75;font-style:italic;"> memory_threshold</span><span style="color:#7F848E;font-style:italic;"> Optional parameter. When the size of written</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * data exceeds this value, the data will be automatically flushed to the</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * disk. Default value is 128MB.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> */</span></span> |
| <span class="line"><span style="color:#61AFEF;"> TsFileTableWriter</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">WriteFile</span><span style="color:#C678DD;">*</span><span style="color:#E06C75;font-style:italic;"> writer_file</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> TableSchema</span><span style="color:#C678DD;">*</span><span style="color:#E06C75;font-style:italic;"> table_schema</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#C678DD;"> uint64_t</span><span style="color:#E06C75;font-style:italic;"> memory_threshold</span><span style="color:#C678DD;"> =</span><span style="color:#D19A66;"> 128</span><span style="color:#C678DD;"> *</span><span style="color:#D19A66;"> 1024</span><span style="color:#C678DD;"> *</span><span style="color:#D19A66;"> 1024</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#61AFEF;"> ~TsFileTableWriter</span><span style="color:#ABB2BF;">();</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> /**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * Writes the given tablet data into the target file according to the schema.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> *</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#E06C75;font-style:italic;"> tablet</span><span style="color:#7F848E;font-style:italic;"> The tablet containing the data to be written. Must not be null.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@return</span><span style="color:#7F848E;font-style:italic;"> Returns 0 on success, or a non-zero error code on failure.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> */</span></span> |
| <span class="line"><span style="color:#C678DD;"> int</span><span style="color:#61AFEF;"> write_table</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">const</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> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> /**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * Flushes any buffered data to the underlying storage medium, ensuring all data is written out.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * This method ensures that all pending writes are persisted.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> *</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@return</span><span style="color:#7F848E;font-style:italic;"> Returns 0 on success, or a non-zero error code on failure.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> */</span></span> |
| <span class="line"><span style="color:#C678DD;"> int</span><span style="color:#61AFEF;"> flush</span><span style="color:#ABB2BF;">();</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> /**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * Closes the writer and releases any resources held by it.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * After calling this method, no further operations should be performed on this instance.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> *</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@return</span><span style="color:#7F848E;font-style:italic;"> Returns 0 on success, or a non-zero error code on failure.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> */</span></span> |
| <span class="line"><span style="color:#C678DD;"> int</span><span style="color:#61AFEF;"> close</span><span style="color:#ABB2BF;">();</span></span> |
| <span class="line"><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 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><h3 id="tableschema" tabindex="-1"><a class="header-anchor" href="#tableschema"><span>TableSchema</span></a></h3><p>Describe the data structure of the table schema</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:#7F848E;font-style:italic;">/**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">* </span><span style="color:#C678DD;font-style:italic;">@brief</span><span style="color:#7F848E;font-style:italic;"> Represents the schema information for an entire table.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">*</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">* This class holds the metadata necessary to describe how a specific table is structured,</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">* including its name and the schemas of all its columns.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">*/</span></span> |
| <span class="line"><span style="color:#C678DD;">class</span><span style="color:#E5C07B;"> TableSchema</span><span style="color:#ABB2BF;"> {</span></span> |
| <span class="line"><span style="color:#C678DD;"> public:</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> /**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * Constructs a TableSchema object with the given table name, column schemas, and column categories.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> *</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#E06C75;font-style:italic;"> table_name</span><span style="color:#7F848E;font-style:italic;"> The name of the table. Must be a non-empty string.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * This name is used to identify the table within the system.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#E06C75;font-style:italic;"> column_schemas</span><span style="color:#7F848E;font-style:italic;"> A vector containing ColumnSchema objects.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * Each ColumnSchema defines the schema for one column in the table.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> */</span></span> |
| <span class="line"><span style="color:#61AFEF;"> TableSchema</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;"> table_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;"><</span><span style="color:#E5C07B;">ColumnSchema</span><span style="color:#ABB2BF;">></span><span style="color:#C678DD;">&</span><span style="color:#E06C75;font-style:italic;"> column_schemas</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#ABB2BF;">};</span></span> |
| <span class="line"></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">/**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">* </span><span style="color:#C678DD;font-style:italic;">@brief</span><span style="color:#7F848E;font-style:italic;"> Represents the schema information for a single column.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">*</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">* This structure holds the metadata necessary to describe how a specific column is stored,</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">* including its name, data type, category.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">*/</span></span> |
| <span class="line"><span style="color:#C678DD;">struct</span><span style="color:#E5C07B;"> ColumnSchema</span><span style="color:#ABB2BF;"> {</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> std::string column_name_;</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> common::TSDataType data_type_;</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ColumnCategory column_category_;</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> /**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@brief</span><span style="color:#7F848E;font-style:italic;"> Constructs a ColumnSchema object with the given parameters.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> *</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#E06C75;font-style:italic;"> column_name</span><span style="color:#7F848E;font-style:italic;"> The name of the column. Must be a non-empty string.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * This name is used to identify the column within the table.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#E06C75;font-style:italic;"> data_type</span><span style="color:#7F848E;font-style:italic;"> The data type of the measurement, such as INT32, DOUBLE, TEXT, etc.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * This determines how the data will be stored and interpreted.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#E06C75;font-style:italic;"> column_category</span><span style="color:#7F848E;font-style:italic;"> The category of the column indicating its role or type</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * within the schema, e.g., FIELD, TAG.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * Defaults to ColumnCategory::FIELD if not specified.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@note</span><span style="color:#7F848E;font-style:italic;"> It is the responsibility of the caller to ensure that `column_name` is not empty.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> */</span></span> |
| <span class="line"><span style="color:#61AFEF;"> ColumnSchema</span><span style="color:#ABB2BF;">(std::</span><span style="color:#E5C07B;">string</span><span style="color:#E06C75;font-style:italic;"> column_name</span><span style="color:#ABB2BF;">, common::</span><span style="color:#E5C07B;">TSDataType</span><span style="color:#E06C75;font-style:italic;"> data_type</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> ColumnCategory</span><span style="color:#E06C75;font-style:italic;"> column_category</span><span style="color:#C678DD;"> =</span><span style="color:#ABB2BF;"> ColumnCategory::</span><span style="color:#E5C07B;">FIELD</span><span style="color:#ABB2BF;">) : </span><span style="color:#61AFEF;">column_name_</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">std</span><span style="color:#ABB2BF;">::</span><span style="color:#61AFEF;">move</span><span style="color:#ABB2BF;">(column_name)),</span></span> |
| <span class="line"><span style="color:#61AFEF;"> data_type_</span><span style="color:#ABB2BF;">(data_type),</span></span> |
| <span class="line"><span style="color:#61AFEF;"> column_category_</span><span style="color:#ABB2BF;">(column_category) {</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> }</span></span> |
| <span class="line"><span style="color:#ABB2BF;">};</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">/**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@brief</span><span style="color:#7F848E;font-style:italic;"> Represents the data type of a measurement.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> *</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * This enumeration defines the supported data types for measurements in the system.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> */</span></span> |
| <span class="line"><span style="color:#C678DD;">enum</span><span style="color:#E5C07B;"> TSDataType</span><span style="color:#ABB2BF;"> : </span><span style="color:#C678DD;">uint8_t</span><span style="color:#ABB2BF;"> {</span></span> |
| <span class="line"><span style="color:#E06C75;"> BOOLEAN</span><span style="color:#C678DD;"> =</span><span style="color:#D19A66;"> 0</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> INT32</span><span style="color:#C678DD;"> =</span><span style="color:#D19A66;"> 1</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> INT64</span><span style="color:#C678DD;"> =</span><span style="color:#D19A66;"> 2</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> FLOAT</span><span style="color:#C678DD;"> =</span><span style="color:#D19A66;"> 3</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> DOUBLE</span><span style="color:#C678DD;"> =</span><span style="color:#D19A66;"> 4</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> TEXT</span><span style="color:#C678DD;"> =</span><span style="color:#D19A66;"> 5</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> STRING</span><span style="color:#C678DD;"> =</span><span style="color:#D19A66;"> 11</span></span> |
| <span class="line"><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 class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h3 id="tablet" tabindex="-1"><a class="header-anchor" href="#tablet"><span>Tablet</span></a></h3><p>Write column memory structure</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:#7F848E;font-style:italic;">/**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@brief</span><span style="color:#7F848E;font-style:italic;"> Represents a collection of data rows with associated metadata for insertion into a table.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> *</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * This class is used to manage and organize data that will be inserted into a specific target table.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * It handles the storage of timestamps and values, along with their associated metadata such as column names and types.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> */</span></span> |
| <span class="line"><span style="color:#C678DD;">class</span><span style="color:#E5C07B;"> Tablet</span><span style="color:#ABB2BF;"> {</span></span> |
| <span class="line"><span style="color:#C678DD;">public:</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> /**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@brief</span><span style="color:#7F848E;font-style:italic;"> Constructs a Tablet object with the given parameters.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> *</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#E06C75;font-style:italic;"> column_names</span><span style="color:#7F848E;font-style:italic;"> A vector containing the names of the columns in the tablet.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * Each name corresponds to a column in the target table.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#E06C75;font-style:italic;"> data_types</span><span style="color:#7F848E;font-style:italic;"> A vector containing the data types of each column.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * These must match the schema of the target table.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#E06C75;font-style:italic;"> max_rows</span><span style="color:#7F848E;font-style:italic;"> The maximum number of rows that this tablet can hold. Defaults to DEFAULT_MAX_ROWS.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> */</span></span> |
| <span class="line"><span style="color:#61AFEF;"> Tablet</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;">column_names</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;"><common::</span><span style="color:#E5C07B;">TSDataType</span><span style="color:#ABB2BF;">> </span><span style="color:#C678DD;">&</span><span style="color:#E06C75;font-style:italic;">data_types</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#C678DD;"> int</span><span style="color:#E06C75;font-style:italic;"> max_rows</span><span style="color:#C678DD;"> =</span><span style="color:#ABB2BF;"> DEFAULT_MAX_ROWS);</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> /**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@brief</span><span style="color:#7F848E;font-style:italic;"> Adds a timestamp to the specified row.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> *</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#E06C75;font-style:italic;"> row_index</span><span style="color:#7F848E;font-style:italic;"> The index of the row to which the timestamp will be added.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * Must be less than the maximum number of rows.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#E06C75;font-style:italic;"> timestamp</span><span style="color:#7F848E;font-style:italic;"> The timestamp value to add.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@return</span><span style="color:#7F848E;font-style:italic;"> Returns 0 on success, or a non-zero error code on failure.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> */</span></span> |
| <span class="line"><span style="color:#C678DD;"> int</span><span style="color:#61AFEF;"> add_timestamp</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">uint32_t</span><span style="color:#E06C75;font-style:italic;"> row_index</span><span style="color:#ABB2BF;">, </span><span style="color:#C678DD;">int64_t</span><span style="color:#E06C75;font-style:italic;"> timestamp</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> /**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@brief</span><span style="color:#7F848E;font-style:italic;"> Template function to add a value of type T to the specified row and column.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> *</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@tparam</span><span style="color:#7F848E;font-style:italic;"> T The type of the value to add.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#E06C75;font-style:italic;"> row_index</span><span style="color:#7F848E;font-style:italic;"> The index of the row to which the value will be added.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * Must be less than the maximum number of rows.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#E06C75;font-style:italic;"> schema_index</span><span style="color:#7F848E;font-style:italic;"> The index of the column schema corresponding to the value being added.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#E06C75;font-style:italic;"> val</span><span style="color:#7F848E;font-style:italic;"> The value to add.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@return</span><span style="color:#7F848E;font-style:italic;"> Returns 0 on success, or a non-zero error code on failure.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> */</span></span> |
| <span class="line"><span style="color:#C678DD;"> template</span><span style="color:#ABB2BF;"> <</span><span style="color:#C678DD;">typename</span><span style="color:#E5C07B;"> T</span><span style="color:#ABB2BF;">></span></span> |
| <span class="line"><span style="color:#C678DD;"> int</span><span style="color:#61AFEF;"> add_value</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">uint32_t</span><span style="color:#E06C75;font-style:italic;"> row_index</span><span style="color:#ABB2BF;">, </span><span style="color:#C678DD;">uint32_t</span><span style="color:#E06C75;font-style:italic;"> schema_index</span><span style="color:#ABB2BF;">, </span><span style="color:#E5C07B;">T</span><span style="color:#E06C75;font-style:italic;"> val</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> /**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@brief</span><span style="color:#7F848E;font-style:italic;"> Template function to add a value of type T to the specified row and column by name.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> *</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@tparam</span><span style="color:#7F848E;font-style:italic;"> T The type of the value to add.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#E06C75;font-style:italic;"> row_index</span><span style="color:#7F848E;font-style:italic;"> The index of the row to which the value will be added.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * Must be less than the maximum number of rows.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#E06C75;font-style:italic;"> measurement_name</span><span style="color:#7F848E;font-style:italic;"> The name of the column to which the value will be added.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * Must match one of the column names provided during construction.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#E06C75;font-style:italic;"> val</span><span style="color:#7F848E;font-style:italic;"> The value to add.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@return</span><span style="color:#7F848E;font-style:italic;"> Returns 0 on success, or a non-zero error code on failure.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> */</span></span> |
| <span class="line"><span style="color:#C678DD;"> template</span><span style="color:#ABB2BF;"> <</span><span style="color:#C678DD;">typename</span><span style="color:#E5C07B;"> T</span><span style="color:#ABB2BF;">></span></span> |
| <span class="line"><span style="color:#C678DD;"> int</span><span style="color:#61AFEF;"> add_value</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">uint32_t</span><span style="color:#E06C75;font-style:italic;"> row_index</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;">measurement_name</span><span style="color:#ABB2BF;">, </span><span style="color:#E5C07B;">T</span><span style="color:#E06C75;font-style:italic;"> val</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><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 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><h2 id="read-interface" tabindex="-1"><a class="header-anchor" href="#read-interface"><span>Read Interface</span></a></h2><h3 id="tsfile-reader" tabindex="-1"><a class="header-anchor" href="#tsfile-reader"><span>Tsfile Reader</span></a></h3><p>use to execute query in tsfile and return value by ResultSet.</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:#7F848E;font-style:italic;">/**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@brief</span><span style="color:#7F848E;font-style:italic;"> TsfileReader provides the ability to query all files with the suffix</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * .tsfile</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> *</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * TsfileReader is designed to query .tsfile files, it accepts tree model</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * queries and table model queries, and supports querying metadata such as</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * TableSchema and TimeseriesSchema.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> */</span></span> |
| <span class="line"><span style="color:#C678DD;">class</span><span style="color:#E5C07B;"> TsFileReader</span><span style="color:#ABB2BF;"> {</span></span> |
| <span class="line"><span style="color:#C678DD;"> public:</span></span> |
| <span class="line"><span style="color:#61AFEF;"> TsFileReader</span><span style="color:#ABB2BF;">();</span></span> |
| <span class="line"><span style="color:#61AFEF;"> ~TsFileReader</span><span style="color:#ABB2BF;">();</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> /**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@brief</span><span style="color:#7F848E;font-style:italic;"> open the tsfile</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> *</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#E06C75;font-style:italic;"> file_path</span><span style="color:#7F848E;font-style:italic;"> the path of the tsfile which will be opened</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@return</span><span style="color:#7F848E;font-style:italic;"> Returns 0 on success, or a non-zero error code on failure.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> */</span></span> |
| <span class="line"><span style="color:#C678DD;"> int</span><span style="color:#61AFEF;"> open</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;">file_path</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> /**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@brief</span><span style="color:#7F848E;font-style:italic;"> close the tsfile, this method should be called after the</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * query is finished</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> *</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@return</span><span style="color:#7F848E;font-style:italic;"> Returns 0 on success, or a non-zero error code on failure.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> */</span></span> |
| <span class="line"><span style="color:#C678DD;"> int</span><span style="color:#61AFEF;"> close</span><span style="color:#ABB2BF;">();</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> /**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@brief</span><span style="color:#7F848E;font-style:italic;"> query the tsfile by the query expression,Users can construct</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * their own query expressions to query tsfile</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> *</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#7F848E;font-style:italic;"> [</span><span style="color:#C678DD;font-style:italic;">in</span><span style="color:#7F848E;font-style:italic;">] </span><span style="color:#E06C75;font-style:italic;">qe</span><span style="color:#7F848E;font-style:italic;"> the query expression</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#7F848E;font-style:italic;"> [</span><span style="color:#C678DD;font-style:italic;">out</span><span style="color:#7F848E;font-style:italic;">] </span><span style="color:#E06C75;font-style:italic;">ret_qds</span><span style="color:#7F848E;font-style:italic;"> the result set</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@return</span><span style="color:#7F848E;font-style:italic;"> Returns 0 on success, or a non-zero error code on failure.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> */</span></span> |
| <span class="line"><span style="color:#C678DD;"> int</span><span style="color:#61AFEF;"> query</span><span style="color:#ABB2BF;">(storage::</span><span style="color:#E5C07B;">QueryExpression</span><span style="color:#C678DD;"> *</span><span style="color:#E06C75;font-style:italic;">qe</span><span style="color:#ABB2BF;">, </span><span style="color:#E5C07B;">ResultSet</span><span style="color:#C678DD;"> *&</span><span style="color:#E06C75;font-style:italic;">ret_qds</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> /**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@brief</span><span style="color:#7F848E;font-style:italic;"> query the tsfile by the path list, start time and end time</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * this method is used to query the tsfile by the tree model.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> *</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#7F848E;font-style:italic;"> [</span><span style="color:#C678DD;font-style:italic;">in</span><span style="color:#7F848E;font-style:italic;">] </span><span style="color:#E06C75;font-style:italic;">path_list</span><span style="color:#7F848E;font-style:italic;"> the path list</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#7F848E;font-style:italic;"> [</span><span style="color:#C678DD;font-style:italic;">in</span><span style="color:#7F848E;font-style:italic;">] </span><span style="color:#E06C75;font-style:italic;">start_time</span><span style="color:#7F848E;font-style:italic;"> the start time</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#7F848E;font-style:italic;"> [</span><span style="color:#C678DD;font-style:italic;">in</span><span style="color:#7F848E;font-style:italic;">] </span><span style="color:#E06C75;font-style:italic;">end_time</span><span style="color:#7F848E;font-style:italic;"> the end time</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#7F848E;font-style:italic;"> [</span><span style="color:#C678DD;font-style:italic;">out</span><span style="color:#7F848E;font-style:italic;">] </span><span style="color:#E06C75;font-style:italic;">result_set</span><span style="color:#7F848E;font-style:italic;"> the result set</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> */</span></span> |
| <span class="line"><span style="color:#C678DD;"> int</span><span style="color:#61AFEF;"> query</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;">path_list</span><span style="color:#ABB2BF;">, </span><span style="color:#C678DD;">int64_t</span><span style="color:#E06C75;font-style:italic;"> start_time</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#C678DD;"> int64_t</span><span style="color:#E06C75;font-style:italic;"> end_time</span><span style="color:#ABB2BF;">, </span><span style="color:#E5C07B;">ResultSet</span><span style="color:#C678DD;"> *&</span><span style="color:#E06C75;font-style:italic;">result_set</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> /**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@brief</span><span style="color:#7F848E;font-style:italic;"> query the tsfile by the table name, columns names, start time</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * and end time. this method is used to query the tsfile by the table</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * model.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> *</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#7F848E;font-style:italic;"> [</span><span style="color:#C678DD;font-style:italic;">in</span><span style="color:#7F848E;font-style:italic;">] </span><span style="color:#E06C75;font-style:italic;">table_name</span><span style="color:#7F848E;font-style:italic;"> the table name</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#7F848E;font-style:italic;"> [</span><span style="color:#C678DD;font-style:italic;">in</span><span style="color:#7F848E;font-style:italic;">] </span><span style="color:#E06C75;font-style:italic;">columns_names</span><span style="color:#7F848E;font-style:italic;"> the columns names</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#7F848E;font-style:italic;"> [</span><span style="color:#C678DD;font-style:italic;">in</span><span style="color:#7F848E;font-style:italic;">] </span><span style="color:#E06C75;font-style:italic;">start_time</span><span style="color:#7F848E;font-style:italic;"> the start time</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#7F848E;font-style:italic;"> [</span><span style="color:#C678DD;font-style:italic;">in</span><span style="color:#7F848E;font-style:italic;">] </span><span style="color:#E06C75;font-style:italic;">end_time</span><span style="color:#7F848E;font-style:italic;"> the end time</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#7F848E;font-style:italic;"> [</span><span style="color:#C678DD;font-style:italic;">out</span><span style="color:#7F848E;font-style:italic;">] </span><span style="color:#E06C75;font-style:italic;">result_set</span><span style="color:#7F848E;font-style:italic;"> the result set</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> */</span></span> |
| <span class="line"><span style="color:#C678DD;"> int</span><span style="color:#61AFEF;"> query</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;">table_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;">columns_names</span><span style="color:#ABB2BF;">, </span><span style="color:#C678DD;">int64_t</span><span style="color:#E06C75;font-style:italic;"> start_time</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#C678DD;"> int64_t</span><span style="color:#E06C75;font-style:italic;"> end_time</span><span style="color:#ABB2BF;">, </span><span style="color:#E5C07B;">ResultSet</span><span style="color:#C678DD;"> *&</span><span style="color:#E06C75;font-style:italic;">result_set</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> /**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@brief</span><span style="color:#7F848E;font-style:italic;"> query the tsfile by the table name, columns names, start time</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * and end time, tag filter. this method is used to query the tsfile by the</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * table model.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> *</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#7F848E;font-style:italic;"> [</span><span style="color:#C678DD;font-style:italic;">in</span><span style="color:#7F848E;font-style:italic;">] </span><span style="color:#E06C75;font-style:italic;">table_name</span><span style="color:#7F848E;font-style:italic;"> the table name</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#7F848E;font-style:italic;"> [</span><span style="color:#C678DD;font-style:italic;">in</span><span style="color:#7F848E;font-style:italic;">] </span><span style="color:#E06C75;font-style:italic;">columns_names</span><span style="color:#7F848E;font-style:italic;"> the columns names</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#7F848E;font-style:italic;"> [</span><span style="color:#C678DD;font-style:italic;">in</span><span style="color:#7F848E;font-style:italic;">] </span><span style="color:#E06C75;font-style:italic;">start_time</span><span style="color:#7F848E;font-style:italic;"> the start time</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#7F848E;font-style:italic;"> [</span><span style="color:#C678DD;font-style:italic;">in</span><span style="color:#7F848E;font-style:italic;">] </span><span style="color:#E06C75;font-style:italic;">end_time</span><span style="color:#7F848E;font-style:italic;"> the end time</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#7F848E;font-style:italic;"> [</span><span style="color:#C678DD;font-style:italic;">in</span><span style="color:#7F848E;font-style:italic;">] </span><span style="color:#E06C75;font-style:italic;">tag_filter</span><span style="color:#7F848E;font-style:italic;"> the tag filter</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#7F848E;font-style:italic;"> [</span><span style="color:#C678DD;font-style:italic;">out</span><span style="color:#7F848E;font-style:italic;">] </span><span style="color:#E06C75;font-style:italic;">result_set</span><span style="color:#7F848E;font-style:italic;"> the result set</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> */</span></span> |
| <span class="line"><span style="color:#C678DD;"> int</span><span style="color:#61AFEF;"> query</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;"> table_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;"> columns_names</span><span style="color:#ABB2BF;">, </span><span style="color:#C678DD;">int64_t</span><span style="color:#E06C75;font-style:italic;"> start_time</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#C678DD;"> int64_t</span><span style="color:#E06C75;font-style:italic;"> end_time</span><span style="color:#ABB2BF;">, </span><span style="color:#E5C07B;">ResultSet</span><span style="color:#C678DD;">*&</span><span style="color:#E06C75;font-style:italic;"> result_set</span><span style="color:#ABB2BF;">, </span><span style="color:#E5C07B;">Filter</span><span style="color:#C678DD;">*</span><span style="color:#E06C75;font-style:italic;"> tag_filter</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> /**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@brief</span><span style="color:#7F848E;font-style:italic;"> destroy the result set, this method should be called after the</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * query is finished and result_set</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> *</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#E06C75;font-style:italic;"> qds</span><span style="color:#7F848E;font-style:italic;"> the result set</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> */</span></span> |
| <span class="line"><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> destroy_query_data_set</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">ResultSet</span><span style="color:#C678DD;"> *</span><span style="color:#E06C75;font-style:italic;">qds</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#E5C07B;"> ResultSet</span><span style="color:#C678DD;"> *</span><span style="color:#61AFEF;">read_timeseries</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;">shared_ptr</span><span style="color:#ABB2BF;"><</span><span style="color:#E5C07B;">IDeviceID</span><span style="color:#ABB2BF;">> </span><span style="color:#C678DD;">&</span><span style="color:#E06C75;font-style:italic;">device_id</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;">measurement_name</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> /**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@brief</span><span style="color:#7F848E;font-style:italic;"> get all devices in the tsfile</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> *</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#E06C75;font-style:italic;"> table_name</span><span style="color:#7F848E;font-style:italic;"> the table name</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@return</span><span style="color:#7F848E;font-style:italic;"> std::vector<std::shared_ptr<IDeviceID>> the device id list</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> */</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;"><std::</span><span style="color:#E5C07B;">shared_ptr</span><span style="color:#ABB2BF;"><</span><span style="color:#E5C07B;">IDeviceID</span><span style="color:#ABB2BF;">>> </span><span style="color:#61AFEF;">get_all_devices</span><span style="color:#ABB2BF;">(</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">string</span><span style="color:#E06C75;font-style:italic;"> table_name</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> /**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@brief</span><span style="color:#7F848E;font-style:italic;"> get the timeseries schema by the device id and measurement name</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> *</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#7F848E;font-style:italic;"> [</span><span style="color:#C678DD;font-style:italic;">in</span><span style="color:#7F848E;font-style:italic;">] </span><span style="color:#E06C75;font-style:italic;">device_id</span><span style="color:#7F848E;font-style:italic;"> the device id</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#7F848E;font-style:italic;"> [</span><span style="color:#C678DD;font-style:italic;">out</span><span style="color:#7F848E;font-style:italic;">] </span><span style="color:#E06C75;font-style:italic;">result</span><span style="color:#7F848E;font-style:italic;"> std::vector<MeasurementSchema> the measurement schema</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * list</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@return</span><span style="color:#7F848E;font-style:italic;"> Returns 0 on success, or a non-zero error code on failure.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> */</span></span> |
| <span class="line"><span style="color:#C678DD;"> int</span><span style="color:#61AFEF;"> get_timeseries_schema</span><span style="color:#ABB2BF;">(std::</span><span style="color:#E5C07B;">shared_ptr</span><span style="color:#ABB2BF;"><</span><span style="color:#E5C07B;">IDeviceID</span><span style="color:#ABB2BF;">> </span><span style="color:#E06C75;font-style:italic;">device_id</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:#E5C07B;">MeasurementSchema</span><span style="color:#ABB2BF;">> </span><span style="color:#C678DD;">&</span><span style="color:#E06C75;font-style:italic;">result</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> /**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@brief</span><span style="color:#7F848E;font-style:italic;"> get the table schema by the table name</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> *</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#E06C75;font-style:italic;"> table_name</span><span style="color:#7F848E;font-style:italic;"> the table name</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@return</span><span style="color:#7F848E;font-style:italic;"> std::shared_ptr<TableSchema> the table schema</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> */</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">shared_ptr</span><span style="color:#ABB2BF;"><</span><span style="color:#E5C07B;">TableSchema</span><span style="color:#ABB2BF;">> </span><span style="color:#61AFEF;">get_table_schema</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;">table_name</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> /**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@brief</span><span style="color:#7F848E;font-style:italic;"> get all table schemas in the tsfile</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> *</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@return</span><span style="color:#7F848E;font-style:italic;"> std::vector<std::shared_ptr<TableSchema>> the table schema list</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> */</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">vector</span><span style="color:#ABB2BF;"><std::</span><span style="color:#E5C07B;">shared_ptr</span><span style="color:#ABB2BF;"><</span><span style="color:#E5C07B;">TableSchema</span><span style="color:#ABB2BF;">>> </span><span style="color:#61AFEF;">get_all_table_schemas</span><span style="color:#ABB2BF;">();</span></span> |
| <span class="line"><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 class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div 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="resultset" tabindex="-1"><a class="header-anchor" href="#resultset"><span>ResultSet</span></a></h3><p>A collection of query.Support iterator to get data, and directly through the column name or index to get specific data.</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:#7F848E;font-style:italic;">/**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@brief</span><span style="color:#7F848E;font-style:italic;"> ResultSet is the query result of the TsfileReader. It provides access</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * to the results.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> *</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * ResultSet is a virtual class. Convert it to the corresponding implementation</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * class when used</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@note</span><span style="color:#7F848E;font-style:italic;"> When using the tree model and the filter is a global time filter,</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * it should be cast as QDSWithoutTimeGenerator.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@note</span><span style="color:#7F848E;font-style:italic;"> When using the tree model and the filter is not a global time filter,</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * it should be QDSWithTimeGenerator.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@note</span><span style="color:#7F848E;font-style:italic;"> If the query uses the table model, the cast should be TableResultSet</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> */</span></span> |
| <span class="line"><span style="color:#C678DD;">class</span><span style="color:#E5C07B;"> ResultSet</span><span style="color:#ABB2BF;"> {</span></span> |
| <span class="line"><span style="color:#C678DD;"> public:</span></span> |
| <span class="line"><span style="color:#61AFEF;"> ResultSet</span><span style="color:#ABB2BF;">() {}</span></span> |
| <span class="line"><span style="color:#C678DD;"> virtual</span><span style="color:#61AFEF;"> ~ResultSet</span><span style="color:#ABB2BF;">() {}</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> /**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@brief</span><span style="color:#7F848E;font-style:italic;"> Get the next row of the result set</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> *</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#7F848E;font-style:italic;">[</span><span style="color:#C678DD;font-style:italic;">out</span><span style="color:#7F848E;font-style:italic;">] </span><span style="color:#E06C75;font-style:italic;">has_next</span><span style="color:#7F848E;font-style:italic;"> a boolean value indicating if there is a next row</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@return</span><span style="color:#7F848E;font-style:italic;"> Returns 0 on success, or a non-zero error code on failure.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> */</span></span> |
| <span class="line"><span style="color:#C678DD;"> virtual</span><span style="color:#C678DD;"> int</span><span style="color:#61AFEF;"> next</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">bool&</span><span style="color:#E06C75;font-style:italic;"> has_next</span><span style="color:#ABB2BF;">) </span><span style="color:#C678DD;">=</span><span style="color:#D19A66;"> 0</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> /**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@brief</span><span style="color:#7F848E;font-style:italic;"> Check if the value of the column is null by column name</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> *</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#E06C75;font-style:italic;"> column_name</span><span style="color:#7F848E;font-style:italic;"> the name of the column</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@return</span><span style="color:#7F848E;font-style:italic;"> true if the value is null, false otherwise</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> */</span></span> |
| <span class="line"><span style="color:#C678DD;"> virtual</span><span style="color:#C678DD;"> bool</span><span style="color:#61AFEF;"> is_null</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;"> column_name</span><span style="color:#ABB2BF;">) </span><span style="color:#C678DD;">=</span><span style="color:#D19A66;"> 0</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> /**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@brief</span><span style="color:#7F848E;font-style:italic;"> Check if the value of the column is null by column index</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> *</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#E06C75;font-style:italic;"> column_index</span><span style="color:#7F848E;font-style:italic;"> the index of the column starting from 1</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@return</span><span style="color:#7F848E;font-style:italic;"> true if the value is null, false otherwise</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> */</span></span> |
| <span class="line"><span style="color:#C678DD;"> virtual</span><span style="color:#C678DD;"> bool</span><span style="color:#61AFEF;"> is_null</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">uint32_t</span><span style="color:#E06C75;font-style:italic;"> column_index</span><span style="color:#ABB2BF;">) </span><span style="color:#C678DD;">=</span><span style="color:#D19A66;"> 0</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> /**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@brief</span><span style="color:#7F848E;font-style:italic;"> Get the value of the column by column name</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> *</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#E06C75;font-style:italic;"> column_name</span><span style="color:#7F848E;font-style:italic;"> the name of the column</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@return</span><span style="color:#7F848E;font-style:italic;"> the value of the column</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> */</span></span> |
| <span class="line"><span style="color:#C678DD;"> template</span><span style="color:#ABB2BF;"> <</span><span style="color:#C678DD;">typename</span><span style="color:#E5C07B;"> T</span><span style="color:#ABB2BF;">></span></span> |
| <span class="line"><span style="color:#E5C07B;"> T</span><span style="color:#61AFEF;"> get_value</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;"> column_name</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#C678DD;"> *</span><span style="color:#ABB2BF;"> @brief Get the value of the column by column index</span></span> |
| <span class="line"><span style="color:#C678DD;"> *</span></span> |
| <span class="line"><span style="color:#C678DD;"> *</span><span style="color:#ABB2BF;"> @param column_index the index of the column starting from </span><span style="color:#D19A66;">1</span></span> |
| <span class="line"><span style="color:#C678DD;"> *</span><span style="color:#ABB2BF;"> @</span><span style="color:#C678DD;">return</span><span style="color:#ABB2BF;"> the value of the column</span></span> |
| <span class="line"><span style="color:#FFFFFF;"> */</span></span> |
| <span class="line"><span style="color:#C678DD;"> template</span><span style="color:#ABB2BF;"> <</span><span style="color:#C678DD;">typename</span><span style="color:#E5C07B;"> T</span><span style="color:#ABB2BF;">></span></span> |
| <span class="line"><span style="color:#E5C07B;"> T</span><span style="color:#61AFEF;"> get_value</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">uint32_t</span><span style="color:#E06C75;font-style:italic;"> column_index</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> /**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@brief</span><span style="color:#7F848E;font-style:italic;"> Get the row record of the result set</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> *</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@return</span><span style="color:#7F848E;font-style:italic;"> the row record</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> */</span></span> |
| <span class="line"><span style="color:#C678DD;"> virtual</span><span style="color:#E5C07B;"> RowRecord</span><span style="color:#C678DD;">*</span><span style="color:#61AFEF;"> get_row_record</span><span style="color:#ABB2BF;">() </span><span style="color:#C678DD;">=</span><span style="color:#D19A66;"> 0</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> /**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@brief</span><span style="color:#7F848E;font-style:italic;"> Get the metadata of the result set</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> *</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@return</span><span style="color:#7F848E;font-style:italic;"> std::shared_ptr<ResultSetMetadata> the metadata of the result set</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> */</span></span> |
| <span class="line"><span style="color:#C678DD;"> virtual</span><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">shared_ptr</span><span style="color:#ABB2BF;"><</span><span style="color:#E5C07B;">ResultSetMetadata</span><span style="color:#ABB2BF;">> </span><span style="color:#61AFEF;">get_metadata</span><span style="color:#ABB2BF;">() </span><span style="color:#C678DD;">=</span><span style="color:#D19A66;"> 0</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> /**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@brief</span><span style="color:#7F848E;font-style:italic;"> Close the result set</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> *</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@note</span><span style="color:#7F848E;font-style:italic;"> this method should be called after the result set is no longer</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * needed.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> */</span></span> |
| <span class="line"><span style="color:#C678DD;"> virtual</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> close</span><span style="color:#ABB2BF;">() </span><span style="color:#C678DD;">=</span><span style="color:#D19A66;"> 0</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><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 class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h3 id="resultmeta" tabindex="-1"><a class="header-anchor" href="#resultmeta"><span>ResultMeta</span></a></h3><p>user can obtain the metadata from ResultSetMetadata, including all columnnames and data types. When a user uses a table model, the first columndefaults to the time column.</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:#7F848E;font-style:italic;">/**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@brief</span><span style="color:#7F848E;font-style:italic;"> metadata of result set</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> *</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * user can obtain the metadata from ResultSetMetadata, including all column</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * names and data types. When a user uses the table model, the first column</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * defaults to the time column.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> */</span></span> |
| <span class="line"><span style="color:#C678DD;">class</span><span style="color:#E5C07B;"> ResultSetMetadata</span><span style="color:#ABB2BF;"> {</span></span> |
| <span class="line"><span style="color:#C678DD;"> public:</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> /**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@brief</span><span style="color:#7F848E;font-style:italic;"> constructor of ResultSetMetadata</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> *</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#E06C75;font-style:italic;"> column_names</span><span style="color:#7F848E;font-style:italic;"> the column names</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#E06C75;font-style:italic;"> column_types</span><span style="color:#7F848E;font-style:italic;"> the column types</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> */</span></span> |
| <span class="line"><span style="color:#61AFEF;"> ResultSetMetadata</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;"> column_names</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;"><common::</span><span style="color:#E5C07B;">TSDataType</span><span style="color:#ABB2BF;">></span><span style="color:#C678DD;">&</span><span style="color:#E06C75;font-style:italic;"> column_types</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> /**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@brief</span><span style="color:#7F848E;font-style:italic;"> get the column type</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> *</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#E06C75;font-style:italic;"> column_index</span><span style="color:#7F848E;font-style:italic;"> the column index starting from 1</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@return</span><span style="color:#7F848E;font-style:italic;"> the column type</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> */</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> common::</span><span style="color:#E5C07B;">TSDataType</span><span style="color:#61AFEF;"> get_column_type</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">uint32_t</span><span style="color:#E06C75;font-style:italic;"> column_index</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> /**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@brief</span><span style="color:#7F848E;font-style:italic;"> get the column name</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> *</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#E06C75;font-style:italic;"> column_index</span><span style="color:#7F848E;font-style:italic;"> the column index starting from 1</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@return</span><span style="color:#7F848E;font-style:italic;"> the column name</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> */</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> std::</span><span style="color:#E5C07B;">string</span><span style="color:#61AFEF;"> get_column_name</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">uint32_t</span><span style="color:#E06C75;font-style:italic;"> column_index</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> /**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@brief</span><span style="color:#7F848E;font-style:italic;"> get the column count</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> *</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@return</span><span style="color:#7F848E;font-style:italic;"> the column count by uint32_t</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> */</span></span> |
| <span class="line"><span style="color:#C678DD;"> uint32_t</span><span style="color:#61AFEF;"> get_column_count</span><span style="color:#ABB2BF;">();</span></span> |
| <span class="line"><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 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="filter" tabindex="-1"><a class="header-anchor" href="#filter"><span>Filter</span></a></h3><h4 id="tagfilterbuilder" tabindex="-1"><a class="header-anchor" href="#tagfilterbuilder"><span>TagFilterBuilder</span></a></h4><p>Used to construct tag-based filters for querying data</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;">class</span><span style="color:#E5C07B;"> TagFilterBuilder</span><span style="color:#ABB2BF;"> {</span></span> |
| <span class="line"><span style="color:#C678DD;"> public:</span></span> |
| <span class="line"><span style="color:#C678DD;"> explicit</span><span style="color:#61AFEF;"> TagFilterBuilder</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">TableSchema</span><span style="color:#C678DD;">*</span><span style="color:#E06C75;font-style:italic;"> schema</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#E5C07B;"> Filter</span><span style="color:#C678DD;">*</span><span style="color:#61AFEF;"> eq</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;"> columnName</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;"> value</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#E5C07B;"> Filter</span><span style="color:#C678DD;">*</span><span style="color:#61AFEF;"> neq</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;"> columnName</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;"> value</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#E5C07B;"> Filter</span><span style="color:#C678DD;">*</span><span style="color:#61AFEF;"> lt</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;"> columnName</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;"> value</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#E5C07B;"> Filter</span><span style="color:#C678DD;">*</span><span style="color:#61AFEF;"> lteq</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;"> columnName</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;"> value</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#E5C07B;"> Filter</span><span style="color:#C678DD;">*</span><span style="color:#61AFEF;"> gt</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;"> columnName</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;"> value</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#E5C07B;"> Filter</span><span style="color:#C678DD;">*</span><span style="color:#61AFEF;"> gteq</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;"> columnName</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;"> value</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#E5C07B;"> Filter</span><span style="color:#C678DD;">*</span><span style="color:#61AFEF;"> reg_exp</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;"> columnName</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;"> value</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#E5C07B;"> Filter</span><span style="color:#C678DD;">*</span><span style="color:#61AFEF;"> not_reg_exp</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;"> columnName</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;"> value</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#E5C07B;"> Filter</span><span style="color:#C678DD;">*</span><span style="color:#61AFEF;"> between_and</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;"> columnName</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;"> lower</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;"> upper</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#E5C07B;"> Filter</span><span style="color:#C678DD;">*</span><span style="color:#61AFEF;"> not_between_and</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;"> columnName</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;"> lower</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;"> upper</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> // Logical operations</span></span> |
| <span class="line"><span style="color:#C678DD;"> static</span><span style="color:#E5C07B;"> Filter</span><span style="color:#C678DD;">*</span><span style="color:#61AFEF;"> and_filter</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">Filter</span><span style="color:#C678DD;">*</span><span style="color:#E06C75;font-style:italic;"> left</span><span style="color:#ABB2BF;">, </span><span style="color:#E5C07B;">Filter</span><span style="color:#C678DD;">*</span><span style="color:#E06C75;font-style:italic;"> right</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#C678DD;"> static</span><span style="color:#E5C07B;"> Filter</span><span style="color:#C678DD;">*</span><span style="color:#61AFEF;"> or_filter</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">Filter</span><span style="color:#C678DD;">*</span><span style="color:#E06C75;font-style:italic;"> left</span><span style="color:#ABB2BF;">, </span><span style="color:#E5C07B;">Filter</span><span style="color:#C678DD;">*</span><span style="color:#E06C75;font-style:italic;"> right</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#C678DD;"> static</span><span style="color:#E5C07B;"> Filter</span><span style="color:#C678DD;">*</span><span style="color:#61AFEF;"> not_filter</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">Filter</span><span style="color:#C678DD;">*</span><span style="color:#E06C75;font-style:italic;"> filter</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><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></div></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/tsfile/edit/docs/dev/src/UserGuide/develop/QuickStart/InterfaceDefinition/InterfaceDefinition-CPP.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">1/9/2026, 1:45:21 AM</span></div><!----></div></footer><!----><!----><!----><!--]--></main><!--]--><footer style="padding-bottom:1rem;padding-top:1rem;"><span id="doc-version" style="display:none;">latest</span><p style="text-align:center;color:#909399;font-size:12px;margin:0 30px;">Copyright © 2026 The Apache Software Foundation.<br> Apache and the Apache feather logo are trademarks of The Apache Software Foundation</p><p style="text-align:center;margin-top:10px;color:#909399;font-size:12px;margin:0 30px;"><strong>Have a question?</strong> Connect with us on issues. </p></footer></div><!--]--><!--]--><!--[--><!----><!--[--><!--]--><!--]--><!--]--></div> |
| <script type="module" src="/assets/app-xkEPX-KM.js" defer></script> |
| </body> |
| </html> |
