| <!doctype html> |
| <html lang="zh-CN" 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="en-us" href="https://iotdb.apache.org/UserGuide/V0.13.x/API/Programming-Java-Native-API.html"><meta property="og:url" content="https://iotdb.apache.org/zh/UserGuide/V0.13.x/API/Programming-Java-Native-API.html"><meta property="og:site_name" content="IoTDB Website"><meta property="og:title" content="应用编程接口"><meta property="og:description" content="应用编程接口 Java 原生接口 安装 依赖 JDK >= 1.8 Maven >= 3.6 在 MAVEN 中使用原生接口 语法说明 对于 IoTDB-SQL 接口：传入的 SQL 参数需要符合 ，并且针对 JAVA 字符串进行反转义，如双引号前需要加反斜杠。（即：经 JAVA 转义之后与命令行执行的 SQL 语句一致。） 对于其他接口： 经参数传入..."><meta property="og:type" content="article"><meta property="og:locale" content="zh-CN"><meta property="og:locale:alternate" content="en-US"><meta property="og:updated_time" content="2024-12-04T09:08:04.000Z"><meta property="article:modified_time" content="2024-12-04T09:08:04.000Z"><script type="application/ld+json">{"@context":"https://schema.org","@type":"Article","headline":"应用编程接口","image":[""],"dateModified":"2024-12-04T09:08:04.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>应用编程接口 | IoTDB Website</title><meta name="description" content="应用编程接口 Java 原生接口 安装 依赖 JDK >= 1.8 Maven >= 3.6 在 MAVEN 中使用原生接口 语法说明 对于 IoTDB-SQL 接口：传入的 SQL 参数需要符合 ，并且针对 JAVA 字符串进行反转义，如双引号前需要加反斜杠。（即：经 JAVA 转义之后与命令行执行的 SQL 语句一致。） 对于其他接口： 经参数传入..."> |
| <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-yBsxfL1p.js"> |
| |
| </head> |
| <body> |
| <div id="app"><!--[--><!--[--><!--[--><span tabindex="-1"></span><a href="#main-content" class="vp-skip-link sr-only">跳至主要內容</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="/zh/" aria-label="带我回家"><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="搜索文档"><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">搜索文档</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="文档"><!--[--><!---->文档<!--]--><span class="arrow"></span><ul class="vp-dropdown"><li class="vp-dropdown-item"><a class="route-link auto-link" href="/zh/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="/zh/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="/zh/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="/zh/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/pages/viewpage.action?pageId=177051872" aria-label="系统设计" rel="noopener noreferrer" target="_blank" iconsizing="height"><!---->系统设计<!----></a></div><div class="vp-nav-item hide-in-mobile"><a class="route-link auto-link" href="/zh/Download/" aria-label="下载" iconsizing="height"><!---->下载<!----></a></div><div class="vp-nav-item hide-in-mobile"><div class="vp-dropdown-wrapper"><button type="button" class="vp-dropdown-title" aria-label="社区"><!--[--><!---->社区<!--]--><span class="arrow"></span><ul class="vp-dropdown"><li class="vp-dropdown-item"><a class="route-link auto-link" href="/zh/Community/About.html" aria-label="关于社区" iconsizing="both"><!---->关于社区<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/zh/Community/Development-Guide.html" aria-label="贡献指南" iconsizing="both"><!---->贡献指南<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/zh/Community/Community-Partners.html" aria-label="社区伙伴" iconsizing="both"><!---->社区伙伴<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/zh/Community/Feedback.html" aria-label="交流与反馈" iconsizing="both"><!---->交流与反馈<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/zh/Community/Events-and-Reports.html" aria-label="活动与报告" iconsizing="both"><!---->活动与报告<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/zh/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="基金会" rel="noopener noreferrer" target="_blank" iconsizing="both"><!---->基金会<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/licenses/" aria-label="许可证" rel="noopener noreferrer" target="_blank" iconsizing="both"><!---->许可证<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/security/" aria-label="安全" rel="noopener noreferrer" target="_blank" iconsizing="both"><!---->安全<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/foundation/sponsorship.html" aria-label="赞助" rel="noopener noreferrer" target="_blank" iconsizing="both"><!---->赞助<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/foundation/thanks.html" aria-label="致谢" rel="noopener noreferrer" target="_blank" iconsizing="both"><!---->致谢<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/events/current-event" aria-label="活动" rel="noopener noreferrer" target="_blank" iconsizing="both"><!---->活动<!----></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="隐私" rel="noopener noreferrer" target="_blank" iconsizing="both"><!---->隐私<!----></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="选择语言"><!--[--><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 auto-link" href="/UserGuide/V0.13.x/API/Programming-Java-Native-API.html" aria-label="English" iconsizing="both"><!---->English<!----></a></li><li class="vp-dropdown-item"><a class="route-link route-link-active auto-link" href="/zh/UserGuide/V0.13.x/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用户手册 (V0.13.x)</span></p><div class="sidebar-top-wrapper"><!----></div><!--]--><ul class="vp-sidebar-links"><li><section class="vp-sidebar-group"><p class="vp-sidebar-header"><!----><span class="vp-sidebar-title">IoTDB用户手册 (V0.13.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">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">快速上手</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">数据模式与概念</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">语法约定</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">应用编程接口</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="/zh/UserGuide/V0.13.x/API/Programming-Java-Native-API.html" aria-label="Java 原生接口" iconsizing="both"><!---->Java 原生接口<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/zh/UserGuide/V0.13.x/API/Programming-Python-Native-API.html" aria-label="Python 原生接口" iconsizing="both"><!---->Python 原生接口<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/zh/UserGuide/V0.13.x/API/Programming-Cpp-Native-API.html" aria-label="C++ 原生接口" iconsizing="both"><!---->C++ 原生接口<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/zh/UserGuide/V0.13.x/API/Programming-Go-Native-API.html" aria-label="Go 原生接口" iconsizing="both"><!---->Go 原生接口<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/zh/UserGuide/V0.13.x/API/Programming-JDBC.html" aria-label="JDBC (不推荐)" iconsizing="both"><!---->JDBC (不推荐)<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/zh/UserGuide/V0.13.x/API/Programming-MQTT.html" aria-label="MQTT" iconsizing="both"><!---->MQTT<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/zh/UserGuide/V0.13.x/API/RestService.html" aria-label="REST API" iconsizing="both"><!---->REST API<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/zh/UserGuide/V0.13.x/API/Programming-TsFile-API.html" aria-label="TsFile API" iconsizing="both"><!---->TsFile API<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/zh/UserGuide/V0.13.x/API/Status-Codes.html" aria-label="状态码" iconsizing="both"><!---->状态码<!----></a></li></ul></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">元数据操作</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">数据写入和删除</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">数据查询</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">数据处理</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">权限管理</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">运维工具</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">系统集成</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">UDF 资料库</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">附录</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><!---->应用编程接口</h1><div class="page-info"><!----><!----><span class="page-date-info" aria-label="写作日期📅" 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">2023年7月10日</span><meta property="datePublished" content="2023-07-10T03:11:17.000Z"></span><!----><span class="page-reading-time-info" aria-label="阅读时间⌛" 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>大约 12 分钟</span><meta property="timeRequired" content="PT12M"></span><!----><!----></div><hr></div><div class="vp-toc-placeholder"><aside id="toc" vp-toc><!----><!--[--><div class="vp-toc-header">此页内容<button type="button" class="print-button" title="打印"><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="#java-原生接口">Java 原生接口</a></li><li><ul class="vp-toc-list"><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level3" href="#安装">安装</a></li><!----><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level3" href="#依赖">依赖</a></li><!----><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level3" href="#在-maven-中使用原生接口">在 MAVEN 中使用原生接口</a></li><!----><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level3" href="#语法说明">语法说明</a></li><!----><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level3" href="#基本接口说明">基本接口说明</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="应用编程接口" tabindex="-1"><a class="header-anchor" href="#应用编程接口"><span>应用编程接口</span></a></h1><h2 id="java-原生接口" tabindex="-1"><a class="header-anchor" href="#java-原生接口"><span>Java 原生接口</span></a></h2><h3 id="安装" tabindex="-1"><a class="header-anchor" href="#安装"><span>安装</span></a></h3><h3 id="依赖" tabindex="-1"><a class="header-anchor" href="#依赖"><span>依赖</span></a></h3><ul><li>JDK >= 1.8</li><li>Maven >= 3.6</li></ul><h3 id="在-maven-中使用原生接口" tabindex="-1"><a class="header-anchor" href="#在-maven-中使用原生接口"><span>在 MAVEN 中使用原生接口</span></a></h3><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:#ABB2BF;"> <</span><span style="color:#E06C75;">version</span><span style="color:#ABB2BF;">>0.13.0-SNAPSHOT</</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></div><h3 id="语法说明" tabindex="-1"><a class="header-anchor" href="#语法说明"><span>语法说明</span></a></h3><ul><li>对于 IoTDB-SQL 接口：传入的 SQL 参数需要符合 <a class="route-link" href="/zh/UserGuide/V0.13.x/Reference/Syntax-Conventions.html">语法规范</a> ，并且针对 JAVA 字符串进行反转义，如双引号前需要加反斜杠。（即：经 JAVA 转义之后与命令行执行的 SQL 语句一致。）</li><li>对于其他接口： <ul><li>经参数传入的路径或路径前缀中的节点： <ul><li>在 SQL 语句中需要使用反引号（`）进行转义的，此处均不需要进行转义。</li><li>使用单引号或双引号括起的节点，仍需要使用单引号或双引号括起，并且要针对 JAVA 字符串进行反转义。</li><li>对于 <code>checkTimeseriesExists</code> 接口，由于内部调用了 IoTDB-SQL 接口，因此需要和 SQL 语法规范保持一致，并且针对 JAVA 字符串进行反转义。</li></ul></li><li>经参数传入的标识符（如模板名）：在 SQL 语句中需要使用反引号（`）进行转义的，此处均不需要进行转义。</li></ul></li></ul><h3 id="基本接口说明" tabindex="-1"><a class="header-anchor" href="#基本接口说明"><span>基本接口说明</span></a></h3><p>下面将给出 Session 对应的接口的简要介绍和对应参数：</p><h4 id="初始化" tabindex="-1"><a class="header-anchor" href="#初始化"><span>初始化</span></a></h4><ul><li>初始化 Session</li></ul><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:#7F848E;font-style:italic;">// 全部使用默认配置</span></span> |
| <span class="line"><span style="color:#E06C75;">session </span><span style="color:#56B6C2;">=</span><span style="color:#C678DD;"> new</span><span style="color:#E06C75;"> Session</span><span style="color:#ABB2BF;">.</span><span style="color:#E5C07B;">Builder</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">build</span><span style="color:#ABB2BF;">();</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">// 指定一个可连接节点</span></span> |
| <span class="line"><span style="color:#E06C75;">session </span><span style="color:#56B6C2;">=</span><span style="color:#E06C75;"> </span></span> |
| <span class="line"><span style="color:#C678DD;"> new</span><span style="color:#E06C75;"> Session</span><span style="color:#ABB2BF;">.</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;">host</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">String</span><span style="color:#ABB2BF;"> host)</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> .</span><span style="color:#61AFEF;">port</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">int</span><span style="color:#ABB2BF;"> port)</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> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">// 指定多个可连接节点</span></span> |
| <span class="line"><span style="color:#E06C75;">session </span><span style="color:#56B6C2;">=</span><span style="color:#E06C75;"> </span></span> |
| <span class="line"><span style="color:#C678DD;"> new</span><span style="color:#E06C75;"> Session</span><span style="color:#ABB2BF;">.</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;">(</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#ABB2BF;">String</span><span style="color:#56B6C2;">></span><span style="color:#ABB2BF;"> nodeUrls)</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> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">// 其他配置项</span></span> |
| <span class="line"><span style="color:#E06C75;">session </span><span style="color:#56B6C2;">=</span><span style="color:#E06C75;"> </span></span> |
| <span class="line"><span style="color:#C678DD;"> new</span><span style="color:#E06C75;"> Session</span><span style="color:#ABB2BF;">.</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;">fetchSize</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">int</span><span style="color:#ABB2BF;"> fetchSize)</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> .</span><span style="color:#61AFEF;">username</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">String</span><span style="color:#ABB2BF;"> username)</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> .</span><span style="color:#61AFEF;">password</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">String</span><span style="color:#ABB2BF;"> password)</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> .</span><span style="color:#61AFEF;">thriftDefaultBufferSize</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">int</span><span style="color:#ABB2BF;"> thriftDefaultBufferSize)</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> .</span><span style="color:#61AFEF;">thriftMaxFrameSize</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">int</span><span style="color:#ABB2BF;"> thriftMaxFrameSize)</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> .</span><span style="color:#61AFEF;">enableCacheLeader</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">boolean</span><span style="color:#ABB2BF;"> enableCacheLeader)</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> .</span><span style="color:#61AFEF;">version</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">Version</span><span style="color:#ABB2BF;"> version)</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> .</span><span style="color:#61AFEF;">build</span><span style="color:#ABB2BF;">();</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>其中，version 表示客户端使用的 SQL 语义版本，用于升级 0.13 时兼容 0.12 的 SQL 语义，可能取值有：<code>V_0_12</code>、<code>V_0_13</code>。</p><ul><li>开启 Session</li></ul><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;">void</span><span style="color:#61AFEF;"> open</span><span style="color:#E06C75;">()</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>开启 Session，并决定是否开启 RPC 压缩</li></ul><div class="language-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;">void</span><span style="color:#61AFEF;"> open</span><span style="color:#E06C75;">(</span><span style="color:#C678DD;">boolean</span><span style="color:#E06C75;"> enableRPCCompression)</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>注意: 客户端的 RPC 压缩开启状态需和服务端一致</p><ul><li>关闭 Session</li></ul><div class="language-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;">void</span><span style="color:#61AFEF;"> close</span><span style="color:#E06C75;">()</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><h4 id="数据定义接口-ddl" tabindex="-1"><a class="header-anchor" href="#数据定义接口-ddl"><span>数据定义接口 DDL</span></a></h4><h5 id="存储组管理" tabindex="-1"><a class="header-anchor" href="#存储组管理"><span>存储组管理</span></a></h5><ul><li>设置存储组</li></ul><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;">void</span><span style="color:#61AFEF;"> setStorageGroup</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> storageGroupId)</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>删除单个或多个存储组</li></ul><div class="language-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;">void</span><span style="color:#61AFEF;"> deleteStorageGroup</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> storageGroup)</span></span> |
| <span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> deleteStorageGroups</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> storageGroups)</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div></div></div><h5 id="时间序列管理" tabindex="-1"><a class="header-anchor" href="#时间序列管理"><span>时间序列管理</span></a></h5><ul><li>创建单个或多个时间序列</li></ul><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;">void</span><span style="color:#61AFEF;"> createTimeseries</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> path</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> TSDataType</span><span style="color:#E06C75;"> dataType</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> TSEncoding</span><span style="color:#E06C75;"> encoding</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> CompressionType</span><span style="color:#E06C75;"> compressor</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> Map</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#ABB2BF;">,</span><span style="color:#E06C75;"> String</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> props</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> Map</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#ABB2BF;">,</span><span style="color:#E06C75;"> String</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> tags</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> Map</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#ABB2BF;">,</span><span style="color:#E06C75;"> String</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> attributes</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> String</span><span style="color:#E06C75;"> measurementAlias)</span></span> |
| <span class="line"><span style="color:#E06C75;"> </span></span> |
| <span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> createMultiTimeseries</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> paths</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">TSDataType</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> dataTypes</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">TSEncoding</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> encodings</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">CompressionType</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> compressors</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E5C07B;">Map</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#ABB2BF;">,</span><span style="color:#E06C75;"> String</span><span style="color:#56B6C2;">>></span><span style="color:#E06C75;"> propsList</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E5C07B;">Map</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#ABB2BF;">,</span><span style="color:#E06C75;"> String</span><span style="color:#56B6C2;">>></span><span style="color:#E06C75;"> tagsList</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E5C07B;">Map</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#ABB2BF;">,</span><span style="color:#E06C75;"> String</span><span style="color:#56B6C2;">>></span><span style="color:#E06C75;"> attributesList</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> measurementAliasList)</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><ul><li>创建对齐时间序列</li></ul><div class="language- line-numbers-mode" data-highlighter="shiki" data-ext="" data-title="" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span>void createAlignedTimeseries(String prefixPath, List<String> measurements,</span></span> |
| <span class="line"><span> List<TSDataType> dataTypes, List<TSEncoding> encodings,</span></span> |
| <span class="line"><span> CompressionType compressor, List<String> measurementAliasList);</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>注意：目前<strong>暂不支持</strong>使用传感器别名。</p><ul><li>删除一个或多个时间序列</li></ul><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;">void</span><span style="color:#61AFEF;"> deleteTimeseries</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> path)</span></span> |
| <span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> deleteTimeseries</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> paths)</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>检测时间序列是否存在</li></ul><div class="language-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;">boolean</span><span style="color:#61AFEF;"> checkTimeseriesExists</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> path)</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><h5 id="元数据模版" tabindex="-1"><a class="header-anchor" href="#元数据模版"><span>元数据模版</span></a></h5><ul><li>创建元数据模板，可以通过先后创建<code>Template</code>、<code>MeasurementNode</code>的对象，描述模板内物理量结构与类型、编码方式、压缩方式等信息，并通过以下接口创建模板</li></ul><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;">public</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> createSchemaTemplate</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">Template</span><span style="color:#E06C75;"> template)</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#E5C07B;">Class</span><span style="color:#E06C75;"> Template {</span></span> |
| <span class="line"><span style="color:#C678DD;"> private</span><span style="color:#E5C07B;"> String</span><span style="color:#E06C75;"> name</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;"> private</span><span style="color:#C678DD;"> boolean</span><span style="color:#E06C75;"> directShareTime</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#E5C07B;"> Map</span><span style="color:#ABB2BF;"><</span><span style="color:#E5C07B;">String</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> Node</span><span style="color:#ABB2BF;">></span><span style="color:#E06C75;"> children</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;"> public</span><span style="color:#61AFEF;"> Template</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> name</span><span style="color:#ABB2BF;">,</span><span style="color:#C678DD;"> boolean</span><span style="color:#E06C75;"> isShareTime)</span><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;"> void</span><span style="color:#61AFEF;"> addToTemplate</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">Node</span><span style="color:#E06C75;"> node)</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;"> public</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> deleteFromTemplate</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> name)</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;"> public</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> setShareTime</span><span style="color:#E06C75;">(</span><span style="color:#C678DD;">boolean</span><span style="color:#E06C75;"> shareTime)</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#E06C75;">}</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#E5C07B;">Abstract</span><span style="color:#E5C07B;"> Class</span><span style="color:#E06C75;"> Node {</span></span> |
| <span class="line"><span style="color:#C678DD;"> private</span><span style="color:#E5C07B;"> String</span><span style="color:#E06C75;"> name</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;"> public</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> addChild</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">Node</span><span style="color:#E06C75;"> node)</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;"> public</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> deleteChild</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">Node</span><span style="color:#E06C75;"> node)</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#E06C75;">}</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#E5C07B;">Class</span><span style="color:#E5C07B;"> MeasurementNode</span><span style="color:#E06C75;"> extends Node {</span></span> |
| <span class="line"><span style="color:#E5C07B;"> TSDataType</span><span style="color:#E06C75;"> dataType</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#E5C07B;"> TSEncoding</span><span style="color:#E06C75;"> encoding</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#E5C07B;"> CompressionType</span><span style="color:#E06C75;"> compressor</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;"> public</span><span style="color:#61AFEF;"> MeasurementNode</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> name</span><span style="color:#ABB2BF;">,</span><span style="color:#E06C75;"> </span></span> |
| <span class="line"><span style="color:#E5C07B;"> TSDataType</span><span style="color:#E06C75;"> dataType</span><span style="color:#ABB2BF;">,</span><span style="color:#E06C75;"> </span></span> |
| <span class="line"><span style="color:#E5C07B;"> TSEncoding</span><span style="color:#E06C75;"> encoding</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> CompressionType</span><span style="color:#E06C75;"> compressor)</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#E06C75;">}</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></div><p>通过上述类的实例描述模板时，<code>Template</code>内应当仅能包含单层的<code>MeasurementNode</code>，具体可以参见如下示例：</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:#E5C07B;">MeasurementNode</span><span style="color:#E06C75;"> nodeX </span><span style="color:#56B6C2;">=</span><span style="color:#C678DD;"> new</span><span style="color:#61AFEF;"> MeasurementNode</span><span style="color:#E06C75;">(</span><span style="color:#98C379;">"x"</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> TSDataType</span><span style="color:#ABB2BF;">.</span><span style="color:#E5C07B;">FLOAT</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> TSEncoding</span><span style="color:#ABB2BF;">.</span><span style="color:#E5C07B;">RLE</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> CompressionType</span><span style="color:#ABB2BF;">.</span><span style="color:#E5C07B;">SNAPPY</span><span style="color:#E06C75;">)</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#E5C07B;">MeasurementNode</span><span style="color:#E06C75;"> nodeY </span><span style="color:#56B6C2;">=</span><span style="color:#C678DD;"> new</span><span style="color:#61AFEF;"> MeasurementNode</span><span style="color:#E06C75;">(</span><span style="color:#98C379;">"y"</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> TSDataType</span><span style="color:#ABB2BF;">.</span><span style="color:#E5C07B;">FLOAT</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> TSEncoding</span><span style="color:#ABB2BF;">.</span><span style="color:#E5C07B;">RLE</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> CompressionType</span><span style="color:#ABB2BF;">.</span><span style="color:#E5C07B;">SNAPPY</span><span style="color:#E06C75;">)</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#E5C07B;">MeasurementNode</span><span style="color:#E06C75;"> nodeSpeed </span><span style="color:#56B6C2;">=</span><span style="color:#C678DD;"> new</span><span style="color:#61AFEF;"> MeasurementNode</span><span style="color:#E06C75;">(</span><span style="color:#98C379;">"speed"</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> TSDataType</span><span style="color:#ABB2BF;">.</span><span style="color:#E5C07B;">DOUBLE</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> TSEncoding</span><span style="color:#ABB2BF;">.</span><span style="color:#E5C07B;">GORILLA</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> CompressionType</span><span style="color:#ABB2BF;">.</span><span style="color:#E5C07B;">SNAPPY</span><span style="color:#E06C75;">)</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">// This is the template we suggest to implement</span></span> |
| <span class="line"><span style="color:#E5C07B;">Template</span><span style="color:#E06C75;"> flatTemplate </span><span style="color:#56B6C2;">=</span><span style="color:#C678DD;"> new</span><span style="color:#61AFEF;"> Template</span><span style="color:#E06C75;">(</span><span style="color:#98C379;">"flatTemplate"</span><span style="color:#E06C75;">)</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#E5C07B;">template</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">addToTemplate</span><span style="color:#ABB2BF;">(nodeX);</span></span> |
| <span class="line"><span style="color:#E5C07B;">template</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">addToTemplate</span><span style="color:#ABB2BF;">(nodeY);</span></span> |
| <span class="line"><span style="color:#E5C07B;">template</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">addToTemplate</span><span style="color:#ABB2BF;">(nodeSpeed);</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#61AFEF;">createSchemaTemplate</span><span style="color:#E06C75;">(flatTemplate)</span><span style="color:#ABB2BF;">;</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>在创建概念元数据模板以后，还可以通过以下接口增加或删除模板内的物理量。请注意，已经挂载的模板不能删除内部的物理量。</li></ul><div class="language-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:#7F848E;font-style:italic;">// 为指定模板新增一组对齐的物理量，若其父节点在模板中已经存在，且不要求对齐，则报错</span></span> |
| <span class="line"><span style="color:#C678DD;">public</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> addAlignedMeasurementsInTemplate</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> templateName</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> String</span><span style="color:#E06C75;">[] measurementsPath</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> TSDataType</span><span style="color:#E06C75;">[] dataTypes</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> TSEncoding</span><span style="color:#E06C75;">[] encodings</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> CompressionType</span><span style="color:#E06C75;">[] compressors)</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">// 为指定模板新增一个对齐物理量, 若其父节点在模板中已经存在，且不要求对齐，则报错</span></span> |
| <span class="line"><span style="color:#C678DD;">public</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> addAlignedMeasurementInTemplate</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> templateName</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> String</span><span style="color:#E06C75;"> measurementPath</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> TSDataType</span><span style="color:#E06C75;"> dataType</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> TSEncoding</span><span style="color:#E06C75;"> encoding</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> CompressionType</span><span style="color:#E06C75;"> compressor)</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">// 为指定模板新增一个不对齐物理量, 若其父节在模板中已经存在，且要求对齐，则报错</span></span> |
| <span class="line"><span style="color:#C678DD;">public</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> addUnalignedMeasurementInTemplate</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> templateName</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> String</span><span style="color:#E06C75;"> measurementPath</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> TSDataType</span><span style="color:#E06C75;"> dataType</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> TSEncoding</span><span style="color:#E06C75;"> encoding</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> CompressionType</span><span style="color:#E06C75;"> compressor)</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#E06C75;"> </span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">// 为指定模板新增一组不对齐的物理量, 若其父节在模板中已经存在，且要求对齐，则报错</span></span> |
| <span class="line"><span style="color:#C678DD;">public</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> addUnalignedMeasurementsIntemplate</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> templateName</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> String</span><span style="color:#E06C75;">[] measurementPaths</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> TSDataType</span><span style="color:#E06C75;">[] dataTypes</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> TSEncoding</span><span style="color:#E06C75;">[] encodings</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> CompressionType</span><span style="color:#E06C75;">[] compressors)</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">// 从指定模板中删除一个节点</span></span> |
| <span class="line"><span style="color:#C678DD;">public</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> deleteNodeInTemplate</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> templateName</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> String</span><span style="color:#E06C75;"> path)</span><span style="color:#ABB2BF;">;</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>对于已经创建的元数据模板，还可以通过以下接口查询模板信息：</li></ul><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:#7F848E;font-style:italic;">// 查询返回目前模板中所有物理量的数量</span></span> |
| <span class="line"><span style="color:#C678DD;">public</span><span style="color:#C678DD;"> int</span><span style="color:#61AFEF;"> countMeasurementsInTemplate</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> templateName)</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">// 检查模板内指定路径是否为物理量</span></span> |
| <span class="line"><span style="color:#C678DD;">public</span><span style="color:#C678DD;"> boolean</span><span style="color:#61AFEF;"> isMeasurementInTemplate</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> templateName</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> String</span><span style="color:#E06C75;"> path)</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">// 检查在指定模板内是否存在某路径</span></span> |
| <span class="line"><span style="color:#C678DD;">public</span><span style="color:#C678DD;"> boolean</span><span style="color:#61AFEF;"> isPathExistInTemplate</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> templateName</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> String</span><span style="color:#E06C75;"> path)</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">// 返回指定模板内所有物理量的路径</span></span> |
| <span class="line"><span style="color:#C678DD;">public</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">></span><span style="color:#61AFEF;"> showMeasurementsInTemplate</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> templateName)</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">// 返回指定模板内某前缀路径下的所有物理量的路径</span></span> |
| <span class="line"><span style="color:#C678DD;">public</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">></span><span style="color:#61AFEF;"> showMeasurementsInTemplate</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> templateName</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> String</span><span style="color:#E06C75;"> pattern)</span><span style="color:#ABB2BF;">;</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>将名为<code>templateName</code>的元数据模板挂载到'prefixPath'路径下，在执行这一步之前，你需要创建名为<code>templateName</code>的元数据模板</li><li><strong>请注意，我们强烈建议您将模板设置在存储组或存储组下层的节点中，以更好地适配未来版本更新及各模块的协作</strong></li></ul><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;">void</span><span style="color:#61AFEF;"> setSchemaTemplate</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> templateName</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> String</span><span style="color:#E06C75;"> prefixPath)</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>将模板挂载到 MTree 上之后，你可以随时查询所有模板的名称、某模板被设置到 MTree 的所有路径、所有正在使用某模板的所有路径，即如下接口：</li></ul><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:#7F848E;font-style:italic;">/** </span><span style="color:#C678DD;font-style:italic;">@return</span><span style="color:#7F848E;font-style:italic;"> All template names. */</span></span> |
| <span class="line"><span style="color:#C678DD;">public</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">></span><span style="color:#61AFEF;"> showAllTemplates</span><span style="color:#E06C75;">()</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">/** </span><span style="color:#C678DD;font-style:italic;">@return</span><span style="color:#7F848E;font-style:italic;"> All paths have been set to designated template. */</span></span> |
| <span class="line"><span style="color:#C678DD;">public</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">></span><span style="color:#61AFEF;"> showPathsTemplateSetOn</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> templateName)</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">/** </span><span style="color:#C678DD;font-style:italic;">@return</span><span style="color:#7F848E;font-style:italic;"> All paths are using designated template. */</span></span> |
| <span class="line"><span style="color:#C678DD;">public</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">></span><span style="color:#61AFEF;"> showPathsTemplateUsingOn</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> templateName)</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><ul><li>如果你需要删除某一个模板，请确保在进行删除之前，MTree 上已经没有节点被挂载了模板，对于已经被挂载模板的节点，可以用如下接口卸载模板；</li></ul><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;">void</span><span style="color:#61AFEF;"> unsetSchemaTemplate</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> prefixPath</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> String</span><span style="color:#E06C75;"> templateName)</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;">public</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> dropSchemaTemplate</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> templateName)</span><span style="color:#ABB2BF;">;</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>请注意，如果一个子树中有多个孩子节点需要使用模板，可以在其共同父母节点上使用 <code>setSchemaTemplate</code> 。而只有在已有数据点插入模板对应的物理量，或使用以下接口激活模板，模板才会被设置为激活状态，进而被 <code>show timeseries</code> 等查询访问到。</li></ul><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;">public</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> createTimeseriesOfTemplateOnPath</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> path)</span><span style="color:#ABB2BF;">;</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>卸载'prefixPath'路径下的名为<code>templateName</code>的元数据模板。你需要保证给定的路径<code>prefixPath</code>下需要有名为<code>templateName</code>的元数据模板。</li><li>如果在挂载模板后，曾经在<code>prefixPath</code>路径及其后代节点使用模板插入数据后，或者使用了激活模板命令，那么在卸载模板之前，还要对所有已激活模板的节点使用以下接口解除模板：</li></ul><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;">public</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> deactivateTemplateOn</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> templateName</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> String</span><span style="color:#E06C75;"> prefixPath)</span><span style="color:#ABB2BF;">;</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>以上解除模板接口中，参数<code>prefixPath</code>如果含有通配符（<code>*</code>或<code>**</code>）则按 PathPattern 匹配目标路径，否则仅表达其字面量对应的路径。</li><li>解除模板接口会删除对应节点按照模板中的序列写入的数据。</li></ul><h4 id="数据操作接口-dml" tabindex="-1"><a class="header-anchor" href="#数据操作接口-dml"><span>数据操作接口 DML</span></a></h4><h5 id="数据写入" tabindex="-1"><a class="header-anchor" href="#数据写入"><span>数据写入</span></a></h5><p>推荐使用 insertTablet 帮助提高写入效率</p><ul><li>插入一个 Tablet，Tablet 是一个设备若干行数据块，每一行的列都相同 <ul><li><strong>写入效率高</strong></li><li><strong>支持批量写入</strong></li><li><strong>支持写入空值</strong>：空值处可以填入任意值，然后通过 BitMap 标记空值</li></ul></li></ul><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;">void</span><span style="color:#61AFEF;"> insertTablet</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">Tablet</span><span style="color:#E06C75;"> tablet)</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;"> Tablet</span><span style="color:#ABB2BF;"> {</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> /** deviceId of this tablet */</span></span> |
| <span class="line"><span style="color:#C678DD;"> public</span><span style="color:#E5C07B;"> String</span><span style="color:#E06C75;"> prefixPath</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> /** the list of measurement schemas for creating the tablet */</span></span> |
| <span class="line"><span style="color:#C678DD;"> private</span><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;"> schemas</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> /** timestamps in this tablet */</span></span> |
| <span class="line"><span style="color:#C678DD;"> public</span><span style="color:#C678DD;"> long</span><span style="color:#E06C75;">[] timestamps</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> /** each object is a primitive type array, which represents values of one measurement */</span></span> |
| <span class="line"><span style="color:#C678DD;"> public</span><span style="color:#E5C07B;"> Object</span><span style="color:#E06C75;">[] values</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> /** each bitmap represents the existence of each value in the current column. */</span></span> |
| <span class="line"><span style="color:#C678DD;"> public</span><span style="color:#E5C07B;"> BitMap</span><span style="color:#E06C75;">[] bitMaps</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> /** the number of rows to include in this tablet */</span></span> |
| <span class="line"><span style="color:#C678DD;"> public</span><span style="color:#C678DD;"> int</span><span style="color:#E06C75;"> rowSize</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> /** the maximum number of rows for this tablet */</span></span> |
| <span class="line"><span style="color:#C678DD;"> private</span><span style="color:#C678DD;"> int</span><span style="color:#E06C75;"> maxRowNumber</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> /** whether this tablet store data of aligned timeseries or not */</span></span> |
| <span class="line"><span style="color:#C678DD;"> private</span><span style="color:#C678DD;"> boolean</span><span style="color:#E06C75;"> isAligned</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>插入多个 Tablet</li></ul><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;">void</span><span style="color:#61AFEF;"> insertTablets</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">Map</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#ABB2BF;">,</span><span style="color:#E06C75;"> Tablet</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> tablets)</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li><p>插入一个 Record，一个 Record 是一个设备一个时间戳下多个测点的数据。这里的 value 是 Object 类型，相当于提供了一个公用接口，后面可以通过 TSDataType 将 value 强转为原类型</p><p>其中，Object 类型与 TSDataType 类型的对应关系如下表所示：</p><table><thead><tr><th>TSDataType</th><th>Object</th></tr></thead><tbody><tr><td>BOOLEAN</td><td>Boolean</td></tr><tr><td>INT32</td><td>Integer</td></tr><tr><td>INT64</td><td>Long</td></tr><tr><td>FLOAT</td><td>Float</td></tr><tr><td>DOUBLE</td><td>Double</td></tr><tr><td>TEXT</td><td>String, Binary</td></tr></tbody></table></li></ul><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;">void</span><span style="color:#61AFEF;"> insertRecord</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> prefixPath</span><span style="color:#ABB2BF;">,</span><span style="color:#C678DD;"> long</span><span style="color:#E06C75;"> time</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> measurements</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">TSDataType</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> types</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">Object</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> values)</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>插入多个 Record</li></ul><div class="language-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;">void</span><span style="color:#61AFEF;"> insertRecords</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> deviceIds</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">Long</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> times</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">>></span><span style="color:#E06C75;"> measurementsList</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">TSDataType</span><span style="color:#56B6C2;">>></span><span style="color:#E06C75;"> typesList</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">Object</span><span style="color:#56B6C2;">>></span><span style="color:#E06C75;"> valuesList)</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>插入同属于一个 device 的多个 Record</li></ul><div class="language-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;">void</span><span style="color:#61AFEF;"> insertRecordsOfOneDevice</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> deviceId</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">Long</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> times</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">>></span><span style="color:#E06C75;"> measurementsList</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">TSDataType</span><span style="color:#56B6C2;">>></span><span style="color:#E06C75;"> typesList</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">Object</span><span style="color:#56B6C2;">>></span><span style="color:#E06C75;"> valuesList)</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h5 id="带有类型推断的写入" tabindex="-1"><a class="header-anchor" href="#带有类型推断的写入"><span>带有类型推断的写入</span></a></h5><p>当数据均是 String 类型时，我们可以使用如下接口，根据 value 的值进行类型推断。例如：value 为 "true" ，就可以自动推断为布尔类型。value 为 "3.2" ，就可以自动推断为数值类型。服务器需要做类型推断，可能会有额外耗时，速度较无需类型推断的写入慢</p><ul><li>插入一个 Record，一个 Record 是一个设备一个时间戳下多个测点的数据</li></ul><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;">void</span><span style="color:#61AFEF;"> insertRecord</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> prefixPath</span><span style="color:#ABB2BF;">,</span><span style="color:#C678DD;"> long</span><span style="color:#E06C75;"> time</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> measurements</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> values)</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>插入多个 Record</li></ul><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;">void</span><span style="color:#61AFEF;"> insertRecords</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> deviceIds</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">Long</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> times</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">>></span><span style="color:#E06C75;"> measurementsList</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">>></span><span style="color:#E06C75;"> valuesList)</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>插入同属于一个 device 的多个 Record</li></ul><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;">void</span><span style="color:#61AFEF;"> insertStringRecordsOfOneDevice</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> deviceId</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">Long</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> times</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">>></span><span style="color:#E06C75;"> measurementsList</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">>></span><span style="color:#E06C75;"> valuesList)</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div></div></div><h5 id="对齐时间序列的写入" tabindex="-1"><a class="header-anchor" href="#对齐时间序列的写入"><span>对齐时间序列的写入</span></a></h5><p>对齐时间序列的写入使用 insertAlignedXXX 接口，其余与上述接口类似：</p><ul><li>insertAlignedRecord</li><li>insertAlignedRecords</li><li>insertAlignedRecordsOfOneDevice</li><li>insertAlignedStringRecordsOfOneDevice</li><li>insertAlignedTablet</li><li>insertAlignedTablets</li></ul><h5 id="数据删除" tabindex="-1"><a class="header-anchor" href="#数据删除"><span>数据删除</span></a></h5><ul><li>删除一个或多个时间序列在某个时间点前或这个时间点的数据</li></ul><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;">void</span><span style="color:#61AFEF;"> deleteData</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> path</span><span style="color:#ABB2BF;">,</span><span style="color:#C678DD;"> long</span><span style="color:#E06C75;"> endTime)</span></span> |
| <span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> deleteData</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> paths</span><span style="color:#ABB2BF;">,</span><span style="color:#C678DD;"> long</span><span style="color:#E06C75;"> endTime)</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div></div></div><h5 id="数据查询" tabindex="-1"><a class="header-anchor" href="#数据查询"><span>数据查询</span></a></h5><ul><li>原始数据查询。时间间隔包含开始时间，不包含结束时间</li></ul><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:#E5C07B;">SessionDataSet</span><span style="color:#61AFEF;"> executeRawDataQuery</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> paths</span><span style="color:#ABB2BF;">,</span><span style="color:#C678DD;"> long</span><span style="color:#E06C75;"> startTime</span><span style="color:#ABB2BF;">,</span><span style="color:#C678DD;"> long</span><span style="color:#E06C75;"> endTime)</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>查询最后一条时间戳大于等于某个时间点的数据</li></ul><div class="language-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:#E5C07B;">SessionDataSet</span><span style="color:#61AFEF;"> executeLastDataQuery</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> paths</span><span style="color:#ABB2BF;">,</span><span style="color:#C678DD;"> long</span><span style="color:#E06C75;"> LastTime)</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><h4 id="iotdb-sql-接口" tabindex="-1"><a class="header-anchor" href="#iotdb-sql-接口"><span>IoTDB-SQL 接口</span></a></h4><ul><li>执行查询语句</li></ul><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:#E5C07B;">SessionDataSet</span><span style="color:#61AFEF;"> executeQueryStatement</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> sql)</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>执行非查询语句</li></ul><div class="language-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;">void</span><span style="color:#61AFEF;"> executeNonQueryStatement</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> sql)</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><h4 id="写入测试接口-用于分析网络带宽" tabindex="-1"><a class="header-anchor" href="#写入测试接口-用于分析网络带宽"><span>写入测试接口 (用于分析网络带宽)</span></a></h4><p>不实际写入数据，只将数据传输到 server 即返回</p><ul><li>测试 insertRecord</li></ul><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;">void</span><span style="color:#61AFEF;"> testInsertRecord</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> deviceId</span><span style="color:#ABB2BF;">,</span><span style="color:#C678DD;"> long</span><span style="color:#E06C75;"> time</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> measurements</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> values)</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> testInsertRecord</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> deviceId</span><span style="color:#ABB2BF;">,</span><span style="color:#C678DD;"> long</span><span style="color:#E06C75;"> time</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> measurements</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">TSDataType</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> types</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">Object</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> values)</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></div><ul><li>测试 testInsertRecords</li></ul><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;">void</span><span style="color:#61AFEF;"> testInsertRecords</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> deviceIds</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">Long</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> times</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">>></span><span style="color:#E06C75;"> measurementsList</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">>></span><span style="color:#E06C75;"> valuesList)</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> testInsertRecords</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> deviceIds</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">Long</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> times</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">>></span><span style="color:#E06C75;"> measurementsList</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">TSDataType</span><span style="color:#56B6C2;">>></span><span style="color:#E06C75;"> typesList</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">Object</span><span style="color:#56B6C2;">>></span><span style="color:#E06C75;"> valuesList)</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></div><ul><li>测试 insertTablet</li></ul><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;">void</span><span style="color:#61AFEF;"> testInsertTablet</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">Tablet</span><span style="color:#E06C75;"> tablet)</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>测试 insertTablets</li></ul><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;">void</span><span style="color:#61AFEF;"> testInsertTablets</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">Map</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#ABB2BF;">,</span><span style="color:#E06C75;"> Tablet</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> tablets)</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><h5 id="示例代码" tabindex="-1"><a class="header-anchor" href="#示例代码"><span>示例代码</span></a></h5><p>浏览上述接口的详细信息，请参阅代码 <code>session/src/main/java/org/apache/iotdb/session/Session.java</code></p><p>使用上述接口的示例代码在 <code>example/session/src/main/java/org/apache/iotdb/SessionExample.java</code></p><p>使用对齐时间序列和元数据模板的示例可以参见 <code>example/session/src/main/java/org/apache/iotdb/AlignedTimeseriesSessionExample.java</code></p><h6 id="针对原生接口的连接池" tabindex="-1"><a class="header-anchor" href="#针对原生接口的连接池"><span>针对原生接口的连接池</span></a></h6><p>我们提供了一个针对原生接口的连接池 (<code>SessionPool</code>)，使用该接口时，你只需要指定连接池的大小，就可以在使用时从池中获取连接。<br> 如果超过 60s 都没得到一个连接的话，那么会打印一条警告日志，但是程序仍将继续等待。</p><p>当一个连接被用完后，他会自动返回池中等待下次被使用；<br> 当一个连接损坏后，他会从池中被删除，并重建一个连接重新执行用户的操作；<br> 你还可以像创建 Session 那样在创建 SessionPool 时指定多个可连接节点的 url，以保证分布式集群中客户端的高可用性。</p><p>对于查询操作：</p><ol><li>使用 SessionPool 进行查询时，得到的结果集是<code>SessionDataSet</code>的封装类<code>SessionDataSetWrapper</code>;</li><li>若对于一个查询的结果集，用户并没有遍历完且不再想继续遍历时，需要手动调用释放连接的操作<code>closeResultSet</code>;</li><li>若对一个查询的结果集遍历时出现异常，也需要手动调用释放连接的操作<code>closeResultSet</code>.</li><li>可以调用 <code>SessionDataSetWrapper</code> 的 <code>getColumnNames()</code> 方法得到结果集列名</li></ol><p>使用示例可以参见 <code>session/src/test/java/org/apache/iotdb/session/pool/SessionPoolTest.java</code></p><p>或 <code>example/session/src/main/java/org/apache/iotdb/SessionPoolExample.java</code></p><h6 id="集群信息相关的接口-仅在集群模式下可用" tabindex="-1"><a class="header-anchor" href="#集群信息相关的接口-仅在集群模式下可用"><span>集群信息相关的接口 （仅在集群模式下可用）</span></a></h6><p>集群信息相关的接口允许用户获取如数据分区情况、节点是否当机等信息。<br> 要使用该 API，需要增加依赖：</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-thrift-cluster</</span><span style="color:#E06C75;">artifactId</span><span style="color:#ABB2BF;">></span></span> |
| <span class="line"><span style="color:#ABB2BF;"> <</span><span style="color:#E06C75;">version</span><span style="color:#ABB2BF;">>0.13.0-SNAPSHOT</</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></div><p>建立连接与关闭连接的示例：</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;"> org.apache.thrift.protocol.TBinaryProtocol</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;">import</span><span style="color:#E5C07B;"> org.apache.thrift.transport.TSocket</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;">import</span><span style="color:#E5C07B;"> org.apache.thrift.transport.TTransport</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;">import</span><span style="color:#E5C07B;"> org.apache.thrift.transport.TTransportException</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;">import</span><span style="color:#E5C07B;"> org.apache.iotdb.rpc.RpcTransportFactory</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;"> CluserInfoClient</span><span style="color:#ABB2BF;"> {</span></span> |
| <span class="line"><span style="color:#E5C07B;"> TTransport</span><span style="color:#E06C75;"> transport</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#E5C07B;"> ClusterInfoService</span><span style="color:#ABB2BF;">.</span><span style="color:#E5C07B;">Client</span><span style="color:#E06C75;"> client</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;"> public</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> connect</span><span style="color:#ABB2BF;">()</span><span style="color:#ABB2BF;"> {</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> transport </span><span style="color:#56B6C2;">=</span></span> |
| <span class="line"><span style="color:#E5C07B;"> RpcTransportFactory</span><span style="color:#ABB2BF;">.</span><span style="color:#E5C07B;">INSTANCE</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">getTransport</span><span style="color:#ABB2BF;">(</span></span> |
| <span class="line"><span style="color:#C678DD;"> new</span><span style="color:#61AFEF;"> TSocket</span><span style="color:#ABB2BF;">(</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> // the RPC address</span></span> |
| <span class="line"><span style="color:#E5C07B;"> IoTDBDescriptor</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">getInstance</span><span style="color:#ABB2BF;">().</span><span style="color:#61AFEF;">getConfig</span><span style="color:#ABB2BF;">().</span><span style="color:#61AFEF;">getRpcAddress</span><span style="color:#ABB2BF;">(),</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> // the RPC port</span></span> |
| <span class="line"><span style="color:#E5C07B;"> ClusterDescriptor</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">getInstance</span><span style="color:#ABB2BF;">().</span><span style="color:#61AFEF;">getConfig</span><span style="color:#ABB2BF;">().</span><span style="color:#61AFEF;">getClusterRpcPort</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;"> transport</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">open</span><span style="color:#ABB2BF;">();</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;">TTransportException</span><span style="color:#E06C75;font-style:italic;"> e</span><span style="color:#ABB2BF;">) {</span></span> |
| <span class="line"><span style="color:#E5C07B;"> Assert</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">fail</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">e</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">getMessage</span><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;"> //get the client</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> client </span><span style="color:#56B6C2;">=</span><span style="color:#C678DD;"> new</span><span style="color:#ABB2BF;"> ClusterInfoService.</span><span style="color:#61AFEF;">Client</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">new</span><span style="color:#61AFEF;"> TBinaryProtocol</span><span style="color:#ABB2BF;">(transport));</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> }</span></span> |
| <span class="line"><span style="color:#C678DD;"> public</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> close</span><span style="color:#ABB2BF;">()</span><span style="color:#ABB2BF;"> {</span></span> |
| <span class="line"><span style="color:#E5C07B;"> transport</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 style="color:#E06C75;"> </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></div><p>API 列表：</p><ul><li>获取集群中的各个节点的信息（构成哈希环）</li></ul><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:#E06C75;">list</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">Node</span><span style="color:#56B6C2;">></span><span style="color:#61AFEF;"> getRing</span><span style="color:#E06C75;">()</span><span style="color:#ABB2BF;">;</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>给定一个路径（应包括一个 SG 作为前缀）和起止时间，获取其覆盖的数据分区情况：</li></ul><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:#7F848E;font-style:italic;">/**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#E06C75;font-style:italic;"> path</span><span style="color:#7F848E;font-style:italic;"> input path (should contains a Storage group name as its prefix)</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@return</span><span style="color:#7F848E;font-style:italic;"> the data partition info. If the time range only covers one data partition, the the size</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * of the list is one.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> */</span></span> |
| <span class="line"><span style="color:#E06C75;">list</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">DataPartitionEntry</span><span style="color:#56B6C2;">></span><span style="color:#61AFEF;"> getDataPartition</span><span style="color:#E06C75;">(</span><span style="color:#D19A66;">1</span><span style="color:#C678DD;">:</span><span style="color:#E06C75;">string path</span><span style="color:#ABB2BF;">,</span><span style="color:#D19A66;"> 2</span><span style="color:#C678DD;">:long</span><span style="color:#E06C75;"> startTime</span><span style="color:#ABB2BF;">,</span><span style="color:#D19A66;"> 3</span><span style="color:#C678DD;">:long</span><span style="color:#E06C75;"> endTime)</span><span style="color:#ABB2BF;">;</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>给定一个路径（应包括一个 SG 作为前缀），获取其被分到了哪个节点上：</li></ul><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:#7F848E;font-style:italic;">/**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#E06C75;font-style:italic;"> path</span><span style="color:#7F848E;font-style:italic;"> input path (should contains a Storage group name as its prefix)</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@return</span><span style="color:#7F848E;font-style:italic;"> metadata partition information</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> */</span></span> |
| <span class="line"><span style="color:#E06C75;">list</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">Node</span><span style="color:#56B6C2;">></span><span style="color:#61AFEF;"> getMetaPartition</span><span style="color:#E06C75;">(</span><span style="color:#D19A66;">1</span><span style="color:#C678DD;">:</span><span style="color:#E06C75;">string path)</span><span style="color:#ABB2BF;">;</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>获取所有节点的死活状态：</li></ul><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:#7F848E;font-style:italic;">/**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@return</span><span style="color:#7F848E;font-style:italic;"> key: node, value: live or not</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> */</span></span> |
| <span class="line"><span style="color:#E06C75;">map</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">Node</span><span style="color:#ABB2BF;">,</span><span style="color:#E06C75;"> bool</span><span style="color:#56B6C2;">></span><span style="color:#61AFEF;"> getAllNodeStatus</span><span style="color:#E06C75;">()</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></div><ul><li>获取当前连接节点的 Raft 组信息（投票编号等）（一般用户无需使用该接口）:</li></ul><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:#7F848E;font-style:italic;">/**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@return</span><span style="color:#7F848E;font-style:italic;"> A multi-line string with each line representing the total time consumption, invocation</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * number, and average time consumption.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> */</span></span> |
| <span class="line"><span style="color:#E06C75;">string </span><span style="color:#61AFEF;">getInstrumentingInfo</span><span style="color:#E06C75;">()</span><span style="color:#ABB2BF;">;</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div></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/zh/UserGuide/V0.13.x/API/Programming-Java-Native-API.md" aria-label="发现错误？在 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><!--]-->发现错误？在 GitHub 上编辑此页<!----></a></div><div class="vp-meta-item git-info"><div class="update-time"><span class="vp-meta-label">上次编辑于: </span><span class="vp-meta-info" data-allow-mismatch="text">2024/12/4 09:08:04</span></div><!----></div></footer><nav class="vp-page-nav"><!----><a class="route-link auto-link next" href="/zh/UserGuide/V0.13.x/API/Programming-Python-Native-API.html" aria-label="Python 原生接口" iconsizing="both"><div class="hint">下一页<span class="arrow end"></span></div><div class="link">Python 原生接口<!----></div></a></nav><!----><!----><!--]--></main><!--]--><footer class="site-footer"><span id="doc-version" style="display:none;">V0.13.x</span><p class="copyright-text">版权所有 © 2025 Apache软件基金会。 |
| Apache IoTDB，IoTDB，Apache，Apache 羽毛标志和 Apache IoTDB 项目标志是 Apache 软件基金会在所有国家的注册商标或商标</p><p style="text-align:center;margin-top:10px;color:#909399;font-size:12px;margin:0 30px;"><strong>有问题吗？</strong> 在 QQ、微信或 Slack 上联系我们。 <a href="https://github.com/apache/iotdb/issues/1995">立即加入社区</a></p></footer></div><!--]--><!--]--><!--[--><!----><!--]--><!--]--></div> |
| <script type="module" src="/assets/app-C-fAkKj6.js" defer></script> |
| </body> |
| </html> |
