| <!doctype html> |
| <html lang="en-US" data-theme="light"> |
| <head> |
| <meta charset="utf-8" /> |
| <meta name="viewport" content="width=device-width,initial-scale=1" /> |
| <meta name="generator" content="VuePress 2.0.0-rc.19" /> |
| <meta name="theme" content="VuePress Theme Hope 2.0.0-rc.71" /> |
| <style> |
| :root { |
| --vp-c-bg: #fff; |
| } |
| |
| [data-theme="dark"] { |
| --vp-c-bg: #1b1b1f; |
| } |
| |
| html, |
| body { |
| background: var(--vp-c-bg); |
| } |
| </style> |
| <script> |
| const userMode = localStorage.getItem("vuepress-theme-hope-scheme"); |
| const systemDarkMode = |
| window.matchMedia && |
| window.matchMedia("(prefers-color-scheme: dark)").matches; |
| |
| if (userMode === "dark" || (userMode !== "light" && systemDarkMode)) { |
| document.documentElement.setAttribute("data-theme", "dark"); |
| } |
| </script> |
| <link rel="alternate" hreflang="zh-cn" href="https://iotdb.apache.org/zh/UserGuide/latest/API/Programming-Java-Native-API.html"><meta property="og:url" content="https://iotdb.apache.org/UserGuide/latest/API/Programming-Java-Native-API.html"><meta property="og:site_name" content="IoTDB Website"><meta property="og:title" content="Java Native API"><meta property="og:description" content="Java Native API In the native API of IoTDB, the Session is the core interface for interacting with the database. It integrates a rich set of methods that support data writing, q..."><meta property="og:type" content="article"><meta property="og:locale" content="en-US"><meta property="og:locale:alternate" content="zh-CN"><meta property="og:updated_time" content="2025-03-05T10:17:06.000Z"><meta property="article:modified_time" content="2025-03-05T10:17:06.000Z"><script type="application/ld+json">{"@context":"https://schema.org","@type":"Article","headline":"Java Native API","image":[""],"dateModified":"2025-03-05T10:17:06.000Z","author":[]}</script><link rel="icon" href="/favicon.ico"><meta name="Description" content="Apache IoTDB: Time Series Database for IoT"><meta name="Keywords" content="TSDB, time series, time series database, IoTDB, IoT database, IoT data management, 时序数据库, 时间序列管理, IoTDB, 物联网数据库, 实时数据库, 物联网数据管理, 物联网数据"><meta name="baidu-site-verification" content="wfKETzB3OT"><meta name="google-site-verification" content="mZWAoRY0yj_HAr-s47zHCGHzx5Ju-RVm5wDbPnwQYFo"><script type="text/javascript">var _paq = window._paq = window._paq || []; |
| /* tracker methods like "setCustomDimension" should be called before "trackPageView" */ |
| _paq.push(["setDoNotTrack", true]); |
| _paq.push(["disableCookies"]); |
| _paq.push(['trackPageView']); |
| _paq.push(['enableLinkTracking']); |
| (function() { |
| var u="https://analytics.apache.org/"; |
| _paq.push(['setTrackerUrl', u+'matomo.php']); |
| _paq.push(['setSiteId', '56']); |
| var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; |
| g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s); |
| })(); |
| </script><title>Java Native API | IoTDB Website</title><meta name="description" content="Java Native API In the native API of IoTDB, the Session is the core interface for interacting with the database. It integrates a rich set of methods that support data writing, q..."> |
| <link rel="preload" href="/assets/style-CI4qIzxp.css" as="style"><link rel="stylesheet" href="/assets/style-CI4qIzxp.css"> |
| <link rel="modulepreload" href="/assets/app-C-fAkKj6.js"><link rel="modulepreload" href="/assets/Programming-Java-Native-API.html-duQhhgpv.js"> |
| |
| </head> |
| <body> |
| <div id="app"><!--[--><!--[--><!--[--><span tabindex="-1"></span><a href="#main-content" class="vp-skip-link sr-only">Skip to main content</a><!--]--><!--[--><div class="theme-container external-link-icon has-toc" vp-container><!--[--><header id="navbar" class="vp-navbar" vp-navbar><div class="vp-navbar-start"><button type="button" class="vp-toggle-sidebar-button" title="Toggle Sidebar"><span class="icon"></span></button><!--[--><a class="route-link vp-brand" href="/" aria-label="Take me home"><img class="vp-nav-logo" src="/logo.png" alt><!----><!----></a><!--]--></div><div class="vp-navbar-center"><!--[--><!--]--></div><div class="vp-navbar-end"><!--[--><!--[--><div id="docsearch-container" style="display:none;"></div><div><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"><kbd class="DocSearch-Button-Key"><svg width="15" height="15" class="DocSearch-Control-Key-Icon"><path d="M4.505 4.496h2M5.505 5.496v5M8.216 4.496l.055 5.993M10 7.5c.333.333.5.667.5 1v2M12.326 4.5v5.996M8.384 4.496c1.674 0 2.116 0 2.116 1.5s-.442 1.5-2.116 1.5M3.205 9.303c-.09.448-.277 1.21-1.241 1.203C1 10.5.5 9.513.5 8V7c0-1.57.5-2.5 1.464-2.494.964.006 1.134.598 1.24 1.342M12.553 10.5h1.953" stroke-width="1.2" stroke="currentColor" fill="none" stroke-linecap="square"></path></svg></kbd><kbd class="DocSearch-Button-Key">K</kbd></span></button></div><!--]--><nav class="vp-nav-links"><div class="vp-nav-item hide-in-mobile"><div class="vp-dropdown-wrapper"><button type="button" class="vp-dropdown-title" aria-label="Documentation"><!--[--><!---->Documentation<!--]--><span class="arrow"></span><ul class="vp-dropdown"><li class="vp-dropdown-item"><a class="route-link auto-link" href="/UserGuide/latest/QuickStart/QuickStart_apache.html" aria-label="v2.0.x" iconsizing="both"><!---->v2.0.x<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/UserGuide/V1.3.x/QuickStart/QuickStart_apache.html" aria-label="v1.3.x" iconsizing="both"><!---->v1.3.x<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/UserGuide/V1.2.x/QuickStart/QuickStart.html" aria-label="v1.2.x" iconsizing="both"><!---->v1.2.x<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/UserGuide/V0.13.x/QuickStart/QuickStart.html" aria-label="v0.13.x" iconsizing="both"><!---->v0.13.x<!----></a></li></ul></button></div></div><div class="vp-nav-item hide-in-mobile"><a class="auto-link external-link" href="https://cwiki.apache.org/confluence/display/IOTDB/System+Design" aria-label="Design" rel="noopener noreferrer" target="_blank" iconsizing="height"><!---->Design<!----></a></div><div class="vp-nav-item hide-in-mobile"><a class="route-link auto-link" href="/Download/" aria-label="Download" iconsizing="height"><!---->Download<!----></a></div><div class="vp-nav-item hide-in-mobile"><div class="vp-dropdown-wrapper"><button type="button" class="vp-dropdown-title" aria-label="Community"><!--[--><!---->Community<!--]--><span class="arrow"></span><ul class="vp-dropdown"><li class="vp-dropdown-item"><a class="route-link auto-link" href="/Community/About-the-Community.html" aria-label="About the Community" iconsizing="both"><!---->About the Community<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/Community/Development-Guide.html" aria-label="Development Guide" iconsizing="both"><!---->Development Guide<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/Community/Community-Partners.html" aria-label="Community Partners" iconsizing="both"><!---->Community Partners<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/Community/Communication-Channels.html" aria-label="Communication Channels" iconsizing="both"><!---->Communication Channels<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/Community/Events-and-Reports.html" aria-label="Events and Reports" iconsizing="both"><!---->Events and Reports<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/Community/Committers.html" aria-label="Committers" iconsizing="both"><!---->Committers<!----></a></li></ul></button></div></div><div class="vp-nav-item hide-in-mobile"><div class="vp-dropdown-wrapper"><button type="button" class="vp-dropdown-title" aria-label="ASF"><!--[--><!---->ASF<!--]--><span class="arrow"></span><ul class="vp-dropdown"><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/" aria-label="Foundation" rel="noopener noreferrer" target="_blank" iconsizing="both"><!---->Foundation<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/licenses/" aria-label="License" rel="noopener noreferrer" target="_blank" iconsizing="both"><!---->License<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/security/" aria-label="Security" rel="noopener noreferrer" target="_blank" iconsizing="both"><!---->Security<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/foundation/sponsorship.html" aria-label="Sponsorship" rel="noopener noreferrer" target="_blank" iconsizing="both"><!---->Sponsorship<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/foundation/thanks.html" aria-label="Thanks" rel="noopener noreferrer" target="_blank" iconsizing="both"><!---->Thanks<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/events/current-event" aria-label="Current Events" rel="noopener noreferrer" target="_blank" iconsizing="both"><!---->Current Events<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://privacy.apache.org/policies/privacy-policy-public.html" aria-label="Privacy" rel="noopener noreferrer" target="_blank" iconsizing="both"><!---->Privacy<!----></a></li></ul></button></div></div></nav><div class="vp-nav-item"><div class="vp-dropdown-wrapper"><button type="button" class="vp-dropdown-title" aria-label="Select language"><!--[--><svg xmlns="http://www.w3.org/2000/svg" class="icon i18n-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="i18n icon" name="i18n" style="width:1rem;height:1rem;vertical-align:middle;"><path d="M379.392 460.8 494.08 575.488l-42.496 102.4L307.2 532.48 138.24 701.44l-71.68-72.704L234.496 460.8l-45.056-45.056c-27.136-27.136-51.2-66.56-66.56-108.544h112.64c7.68 14.336 16.896 27.136 26.112 35.84l45.568 46.08 45.056-45.056C382.976 312.32 409.6 247.808 409.6 204.8H0V102.4h256V0h102.4v102.4h256v102.4H512c0 70.144-37.888 161.28-87.04 210.944L378.88 460.8zM576 870.4 512 1024H409.6l256-614.4H768l256 614.4H921.6l-64-153.6H576zM618.496 768h196.608L716.8 532.48 618.496 768z"></path></svg><!--]--><span class="arrow"></span><ul class="vp-dropdown"><li class="vp-dropdown-item"><a class="route-link route-link-active auto-link" href="/UserGuide/latest/API/Programming-Java-Native-API.html" aria-label="English" iconsizing="both"><!---->English<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/zh/UserGuide/latest/API/Programming-Java-Native-API.html" aria-label="简体中文" iconsizing="both"><!---->简体中文<!----></a></li></ul></button></div></div><div class="vp-nav-item hide-in-mobile"><button type="button" class="vp-color-mode-switch" id="color-mode-switch"><svg xmlns="http://www.w3.org/2000/svg" class="icon auto-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="auto icon" name="auto" style="display:none;"><path d="M512 992C246.92 992 32 777.08 32 512S246.92 32 512 32s480 214.92 480 480-214.92 480-480 480zm0-840c-198.78 0-360 161.22-360 360 0 198.84 161.22 360 360 360s360-161.16 360-360c0-198.78-161.22-360-360-360zm0 660V212c165.72 0 300 134.34 300 300 0 165.72-134.28 300-300 300z"></path></svg><svg xmlns="http://www.w3.org/2000/svg" class="icon dark-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="dark icon" name="dark" style="display:none;"><path d="M524.8 938.667h-4.267a439.893 439.893 0 0 1-313.173-134.4 446.293 446.293 0 0 1-11.093-597.334A432.213 432.213 0 0 1 366.933 90.027a42.667 42.667 0 0 1 45.227 9.386 42.667 42.667 0 0 1 10.24 42.667 358.4 358.4 0 0 0 82.773 375.893 361.387 361.387 0 0 0 376.747 82.774 42.667 42.667 0 0 1 54.187 55.04 433.493 433.493 0 0 1-99.84 154.88 438.613 438.613 0 0 1-311.467 128z"></path></svg><svg xmlns="http://www.w3.org/2000/svg" class="icon light-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="light icon" name="light" style="display:block;"><path d="M952 552h-80a40 40 0 0 1 0-80h80a40 40 0 0 1 0 80zM801.88 280.08a41 41 0 0 1-57.96-57.96l57.96-58a41.04 41.04 0 0 1 58 58l-58 57.96zM512 752a240 240 0 1 1 0-480 240 240 0 0 1 0 480zm0-560a40 40 0 0 1-40-40V72a40 40 0 0 1 80 0v80a40 40 0 0 1-40 40zm-289.88 88.08-58-57.96a41.04 41.04 0 0 1 58-58l57.96 58a41 41 0 0 1-57.96 57.96zM192 512a40 40 0 0 1-40 40H72a40 40 0 0 1 0-80h80a40 40 0 0 1 40 40zm30.12 231.92a41 41 0 0 1 57.96 57.96l-57.96 58a41.04 41.04 0 0 1-58-58l58-57.96zM512 832a40 40 0 0 1 40 40v80a40 40 0 0 1-80 0v-80a40 40 0 0 1 40-40zm289.88-88.08 58 57.96a41.04 41.04 0 0 1-58 58l-57.96-58a41 41 0 0 1 57.96-57.96z"></path></svg></button></div><div class="vp-nav-item vp-action"><a class="vp-action-link" href="https://github.com/apache/iotdb" target="_blank" rel="noopener noreferrer" aria-label="GitHub"><svg xmlns="http://www.w3.org/2000/svg" class="icon github-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="github icon" name="github" style="width:1.25rem;height:1.25rem;vertical-align:middle;"><path d="M511.957 21.333C241.024 21.333 21.333 240.981 21.333 512c0 216.832 140.544 400.725 335.574 465.664 24.49 4.395 32.256-10.07 32.256-23.083 0-11.69.256-44.245 0-85.205-136.448 29.61-164.736-64.64-164.736-64.64-22.315-56.704-54.4-71.765-54.4-71.765-44.587-30.464 3.285-29.824 3.285-29.824 49.195 3.413 75.179 50.517 75.179 50.517 43.776 75.008 114.816 53.333 142.762 40.79 4.523-31.66 17.152-53.377 31.19-65.537-108.971-12.458-223.488-54.485-223.488-242.602 0-53.547 19.114-97.323 50.517-131.67-5.035-12.33-21.93-62.293 4.779-129.834 0 0 41.258-13.184 134.912 50.346a469.803 469.803 0 0 1 122.88-16.554c41.642.213 83.626 5.632 122.88 16.554 93.653-63.488 134.784-50.346 134.784-50.346 26.752 67.541 9.898 117.504 4.864 129.834 31.402 34.347 50.474 78.123 50.474 131.67 0 188.586-114.73 230.016-224.042 242.09 17.578 15.232 33.578 44.672 33.578 90.454v135.85c0 13.142 7.936 27.606 32.854 22.87C862.25 912.597 1002.667 728.747 1002.667 512c0-271.019-219.648-490.667-490.71-490.667z"></path></svg></a></div><!--]--><button type="button" class="vp-toggle-navbar-button" aria-label="Toggle Navbar" aria-expanded="false" aria-controls="nav-screen"><span><span class="vp-top"></span><span class="vp-middle"></span><span class="vp-bottom"></span></span></button></div></header><!----><!--]--><!----><div class="toggle-sidebar-wrapper"><span class="arrow start"></span></div><aside id="sidebar" class="vp-sidebar iotdb-sidebar" vp-sidebar><!--[--><p class="vp-sidebar-header iotdb-sidebar-header"><span class="vp-sidebar-title">IoTDB User Guide (V2.0.x)</span></p><div class="sidebar-top-wrapper"><ul class="switch-list"><li class="switch-type switch-active">Tree</li><li class="switch-type">Table</li></ul></div><!--]--><ul class="vp-sidebar-links"><li><section class="vp-sidebar-group"><p class="vp-sidebar-header"><!----><span class="vp-sidebar-title">IoTDB User Guide (V2.0.x)</span><!----></p><ul class="vp-sidebar-links"></ul></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">About IoTDB</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Background knowledge</span><span class="vp-arrow end"></span></button><!----></section></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/latest/QuickStart/QuickStart_apache.html" aria-label="Quick Start" iconsizing="both"><!---->Quick Start<!----></a></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Deployment & Maintenance</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Basic Functions</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Advanced Features</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">AI capability</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Tools System</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable active" type="button"><!----><span class="vp-sidebar-title">API</span><span class="vp-arrow down"></span></button><ul class="vp-sidebar-links"><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable active" type="button"><!----><span class="vp-sidebar-title">Java Native Interface</span><span class="vp-arrow down"></span></button><ul class="vp-sidebar-links"><li><a class="route-link route-link-active auto-link vp-sidebar-link active" href="/UserGuide/latest/API/Programming-Java-Native-API.html" aria-label="Java Native API" iconsizing="both"><!---->Java Native API<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/latest/API/Programming-Data-Subscription.html" aria-label="Data Subscription API" iconsizing="both"><!---->Data Subscription API<!----></a></li></ul></section></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/latest/API/Programming-Python-Native-API.html" aria-label="Python Native API" iconsizing="both"><!---->Python Native API<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/latest/API/Programming-Cpp-Native-API.html" aria-label="C++ Native API" iconsizing="both"><!---->C++ Native API<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/latest/API/Programming-Go-Native-API.html" aria-label="Go Native API" iconsizing="both"><!---->Go Native API<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/latest/API/Programming-CSharp-Native-API.html" aria-label="C# Native API" iconsizing="both"><!---->C# Native API<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/latest/API/Programming-NodeJS-Native-API.html" aria-label="Node.js Native API" iconsizing="both"><!---->Node.js Native API<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/latest/API/Programming-Rust-Native-API.html" aria-label="Rust Native API" iconsizing="both"><!---->Rust Native API<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/latest/API/Programming-JDBC.html" aria-label="JDBC (Not Recommend)" iconsizing="both"><!---->JDBC (Not Recommend)<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/latest/API/Programming-MQTT.html" aria-label="MQTT Protocol" iconsizing="both"><!---->MQTT Protocol<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/latest/API/Programming-Kafka.html" aria-label="Kafka" iconsizing="both"><!---->Kafka<!----></a></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">REST API</span><span class="vp-arrow end"></span></button><!----></section></li></ul></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Ecosystem Integration</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">SQL Manual</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Technical Insider</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Reference</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">FAQ</span><span class="vp-arrow end"></span></button><!----></section></li></ul><!----></aside><!--[--><main id="main-content" class="vp-page"><!--[--><!----><!----><nav class="vp-breadcrumb disable"></nav><div class="vp-page-title"><h1><!---->Java Native API</h1><div class="page-info"><!----><!----><span class="page-date-info" aria-label="Writing Date📅" data-balloon-pos="up"><svg xmlns="http://www.w3.org/2000/svg" class="icon calendar-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="calendar icon" name="calendar"><path d="M716.4 110.137c0-18.753-14.72-33.473-33.472-33.473-18.753 0-33.473 14.72-33.473 33.473v33.473h66.993v-33.473zm-334.87 0c0-18.753-14.72-33.473-33.473-33.473s-33.52 14.72-33.52 33.473v33.473h66.993v-33.473zm468.81 33.52H716.4v100.465c0 18.753-14.72 33.473-33.472 33.473a33.145 33.145 0 01-33.473-33.473V143.657H381.53v100.465c0 18.753-14.72 33.473-33.473 33.473a33.145 33.145 0 01-33.473-33.473V143.657H180.6A134.314 134.314 0 0046.66 277.595v535.756A134.314 134.314 0 00180.6 947.289h669.74a134.36 134.36 0 00133.94-133.938V277.595a134.314 134.314 0 00-133.94-133.938zm33.473 267.877H147.126a33.145 33.145 0 01-33.473-33.473c0-18.752 14.72-33.473 33.473-33.473h736.687c18.752 0 33.472 14.72 33.472 33.473a33.145 33.145 0 01-33.472 33.473z"></path></svg><span data-allow-mismatch="text">July 10, 2023</span><meta property="datePublished" content="2023-07-10T03:11:17.000Z"></span><!----><span class="page-reading-time-info" aria-label="Reading Time⌛" data-balloon-pos="up"><svg xmlns="http://www.w3.org/2000/svg" class="icon timer-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="timer icon" name="timer"><path d="M799.387 122.15c4.402-2.978 7.38-7.897 7.38-13.463v-1.165c0-8.933-7.38-16.312-16.312-16.312H256.33c-8.933 0-16.311 7.38-16.311 16.312v1.165c0 5.825 2.977 10.874 7.637 13.592 4.143 194.44 97.22 354.963 220.201 392.763-122.204 37.542-214.893 196.511-220.2 389.397-4.661 5.049-7.638 11.651-7.638 19.03v5.825h566.49v-5.825c0-7.379-2.849-13.981-7.509-18.9-5.049-193.016-97.867-351.985-220.2-389.527 123.24-37.67 216.446-198.453 220.588-392.892zM531.16 450.445v352.632c117.674 1.553 211.787 40.778 211.787 88.676H304.097c0-48.286 95.149-87.382 213.728-88.676V450.445c-93.077-3.107-167.901-81.297-167.901-177.093 0-8.803 6.99-15.793 15.793-15.793 8.803 0 15.794 6.99 15.794 15.793 0 80.261 63.69 145.635 142.01 145.635s142.011-65.374 142.011-145.635c0-8.803 6.99-15.793 15.794-15.793s15.793 6.99 15.793 15.793c0 95.019-73.789 172.82-165.96 177.093z"></path></svg><span>About 11 min</span><meta property="timeRequired" content="PT11M"></span><!----><!----></div><hr></div><div class="vp-toc-placeholder"><aside id="toc" vp-toc><!----><!--[--><div class="vp-toc-header">On This Page<button type="button" class="print-button" title="Print"><svg xmlns="http://www.w3.org/2000/svg" class="icon print-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="print icon" name="print"><path d="M819.2 364.8h-44.8V128c0-17.067-14.933-32-32-32H281.6c-17.067 0-32 14.933-32 32v236.8h-44.8C145.067 364.8 96 413.867 96 473.6v192c0 59.733 49.067 108.8 108.8 108.8h44.8V896c0 17.067 14.933 32 32 32h460.8c17.067 0 32-14.933 32-32V774.4h44.8c59.733 0 108.8-49.067 108.8-108.8v-192c0-59.733-49.067-108.8-108.8-108.8zM313.6 160h396.8v204.8H313.6V160zm396.8 704H313.6V620.8h396.8V864zM864 665.6c0 25.6-19.2 44.8-44.8 44.8h-44.8V588.8c0-17.067-14.933-32-32-32H281.6c-17.067 0-32 14.933-32 32v121.6h-44.8c-25.6 0-44.8-19.2-44.8-44.8v-192c0-25.6 19.2-44.8 44.8-44.8h614.4c25.6 0 44.8 19.2 44.8 44.8v192z"></path></svg></button><div class="arrow end"></div></div><div class="vp-toc-wrapper"><ul class="vp-toc-list"><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level2" href="#_1-overview-of-steps">1. Overview of Steps</a></li><!----><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level2" href="#_2-detailed-steps">2. Detailed Steps</a></li><li><ul class="vp-toc-list"><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level3" href="#_2-1-create-a-maven-project">2.1 Create a Maven Project</a></li><!----><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level3" href="#_2-2-creating-a-connection-pool-instance">2.2 Creating a Connection Pool Instance</a></li><!----><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level3" href="#_2-3-performing-database-operations">2.3 Performing Database Operations</a></li><!----><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level3" href="#_3-native-interface-description">3. Native Interface Description</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="java-native-api" tabindex="-1"><a class="header-anchor" href="#java-native-api"><span>Java Native API</span></a></h1><p>In the native API of IoTDB, the <code>Session</code> is the core interface for interacting with the database. It integrates a rich set of methods that support data writing, querying, and metadata operations. By instantiating a <code>Session</code>, you can establish a connection to the IoTDB server and perform various database operations within the environment constructed by this connection. The <code>Session</code> is not thread-safe and should not be called simultaneously by multiple threads.</p><p><code>SessionPool</code> is a connection pool for <code>Session</code>, and it is recommended to use <code>SessionPool</code> for programming. In scenarios with multi-threaded concurrency, <code>SessionPool</code> can manage and allocate connection resources effectively, thereby improving system performance and resource utilization efficiency.</p><h2 id="_1-overview-of-steps" tabindex="-1"><a class="header-anchor" href="#_1-overview-of-steps"><span>1. Overview of Steps</span></a></h2><ol><li>Create a Connection Pool Instance: Initialize a SessionPool object to manage multiple Session instances.</li><li>Perform Operations: Directly obtain a Session instance from the SessionPool and execute database operations, without the need to open and close connections each time.</li><li>Close Connection Pool Resources: When database operations are no longer needed, close the SessionPool to release all related resources.</li></ol><h2 id="_2-detailed-steps" tabindex="-1"><a class="header-anchor" href="#_2-detailed-steps"><span>2. Detailed Steps</span></a></h2><p>This section provides an overview of the core development process and does not demonstrate all parameters and interfaces. For a complete list of functionalities and parameters, please refer to:<a class="route-link" href="/UserGuide/latest/API/Programming-Java-Native-API.html#3-native-interface-description">Java Native API</a> or check the: <a href="https://github.com/apache/iotdb/tree/rc/2.0.1/example/session/src/main/java/org/apache/iotdb" target="_blank" rel="noopener noreferrer">Source Code</a></p><h3 id="_2-1-create-a-maven-project" tabindex="-1"><a class="header-anchor" href="#_2-1-create-a-maven-project"><span>2.1 Create a Maven Project</span></a></h3><p>Create a Maven project and add the following dependencies to the pom.xml file (JDK >= 1.8, Maven >= 3.6):</p><div class="language-xml line-numbers-mode" data-highlighter="shiki" data-ext="xml" data-title="xml" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;"><</span><span style="color:#E06C75;">dependencies</span><span style="color:#ABB2BF;">></span></span> |
| <span class="line"><span style="color:#ABB2BF;"> <</span><span style="color:#E06C75;">dependency</span><span style="color:#ABB2BF;">></span></span> |
| <span class="line"><span style="color:#ABB2BF;"> <</span><span style="color:#E06C75;">groupId</span><span style="color:#ABB2BF;">>org.apache.iotdb</</span><span style="color:#E06C75;">groupId</span><span style="color:#ABB2BF;">></span></span> |
| <span class="line"><span style="color:#ABB2BF;"> <</span><span style="color:#E06C75;">artifactId</span><span style="color:#ABB2BF;">>iotdb-session</</span><span style="color:#E06C75;">artifactId</span><span style="color:#ABB2BF;">></span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> <!-- The version number is the same as the database version number --></span></span> |
| <span class="line"><span style="color:#ABB2BF;"> <</span><span style="color:#E06C75;">version</span><span style="color:#ABB2BF;">>${project.version}</</span><span style="color:#E06C75;">version</span><span style="color:#ABB2BF;">></span></span> |
| <span class="line"><span style="color:#ABB2BF;"> </</span><span style="color:#E06C75;">dependency</span><span style="color:#ABB2BF;">></span></span> |
| <span class="line"><span style="color:#ABB2BF;"></</span><span style="color:#E06C75;">dependencies</span><span style="color:#ABB2BF;">></span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h3 id="_2-2-creating-a-connection-pool-instance" tabindex="-1"><a class="header-anchor" href="#_2-2-creating-a-connection-pool-instance"><span>2.2 Creating a Connection Pool Instance</span></a></h3><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" data-title="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">import</span><span style="color:#E5C07B;"> java.util.ArrayList</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;">import</span><span style="color:#E5C07B;"> java.util.List</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;">import</span><span style="color:#E5C07B;"> org.apache.iotdb.session.pool.SessionPool</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#C678DD;">public</span><span style="color:#C678DD;"> class</span><span style="color:#E5C07B;"> IoTDBSessionPoolExample</span><span style="color:#ABB2BF;"> {</span></span> |
| <span class="line"><span style="color:#C678DD;"> private</span><span style="color:#C678DD;"> static</span><span style="color:#E5C07B;"> SessionPool</span><span style="color:#E06C75;"> sessionPool</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#C678DD;"> public</span><span style="color:#C678DD;"> static</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> main</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">String</span><span style="color:#ABB2BF;">[] </span><span style="color:#E06C75;font-style:italic;">args</span><span style="color:#ABB2BF;">)</span><span style="color:#ABB2BF;"> {</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> // Using nodeUrls ensures that when one node goes down, other nodes are automatically connected to retry</span></span> |
| <span class="line"><span style="color:#E5C07B;"> List</span><span style="color:#ABB2BF;"><</span><span style="color:#E5C07B;">String</span><span style="color:#ABB2BF;">> </span><span style="color:#E06C75;">nodeUrls</span><span style="color:#56B6C2;"> =</span><span style="color:#C678DD;"> new</span><span style="color:#E5C07B;"> ArrayList</span><span style="color:#ABB2BF;"><>();</span></span> |
| <span class="line"><span style="color:#E5C07B;"> nodeUrls</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">add</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"127.0.0.1:6667"</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#E5C07B;"> nodeUrls</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">add</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"127.0.0.1:6668"</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> sessionPool </span><span style="color:#56B6C2;">=</span></span> |
| <span class="line"><span style="color:#C678DD;"> new</span><span style="color:#ABB2BF;"> SessionPool.</span><span style="color:#61AFEF;">Builder</span><span style="color:#ABB2BF;">()</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> .</span><span style="color:#61AFEF;">nodeUrls</span><span style="color:#ABB2BF;">(nodeUrls)</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> .</span><span style="color:#61AFEF;">user</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"root"</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> .</span><span style="color:#61AFEF;">password</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"root"</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> .</span><span style="color:#61AFEF;">maxSize</span><span style="color:#ABB2BF;">(</span><span style="color:#D19A66;">3</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> .</span><span style="color:#61AFEF;">build</span><span style="color:#ABB2BF;">();</span></span> |
| <span class="line"><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></div><h3 id="_2-3-performing-database-operations" tabindex="-1"><a class="header-anchor" href="#_2-3-performing-database-operations"><span>2.3 Performing Database Operations</span></a></h3><h4 id="_2-3-1-data-insertion" tabindex="-1"><a class="header-anchor" href="#_2-3-1-data-insertion"><span>2.3.1 Data Insertion</span></a></h4><p>In industrial scenarios, data insertion can be categorized into the following types: inserting multiple rows of data, and inserting multiple rows of data for a single device. Below, we introduce the insertion interfaces for different scenarios.</p><h5 id="multi-row-data-insertion-interface" tabindex="-1"><a class="header-anchor" href="#multi-row-data-insertion-interface"><span>Multi-Row Data Insertion Interface</span></a></h5><p>Interface Description: Supports inserting multiple rows of data at once, where each row corresponds to multiple measurement values for a device at a specific timestamp.</p><p>Interface List:</p><table><thead><tr><th><strong>Interface Name</strong></th><th><strong>Function Description</strong></th></tr></thead><tbody><tr><td><code>insertRecords(List<String> deviceIds, List<Long> times, List<List<String>> measurementsList, List<List<TSDataType>> typesList, List<List<Object>> valuesList)</code></td><td>Inserts multiple rows of data, suitable for scenarios where measurements are independently collected.</td></tr></tbody></table><p>Code Example:</p><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" data-title="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">import</span><span style="color:#E5C07B;"> java.util.ArrayList</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;">import</span><span style="color:#E5C07B;"> java.util.List</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;">import</span><span style="color:#E5C07B;"> org.apache.iotdb.rpc.IoTDBConnectionException</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;">import</span><span style="color:#E5C07B;"> org.apache.iotdb.rpc.StatementExecutionException</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;">import</span><span style="color:#E5C07B;"> org.apache.iotdb.session.pool.SessionPool</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;">import</span><span style="color:#E5C07B;"> org.apache.tsfile.enums.TSDataType</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#C678DD;">public</span><span style="color:#C678DD;"> class</span><span style="color:#E5C07B;"> SessionPoolExample</span><span style="color:#ABB2BF;"> {</span></span> |
| <span class="line"><span style="color:#C678DD;"> private</span><span style="color:#C678DD;"> static</span><span style="color:#E5C07B;"> SessionPool</span><span style="color:#E06C75;"> sessionPool</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;"> public</span><span style="color:#C678DD;"> static</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> main</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">String</span><span style="color:#ABB2BF;">[] </span><span style="color:#E06C75;font-style:italic;">args</span><span style="color:#ABB2BF;">)</span><span style="color:#C678DD;"> throws</span><span style="color:#E5C07B;"> IoTDBConnectionException</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> StatementExecutionException</span><span style="color:#ABB2BF;"> {</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> // 1. init SessionPool</span></span> |
| <span class="line"><span style="color:#61AFEF;"> constructSessionPool</span><span style="color:#ABB2BF;">();</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> // 2. execute insert data</span></span> |
| <span class="line"><span style="color:#61AFEF;"> insertRecordsExample</span><span style="color:#ABB2BF;">();</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> // 3. close SessionPool</span></span> |
| <span class="line"><span style="color:#61AFEF;"> closeSessionPool</span><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:#C678DD;"> private</span><span style="color:#C678DD;"> static</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> constructSessionPool</span><span style="color:#ABB2BF;">()</span><span style="color:#ABB2BF;"> {</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> // Using nodeUrls ensures that when one node goes down, other nodes are automatically connected to retry</span></span> |
| <span class="line"><span style="color:#E5C07B;"> List</span><span style="color:#ABB2BF;"><</span><span style="color:#E5C07B;">String</span><span style="color:#ABB2BF;">> </span><span style="color:#E06C75;">nodeUrls</span><span style="color:#56B6C2;"> =</span><span style="color:#C678DD;"> new</span><span style="color:#E5C07B;"> ArrayList</span><span style="color:#ABB2BF;"><>();</span></span> |
| <span class="line"><span style="color:#E5C07B;"> nodeUrls</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">add</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"127.0.0.1:6667"</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#E5C07B;"> nodeUrls</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">add</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"127.0.0.1:6668"</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> sessionPool </span><span style="color:#56B6C2;">=</span></span> |
| <span class="line"><span style="color:#C678DD;"> new</span><span style="color:#ABB2BF;"> SessionPool.</span><span style="color:#61AFEF;">Builder</span><span style="color:#ABB2BF;">()</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> .</span><span style="color:#61AFEF;">nodeUrls</span><span style="color:#ABB2BF;">(nodeUrls)</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> .</span><span style="color:#61AFEF;">user</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"root"</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> .</span><span style="color:#61AFEF;">password</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"root"</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> .</span><span style="color:#61AFEF;">maxSize</span><span style="color:#ABB2BF;">(</span><span style="color:#D19A66;">3</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> .</span><span style="color:#61AFEF;">build</span><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:#C678DD;"> public</span><span style="color:#C678DD;"> static</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> insertRecordsExample</span><span style="color:#ABB2BF;">()</span><span style="color:#C678DD;"> throws</span><span style="color:#E5C07B;"> IoTDBConnectionException</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> StatementExecutionException</span><span style="color:#ABB2BF;"> {</span></span> |
| <span class="line"><span style="color:#E5C07B;"> String</span><span style="color:#E06C75;"> deviceId</span><span style="color:#56B6C2;"> =</span><span style="color:#98C379;"> "root.sg1.d1"</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#E5C07B;"> List</span><span style="color:#ABB2BF;"><</span><span style="color:#E5C07B;">String</span><span style="color:#ABB2BF;">> </span><span style="color:#E06C75;">measurements</span><span style="color:#56B6C2;"> =</span><span style="color:#C678DD;"> new</span><span style="color:#E5C07B;"> ArrayList</span><span style="color:#ABB2BF;"><>();</span></span> |
| <span class="line"><span style="color:#E5C07B;"> measurements</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">add</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"s1"</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#E5C07B;"> measurements</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">add</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"s2"</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#E5C07B;"> measurements</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">add</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"s3"</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#E5C07B;"> List</span><span style="color:#ABB2BF;"><</span><span style="color:#E5C07B;">String</span><span style="color:#ABB2BF;">> </span><span style="color:#E06C75;">deviceIds</span><span style="color:#56B6C2;"> =</span><span style="color:#C678DD;"> new</span><span style="color:#E5C07B;"> ArrayList</span><span style="color:#ABB2BF;"><>();</span></span> |
| <span class="line"><span style="color:#E5C07B;"> List</span><span style="color:#ABB2BF;"><</span><span style="color:#E5C07B;">List</span><span style="color:#ABB2BF;"><</span><span style="color:#E5C07B;">String</span><span style="color:#ABB2BF;">>> </span><span style="color:#E06C75;">measurementsList</span><span style="color:#56B6C2;"> =</span><span style="color:#C678DD;"> new</span><span style="color:#E5C07B;"> ArrayList</span><span style="color:#ABB2BF;"><>();</span></span> |
| <span class="line"><span style="color:#E5C07B;"> List</span><span style="color:#ABB2BF;"><</span><span style="color:#E5C07B;">List</span><span style="color:#ABB2BF;"><</span><span style="color:#E5C07B;">Object</span><span style="color:#ABB2BF;">>> </span><span style="color:#E06C75;">valuesList</span><span style="color:#56B6C2;"> =</span><span style="color:#C678DD;"> new</span><span style="color:#E5C07B;"> ArrayList</span><span style="color:#ABB2BF;"><>();</span></span> |
| <span class="line"><span style="color:#E5C07B;"> List</span><span style="color:#ABB2BF;"><</span><span style="color:#E5C07B;">Long</span><span style="color:#ABB2BF;">> </span><span style="color:#E06C75;">timestamps</span><span style="color:#56B6C2;"> =</span><span style="color:#C678DD;"> new</span><span style="color:#E5C07B;"> ArrayList</span><span style="color:#ABB2BF;"><>();</span></span> |
| <span class="line"><span style="color:#E5C07B;"> List</span><span style="color:#ABB2BF;"><</span><span style="color:#E5C07B;">List</span><span style="color:#ABB2BF;"><</span><span style="color:#E5C07B;">TSDataType</span><span style="color:#ABB2BF;">>> </span><span style="color:#E06C75;">typesList</span><span style="color:#56B6C2;"> =</span><span style="color:#C678DD;"> new</span><span style="color:#E5C07B;"> ArrayList</span><span style="color:#ABB2BF;"><>();</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#C678DD;"> for</span><span style="color:#ABB2BF;"> (</span><span style="color:#C678DD;">long</span><span style="color:#E06C75;"> time</span><span style="color:#56B6C2;"> =</span><span style="color:#D19A66;"> 0</span><span style="color:#ABB2BF;">; time </span><span style="color:#56B6C2;"><</span><span style="color:#D19A66;"> 500</span><span style="color:#ABB2BF;">; time++) {</span></span> |
| <span class="line"><span style="color:#E5C07B;"> List</span><span style="color:#ABB2BF;"><</span><span style="color:#E5C07B;">Object</span><span style="color:#ABB2BF;">> </span><span style="color:#E06C75;">values</span><span style="color:#56B6C2;"> =</span><span style="color:#C678DD;"> new</span><span style="color:#E5C07B;"> ArrayList</span><span style="color:#ABB2BF;"><>();</span></span> |
| <span class="line"><span style="color:#E5C07B;"> List</span><span style="color:#ABB2BF;"><</span><span style="color:#E5C07B;">TSDataType</span><span style="color:#ABB2BF;">> </span><span style="color:#E06C75;">types</span><span style="color:#56B6C2;"> =</span><span style="color:#C678DD;"> new</span><span style="color:#E5C07B;"> ArrayList</span><span style="color:#ABB2BF;"><>();</span></span> |
| <span class="line"><span style="color:#E5C07B;"> values</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">add</span><span style="color:#ABB2BF;">(</span><span style="color:#D19A66;">1L</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#E5C07B;"> values</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">add</span><span style="color:#ABB2BF;">(</span><span style="color:#D19A66;">2L</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#E5C07B;"> values</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">add</span><span style="color:#ABB2BF;">(</span><span style="color:#D19A66;">3L</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#E5C07B;"> types</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">add</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">TSDataType</span><span style="color:#ABB2BF;">.</span><span style="color:#E5C07B;">INT64</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#E5C07B;"> types</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">add</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">TSDataType</span><span style="color:#ABB2BF;">.</span><span style="color:#E5C07B;">INT64</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#E5C07B;"> types</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">add</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">TSDataType</span><span style="color:#ABB2BF;">.</span><span style="color:#E5C07B;">INT64</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#E5C07B;"> deviceIds</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">add</span><span style="color:#ABB2BF;">(deviceId);</span></span> |
| <span class="line"><span style="color:#E5C07B;"> measurementsList</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">add</span><span style="color:#ABB2BF;">(measurements);</span></span> |
| <span class="line"><span style="color:#E5C07B;"> valuesList</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">add</span><span style="color:#ABB2BF;">(values);</span></span> |
| <span class="line"><span style="color:#E5C07B;"> typesList</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">add</span><span style="color:#ABB2BF;">(types);</span></span> |
| <span class="line"><span style="color:#E5C07B;"> timestamps</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">add</span><span style="color:#ABB2BF;">(time);</span></span> |
| <span class="line"><span style="color:#C678DD;"> if</span><span style="color:#ABB2BF;"> (time </span><span style="color:#56B6C2;">!=</span><span style="color:#D19A66;"> 0</span><span style="color:#56B6C2;"> &&</span><span style="color:#ABB2BF;"> time </span><span style="color:#56B6C2;">%</span><span style="color:#D19A66;"> 100</span><span style="color:#56B6C2;"> ==</span><span style="color:#D19A66;"> 0</span><span style="color:#ABB2BF;">) {</span></span> |
| <span class="line"><span style="color:#C678DD;"> try</span><span style="color:#ABB2BF;"> {</span></span> |
| <span class="line"><span style="color:#E5C07B;"> sessionPool</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">insertRecords</span><span style="color:#ABB2BF;">(deviceIds, timestamps, measurementsList, typesList, valuesList);</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> } </span><span style="color:#C678DD;">catch</span><span style="color:#ABB2BF;"> (</span><span style="color:#E5C07B;">IoTDBConnectionException</span><span style="color:#ABB2BF;"> | </span><span style="color:#E5C07B;">StatementExecutionException</span><span style="color:#E06C75;font-style:italic;"> e</span><span style="color:#ABB2BF;">) {</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> // solve exception</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> }</span></span> |
| <span class="line"><span style="color:#E5C07B;"> deviceIds</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">clear</span><span style="color:#ABB2BF;">();</span></span> |
| <span class="line"><span style="color:#E5C07B;"> measurementsList</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">clear</span><span style="color:#ABB2BF;">();</span></span> |
| <span class="line"><span style="color:#E5C07B;"> valuesList</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">clear</span><span style="color:#ABB2BF;">();</span></span> |
| <span class="line"><span style="color:#E5C07B;"> typesList</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">clear</span><span style="color:#ABB2BF;">();</span></span> |
| <span class="line"><span style="color:#E5C07B;"> timestamps</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">clear</span><span style="color:#ABB2BF;">();</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> }</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> }</span></span> |
| <span class="line"><span style="color:#C678DD;"> try</span><span style="color:#ABB2BF;"> {</span></span> |
| <span class="line"><span style="color:#E5C07B;"> sessionPool</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">insertRecords</span><span style="color:#ABB2BF;">(deviceIds, timestamps, measurementsList, typesList, valuesList);</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> } </span><span style="color:#C678DD;">catch</span><span style="color:#ABB2BF;"> (</span><span style="color:#E5C07B;">IoTDBConnectionException</span><span style="color:#ABB2BF;"> | </span><span style="color:#E5C07B;">StatementExecutionException</span><span style="color:#E06C75;font-style:italic;"> e</span><span style="color:#ABB2BF;">) {</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> // solve exception</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> }</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> }</span></span> |
| <span class="line"><span style="color:#E06C75;"> </span></span> |
| <span class="line"><span style="color:#C678DD;"> public</span><span style="color:#C678DD;"> static</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> closeSessionPool</span><span style="color:#ABB2BF;">(){</span></span> |
| <span class="line"><span style="color:#E5C07B;"> sessionPool</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">close</span><span style="color:#ABB2BF;">();</span></span> |
| <span class="line"><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></div><h5 id="single-device-multi-row-data-insertion-interface" tabindex="-1"><a class="header-anchor" href="#single-device-multi-row-data-insertion-interface"><span>Single-Device Multi-Row Data Insertion Interface</span></a></h5><p>Interface Description: Supports inserting multiple rows of data for a single device at once, where each row corresponds to multiple measurement values for a specific timestamp.</p><p>Interface List：</p><table><thead><tr><th><strong>Interface Name</strong></th><th><strong>Function Description</strong></th></tr></thead><tbody><tr><td><code>insertTablet(Tablet tablet)</code></td><td>Inserts multiple rows of data for a single device, suitable for scenarios where measurements are independently collected.</td></tr></tbody></table><p>Code Example:</p><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" data-title="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">import</span><span style="color:#E5C07B;"> java.util.ArrayList</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;">import</span><span style="color:#E5C07B;"> java.util.List</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;">import</span><span style="color:#E5C07B;"> java.util.Random</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;">import</span><span style="color:#E5C07B;"> org.apache.iotdb.rpc.IoTDBConnectionException</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;">import</span><span style="color:#E5C07B;"> org.apache.iotdb.rpc.StatementExecutionException</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;">import</span><span style="color:#E5C07B;"> org.apache.iotdb.session.pool.SessionPool</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;">import</span><span style="color:#E5C07B;"> org.apache.tsfile.enums.TSDataType</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;">import</span><span style="color:#E5C07B;"> org.apache.tsfile.write.record.Tablet</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;">import</span><span style="color:#E5C07B;"> org.apache.tsfile.write.schema.MeasurementSchema</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#C678DD;">public</span><span style="color:#C678DD;"> class</span><span style="color:#E5C07B;"> SessionPoolExample</span><span style="color:#ABB2BF;"> {</span></span> |
| <span class="line"><span style="color:#C678DD;"> private</span><span style="color:#C678DD;"> static</span><span style="color:#E5C07B;"> SessionPool</span><span style="color:#E06C75;"> sessionPool</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;"> public</span><span style="color:#C678DD;"> static</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> main</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">String</span><span style="color:#ABB2BF;">[] </span><span style="color:#E06C75;font-style:italic;">args</span><span style="color:#ABB2BF;">)</span><span style="color:#C678DD;"> throws</span><span style="color:#E5C07B;"> IoTDBConnectionException</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> StatementExecutionException</span><span style="color:#ABB2BF;"> {</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> // 1. init SessionPool</span></span> |
| <span class="line"><span style="color:#61AFEF;"> constructSessionPool</span><span style="color:#ABB2BF;">();</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> // 2. execute insert data</span></span> |
| <span class="line"><span style="color:#61AFEF;"> insertTabletExample</span><span style="color:#ABB2BF;">();</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> // 3. close SessionPool</span></span> |
| <span class="line"><span style="color:#61AFEF;"> closeSessionPool</span><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:#C678DD;"> private</span><span style="color:#C678DD;"> static</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> constructSessionPool</span><span style="color:#ABB2BF;">()</span><span style="color:#ABB2BF;"> {</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> // Using nodeUrls ensures that when one node goes down, other nodes are automatically connected to retry</span></span> |
| <span class="line"><span style="color:#E5C07B;"> List</span><span style="color:#ABB2BF;"><</span><span style="color:#E5C07B;">String</span><span style="color:#ABB2BF;">> </span><span style="color:#E06C75;">nodeUrls</span><span style="color:#56B6C2;"> =</span><span style="color:#C678DD;"> new</span><span style="color:#E5C07B;"> ArrayList</span><span style="color:#ABB2BF;"><>();</span></span> |
| <span class="line"><span style="color:#E5C07B;"> nodeUrls</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">add</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"127.0.0.1:6667"</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#E5C07B;"> nodeUrls</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">add</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"127.0.0.1:6668"</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> sessionPool </span><span style="color:#56B6C2;">=</span></span> |
| <span class="line"><span style="color:#C678DD;"> new</span><span style="color:#ABB2BF;"> SessionPool.</span><span style="color:#61AFEF;">Builder</span><span style="color:#ABB2BF;">()</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> .</span><span style="color:#61AFEF;">nodeUrls</span><span style="color:#ABB2BF;">(nodeUrls)</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> .</span><span style="color:#61AFEF;">user</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"root"</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> .</span><span style="color:#61AFEF;">password</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"root"</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> .</span><span style="color:#61AFEF;">maxSize</span><span style="color:#ABB2BF;">(</span><span style="color:#D19A66;">3</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> .</span><span style="color:#61AFEF;">build</span><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:#C678DD;"> private</span><span style="color:#C678DD;"> static</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> insertTabletExample</span><span style="color:#ABB2BF;">()</span><span style="color:#C678DD;"> throws</span><span style="color:#E5C07B;"> IoTDBConnectionException</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> StatementExecutionException</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;"> * A Tablet example:</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * device1</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * time s1, s2, s3</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * 1, 1, 1, 1</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * 2, 2, 2, 2</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * 3, 3, 3, 3</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 schema of measurements of one device</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> // only measurementId and data type in MeasurementSchema take effects in Tablet</span></span> |
| <span class="line"><span style="color:#E5C07B;"> List</span><span style="color:#ABB2BF;"><</span><span style="color:#E5C07B;">MeasurementSchema</span><span style="color:#ABB2BF;">> </span><span style="color:#E06C75;">schemaList</span><span style="color:#56B6C2;"> =</span><span style="color:#C678DD;"> new</span><span style="color:#E5C07B;"> ArrayList</span><span style="color:#ABB2BF;"><>();</span></span> |
| <span class="line"><span style="color:#E5C07B;"> schemaList</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">add</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">new</span><span style="color:#61AFEF;"> MeasurementSchema</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"s1"</span><span style="color:#ABB2BF;">, </span><span style="color:#E5C07B;">TSDataType</span><span style="color:#ABB2BF;">.</span><span style="color:#E5C07B;">INT64</span><span style="color:#ABB2BF;">));</span></span> |
| <span class="line"><span style="color:#E5C07B;"> schemaList</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">add</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">new</span><span style="color:#61AFEF;"> MeasurementSchema</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"s2"</span><span style="color:#ABB2BF;">, </span><span style="color:#E5C07B;">TSDataType</span><span style="color:#ABB2BF;">.</span><span style="color:#E5C07B;">INT64</span><span style="color:#ABB2BF;">));</span></span> |
| <span class="line"><span style="color:#E5C07B;"> schemaList</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">add</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">new</span><span style="color:#61AFEF;"> MeasurementSchema</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"s3"</span><span style="color:#ABB2BF;">, </span><span style="color:#E5C07B;">TSDataType</span><span style="color:#ABB2BF;">.</span><span style="color:#E5C07B;">INT64</span><span style="color:#ABB2BF;">));</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#E5C07B;"> Tablet</span><span style="color:#E06C75;"> tablet</span><span style="color:#56B6C2;"> =</span><span style="color:#C678DD;"> new</span><span style="color:#61AFEF;"> Tablet</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"root.sg.d1"</span><span style="color:#ABB2BF;">, schemaList, </span><span style="color:#D19A66;">100</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> // Method 1 to add tablet data</span></span> |
| <span class="line"><span style="color:#C678DD;"> long</span><span style="color:#E06C75;"> timestamp</span><span style="color:#56B6C2;"> =</span><span style="color:#E5C07B;"> System</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">currentTimeMillis</span><span style="color:#ABB2BF;">();</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#E5C07B;"> Random</span><span style="color:#E06C75;"> random</span><span style="color:#56B6C2;"> =</span><span style="color:#C678DD;"> new</span><span style="color:#61AFEF;"> Random</span><span style="color:#ABB2BF;">();</span></span> |
| <span class="line"><span style="color:#C678DD;"> for</span><span style="color:#ABB2BF;"> (</span><span style="color:#C678DD;">long</span><span style="color:#E06C75;"> row</span><span style="color:#56B6C2;"> =</span><span style="color:#D19A66;"> 0</span><span style="color:#ABB2BF;">; row </span><span style="color:#56B6C2;"><</span><span style="color:#D19A66;"> 100</span><span style="color:#ABB2BF;">; row++) {</span></span> |
| <span class="line"><span style="color:#C678DD;"> int</span><span style="color:#E06C75;"> rowIndex</span><span style="color:#56B6C2;"> =</span><span style="color:#E5C07B;"> tablet</span><span style="color:#ABB2BF;">.</span><span style="color:#E5C07B;">rowSize</span><span style="color:#ABB2BF;">++;</span></span> |
| <span class="line"><span style="color:#E5C07B;"> tablet</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">addTimestamp</span><span style="color:#ABB2BF;">(rowIndex, timestamp);</span></span> |
| <span class="line"><span style="color:#C678DD;"> for</span><span style="color:#ABB2BF;"> (</span><span style="color:#C678DD;">int</span><span style="color:#E06C75;"> s</span><span style="color:#56B6C2;"> =</span><span style="color:#D19A66;"> 0</span><span style="color:#ABB2BF;">; s </span><span style="color:#56B6C2;"><</span><span style="color:#D19A66;"> 3</span><span style="color:#ABB2BF;">; s++) {</span></span> |
| <span class="line"><span style="color:#C678DD;"> long</span><span style="color:#E06C75;"> value</span><span style="color:#56B6C2;"> =</span><span style="color:#E5C07B;"> random</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">nextLong</span><span style="color:#ABB2BF;">();</span></span> |
| <span class="line"><span style="color:#E5C07B;"> tablet</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">addValue</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">schemaList</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">get</span><span style="color:#ABB2BF;">(s).</span><span style="color:#61AFEF;">getMeasurementId</span><span style="color:#ABB2BF;">(), rowIndex, value);</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> }</span></span> |
| <span class="line"><span style="color:#C678DD;"> if</span><span style="color:#ABB2BF;"> (</span><span style="color:#E5C07B;">tablet</span><span style="color:#ABB2BF;">.</span><span style="color:#E5C07B;">rowSize</span><span style="color:#56B6C2;"> ==</span><span style="color:#E5C07B;"> tablet</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">getMaxRowNumber</span><span style="color:#ABB2BF;">()) {</span></span> |
| <span class="line"><span style="color:#E5C07B;"> sessionPool</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">insertTablet</span><span style="color:#ABB2BF;">(tablet);</span></span> |
| <span class="line"><span style="color:#E5C07B;"> tablet</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">reset</span><span style="color:#ABB2BF;">();</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> }</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> timestamp++;</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> }</span></span> |
| <span class="line"><span style="color:#C678DD;"> if</span><span style="color:#ABB2BF;"> (</span><span style="color:#E5C07B;">tablet</span><span style="color:#ABB2BF;">.</span><span style="color:#E5C07B;">rowSize</span><span style="color:#56B6C2;"> !=</span><span style="color:#D19A66;"> 0</span><span style="color:#ABB2BF;">) {</span></span> |
| <span class="line"><span style="color:#E5C07B;"> sessionPool</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">insertTablet</span><span style="color:#ABB2BF;">(tablet);</span></span> |
| <span class="line"><span style="color:#E5C07B;"> tablet</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">reset</span><span style="color:#ABB2BF;">();</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:#C678DD;"> public</span><span style="color:#C678DD;"> static</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> closeSessionPool</span><span style="color:#ABB2BF;">(){</span></span> |
| <span class="line"><span style="color:#E5C07B;"> sessionPool</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">close</span><span style="color:#ABB2BF;">();</span></span> |
| <span class="line"><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></div><h4 id="_2-3-2-sql-operations" tabindex="-1"><a class="header-anchor" href="#_2-3-2-sql-operations"><span>2.3.2 SQL Operations</span></a></h4><p>SQL operations are divided into two categories: queries and non-queries. The corresponding interfaces are executeQuery and executeNonQuery. The difference between them is that the former executes specific query statements and returns a result set, while the latter performs insert, delete, and update operations and does not return a result set.</p><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" data-title="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">import</span><span style="color:#E5C07B;"> java.util.ArrayList</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;">import</span><span style="color:#E5C07B;"> java.util.List</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;">import</span><span style="color:#E5C07B;"> org.apache.iotdb.isession.pool.SessionDataSetWrapper</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;">import</span><span style="color:#E5C07B;"> org.apache.iotdb.rpc.IoTDBConnectionException</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;">import</span><span style="color:#E5C07B;"> org.apache.iotdb.rpc.StatementExecutionException</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;">import</span><span style="color:#E5C07B;"> org.apache.iotdb.session.pool.SessionPool</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#C678DD;">public</span><span style="color:#C678DD;"> class</span><span style="color:#E5C07B;"> SessionPoolExample</span><span style="color:#ABB2BF;"> {</span></span> |
| <span class="line"><span style="color:#C678DD;"> private</span><span style="color:#C678DD;"> static</span><span style="color:#E5C07B;"> SessionPool</span><span style="color:#E06C75;"> sessionPool</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;"> public</span><span style="color:#C678DD;"> static</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> main</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">String</span><span style="color:#ABB2BF;">[] </span><span style="color:#E06C75;font-style:italic;">args</span><span style="color:#ABB2BF;">)</span><span style="color:#C678DD;"> throws</span><span style="color:#E5C07B;"> IoTDBConnectionException</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> StatementExecutionException</span><span style="color:#ABB2BF;"> {</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> // 1. init SessionPool</span></span> |
| <span class="line"><span style="color:#61AFEF;"> constructSessionPool</span><span style="color:#ABB2BF;">(); </span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> // 2. executes a non-query SQL statement, such as a DDL or DML command.</span></span> |
| <span class="line"><span style="color:#61AFEF;"> executeQueryExample</span><span style="color:#ABB2BF;">();</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> // 3. executes a query SQL statement and returns the result set.</span></span> |
| <span class="line"><span style="color:#61AFEF;"> executeNonQueryExample</span><span style="color:#ABB2BF;">();</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> // 4. close SessionPool</span></span> |
| <span class="line"><span style="color:#61AFEF;"> closeSessionPool</span><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:#C678DD;"> private</span><span style="color:#C678DD;"> static</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> executeNonQueryExample</span><span style="color:#ABB2BF;">()</span><span style="color:#C678DD;"> throws</span><span style="color:#E5C07B;"> IoTDBConnectionException</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> StatementExecutionException</span><span style="color:#ABB2BF;"> {</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> // 1. create a nonAligned time series</span></span> |
| <span class="line"><span style="color:#E5C07B;"> sessionPool</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">executeNonQueryStatement</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"create timeseries root.test.d1.s1 with dataType = int32"</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> // 2. set ttl</span></span> |
| <span class="line"><span style="color:#E5C07B;"> sessionPool</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">executeNonQueryStatement</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"set TTL to root.test.** 10000"</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> // 3. delete time series</span></span> |
| <span class="line"><span style="color:#E5C07B;"> sessionPool</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">executeNonQueryStatement</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"delete timeseries root.test.d1.s1"</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#C678DD;"> private</span><span style="color:#C678DD;"> static</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> executeQueryExample</span><span style="color:#ABB2BF;">() throws IoTDBConnectionException, StatementExecutionException {</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> // 1. execute normal query</span></span> |
| <span class="line"><span style="color:#C678DD;"> try</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">SessionDataSetWrapper</span><span style="color:#E06C75;"> wrapper</span><span style="color:#56B6C2;"> =</span><span style="color:#E5C07B;"> sessionPool</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">executeQueryStatement</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"select s1 from root.sg1.d1 limit 10"</span><span style="color:#ABB2BF;">)) {</span></span> |
| <span class="line"><span style="color:#C678DD;"> while</span><span style="color:#ABB2BF;"> (</span><span style="color:#E5C07B;">wrapper</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">hasNext</span><span style="color:#ABB2BF;">()) {</span></span> |
| <span class="line"><span style="color:#E5C07B;"> System</span><span style="color:#ABB2BF;">.</span><span style="color:#E5C07B;">out</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">println</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">wrapper</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">next</span><span style="color:#ABB2BF;">());</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> }</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> }</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> // 2. execute aggregate query</span></span> |
| <span class="line"><span style="color:#C678DD;"> try</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">SessionDataSetWrapper</span><span style="color:#E06C75;"> wrapper</span><span style="color:#56B6C2;"> =</span><span style="color:#E5C07B;"> sessionPool</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">executeQueryStatement</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"select count(s1) from root.sg1.d1 group by ([0, 40), 5ms) "</span><span style="color:#ABB2BF;">)) {</span></span> |
| <span class="line"><span style="color:#C678DD;"> while</span><span style="color:#ABB2BF;"> (</span><span style="color:#E5C07B;">wrapper</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">hasNext</span><span style="color:#ABB2BF;">()) {</span></span> |
| <span class="line"><span style="color:#E5C07B;"> System</span><span style="color:#ABB2BF;">.</span><span style="color:#E5C07B;">out</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">println</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">wrapper</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">next</span><span style="color:#ABB2BF;">());</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> }</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:#C678DD;"> private</span><span style="color:#C678DD;"> static</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> constructSessionPool</span><span style="color:#ABB2BF;">() {</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> // Using nodeUrls ensures that when one node goes down, other nodes are automatically connected to retry</span></span> |
| <span class="line"><span style="color:#E5C07B;"> List</span><span style="color:#ABB2BF;"><</span><span style="color:#E5C07B;">String</span><span style="color:#ABB2BF;">> </span><span style="color:#E06C75;">nodeUrls</span><span style="color:#56B6C2;"> =</span><span style="color:#C678DD;"> new</span><span style="color:#E5C07B;"> ArrayList</span><span style="color:#ABB2BF;"><>();</span></span> |
| <span class="line"><span style="color:#E5C07B;"> nodeUrls</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">add</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"127.0.0.1:6667"</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#E5C07B;"> nodeUrls</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">add</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"127.0.0.1:6668"</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> sessionPool </span><span style="color:#56B6C2;">=</span></span> |
| <span class="line"><span style="color:#C678DD;"> new</span><span style="color:#ABB2BF;"> SessionPool.</span><span style="color:#61AFEF;">Builder</span><span style="color:#ABB2BF;">()</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> .</span><span style="color:#61AFEF;">nodeUrls</span><span style="color:#ABB2BF;">(nodeUrls)</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> .</span><span style="color:#61AFEF;">user</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"root"</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> .</span><span style="color:#61AFEF;">password</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"root"</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> .</span><span style="color:#61AFEF;">maxSize</span><span style="color:#ABB2BF;">(</span><span style="color:#D19A66;">3</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> .</span><span style="color:#61AFEF;">build</span><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:#C678DD;"> public</span><span style="color:#C678DD;"> static</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> closeSessionPool</span><span style="color:#ABB2BF;">(){</span></span> |
| <span class="line"><span style="color:#E5C07B;"> sessionPool</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">close</span><span style="color:#ABB2BF;">();</span></span> |
| <span class="line"><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></div><h3 id="_3-native-interface-description" tabindex="-1"><a class="header-anchor" href="#_3-native-interface-description"><span>3. Native Interface Description</span></a></h3><h4 id="_3-1-parameter-list" tabindex="-1"><a class="header-anchor" href="#_3-1-parameter-list"><span>3.1 Parameter List</span></a></h4><p>The Session class has the following fields, which can be set through the constructor or the Session.Builder method:</p><table><thead><tr><th><strong>Field Name</strong></th><th><strong>Type</strong></th><th><strong>Description</strong></th></tr></thead><tbody><tr><td><code>nodeUrls</code></td><td><code>List<String></code></td><td>List of URLs for database nodes, supporting multiple node connections</td></tr><tr><td><code>username</code></td><td><code>String</code></td><td>Username</td></tr><tr><td><code>password</code></td><td><code>String</code></td><td>Password</td></tr><tr><td><code>fetchSize</code></td><td><code>int</code></td><td>Default batch size for query results</td></tr><tr><td><code>useSSL</code></td><td><code>boolean</code></td><td>Whether to enable SSL</td></tr><tr><td><code>trustStore</code></td><td><code>String</code></td><td>Path to the trust store</td></tr><tr><td><code>trustStorePwd</code></td><td><code>String</code></td><td>Password for the trust store</td></tr><tr><td><code>queryTimeoutInMs</code></td><td><code>long</code></td><td>Query timeout in milliseconds</td></tr><tr><td><code>enableRPCCompression</code></td><td><code>boolean</code></td><td>Whether to enable RPC compression</td></tr><tr><td><code>connectionTimeoutInMs</code></td><td><code>int</code></td><td>Connection timeout in milliseconds</td></tr><tr><td><code>zoneId</code></td><td><code>ZoneId</code></td><td>Time zone setting for the session</td></tr><tr><td><code>thriftDefaultBufferSize</code></td><td><code>int</code></td><td>Default buffer size for Thrift Thrift</td></tr><tr><td><code>thriftMaxFrameSize</code></td><td><code>int</code></td><td>Maximum frame size for Thrift Thrift</td></tr><tr><td><code>defaultEndPoint</code></td><td><code>TEndPoint</code></td><td>Default database endpoint information</td></tr><tr><td><code>defaultSessionConnection</code></td><td><code>SessionConnection</code></td><td>Default session connection object</td></tr><tr><td><code>isClosed</code></td><td><code>boolean</code></td><td>Whether the current session is closed</td></tr><tr><td><code>enableRedirection</code></td><td><code>boolean</code></td><td>Whether to enable redirection</td></tr><tr><td><code>enableRecordsAutoConvertTablet</code></td><td><code>boolean</code></td><td>Whether to enable the function of recording the automatic transfer to Tablet</td></tr><tr><td><code>deviceIdToEndpoint</code></td><td><code>Map<String, TEndPoint></code></td><td>Mapping of device IDs to database endpoints</td></tr><tr><td><code>endPointToSessionConnection</code></td><td><code>Map<TEndPoint, SessionConnection></code></td><td>Mapping of database endpoints to session connections</td></tr><tr><td><code>executorService</code></td><td><code>ScheduledExecutorService</code></td><td>Thread pool for periodically updating the node list</td></tr><tr><td><code>availableNodes</code></td><td><code>INodeSupplier</code></td><td>Supplier of available nodes</td></tr><tr><td><code>enableQueryRedirection</code></td><td><code>boolean</code></td><td>Whether to enable query redirection</td></tr><tr><td><code>version</code></td><td><code>Version</code></td><td>Client version number, used for compatibility judgment with the server</td></tr><tr><td><code>enableAutoFetch</code></td><td><code>boolean</code></td><td>Whether to enable automatic fetching</td></tr><tr><td><code>maxRetryCount</code></td><td><code>int</code></td><td>Maximum number of retries</td></tr><tr><td><code>retryIntervalInMs</code></td><td><code>long</code></td><td>Retry interval in milliseconds</td></tr></tbody></table><h4 id="_3-2-interface-list" tabindex="-1"><a class="header-anchor" href="#_3-2-interface-list"><span>3.2 Interface list</span></a></h4><h5 id="_3-2-1-metadata-management" tabindex="-1"><a class="header-anchor" href="#_3-2-1-metadata-management"><span>3.2.1 Metadata Management</span></a></h5><table><thead><tr><th><strong>Method Name</strong></th><th><strong>Function Description</strong></th><th><strong>Parameter Explanation</strong></th></tr></thead><tbody><tr><td><code>createDatabase(String database)</code></td><td>Create a database</td><td><code>database</code>: The name of the database to be created</td></tr><tr><td><code>deleteDatabase(String database)</code></td><td>Delete a specified database</td><td><code>database</code>: The name of the database to be deleted</td></tr><tr><td><code>deleteDatabases(List<String> databases)</code></td><td>Batch delete databases</td><td><code>databases</code>: A list of database names to be deleted</td></tr><tr><td><code>createTimeseries(String path, TSDataType dataType, TSEncoding encoding, CompressionType compressor)</code></td><td>Create a single time series</td><td><code>path</code>: The path of the time series，<code>dataType</code>: The data type，<code>encoding</code>: The encoding type，<code>compressor</code>: The compression type</td></tr><tr><td><code>createAlignedTimeseries(...)</code></td><td>Create aligned time series</td><td>Device ID, list of measurement points, list of data types, list of encodings, list of compression types</td></tr><tr><td><code>createMultiTimeseries(...)</code></td><td>Batch create time series</td><td>Multiple paths, data types, encodings, compression types, properties, tags, aliases, etc.</td></tr><tr><td><code>deleteTimeseries(String path)</code></td><td>Delete a time series</td><td><code>path</code>: The path of the time series to be deleted</td></tr><tr><td><code>deleteTimeseries(List<String> paths)</code></td><td>Batch delete time series</td><td><code>paths</code>: A list of time series paths to be deleted</td></tr><tr><td><code>setSchemaTemplate(String templateName, String prefixPath)</code></td><td>Set a schema template</td><td><code>templateName</code>: The name of template，<code>prefixPath</code>: The path where the template is applied</td></tr><tr><td><code>createSchemaTemplate(Template template)</code></td><td>Create a schema template</td><td><code>template</code>: The template object</td></tr><tr><td><code>dropSchemaTemplate(String templateName)</code></td><td>Delete a schema template</td><td><code>templateName</code>: The name of template to be deleted</td></tr><tr><td><code>addAlignedMeasurementsInTemplate(...)</code></td><td>Add aligned measurements to a template</td><td>Template name, list of measurement paths, data type, encoding type, compression type</td></tr><tr><td><code>addUnalignedMeasurementsInTemplate(...)</code></td><td>Add unaligned measurements to a template</td><td>Same as above</td></tr><tr><td><code>deleteNodeInTemplate(String templateName, String path)</code></td><td>Delete a node in a template</td><td><code>templateName</code>: The name of template，<code>path</code>: The path to be deleted</td></tr><tr><td><code>countMeasurementsInTemplate(String name)</code></td><td>Count the number of measurements in a template</td><td><code>name</code>: The name of template</td></tr><tr><td><code>isMeasurementInTemplate(String templateName, String path)</code></td><td>Check if a measurement exists in a template</td><td><code>templateName</code>: The name of template，<code>path</code>: The path of the measurement</td></tr><tr><td><code>isPathExistInTemplate(String templateName, String path)</code></td><td>Check if a path exists in a template</td><td>same as above</td></tr><tr><td><code>showMeasurementsInTemplate(String templateName)</code></td><td>Show measurements in a template</td><td><code>templateName</code>: The name of template</td></tr><tr><td><code>showMeasurementsInTemplate(String templateName, String pattern)</code></td><td>Show measurements in a template by pattern</td><td><code>templateName</code>: The name of template，<code>pattern</code>: The matching pattern</td></tr><tr><td><code>showAllTemplates()</code></td><td>Show all templates</td><td>No parameters</td></tr><tr><td><code>showPathsTemplateSetOn(String templateName)</code></td><td>Show paths where a template is set</td><td><code>templateName</code>: The name of the template</td></tr><tr><td><code>showPathsTemplateUsingOn(String templateName)</code></td><td>Show actual paths using a template</td><td>Same as above上</td></tr><tr><td><code>unsetSchemaTemplate(String prefixPath, String templateName)</code></td><td>Unset the template setting for a path</td><td><code>prefixPath</code>: The path，<code>templateName</code>: The name of template</td></tr></tbody></table><h5 id="_3-2-2-data-insertion" tabindex="-1"><a class="header-anchor" href="#_3-2-2-data-insertion"><span>3.2.2 Data Insertion</span></a></h5><table><thead><tr><th><strong>Method Name</strong></th><th><strong>Function Description</strong></th><th><strong>Parameter Explanation</strong></th></tr></thead><tbody><tr><td><code>insertRecord(String deviceId, long time, List<String> measurements, List<TSDataType> types, Object... values)</code></td><td>Insert a single record</td><td><code>deviceId</code>: Device ID，<code>time</code>: Timestamp，<code>measurements</code>: List of measurement points，<code>types</code>: List of data types，<code>values</code>: List of values</td></tr><tr><td><code>insertRecord(String deviceId, long time, List<String> measurements, List<String> values)</code></td><td>Insert a single record</td><td><code>deviceId</code>: Device ID，<code>time</code>: Timestamp，<code>measurements</code>: List of measurement points，<code>values</code>: List of values</td></tr><tr><td><code>insertRecords(List<String> deviceIds, List<Long> times, List<List<String>> measurementsList, List<List<Object>> valuesList)</code></td><td>Insert multiple records</td><td><code>deviceIds</code>: List of device IDs，<code>times</code>: List of timestamps，<code>measurementsList</code>: List of timestamps，<code>valuesList</code>: List of lists of values</td></tr><tr><td><code>insertRecords(List<String> deviceIds, List<Long> times, List<List<String>> measurementsList, List<List<TSDataType>> typesList, List<List<Object>> valuesList)</code></td><td>Insert multiple records</td><td>Same as above，plus <code>typesList</code>: List of lists of data types</td></tr><tr><td><code>insertRecordsOfOneDevice(String deviceId, List<Long> times, List<List<String>> measurementsList, List<List<TSDataType>> typesList, List<List<Object>> valuesList)</code></td><td>Insert multiple records for a single device</td><td><code>deviceId</code>: Device ID，<code>times</code>: List of timestamps，<code>measurementsList</code>: List of lists of measurement points，<code>typesList</code>: List of lists of types，<code>valuesList</code>: List of lists of values</td></tr><tr><td><code>insertRecordsOfOneDevice(String deviceId, List<Long> times, List<List<String>> measurementsList, List<List<TSDataType>> typesList, List<List<Object>> valuesList, boolean haveSorted)</code></td><td>Insert sorted multiple records for a single device</td><td>Same as above, plus <code>haveSorted</code>: Whether the data is already sorted</td></tr><tr><td><code>insertStringRecordsOfOneDevice(String deviceId, List<Long> times, List<List<String>> measurementsList, List<List<String>> valuesList)</code></td><td>Insert string-formatted records for a single device</td><td><code>deviceId</code>: Device ID，<code>times</code>: List of timestamps，<code>measurementsList</code>: List of lists of measurement points，<code>valuesList</code>: List of lists of values</td></tr><tr><td><code>insertStringRecordsOfOneDevice(String deviceId, List<Long> times, List<List<String>> measurementsList, List<List<String>> valuesList, boolean haveSorted)</code></td><td>Insert sorted string-formatted records for a single device</td><td>Same as above, plus <code>haveSorted</code>: Whether the data is already sorted序</td></tr><tr><td><code>insertAlignedRecord(String deviceId, long time, List<String> measurements, List<TSDataType> types, List<Object> values)</code></td><td>Insert a single aligned record</td><td><code>deviceId</code>: Device ID，<code>time</code>: Timestamp，<code>measurements</code>: List of measurement points，<code>types</code>: List of types，<code>values</code>: List of values</td></tr><tr><td><code>insertAlignedRecord(String deviceId, long time, List<String> measurements, List<String> values)</code></td><td>Insert a single string-formatted aligned record</td><td><code>deviceId</code>: Device ID<code>time</code>: Timestamp,<code>measurements</code>: List of measurement points，<code>values</code>: List of values</td></tr><tr><td><code>insertAlignedRecords(List<String> deviceIds, List<Long> times, List<List<String>> measurementsList, List<List<Object>> valuesList)</code></td><td>Insert multiple aligned records</td><td><code>deviceIds</code>: List of device IDs，<code>times</code>: List of timestamps，<code>measurementsList</code>: List of lists of measurement points，<code>valuesList</code>: List of lists of values</td></tr><tr><td><code>insertAlignedRecords(List<String> deviceIds, List<Long> times, List<List<String>> measurementsList, List<List<TSDataType>> typesList, List<List<Object>> valuesList)</code></td><td>Insert multiple aligned records</td><td>Same as above, plus <code>typesList</code>: List of lists of data types</td></tr><tr><td><code>insertAlignedRecordsOfOneDevice(String deviceId, List<Long> times, List<List<String>> measurementsList, List<List<TSDataType>> typesList, List<List<Object>> valuesList)</code></td><td>Insert multiple aligned records for a single device</td><td>Same as above</td></tr><tr><td><code>insertAlignedRecordsOfOneDevice(String deviceId, List<Long> times, List<List<String>> measurementsList, List<List<TSDataType>> typesList, List<List<Object>> valuesList, boolean haveSorted)</code></td><td>Insert sorted multiple aligned records for a single device</td><td>Same as above, plus <code>haveSorted</code>: Whether the data is already sorted</td></tr><tr><td><code>insertAlignedStringRecordsOfOneDevice(String deviceId, List<Long> times, List<List<String>> measurementsList, List<List<String>> valuesList)</code></td><td>Insert string-formatted aligned records for a single device</td><td><code>deviceId</code>: Device ID，<code>times</code>: List of timestamps，<code>measurementsList</code>: List of lists of measurement points，<code>valuesList</code>: List of lists of values</td></tr><tr><td><code>insertAlignedStringRecordsOfOneDevice(String deviceId, List<Long> times, List<List<String>> measurementsList, List<List<String>> valuesList, boolean haveSorted)</code></td><td>Insert sorted string-formatted aligned records for a single device</td><td>Same as above, plus w <code>haveSorted</code>: whether the data is already sorted</td></tr><tr><td><code>insertTablet(Tablet tablet)</code></td><td>Insert a single Tablet data</td><td><code>tablet</code>: The Tablet data to be inserted</td></tr><tr><td><code>insertTablet(Tablet tablet, boolean sorted)</code></td><td>Insert a sorted Tablet data</td><td>Same as above, plus <code>sorted</code>: whether the data is already sorted</td></tr><tr><td><code>insertAlignedTablet(Tablet tablet)</code></td><td>Insert an aligned Tablet data</td><td><code>tablet</code>: The Tablet data to be inserted</td></tr><tr><td><code>insertAlignedTablet(Tablet tablet, boolean sorted)</code></td><td>Insert a sorted aligned Tablet data</td><td>Same as above, plus <code>sorted</code>: whether the data is already sorted</td></tr><tr><td><code>insertTablets(Map<String, Tablet> tablets)</code></td><td>Insert multiple Tablet data in batch</td><td><code>tablets</code>: Mapping from device IDs to Tablet data</td></tr><tr><td><code>insertTablets(Map<String, Tablet> tablets, boolean sorted)</code></td><td>Insert sorted multiple Tablet data in batch</td><td>Same as above, plus <code>sorted</code>: whether the data is already sorted</td></tr><tr><td><code>insertAlignedTablets(Map<String, Tablet> tablets)</code></td><td>Insert multiple aligned Tablet data in batch</td><td><code>tablets</code>: Mapping from device IDs to Tablet data</td></tr><tr><td><code>insertAlignedTablets(Map<String, Tablet> tablets, boolean sorted)</code></td><td>Insert sorted multiple aligned Tablet data in batch</td><td>Same as above, plus <code>sorted</code>: whether the data is already sorted</td></tr></tbody></table><h5 id="_3-2-3-data-deletion" tabindex="-1"><a class="header-anchor" href="#_3-2-3-data-deletion"><span>3.2.3 Data Deletion</span></a></h5><table><thead><tr><th><strong>Method Name</strong></th><th><strong>Function Description</strong></th><th><strong>Parameter Explanation</strong></th></tr></thead><tbody><tr><td><code>deleteTimeseries(String path)</code></td><td>Delete a single time series</td><td><code>path</code>: The path of the time series</td></tr><tr><td><code>deleteTimeseries(List<String> paths)</code></td><td>Batch delete time series</td><td><code>paths</code>: A list of time series paths</td></tr><tr><td><code>deleteData(String path, long endTime)</code></td><td>Delete historical data for a specified path</td><td><code>path</code>: The path，<code>endTime</code>: The end timestamp</td></tr><tr><td><code>deleteData(List<String> paths, long endTime)</code></td><td>Batch delete historical data for specified paths</td><td><code>paths</code>: A list of paths，<code>endTime</code>: The end timestamp</td></tr><tr><td><code>deleteData(List<String> paths, long startTime, long endTime)</code></td><td>Delete historical data within a time range for specified paths</td><td>Same as above, plus <code>startTime</code>: The start timestamp</td></tr></tbody></table><h5 id="_3-2-4-data-query" tabindex="-1"><a class="header-anchor" href="#_3-2-4-data-query"><span>3.2.4 Data Query</span></a></h5><table><thead><tr><th><strong>Method Name</strong></th><th><strong>Function Description</strong></th><th><strong>Parameter Explanation</strong></th></tr></thead><tbody><tr><td><code>executeQueryStatement(String sql)</code></td><td>Execute a query statement</td><td><code>sql</code>: The query SQL statement</td></tr><tr><td><code>executeQueryStatement(String sql, long timeoutInMs)</code></td><td>Execute a query statement with timeout</td><td><code>sql</code>: The query SQL statement, <code>timeoutInMs</code>: The query timeout (in milliseconds)</td></tr><tr><td><code>executeRawDataQuery(List<String> paths, long startTime, long endTime)</code></td><td>Query raw data for specified paths</td><td>paths: A list of query paths, <code>startTime</code>: The start timestamp, <code>endTime</code>: The end timestamp</td></tr><tr><td><code>executeRawDataQuery(List<String> paths, long startTime, long endTime, long timeOut)</code></td><td>Query raw data for specified paths (with timeout)</td><td>Same as above, plus <code>timeOut</code>: The timeout time</td></tr><tr><td><code>executeLastDataQuery(List<String> paths)</code></td><td>Query the latest data</td><td><code>paths</code>: A list of query paths</td></tr><tr><td><code>executeLastDataQuery(List<String> paths, long lastTime)</code></td><td>Query the latest data at a specified time</td><td><code>paths</code>: A list of query paths, <code>lastTime</code>: The specified timestamp</td></tr><tr><td><code>executeLastDataQuery(List<String> paths, long lastTime, long timeOut)</code></td><td>Query the latest data at a specified time (with timeout)</td><td>Same as above, plus <code>timeOut</code>: The timeout time</td></tr><tr><td><code>executeLastDataQueryForOneDevice(String db, String device, List<String> sensors, boolean isLegalPathNodes)</code></td><td>Query the latest data for a single device</td><td><code>db</code>: The database name, <code>device</code>: The device name, <code>sensors</code>: A list of sensors, <code>isLegalPathNodes</code>: Whether the path nodes are legal</td></tr><tr><td><code>executeAggregationQuery(List<String> paths, List<TAggregationType> aggregations)</code></td><td>Execute an aggregation query</td><td><code>paths</code>: A list of query paths, <code>aggregations</code>: A list of aggregation types</td></tr><tr><td><code>executeAggregationQuery(List<String> paths, List<TAggregationType> aggregations, long startTime, long endTime)</code></td><td>Execute an aggregation query with a time range</td><td>Same as above, plus <code>startTime</code>: The start timestamp, <code>endTime</code>:` The end timestamp</td></tr><tr><td><code>executeAggregationQuery(List<String> paths, List<TAggregationType> aggregations, long startTime, long endTime, long interval)</code></td><td>Execute an aggregation query with a time interval</td><td>Same as above, plus <code>interval</code>: The time interval</td></tr><tr><td><code>executeAggregationQuery(List<String> paths, List<TAggregationType> aggregations, long startTime, long endTime, long interval, long slidingStep)</code></td><td>Execute a sliding window aggregation query</td><td>Same as above, plus <code>slidingStep</code>: The sliding step</td></tr><tr><td><code>fetchAllConnections()</code></td><td>Get information of all active connections</td><td>No parameters</td></tr></tbody></table><h5 id="_3-2-5-system-status-and-backup" tabindex="-1"><a class="header-anchor" href="#_3-2-5-system-status-and-backup"><span>3.2.5 System Status and Backup</span></a></h5><table><thead><tr><th><strong>Method Name</strong></th><th><strong>Function Description</strong></th><th><strong>Parameter Explanation</strong></th></tr></thead><tbody><tr><td><code>getBackupConfiguration()</code></td><td>Get backup configuration information</td><td>No parameters</td></tr><tr><td><code>fetchAllConnections()</code></td><td>Get information of all active connections</td><td>No parameters</td></tr><tr><td><code>getSystemStatus()</code></td><td>Get the system status</td><td>Deprecated, returns <code>SystemStatus.NORMAL</code></td></tr></tbody></table></div><!----><footer class="vp-page-meta"><div class="vp-meta-item edit-link"><a class="auto-link external-link vp-meta-label" href="https://github.com/apache/iotdb-docs/edit/main/src/UserGuide/latest/API/Programming-Java-Native-API.md" aria-label="Found Error? Edit this page on GitHub" rel="noopener noreferrer" target="_blank" iconsizing="both"><!--[--><svg xmlns="http://www.w3.org/2000/svg" class="icon edit-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="edit icon" name="edit"><path d="M430.818 653.65a60.46 60.46 0 0 1-50.96-93.281l71.69-114.012 7.773-10.365L816.038 80.138A60.46 60.46 0 0 1 859.225 62a60.46 60.46 0 0 1 43.186 18.138l43.186 43.186a60.46 60.46 0 0 1 0 86.373L588.879 565.55l-8.637 8.637-117.466 68.234a60.46 60.46 0 0 1-31.958 11.229z"></path><path d="M728.802 962H252.891A190.883 190.883 0 0 1 62.008 771.98V296.934a190.883 190.883 0 0 1 190.883-192.61h267.754a60.46 60.46 0 0 1 0 120.92H252.891a69.962 69.962 0 0 0-69.098 69.099V771.98a69.962 69.962 0 0 0 69.098 69.098h475.911A69.962 69.962 0 0 0 797.9 771.98V503.363a60.46 60.46 0 1 1 120.922 0V771.98A190.883 190.883 0 0 1 728.802 962z"></path></svg><!--]-->Found Error? Edit this page on GitHub<!----></a></div><div class="vp-meta-item git-info"><div class="update-time"><span class="vp-meta-label">Last update: </span><span class="vp-meta-info" data-allow-mismatch="text">3/5/2025, 10:17:06 AM</span></div><!----></div></footer><nav class="vp-page-nav"><!----><a class="route-link auto-link next" href="/UserGuide/latest/API/Programming-Data-Subscription.html" aria-label="Data Subscription API" iconsizing="both"><div class="hint">Next<span class="arrow end"></span></div><div class="link">Data Subscription API<!----></div></a></nav><!----><!----><!--]--></main><!--]--><footer class="site-footer"><span id="doc-version" style="display:none;">latest</span><p class="copyright-text">Copyright © 2025 The Apache Software Foundation. |
| Apache IoTDB, IoTDB, Apache, the Apache feather logo, and the Apache IoTDB project logo are either registered trademarks or trademarks of The Apache Software Foundation in all countries</p><p style="text-align:center;margin-top:10px;color:#909399;font-size:12px;margin:0 30px;"><strong>Having questions?</strong> Connect with us on QQ, WeChat, or Slack. <a href="https://github.com/apache/iotdb/issues/1995">Join the community</a></p></footer></div><!--]--><!--]--><!--[--><!----><!--]--><!--]--></div> |
| <script type="module" src="/assets/app-C-fAkKj6.js" defer></script> |
| </body> |
| </html> |
