| <!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.26" /> |
| <meta name="theme" content="VuePress Theme Hope 2.0.0-rc.99" /> |
| <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> |
| <script type="application/ld+json">{"@context":"https://schema.org","@type":"Article","headline":"Python 原生接口","image":["https://iotdb.apache.org/img/UserGuide/API/IoTDB-SQLAlchemy/sqlalchemy-to-iotdb.png?raw=true"],"dateModified":"2025-04-29T04:30:02.000Z","author":[]}</script><meta property="og:url" content="https://iotdb.apache.org/zh/UserGuide/V1.3.x/API/Programming-Python-Native-API.html"><meta property="og:site_name" content="IoTDB Website"><meta property="og:title" content="Python 原生接口"><meta property="og:description" content="Python 原生接口 依赖 在使用 Python 原生接口包前，您需要安装 thrift (>=0.13) 依赖。 如何使用 （示例） 首先下载包：pip3 install "apache-iotdb<2.0" 您可以从这里得到一个使用该包进行数据读写的例子：Session Example 关于对齐时间序列读写的例子：Aligned Timeseri..."><meta property="og:type" content="article"><meta property="og:image" content="https://iotdb.apache.org/img/UserGuide/API/IoTDB-SQLAlchemy/sqlalchemy-to-iotdb.png?raw=true"><meta property="og:locale" content="zh-CN"><meta property="og:locale:alternate" content="en-US"><meta property="og:updated_time" content="2025-04-29T04:30:02.000Z"><meta property="article:modified_time" content="2025-04-29T04:30:02.000Z"><link rel="alternate" hreflang="en-us" href="https://iotdb.apache.org/UserGuide/V1.3.x/API/Programming-Python-Native-API.html"><script async src="https://widget.kapa.ai/kapa-widget.bundle.js" data-website-id="2d37bfdd-8d98-40ba-9223-9d4f81bfb327" data-project-name="Apache IoTDB" data-project-color="#FFFFFF" data-button-z-index="1999" data-button-padding="4px" data-button-border-radius="4px" data-button-image-height="24px" data-button-image-width="20px" data-button-text-color="#9E2878" data-project-logo="https://iotdb.apache.org/img/logo.svg" data-button-position-right="16px" data-button-position-bottom="8px" data-button-height="56px" data-button-width="48px" data-button-text="Ask" data-modal-override-open-selector="#custom-ask-ai-button" data-modal-image-width="150px" data-modal-title="AI Docs" data-modal-title-color="#9E2878" data-deep-thinking-button-active-bg-color="#F6F7F8" data-deep-thinking-button-active-text-color="#9E2878" data-deep-thinking-button-active-hover-text-color="#9E2878" data-modal-disclaimer="这是一个针对 Apache IoTDB 的定制化大型语言模型，能够访问所有[文档](iotdb.apache.org/docs/)、[GitHub 公开问题、PR 和自述文件](github.com/apache/iotdb)。 |
| |
| 如果您遇到 <Error in verifying browser for feedback submission. Captcha token could not be obtained.> 请确保您能够顺畅访问 Google 服务。" data-user-analytics-fingerprint-enabled="true" data-consent-required="true" data-consent-screen-disclaimer="点击<I agree, let's chat>即表示您同意按照 kapa.ai 的[隐私政策](https://www.kapa.ai/content/privacy-policy)使用 AI 助手。本服务使用 reCAPTCHA，您需要同意 Google 的[隐私政策](https://policies.google.com/privacy)和[服务条款](https://policies.google.com/terms)。继续操作即表示您明确同意 kapa.ai 和 Google 的隐私政策。" data-language="zh"></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>Python 原生接口 | IoTDB Website</title><meta name="description" content="Python 原生接口 依赖 在使用 Python 原生接口包前，您需要安装 thrift (>=0.13) 依赖。 如何使用 （示例） 首先下载包：pip3 install "apache-iotdb<2.0" 您可以从这里得到一个使用该包进行数据读写的例子：Session Example 关于对齐时间序列读写的例子：Aligned Timeseri..."> |
| <link rel="preload" href="/assets/style-JraSdRX4.css" as="style"><link rel="stylesheet" href="/assets/style-JraSdRX4.css"> |
| <link rel="modulepreload" href="/assets/app-pmkzp6TS.js"><link rel="modulepreload" href="/assets/Programming-Python-Native-API.html-DRQHvx6P.js"><link rel="modulepreload" href="/assets/sqlalchemy-to-iotdb-DddIeZsO.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 class="docsearch-placeholder"><button type="button" aria-label="搜索文档" aria-keyshortcuts="Control+k" class="DocSearch DocSearch-Button"><span class="DocSearch-Button-Container"><svg width="20" height="20" viewBox="0 0 24 24" aria-hidden="true" class="DocSearch-Search-Icon"><circle cx="11" cy="11" r="8" stroke="currentColor" fill="none" stroke-width="1.4"></circle><path d="m21 21-4.3-4.3" stroke="currentColor" fill="none" 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 DocSearch-Button-Key--ctrl">Ctrl</kbd><kbd class="DocSearch-Button-Key">K</kbd></span></button></div><!--]--><div><button id="custom-ask-ai-button"> ✨ Ask AI </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"><!---->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"><!---->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"><!---->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"><!---->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"><!---->系统设计<!----></a></div><div class="vp-nav-item hide-in-mobile"><a class="route-link auto-link" href="/zh/Download/" aria-label="下载"><!---->下载<!----></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="关于社区"><!---->关于社区<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/zh/Community/Development-Guide.html" aria-label="贡献指南"><!---->贡献指南<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/zh/Community/Community-Partners.html" aria-label="社区伙伴"><!---->社区伙伴<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/zh/Community/Feedback.html" aria-label="交流与反馈"><!---->交流与反馈<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/zh/Community/Events-and-Reports.html" aria-label="活动与报告"><!---->活动与报告<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/zh/Community/Committers.html" aria-label="Committers"><!---->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"><!---->基金会<!----></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"><!---->许可证<!----></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"><!---->安全<!----></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"><!---->赞助<!----></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"><!---->致谢<!----></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"><!---->活动<!----></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"><!---->隐私<!----></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/V1.3.x/API/Programming-Python-Native-API.html" aria-label="English"><!---->English<!----></a></li><li class="vp-dropdown-item"><a class="route-link route-link-active auto-link" href="/zh/UserGuide/V1.3.x/API/Programming-Python-Native-API.html" aria-label="简体中文"><!---->简体中文<!----></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" vp-sidebar><!--[--><p class="vp-sidebar-header iotdb-sidebar-header"><span class="vp-sidebar-title">IoTDB用户手册 (V1.3.x)</span></p><!----><!--]--><ul class="vp-sidebar-links"><li><section class="vp-sidebar-group"><p class="vp-sidebar-header"><!----><span class="vp-sidebar-title">IoTDB用户手册 (V1.3.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><a class="route-link auto-link vp-sidebar-link" href="/zh/UserGuide/V1.3.x/QuickStart/QuickStart_apache.html" aria-label="快速上手"><!---->快速上手<!----></a></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">AI 能力</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><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Java原生接口</span><span class="vp-arrow end"></span></button><!----></section></li><li><a class="route-link route-link-active auto-link vp-sidebar-link active" href="/zh/UserGuide/V1.3.x/API/Programming-Python-Native-API.html" aria-label="Python原生接口"><!---->Python原生接口<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/zh/UserGuide/V1.3.x/API/Programming-Cpp-Native-API.html" aria-label="C++原生接口"><!---->C++原生接口<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/zh/UserGuide/V1.3.x/API/Programming-Go-Native-API.html" aria-label="Go原生接口"><!---->Go原生接口<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/zh/UserGuide/V1.3.x/API/Programming-CSharp-Native-API.html" aria-label="C#原生接口"><!---->C#原生接口<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/zh/UserGuide/V1.3.x/API/Programming-NodeJS-Native-API.html" aria-label="Node.js原生接口"><!---->Node.js原生接口<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/zh/UserGuide/V1.3.x/API/Programming-Rust-Native-API.html" aria-label="Rust原生接口"><!---->Rust原生接口<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/zh/UserGuide/V1.3.x/API/Programming-JDBC.html" aria-label="JDBC"><!---->JDBC<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/zh/UserGuide/V1.3.x/API/Programming-MQTT.html" aria-label="MQTT协议"><!---->MQTT协议<!----></a></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">REST API</span><span class="vp-arrow end"></span></button><!----></section></li></ul></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">生态集成</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">SQL手册</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">FAQ</span><span class="vp-arrow end"></span></button><!----></section></li></ul><!----></aside><!--[--><main id="main-content" class="vp-page"><!--[--><!----><!----><nav class="vp-breadcrumb disable"></nav><div class="vp-page-title"><h1><!---->Python 原生接口</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-content><!----><div id="markdown-content"><h1 id="python-原生接口" tabindex="-1"><a class="header-anchor" href="#python-原生接口"><span>Python 原生接口</span></a></h1><h2 id="依赖" tabindex="-1"><a class="header-anchor" href="#依赖"><span>依赖</span></a></h2><p>在使用 Python 原生接口包前，您需要安装 thrift (>=0.13) 依赖。</p><h2 id="如何使用-示例" tabindex="-1"><a class="header-anchor" href="#如何使用-示例"><span>如何使用 （示例）</span></a></h2><p>首先下载包：<code>pip3 install "apache-iotdb<2.0"</code></p><p>您可以从这里得到一个使用该包进行数据读写的例子：<a href="https://github.com/apache/iotdb/blob/rc/1.3.3/iotdb-client/client-py/SessionExample.py" target="_blank" rel="noopener noreferrer">Session Example</a></p><p>关于对齐时间序列读写的例子：<a href="https://github.com/apache/iotdb/blob/rc/1.3.3/iotdb-client/client-py/SessionAlignedTimeseriesExample.py" target="_blank" rel="noopener noreferrer">Aligned Timeseries Session Example</a></p><p>（您需要在文件的头部添加<code>import iotdb</code>）</p><p>或者：</p><div class="language-python line-numbers-mode" data-highlighter="shiki" data-ext="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-python"><span class="line"><span style="color:#C678DD;">from</span><span style="color:#ABB2BF;"> iotdb.Session </span><span style="color:#C678DD;">import</span><span style="color:#ABB2BF;"> Session</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#ABB2BF;">ip </span><span style="color:#56B6C2;">=</span><span style="color:#98C379;"> "127.0.0.1"</span></span> |
| <span class="line"><span style="color:#ABB2BF;">port_ </span><span style="color:#56B6C2;">=</span><span style="color:#98C379;"> "6667"</span></span> |
| <span class="line"><span style="color:#ABB2BF;">username_ </span><span style="color:#56B6C2;">=</span><span style="color:#98C379;"> "root"</span></span> |
| <span class="line"><span style="color:#ABB2BF;">password_ </span><span style="color:#56B6C2;">=</span><span style="color:#98C379;"> "root"</span></span> |
| <span class="line"><span style="color:#ABB2BF;">session </span><span style="color:#56B6C2;">=</span><span style="color:#61AFEF;"> Session</span><span style="color:#ABB2BF;">(ip, port_, username_, password_)</span></span> |
| <span class="line"><span style="color:#ABB2BF;">session.</span><span style="color:#61AFEF;">open</span><span style="color:#ABB2BF;">(</span><span style="color:#D19A66;">False</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#ABB2BF;">zone </span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;"> session.</span><span style="color:#61AFEF;">get_time_zone</span><span style="color:#ABB2BF;">()</span></span> |
| <span class="line"><span style="color:#ABB2BF;">session.</span><span style="color:#61AFEF;">close</span><span style="color:#ABB2BF;">()</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h2 id="基本接口说明" tabindex="-1"><a class="header-anchor" href="#基本接口说明"><span>基本接口说明</span></a></h2><p>下面将给出 Session 对应的接口的简要介绍和对应参数：</p><h3 id="初始化" tabindex="-1"><a class="header-anchor" href="#初始化"><span>初始化</span></a></h3><ul><li>初始化 Session</li></ul><div class="language-python line-numbers-mode" data-highlighter="shiki" data-ext="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-python"><span class="line"><span style="color:#ABB2BF;">session </span><span style="color:#56B6C2;">=</span><span style="color:#61AFEF;"> Session</span><span style="color:#ABB2BF;">(</span></span> |
| <span class="line"><span style="color:#E06C75;font-style:italic;"> ip</span><span style="color:#56B6C2;">=</span><span style="color:#98C379;">"127.0.0.1"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;font-style:italic;"> port</span><span style="color:#56B6C2;">=</span><span style="color:#98C379;">"6667"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;font-style:italic;"> user</span><span style="color:#56B6C2;">=</span><span style="color:#98C379;">"root"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;font-style:italic;"> password</span><span style="color:#56B6C2;">=</span><span style="color:#98C379;">"root"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;font-style:italic;"> fetch_size</span><span style="color:#56B6C2;">=</span><span style="color:#D19A66;">1024</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;font-style:italic;"> zone_id</span><span style="color:#56B6C2;">=</span><span style="color:#98C379;">"UTC+8"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;font-style:italic;"> enable_redirection</span><span style="color:#56B6C2;">=</span><span style="color:#D19A66;">True</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></div><ul><li>初始化可连接多节点的 Session</li></ul><div class="language-python line-numbers-mode" data-highlighter="shiki" data-ext="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-python"><span class="line"><span style="color:#ABB2BF;">session </span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;"> Session.</span><span style="color:#61AFEF;">init_from_node_urls</span><span style="color:#ABB2BF;">(</span></span> |
| <span class="line"><span style="color:#E06C75;font-style:italic;"> node_urls</span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;">[</span><span style="color:#98C379;">"127.0.0.1:6667"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"127.0.0.1:6668"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"127.0.0.1:6669"</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#E06C75;font-style:italic;"> user</span><span style="color:#56B6C2;">=</span><span style="color:#98C379;">"root"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;font-style:italic;"> password</span><span style="color:#56B6C2;">=</span><span style="color:#98C379;">"root"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;font-style:italic;"> fetch_size</span><span style="color:#56B6C2;">=</span><span style="color:#D19A66;">1024</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;font-style:italic;"> zone_id</span><span style="color:#56B6C2;">=</span><span style="color:#98C379;">"UTC+8"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;font-style:italic;"> enable_redirection</span><span style="color:#56B6C2;">=</span><span style="color:#D19A66;">True</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></div><ul><li>开启 Session，并决定是否开启 RPC 压缩</li></ul><div class="language-python line-numbers-mode" data-highlighter="shiki" data-ext="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-python"><span class="line"><span style="color:#ABB2BF;">session.</span><span style="color:#61AFEF;">open</span><span style="color:#ABB2BF;">(</span><span style="color:#E06C75;font-style:italic;">enable_rpc_compression</span><span style="color:#56B6C2;">=</span><span style="color:#D19A66;">False</span><span style="color:#ABB2BF;">)</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>注意: 客户端的 RPC 压缩开启状态需和服务端一致</p><ul><li>关闭 Session</li></ul><div class="language-python line-numbers-mode" data-highlighter="shiki" data-ext="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-python"><span class="line"><span style="color:#ABB2BF;">session.</span><span style="color:#61AFEF;">close</span><span style="color:#ABB2BF;">()</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><h3 id="通过sessionpool管理session连接" tabindex="-1"><a class="header-anchor" href="#通过sessionpool管理session连接"><span>通过SessionPool管理session连接</span></a></h3><p>利用SessionPool管理session，不需要再考虑如何重用session。当session连接到达pool的最大值时，获取session的请求会被阻塞，可以通过参数设置阻塞等待时间。每次session使用完需要使用putBack方法将session归还到SessionPool中管理。</p><h4 id="创建sessionpool" tabindex="-1"><a class="header-anchor" href="#创建sessionpool"><span>创建SessionPool</span></a></h4><div class="language-python line-numbers-mode" data-highlighter="shiki" data-ext="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-python"><span class="line"><span style="color:#ABB2BF;">pool_config </span><span style="color:#56B6C2;">=</span><span style="color:#61AFEF;"> PoolConfig</span><span style="color:#ABB2BF;">(</span><span style="color:#E06C75;font-style:italic;">host</span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;">ip,</span><span style="color:#E06C75;font-style:italic;">port</span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;">port, </span><span style="color:#E06C75;font-style:italic;">user_name</span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;">username,</span></span> |
| <span class="line"><span style="color:#E06C75;font-style:italic;"> password</span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;">password, </span><span style="color:#E06C75;font-style:italic;">fetch_size</span><span style="color:#56B6C2;">=</span><span style="color:#D19A66;">1024</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;font-style:italic;"> time_zone</span><span style="color:#56B6C2;">=</span><span style="color:#98C379;">"UTC+8"</span><span style="color:#ABB2BF;">, </span><span style="color:#E06C75;font-style:italic;">max_retry</span><span style="color:#56B6C2;">=</span><span style="color:#D19A66;">3</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#ABB2BF;">max_pool_size </span><span style="color:#56B6C2;">=</span><span style="color:#D19A66;"> 5</span></span> |
| <span class="line"><span style="color:#ABB2BF;">wait_timeout_in_ms </span><span style="color:#56B6C2;">=</span><span style="color:#D19A66;"> 3000</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"># 通过配置参数创建连接池</span></span> |
| <span class="line"><span style="color:#ABB2BF;">session_pool </span><span style="color:#56B6C2;">=</span><span style="color:#61AFEF;"> SessionPool</span><span style="color:#ABB2BF;">(pool_config, max_pool_size, wait_timeout_in_ms)</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><h4 id="通过分布式节点创建sessionpool" tabindex="-1"><a class="header-anchor" href="#通过分布式节点创建sessionpool"><span>通过分布式节点创建SessionPool</span></a></h4><div class="language-python line-numbers-mode" data-highlighter="shiki" data-ext="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-python"><span class="line"><span style="color:#ABB2BF;">pool_config </span><span style="color:#56B6C2;">=</span><span style="color:#61AFEF;"> PoolConfig</span><span style="color:#ABB2BF;">(</span><span style="color:#E06C75;font-style:italic;">node_urls</span><span style="color:#56B6C2;">=</span><span style="color:#E06C75;font-style:italic;">node_urls</span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;">[</span><span style="color:#98C379;">"127.0.0.1:6667"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"127.0.0.1:6668"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"127.0.0.1:6669"</span><span style="color:#ABB2BF;">], </span><span style="color:#E06C75;font-style:italic;">user_name</span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;">username,</span></span> |
| <span class="line"><span style="color:#E06C75;font-style:italic;"> password</span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;">password, </span><span style="color:#E06C75;font-style:italic;">fetch_size</span><span style="color:#56B6C2;">=</span><span style="color:#D19A66;">1024</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;font-style:italic;"> time_zone</span><span style="color:#56B6C2;">=</span><span style="color:#98C379;">"UTC+8"</span><span style="color:#ABB2BF;">, </span><span style="color:#E06C75;font-style:italic;">max_retry</span><span style="color:#56B6C2;">=</span><span style="color:#D19A66;">3</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#ABB2BF;">max_pool_size </span><span style="color:#56B6C2;">=</span><span style="color:#D19A66;"> 5</span></span> |
| <span class="line"><span style="color:#ABB2BF;">wait_timeout_in_ms </span><span style="color:#56B6C2;">=</span><span style="color:#D19A66;"> 3000</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h4 id="通过sessionpool获取session-使用完手动调用putback" tabindex="-1"><a class="header-anchor" href="#通过sessionpool获取session-使用完手动调用putback"><span>通过SessionPool获取session，使用完手动调用PutBack</span></a></h4><div class="language-python line-numbers-mode" data-highlighter="shiki" data-ext="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-python"><span class="line"><span style="color:#ABB2BF;">session </span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;"> session_pool.</span><span style="color:#61AFEF;">get_session</span><span style="color:#ABB2BF;">()</span></span> |
| <span class="line"><span style="color:#ABB2BF;">session.</span><span style="color:#61AFEF;">set_storage_group</span><span style="color:#ABB2BF;">(</span><span style="color:#D19A66;">STORAGE_GROUP_NAME</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#ABB2BF;">session.</span><span style="color:#61AFEF;">create_time_series</span><span style="color:#ABB2BF;">(</span></span> |
| <span class="line"><span style="color:#D19A66;"> TIMESERIES_PATH</span><span style="color:#ABB2BF;">, TSDataType.</span><span style="color:#D19A66;">BOOLEAN</span><span style="color:#ABB2BF;">, TSEncoding.</span><span style="color:#D19A66;">PLAIN</span><span style="color:#ABB2BF;">, Compressor.</span><span style="color:#D19A66;">SNAPPY</span></span> |
| <span class="line"><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"># 使用完调用putBack归还</span></span> |
| <span class="line"><span style="color:#ABB2BF;">session_pool.</span><span style="color:#61AFEF;">put_back</span><span style="color:#ABB2BF;">(session)</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"># 关闭sessionPool时同时关闭管理的session</span></span> |
| <span class="line"><span style="color:#ABB2BF;">session_pool.</span><span style="color:#61AFEF;">close</span><span style="color:#ABB2BF;">()</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="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="ssl-连接" tabindex="-1"><a class="header-anchor" href="#ssl-连接"><span>SSL 连接</span></a></h3><h4 id="服务器端配置证书" tabindex="-1"><a class="header-anchor" href="#服务器端配置证书"><span>服务器端配置证书</span></a></h4><p><code>conf/iotdb-system.properties</code> 配置文件中查找或添加以下配置项：</p><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-java"><span class="line"><span style="color:#E06C75;">enable_thrift_ssl</span><span style="color:#56B6C2;">=</span><span style="color:#D19A66;">true</span></span> |
| <span class="line"><span style="color:#E06C75;">key_store_path</span><span style="color:#56B6C2;">=/</span><span style="color:#E06C75;">path</span><span style="color:#56B6C2;">/</span><span style="color:#E06C75;">to</span><span style="color:#56B6C2;">/</span><span style="color:#E06C75;">your</span><span style="color:#56B6C2;">/</span><span style="color:#E5C07B;">server_keystore</span><span style="color:#ABB2BF;">.</span><span style="color:#E5C07B;">jks</span></span> |
| <span class="line"><span style="color:#E06C75;">key_store_pwd</span><span style="color:#56B6C2;">=</span><span style="color:#E06C75;">your_keystore_password</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><h4 id="配置-python-客户端证书" tabindex="-1"><a class="header-anchor" href="#配置-python-客户端证书"><span>配置 python 客户端证书</span></a></h4><ul><li>设置 use_ssl 为 True 以启用 SSL。</li><li>指定客户端证书路径，使用 ca_certs 参数。</li></ul><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-java"><span class="line"><span style="color:#E06C75;">use_ssl </span><span style="color:#56B6C2;">=</span><span style="color:#E5C07B;"> True</span></span> |
| <span class="line"><span style="color:#E06C75;">ca_certs </span><span style="color:#56B6C2;">=</span><span style="color:#98C379;"> "/path/to/your/server.crt"</span><span style="color:#E06C75;"> # 或 ca_certs </span><span style="color:#56B6C2;">=</span><span style="color:#98C379;"> "/path/to/your//ca_cert.pem"</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><p><strong>示例代码：使用 SSL 连接 IoTDB</strong></p><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-java"><span class="line"><span style="color:#E06C75;"># </span><span style="color:#E5C07B;">Licensed</span><span style="color:#E06C75;"> to the </span><span style="color:#E5C07B;">Apache</span><span style="color:#E5C07B;"> Software</span><span style="color:#61AFEF;"> Foundation</span><span style="color:#E06C75;"> (ASF) under one</span></span> |
| <span class="line"><span style="color:#E06C75;"># or more contributor license </span><span style="color:#E5C07B;">agreements</span><span style="color:#ABB2BF;">.</span><span style="color:#E5C07B;"> See</span><span style="color:#E06C75;"> the </span><span style="color:#E5C07B;">NOTICE</span><span style="color:#E06C75;"> file</span></span> |
| <span class="line"><span style="color:#E06C75;"># distributed with </span><span style="color:#E5C07B;">this</span><span style="color:#E06C75;"> work </span><span style="color:#C678DD;">for</span><span style="color:#E06C75;"> additional information</span></span> |
| <span class="line"><span style="color:#E06C75;"># regarding copyright </span><span style="color:#E5C07B;">ownership</span><span style="color:#ABB2BF;">.</span><span style="color:#E5C07B;"> The</span><span style="color:#E5C07B;"> ASF</span><span style="color:#E06C75;"> licenses </span><span style="color:#E5C07B;">this</span><span style="color:#E06C75;"> file</span></span> |
| <span class="line"><span style="color:#E06C75;"># to you under the </span><span style="color:#E5C07B;">Apache</span><span style="color:#E06C75;"> License</span><span style="color:#ABB2BF;">,</span><span style="color:#E06C75;"> Version </span><span style="color:#D19A66;">2.0</span><span style="color:#E06C75;"> (the</span></span> |
| <span class="line"><span style="color:#E06C75;"># </span><span style="color:#98C379;">"License"</span><span style="color:#E06C75;">)</span><span style="color:#ABB2BF;">;</span><span style="color:#E06C75;"> you may not use </span><span style="color:#E5C07B;">this</span><span style="color:#E06C75;"> file except in compliance</span></span> |
| <span class="line"><span style="color:#E06C75;"># with the </span><span style="color:#E5C07B;">License</span><span style="color:#ABB2BF;">.</span><span style="color:#E5C07B;"> You</span><span style="color:#E06C75;"> may obtain a copy of the </span><span style="color:#E5C07B;">License</span><span style="color:#E06C75;"> at</span></span> |
| <span class="line"><span style="color:#E06C75;">#</span></span> |
| <span class="line"><span style="color:#E06C75;"># http</span><span style="color:#C678DD;">:</span><span style="color:#7F848E;font-style:italic;">//www.apache.org/licenses/LICENSE-2.0</span></span> |
| <span class="line"><span style="color:#E06C75;">#</span></span> |
| <span class="line"><span style="color:#E06C75;"># </span><span style="color:#E5C07B;">Unless</span><span style="color:#E06C75;"> required by applicable law or agreed to in writing</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"># software distributed under the </span><span style="color:#E5C07B;">License</span><span style="color:#E06C75;"> is distributed on an</span></span> |
| <span class="line"><span style="color:#E06C75;"># </span><span style="color:#98C379;">"AS IS"</span><span style="color:#E06C75;"> BASIS</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> WITHOUT</span><span style="color:#E5C07B;"> WARRANTIES</span><span style="color:#E5C07B;"> OR</span><span style="color:#E5C07B;"> CONDITIONS</span><span style="color:#E5C07B;"> OF</span><span style="color:#E5C07B;"> ANY</span></span> |
| <span class="line"><span style="color:#E06C75;"># KIND</span><span style="color:#ABB2BF;">,</span><span style="color:#E06C75;"> either express or </span><span style="color:#E5C07B;">implied</span><span style="color:#ABB2BF;">.</span><span style="color:#E5C07B;"> See</span><span style="color:#E06C75;"> the </span><span style="color:#E5C07B;">License</span><span style="color:#C678DD;"> for</span><span style="color:#E06C75;"> the</span></span> |
| <span class="line"><span style="color:#E06C75;"># specific language governing permissions and limitations</span></span> |
| <span class="line"><span style="color:#E06C75;"># under the License</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:#E06C75;">from </span><span style="color:#E5C07B;">iotdb</span><span style="color:#ABB2BF;">.</span><span style="color:#E5C07B;">SessionPool</span><span style="color:#C678DD;"> import</span><span style="color:#E5C07B;"> PoolConfig, SessionPool</span></span> |
| <span class="line"><span style="color:#E5C07B;">from iotdb.Session </span><span style="color:#FFFFFF;">import</span><span style="color:#E5C07B;"> Session</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#E5C07B;">ip = "</span><span style="color:#FFFFFF;">127</span><span style="color:#E5C07B;">.</span><span style="color:#FFFFFF;">0</span><span style="color:#E5C07B;">.</span><span style="color:#FFFFFF;">0</span><span style="color:#E5C07B;">.</span><span style="color:#FFFFFF;">1</span><span style="color:#E5C07B;">"</span></span> |
| <span class="line"><span style="color:#E5C07B;">port_ = "</span><span style="color:#FFFFFF;">6667</span><span style="color:#E5C07B;">"</span></span> |
| <span class="line"><span style="color:#E5C07B;">username_ = "root"</span></span> |
| <span class="line"><span style="color:#E5C07B;">password_ = "root"</span></span> |
| <span class="line"><span style="color:#E5C07B;"># Configure SSL enabled</span></span> |
| <span class="line"><span style="color:#E5C07B;">use_ssl = True</span></span> |
| <span class="line"><span style="color:#E5C07B;"># Configure certificate path</span></span> |
| <span class="line"><span style="color:#E5C07B;">ca_certs = "/path/server.crt"</span></span> |
| <span class="line"></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#E5C07B;">def get_data():</span></span> |
| <span class="line"><span style="color:#E5C07B;"> session = Session(</span></span> |
| <span class="line"><span style="color:#E5C07B;"> ip, port_, username_, password_, use_ssl=use_ssl, ca_certs=ca_certs</span></span> |
| <span class="line"><span style="color:#E5C07B;"> )</span></span> |
| <span class="line"><span style="color:#E5C07B;"> session.open(False)</span></span> |
| <span class="line"><span style="color:#E5C07B;"> result = session.execute_query_statement("select</span><span style="color:#FFFFFF;"> *</span><span style="color:#E5C07B;"> from root.eg.etth")</span></span> |
| <span class="line"><span style="color:#E5C07B;"> df = result.todf()</span></span> |
| <span class="line"><span style="color:#E5C07B;"> df.rename(columns={"Time": "date"}, inplace=True)</span></span> |
| <span class="line"><span style="color:#E5C07B;"> session.close()</span></span> |
| <span class="line"><span style="color:#FFFFFF;"> return</span><span style="color:#E5C07B;"> df</span></span> |
| <span class="line"></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#E5C07B;">def get_data2():</span></span> |
| <span class="line"><span style="color:#E5C07B;"> pool_config = PoolConfig(</span></span> |
| <span class="line"><span style="color:#E5C07B;"> host=ip,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> port=port_,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> user_name=username_,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> password=password_,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> fetch_size=</span><span style="color:#FFFFFF;">1024</span><span style="color:#E5C07B;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> time_zone="UTC+</span><span style="color:#FFFFFF;">8</span><span style="color:#E5C07B;">",</span></span> |
| <span class="line"><span style="color:#E5C07B;"> max_retry=</span><span style="color:#FFFFFF;">3</span><span style="color:#E5C07B;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> use_ssl=use_ssl,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> ca_certs=ca_certs,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> )</span></span> |
| <span class="line"><span style="color:#E5C07B;"> max_pool_size = </span><span style="color:#FFFFFF;">5</span></span> |
| <span class="line"><span style="color:#E5C07B;"> wait_timeout_in_ms = </span><span style="color:#FFFFFF;">3000</span></span> |
| <span class="line"><span style="color:#E5C07B;"> session_pool = SessionPool(pool_config, max_pool_size, wait_timeout_in_ms)</span></span> |
| <span class="line"><span style="color:#E5C07B;"> session = session_pool.get_session()</span></span> |
| <span class="line"><span style="color:#E5C07B;"> result = session.execute_query_statement("select</span><span style="color:#FFFFFF;"> *</span><span style="color:#E5C07B;"> from root.eg.etth")</span></span> |
| <span class="line"><span style="color:#E5C07B;"> df = result.todf()</span></span> |
| <span class="line"><span style="color:#E5C07B;"> df.rename(columns={"Time": "date"}, inplace=True)</span></span> |
| <span class="line"><span style="color:#E5C07B;"> session_pool.put_back(session)</span></span> |
| <span class="line"><span style="color:#E5C07B;"> session_pool.close()</span></span> |
| <span class="line"></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#FFFFFF;">if</span><span style="color:#E5C07B;"> __name__ == "__main__":</span></span> |
| <span class="line"><span style="color:#E5C07B;"> df = get_data()</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h2 id="数据定义接口-ddl" tabindex="-1"><a class="header-anchor" href="#数据定义接口-ddl"><span>数据定义接口 DDL</span></a></h2><h3 id="database-管理" tabindex="-1"><a class="header-anchor" href="#database-管理"><span>Database 管理</span></a></h3><ul><li>设置 database</li></ul><div class="language-python line-numbers-mode" data-highlighter="shiki" data-ext="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-python"><span class="line"><span style="color:#ABB2BF;">session.</span><span style="color:#61AFEF;">set_storage_group</span><span style="color:#ABB2BF;">(group_name)</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>删除单个或多个 database</li></ul><div class="language-python line-numbers-mode" data-highlighter="shiki" data-ext="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-python"><span class="line"><span style="color:#ABB2BF;">session.</span><span style="color:#61AFEF;">delete_storage_group</span><span style="color:#ABB2BF;">(group_name)</span></span> |
| <span class="line"><span style="color:#ABB2BF;">session.</span><span style="color:#61AFEF;">delete_storage_groups</span><span style="color:#ABB2BF;">(group_name_lst)</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><h3 id="时间序列管理" tabindex="-1"><a class="header-anchor" href="#时间序列管理"><span>时间序列管理</span></a></h3><ul><li>创建单个或多个时间序列</li></ul><div class="language-python line-numbers-mode" data-highlighter="shiki" data-ext="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-python"><span class="line"><span style="color:#ABB2BF;">session.</span><span style="color:#61AFEF;">create_time_series</span><span style="color:#ABB2BF;">(ts_path, data_type, encoding, compressor,</span></span> |
| <span class="line"><span style="color:#E06C75;font-style:italic;"> props</span><span style="color:#56B6C2;">=</span><span style="color:#D19A66;">None</span><span style="color:#ABB2BF;">, </span><span style="color:#E06C75;font-style:italic;">tags</span><span style="color:#56B6C2;">=</span><span style="color:#D19A66;">None</span><span style="color:#ABB2BF;">, </span><span style="color:#E06C75;font-style:italic;">attributes</span><span style="color:#56B6C2;">=</span><span style="color:#D19A66;">None</span><span style="color:#ABB2BF;">, </span><span style="color:#E06C75;font-style:italic;">alias</span><span style="color:#56B6C2;">=</span><span style="color:#D19A66;">None</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> </span></span> |
| <span class="line"><span style="color:#ABB2BF;">session.</span><span style="color:#61AFEF;">create_multi_time_series</span><span style="color:#ABB2BF;">(</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ts_path_lst, data_type_lst, encoding_lst, compressor_lst,</span></span> |
| <span class="line"><span style="color:#E06C75;font-style:italic;"> props_lst</span><span style="color:#56B6C2;">=</span><span style="color:#D19A66;">None</span><span style="color:#ABB2BF;">, </span><span style="color:#E06C75;font-style:italic;">tags_lst</span><span style="color:#56B6C2;">=</span><span style="color:#D19A66;">None</span><span style="color:#ABB2BF;">, </span><span style="color:#E06C75;font-style:italic;">attributes_lst</span><span style="color:#56B6C2;">=</span><span style="color:#D19A66;">None</span><span style="color:#ABB2BF;">, </span><span style="color:#E06C75;font-style:italic;">alias_lst</span><span style="color:#56B6C2;">=</span><span style="color:#D19A66;">None</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></div><ul><li>创建对齐时间序列</li></ul><div class="language-python line-numbers-mode" data-highlighter="shiki" data-ext="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-python"><span class="line"><span style="color:#ABB2BF;">session.</span><span style="color:#61AFEF;">create_aligned_time_series</span><span style="color:#ABB2BF;">(</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> device_id, measurements_lst, data_type_lst, encoding_lst, compressor_lst</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></div><p>注意：目前<strong>暂不支持</strong>使用传感器别名。</p><ul><li>删除一个或多个时间序列</li></ul><div class="language-python line-numbers-mode" data-highlighter="shiki" data-ext="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-python"><span class="line"><span style="color:#ABB2BF;">session.</span><span style="color:#61AFEF;">delete_time_series</span><span style="color:#ABB2BF;">(paths_list)</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-python line-numbers-mode" data-highlighter="shiki" data-ext="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-python"><span class="line"><span style="color:#ABB2BF;">session.</span><span style="color:#61AFEF;">check_time_series_exists</span><span style="color:#ABB2BF;">(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><h2 id="数据操作接口-dml" tabindex="-1"><a class="header-anchor" href="#数据操作接口-dml"><span>数据操作接口 DML</span></a></h2><h3 id="数据写入" tabindex="-1"><a class="header-anchor" href="#数据写入"><span>数据写入</span></a></h3><p>推荐使用 insert_tablet 帮助提高写入效率</p><ul><li>插入一个 Tablet，Tablet 是一个设备若干行数据块，每一行的列都相同 <ul><li><strong>写入效率高</strong></li><li><strong>支持写入空值</strong> （0.13 版本起）</li></ul></li></ul><p>Python API 里目前有两种 Tablet 实现</p><ul><li>普通 Tablet</li></ul><div class="language-python line-numbers-mode" data-highlighter="shiki" data-ext="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-python"><span class="line"><span style="color:#ABB2BF;">values_ </span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span><span style="color:#D19A66;">False</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">10</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">11</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">1.1</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">10011.1</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"test01"</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span><span style="color:#D19A66;">True</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">100</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">11111</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">1.25</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">101.0</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"test02"</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span><span style="color:#D19A66;">False</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">100</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">1</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">188.1</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">688.25</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"test03"</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span><span style="color:#D19A66;">True</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">0</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">0</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">0</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">6.25</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"test04"</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#ABB2BF;">]</span></span> |
| <span class="line"><span style="color:#ABB2BF;">timestamps_ </span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;"> [</span><span style="color:#D19A66;">1</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">2</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">3</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">4</span><span style="color:#ABB2BF;">]</span></span> |
| <span class="line"><span style="color:#ABB2BF;">tablet_ </span><span style="color:#56B6C2;">=</span><span style="color:#61AFEF;"> Tablet</span><span style="color:#ABB2BF;">(</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> device_id, measurements_, data_types_, values_, timestamps_</span></span> |
| <span class="line"><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#ABB2BF;">session.</span><span style="color:#61AFEF;">insert_tablet</span><span style="color:#ABB2BF;">(tablet_)</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#ABB2BF;">values_ </span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span><span style="color:#D19A66;">None</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">10</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">11</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">1.1</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">10011.1</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"test01"</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span><span style="color:#D19A66;">True</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">None</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">11111</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">1.25</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">101.0</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"test02"</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span><span style="color:#D19A66;">False</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">100</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">None</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">188.1</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">688.25</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"test03"</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span><span style="color:#D19A66;">True</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">0</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">0</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">0</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">None</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">None</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#ABB2BF;">]</span></span> |
| <span class="line"><span style="color:#ABB2BF;">timestamps_ </span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;"> [</span><span style="color:#D19A66;">16</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">17</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">18</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">19</span><span style="color:#ABB2BF;">]</span></span> |
| <span class="line"><span style="color:#ABB2BF;">tablet_ </span><span style="color:#56B6C2;">=</span><span style="color:#61AFEF;"> Tablet</span><span style="color:#ABB2BF;">(</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> device_id, measurements_, data_types_, values_, timestamps_</span></span> |
| <span class="line"><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#ABB2BF;">session.</span><span style="color:#61AFEF;">insert_tablet</span><span style="color:#ABB2BF;">(tablet_)</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Numpy Tablet</li></ul><p>相较于普通 Tablet，Numpy Tablet 使用 <a href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html" target="_blank" rel="noopener noreferrer">numpy.ndarray</a> 来记录数值型数据。<br> 内存占用和序列化耗时会降低很多，写入效率也会有很大提升。</p><p><strong>注意</strong></p><ol><li>Tablet 中的每一列时间戳和值记录为一个 ndarray</li><li>Numpy Tablet 只支持大端类型数据，ndarray 构建时如果不指定数据类型会使用小端，因此推荐在构建 ndarray 时指定下面例子中类型使用大端。如果不指定，IoTDB Python客户端也会进行大小端转换，不影响使用正确性。</li></ol><div class="language-python line-numbers-mode" data-highlighter="shiki" data-ext="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-python"><span class="line"><span style="color:#C678DD;">import</span><span style="color:#ABB2BF;"> numpy </span><span style="color:#C678DD;">as</span><span style="color:#ABB2BF;"> np</span></span> |
| <span class="line"><span style="color:#ABB2BF;">data_types_ </span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> TSDataType.</span><span style="color:#D19A66;">BOOLEAN</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> TSDataType.</span><span style="color:#D19A66;">INT32</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> TSDataType.</span><span style="color:#D19A66;">INT64</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> TSDataType.</span><span style="color:#D19A66;">FLOAT</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> TSDataType.</span><span style="color:#D19A66;">DOUBLE</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> TSDataType.</span><span style="color:#D19A66;">TEXT</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#ABB2BF;">]</span></span> |
| <span class="line"><span style="color:#ABB2BF;">np_values_ </span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> np.</span><span style="color:#61AFEF;">array</span><span style="color:#ABB2BF;">([</span><span style="color:#D19A66;">False</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">True</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">False</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">True</span><span style="color:#ABB2BF;">], TSDataType.</span><span style="color:#D19A66;">BOOLEAN</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">np_dtype</span><span style="color:#ABB2BF;">()),</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> np.</span><span style="color:#61AFEF;">array</span><span style="color:#ABB2BF;">([</span><span style="color:#D19A66;">10</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">100</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">100</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">0</span><span style="color:#ABB2BF;">], TSDataType.</span><span style="color:#D19A66;">INT32</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">np_dtype</span><span style="color:#ABB2BF;">()),</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> np.</span><span style="color:#61AFEF;">array</span><span style="color:#ABB2BF;">([</span><span style="color:#D19A66;">11</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">11111</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">1</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">0</span><span style="color:#ABB2BF;">], TSDataType.</span><span style="color:#D19A66;">INT64</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">np_dtype</span><span style="color:#ABB2BF;">()),</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> np.</span><span style="color:#61AFEF;">array</span><span style="color:#ABB2BF;">([</span><span style="color:#D19A66;">1.1</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">1.25</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">188.1</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">0</span><span style="color:#ABB2BF;">], TSDataType.</span><span style="color:#D19A66;">FLOAT</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">np_dtype</span><span style="color:#ABB2BF;">()),</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> np.</span><span style="color:#61AFEF;">array</span><span style="color:#ABB2BF;">([</span><span style="color:#D19A66;">10011.1</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">101.0</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">688.25</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">6.25</span><span style="color:#ABB2BF;">], TSDataType.</span><span style="color:#D19A66;">DOUBLE</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">np_dtype</span><span style="color:#ABB2BF;">()),</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> np.</span><span style="color:#61AFEF;">array</span><span style="color:#ABB2BF;">([</span><span style="color:#98C379;">"test01"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"test02"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"test03"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"test04"</span><span style="color:#ABB2BF;">], TSDataType.</span><span style="color:#D19A66;">TEXT</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">np_dtype</span><span style="color:#ABB2BF;">()),</span></span> |
| <span class="line"><span style="color:#ABB2BF;">]</span></span> |
| <span class="line"><span style="color:#ABB2BF;">np_timestamps_ </span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;"> np.</span><span style="color:#61AFEF;">array</span><span style="color:#ABB2BF;">([</span><span style="color:#D19A66;">1</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">2</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">3</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">4</span><span style="color:#ABB2BF;">], TSDataType.</span><span style="color:#D19A66;">INT64</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">np_dtype</span><span style="color:#ABB2BF;">())</span></span> |
| <span class="line"><span style="color:#ABB2BF;">np_tablet_ </span><span style="color:#56B6C2;">=</span><span style="color:#61AFEF;"> NumpyTablet</span><span style="color:#ABB2BF;">(</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> device_id, measurements_, data_types_, np_values_, np_timestamps_</span></span> |
| <span class="line"><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#ABB2BF;">session.</span><span style="color:#61AFEF;">insert_tablet</span><span style="color:#ABB2BF;">(np_tablet_)</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"># insert one numpy tablet with None into the database.</span></span> |
| <span class="line"><span style="color:#ABB2BF;">np_values_ </span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> np.</span><span style="color:#61AFEF;">array</span><span style="color:#ABB2BF;">([</span><span style="color:#D19A66;">False</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">True</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">False</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">True</span><span style="color:#ABB2BF;">], TSDataType.</span><span style="color:#D19A66;">BOOLEAN</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">np_dtype</span><span style="color:#ABB2BF;">()),</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> np.</span><span style="color:#61AFEF;">array</span><span style="color:#ABB2BF;">([</span><span style="color:#D19A66;">10</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">100</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">100</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">0</span><span style="color:#ABB2BF;">], TSDataType.</span><span style="color:#D19A66;">INT32</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">np_dtype</span><span style="color:#ABB2BF;">()),</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> np.</span><span style="color:#61AFEF;">array</span><span style="color:#ABB2BF;">([</span><span style="color:#D19A66;">11</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">11111</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">1</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">0</span><span style="color:#ABB2BF;">], TSDataType.</span><span style="color:#D19A66;">INT64</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">np_dtype</span><span style="color:#ABB2BF;">()),</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> np.</span><span style="color:#61AFEF;">array</span><span style="color:#ABB2BF;">([</span><span style="color:#D19A66;">1.1</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">1.25</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">188.1</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">0</span><span style="color:#ABB2BF;">], TSDataType.</span><span style="color:#D19A66;">FLOAT</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">np_dtype</span><span style="color:#ABB2BF;">()),</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> np.</span><span style="color:#61AFEF;">array</span><span style="color:#ABB2BF;">([</span><span style="color:#D19A66;">10011.1</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">101.0</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">688.25</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">6.25</span><span style="color:#ABB2BF;">], TSDataType.</span><span style="color:#D19A66;">DOUBLE</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">np_dtype</span><span style="color:#ABB2BF;">()),</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> np.</span><span style="color:#61AFEF;">array</span><span style="color:#ABB2BF;">([</span><span style="color:#98C379;">"test01"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"test02"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"test03"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"test04"</span><span style="color:#ABB2BF;">], TSDataType.</span><span style="color:#D19A66;">TEXT</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">np_dtype</span><span style="color:#ABB2BF;">()),</span></span> |
| <span class="line"><span style="color:#ABB2BF;">]</span></span> |
| <span class="line"><span style="color:#ABB2BF;">np_timestamps_ </span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;"> np.</span><span style="color:#61AFEF;">array</span><span style="color:#ABB2BF;">([</span><span style="color:#D19A66;">98</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">99</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">100</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">101</span><span style="color:#ABB2BF;">], TSDataType.</span><span style="color:#D19A66;">INT64</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">np_dtype</span><span style="color:#ABB2BF;">())</span></span> |
| <span class="line"><span style="color:#ABB2BF;">np_bitmaps_ </span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;"> []</span></span> |
| <span class="line"><span style="color:#C678DD;">for</span><span style="color:#ABB2BF;"> i </span><span style="color:#C678DD;">in</span><span style="color:#56B6C2;"> range</span><span style="color:#ABB2BF;">(</span><span style="color:#56B6C2;">len</span><span style="color:#ABB2BF;">(measurements_)):</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> np_bitmaps_.</span><span style="color:#61AFEF;">append</span><span style="color:#ABB2BF;">(</span><span style="color:#61AFEF;">BitMap</span><span style="color:#ABB2BF;">(</span><span style="color:#56B6C2;">len</span><span style="color:#ABB2BF;">(np_timestamps_)))</span></span> |
| <span class="line"><span style="color:#ABB2BF;">np_bitmaps_[</span><span style="color:#D19A66;">0</span><span style="color:#ABB2BF;">].</span><span style="color:#61AFEF;">mark</span><span style="color:#ABB2BF;">(</span><span style="color:#D19A66;">0</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#ABB2BF;">np_bitmaps_[</span><span style="color:#D19A66;">1</span><span style="color:#ABB2BF;">].</span><span style="color:#61AFEF;">mark</span><span style="color:#ABB2BF;">(</span><span style="color:#D19A66;">1</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#ABB2BF;">np_bitmaps_[</span><span style="color:#D19A66;">2</span><span style="color:#ABB2BF;">].</span><span style="color:#61AFEF;">mark</span><span style="color:#ABB2BF;">(</span><span style="color:#D19A66;">2</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#ABB2BF;">np_bitmaps_[</span><span style="color:#D19A66;">4</span><span style="color:#ABB2BF;">].</span><span style="color:#61AFEF;">mark</span><span style="color:#ABB2BF;">(</span><span style="color:#D19A66;">3</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#ABB2BF;">np_bitmaps_[</span><span style="color:#D19A66;">5</span><span style="color:#ABB2BF;">].</span><span style="color:#61AFEF;">mark</span><span style="color:#ABB2BF;">(</span><span style="color:#D19A66;">3</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#ABB2BF;">np_tablet_with_none </span><span style="color:#56B6C2;">=</span><span style="color:#61AFEF;"> NumpyTablet</span><span style="color:#ABB2BF;">(</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> device_id, measurements_, data_types_, np_values_, np_timestamps_, np_bitmaps_</span></span> |
| <span class="line"><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#ABB2BF;">session.</span><span style="color:#61AFEF;">insert_tablet</span><span style="color:#ABB2BF;">(np_tablet_with_none)</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>插入多个 Tablet</li></ul><div class="language-python line-numbers-mode" data-highlighter="shiki" data-ext="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-python"><span class="line"><span style="color:#ABB2BF;">session.</span><span style="color:#61AFEF;">insert_tablets</span><span style="color:#ABB2BF;">(tablet_lst)</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，一个 Record 是一个设备一个时间戳下多个测点的数据。</li></ul><div class="language-python line-numbers-mode" data-highlighter="shiki" data-ext="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-python"><span class="line"><span style="color:#ABB2BF;">session.</span><span style="color:#61AFEF;">insert_record</span><span style="color:#ABB2BF;">(device_id, timestamp, measurements_, data_types_, 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-python line-numbers-mode" data-highlighter="shiki" data-ext="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-python"><span class="line"><span style="color:#ABB2BF;">session.</span><span style="color:#61AFEF;">insert_records</span><span style="color:#ABB2BF;">(</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> device_ids_, time_list_, measurements_list_, data_type_list_, values_list_</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></div><ul><li>插入同属于一个 device 的多个 Record</li></ul><div class="language-python line-numbers-mode" data-highlighter="shiki" data-ext="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-python"><span class="line"><span style="color:#ABB2BF;">session.</span><span style="color:#61AFEF;">insert_records_of_one_device</span><span style="color:#ABB2BF;">(device_id, time_list, measurements_list, data_types_list, values_list)</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><h3 id="带有类型推断的写入" tabindex="-1"><a class="header-anchor" href="#带有类型推断的写入"><span>带有类型推断的写入</span></a></h3><p>当数据均是 String 类型时，我们可以使用如下接口，根据 value 的值进行类型推断。例如：value 为 "true" ，就可以自动推断为布尔类型。value 为 "3.2" ，就可以自动推断为数值类型。服务器需要做类型推断，可能会有额外耗时，速度较无需类型推断的写入慢</p><div class="language-python line-numbers-mode" data-highlighter="shiki" data-ext="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-python"><span class="line"><span style="color:#ABB2BF;">session.</span><span style="color:#61AFEF;">insert_str_record</span><span style="color:#ABB2BF;">(device_id, timestamp, measurements, string_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><h3 id="对齐时间序列的写入" tabindex="-1"><a class="header-anchor" href="#对齐时间序列的写入"><span>对齐时间序列的写入</span></a></h3><p>对齐时间序列的写入使用 insert_aligned_xxx 接口，其余与上述接口类似：</p><ul><li>insert_aligned_record</li><li>insert_aligned_records</li><li>insert_aligned_records_of_one_device</li><li>insert_aligned_tablet</li><li>insert_aligned_tablets</li></ul><h2 id="iotdb-sql-接口" tabindex="-1"><a class="header-anchor" href="#iotdb-sql-接口"><span>IoTDB-SQL 接口</span></a></h2><ul><li>执行查询语句</li></ul><div class="language-python line-numbers-mode" data-highlighter="shiki" data-ext="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-python"><span class="line"><span style="color:#ABB2BF;">session.</span><span style="color:#61AFEF;">execute_query_statement</span><span style="color:#ABB2BF;">(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-python line-numbers-mode" data-highlighter="shiki" data-ext="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-python"><span class="line"><span style="color:#ABB2BF;">session.</span><span style="color:#61AFEF;">execute_non_query_statement</span><span style="color:#ABB2BF;">(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-python line-numbers-mode" data-highlighter="shiki" data-ext="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-python"><span class="line"><span style="color:#ABB2BF;">session.</span><span style="color:#61AFEF;">execute_statement</span><span style="color:#ABB2BF;">(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><h2 id="元数据模版接口" tabindex="-1"><a class="header-anchor" href="#元数据模版接口"><span>元数据模版接口</span></a></h2><h3 id="构建元数据模版" tabindex="-1"><a class="header-anchor" href="#构建元数据模版"><span>构建元数据模版</span></a></h3><ol><li>首先构建 Template 类</li><li>添加子节点 MeasurementNode</li><li>调用创建元数据模版接口</li></ol><div class="language-python line-numbers-mode" data-highlighter="shiki" data-ext="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-python"><span class="line"><span style="color:#ABB2BF;">template </span><span style="color:#56B6C2;">=</span><span style="color:#61AFEF;"> Template</span><span style="color:#ABB2BF;">(</span><span style="color:#E06C75;font-style:italic;">name</span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;">template_name, </span><span style="color:#E06C75;font-style:italic;">share_time</span><span style="color:#56B6C2;">=</span><span style="color:#D19A66;">True</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#ABB2BF;">m_node_x </span><span style="color:#56B6C2;">=</span><span style="color:#61AFEF;"> MeasurementNode</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"x"</span><span style="color:#ABB2BF;">, TSDataType.</span><span style="color:#D19A66;">FLOAT</span><span style="color:#ABB2BF;">, TSEncoding.</span><span style="color:#D19A66;">RLE</span><span style="color:#ABB2BF;">, Compressor.</span><span style="color:#D19A66;">SNAPPY</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#ABB2BF;">m_node_y </span><span style="color:#56B6C2;">=</span><span style="color:#61AFEF;"> MeasurementNode</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"y"</span><span style="color:#ABB2BF;">, TSDataType.</span><span style="color:#D19A66;">FLOAT</span><span style="color:#ABB2BF;">, TSEncoding.</span><span style="color:#D19A66;">RLE</span><span style="color:#ABB2BF;">, Compressor.</span><span style="color:#D19A66;">SNAPPY</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#ABB2BF;">m_node_z </span><span style="color:#56B6C2;">=</span><span style="color:#61AFEF;"> MeasurementNode</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"z"</span><span style="color:#ABB2BF;">, TSDataType.</span><span style="color:#D19A66;">FLOAT</span><span style="color:#ABB2BF;">, TSEncoding.</span><span style="color:#D19A66;">RLE</span><span style="color:#ABB2BF;">, Compressor.</span><span style="color:#D19A66;">SNAPPY</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#ABB2BF;">template.</span><span style="color:#61AFEF;">add_template</span><span style="color:#ABB2BF;">(m_node_x)</span></span> |
| <span class="line"><span style="color:#ABB2BF;">template.</span><span style="color:#61AFEF;">add_template</span><span style="color:#ABB2BF;">(m_node_y)</span></span> |
| <span class="line"><span style="color:#ABB2BF;">template.</span><span style="color:#61AFEF;">add_template</span><span style="color:#ABB2BF;">(m_node_z)</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#ABB2BF;">session.</span><span style="color:#61AFEF;">create_schema_template</span><span style="color:#ABB2BF;">(template)</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><h3 id="修改模版节点信息" tabindex="-1"><a class="header-anchor" href="#修改模版节点信息"><span>修改模版节点信息</span></a></h3><p>修改模版节点，其中修改的模版必须已经被创建。以下函数能够在已经存在的模版中增加或者删除物理量</p><ul><li>在模版中增加实体</li></ul><div class="language-python line-numbers-mode" data-highlighter="shiki" data-ext="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-python"><span class="line"><span style="color:#ABB2BF;">session.</span><span style="color:#61AFEF;">add_measurements_in_template</span><span style="color:#ABB2BF;">(template_name, measurements_path, data_types, encodings, compressors, is_aligned)</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-python line-numbers-mode" data-highlighter="shiki" data-ext="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-python"><span class="line"><span style="color:#ABB2BF;">session.</span><span style="color:#61AFEF;">delete_node_in_template</span><span style="color:#ABB2BF;">(template_name, 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><h3 id="挂载元数据模板" tabindex="-1"><a class="header-anchor" href="#挂载元数据模板"><span>挂载元数据模板</span></a></h3><div class="language-python line-numbers-mode" data-highlighter="shiki" data-ext="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-python"><span class="line"><span style="color:#ABB2BF;">session.</span><span style="color:#61AFEF;">set_schema_template</span><span style="color:#ABB2BF;">(template_name, prefix_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><h3 id="卸载元数据模版" tabindex="-1"><a class="header-anchor" href="#卸载元数据模版"><span>卸载元数据模版</span></a></h3><div class="language-python line-numbers-mode" data-highlighter="shiki" data-ext="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-python"><span class="line"><span style="color:#ABB2BF;">session.</span><span style="color:#61AFEF;">unset_schema_template</span><span style="color:#ABB2BF;">(template_name, prefix_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><h3 id="查看元数据模版" tabindex="-1"><a class="header-anchor" href="#查看元数据模版"><span>查看元数据模版</span></a></h3><ul><li>查看所有的元数据模版</li></ul><div class="language-python line-numbers-mode" data-highlighter="shiki" data-ext="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-python"><span class="line"><span style="color:#ABB2BF;">session.</span><span style="color:#61AFEF;">show_all_templates</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>查看元数据模版中的物理量个数</li></ul><div class="language-python line-numbers-mode" data-highlighter="shiki" data-ext="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-python"><span class="line"><span style="color:#ABB2BF;">session.</span><span style="color:#61AFEF;">count_measurements_in_template</span><span style="color:#ABB2BF;">(template_name)</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-python line-numbers-mode" data-highlighter="shiki" data-ext="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-python"><span class="line"><span style="color:#ABB2BF;">session.</span><span style="color:#61AFEF;">count_measurements_in_template</span><span style="color:#ABB2BF;">(template_name, 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><ul><li>判断某个路径是否在元数据模版中，这个路径有可能不在元数据模版中</li></ul><div class="language-python line-numbers-mode" data-highlighter="shiki" data-ext="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-python"><span class="line"><span style="color:#ABB2BF;">session.</span><span style="color:#61AFEF;">is_path_exist_in_template</span><span style="color:#ABB2BF;">(template_name, 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><ul><li>查看某个元数据模板下的物理量</li></ul><div class="language-python line-numbers-mode" data-highlighter="shiki" data-ext="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-python"><span class="line"><span style="color:#ABB2BF;">session.</span><span style="color:#61AFEF;">show_measurements_in_template</span><span style="color:#ABB2BF;">(template_name)</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-python line-numbers-mode" data-highlighter="shiki" data-ext="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-python"><span class="line"><span style="color:#ABB2BF;">session.</span><span style="color:#61AFEF;">show_paths_template_set_on</span><span style="color:#ABB2BF;">(template_name)</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-python line-numbers-mode" data-highlighter="shiki" data-ext="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-python"><span class="line"><span style="color:#ABB2BF;">session.</span><span style="color:#61AFEF;">show_paths_template_using_on</span><span style="color:#ABB2BF;">(template_name)</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><h3 id="删除元数据模版" tabindex="-1"><a class="header-anchor" href="#删除元数据模版"><span>删除元数据模版</span></a></h3><p>删除已经存在的元数据模版，不支持删除已经挂载的模版</p><div class="language-python line-numbers-mode" data-highlighter="shiki" data-ext="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-python"><span class="line"><span style="color:#ABB2BF;">session.</span><span style="color:#61AFEF;">drop_schema_template</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"template_python"</span><span style="color:#ABB2BF;">)</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><h2 id="对-pandas-的支持" tabindex="-1"><a class="header-anchor" href="#对-pandas-的支持"><span>对 Pandas 的支持</span></a></h2><p>我们支持将查询结果轻松地转换为 <a href="https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.html" target="_blank" rel="noopener noreferrer">Pandas Dataframe</a>。</p><p>SessionDataSet 有一个方法<code>.todf()</code>，它的作用是消费 SessionDataSet 中的数据，并将数据转换为 pandas dataframe。</p><p>例子：</p><div class="language-python line-numbers-mode" data-highlighter="shiki" data-ext="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-python"><span class="line"><span style="color:#C678DD;">from</span><span style="color:#ABB2BF;"> iotdb.Session </span><span style="color:#C678DD;">import</span><span style="color:#ABB2BF;"> Session</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#ABB2BF;">ip </span><span style="color:#56B6C2;">=</span><span style="color:#98C379;"> "127.0.0.1"</span></span> |
| <span class="line"><span style="color:#ABB2BF;">port_ </span><span style="color:#56B6C2;">=</span><span style="color:#98C379;"> "6667"</span></span> |
| <span class="line"><span style="color:#ABB2BF;">username_ </span><span style="color:#56B6C2;">=</span><span style="color:#98C379;"> "root"</span></span> |
| <span class="line"><span style="color:#ABB2BF;">password_ </span><span style="color:#56B6C2;">=</span><span style="color:#98C379;"> "root"</span></span> |
| <span class="line"><span style="color:#ABB2BF;">session </span><span style="color:#56B6C2;">=</span><span style="color:#61AFEF;"> Session</span><span style="color:#ABB2BF;">(ip, port_, username_, password_)</span></span> |
| <span class="line"><span style="color:#ABB2BF;">session.</span><span style="color:#61AFEF;">open</span><span style="color:#ABB2BF;">(</span><span style="color:#D19A66;">False</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#ABB2BF;">result </span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;"> session.</span><span style="color:#61AFEF;">execute_query_statement</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"SELECT ** FROM root"</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"># Transform to Pandas Dataset</span></span> |
| <span class="line"><span style="color:#ABB2BF;">df </span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;"> result.</span><span style="color:#61AFEF;">todf</span><span style="color:#ABB2BF;">()</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#ABB2BF;">session.</span><span style="color:#61AFEF;">close</span><span style="color:#ABB2BF;">()</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"># Now you can work with the dataframe</span></span> |
| <span class="line"><span style="color:#ABB2BF;">df </span><span style="color:#56B6C2;">=</span><span style="color:#D19A66;"> ...</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></div><h2 id="iotdb-testcontainer" tabindex="-1"><a class="header-anchor" href="#iotdb-testcontainer"><span>IoTDB Testcontainer</span></a></h2><p>Python 客户端对测试的支持是基于<code>testcontainers</code>库 (<a href="https://testcontainers-python.readthedocs.io/en/latest/index.html" target="_blank" rel="noopener noreferrer">https://testcontainers-python.readthedocs.io/en/latest/index.html</a>) 的，如果您想使用该特性，就需要将其安装到您的项目中。</p><p>要在 Docker 容器中启动（和停止）一个 IoTDB 数据库，只需这样做：</p><div class="language-python line-numbers-mode" data-highlighter="shiki" data-ext="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-python"><span class="line"><span style="color:#C678DD;">class</span><span style="color:#E5C07B;"> MyTestCase</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">unittest</span><span style="color:#ABB2BF;">.</span><span style="color:#E5C07B;">TestCase</span><span style="color:#ABB2BF;">):</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#C678DD;"> def</span><span style="color:#61AFEF;"> test_something</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;font-style:italic;">self</span><span style="color:#ABB2BF;">):</span></span> |
| <span class="line"><span style="color:#C678DD;"> with</span><span style="color:#61AFEF;"> IoTDBContainer</span><span style="color:#ABB2BF;">() </span><span style="color:#C678DD;">as</span><span style="color:#ABB2BF;"> c:</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> session </span><span style="color:#56B6C2;">=</span><span style="color:#61AFEF;"> Session</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"localhost"</span><span style="color:#ABB2BF;">, c.</span><span style="color:#61AFEF;">get_exposed_port</span><span style="color:#ABB2BF;">(</span><span style="color:#D19A66;">6667</span><span style="color:#ABB2BF;">), </span><span style="color:#98C379;">"root"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"root"</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> session.</span><span style="color:#61AFEF;">open</span><span style="color:#ABB2BF;">(</span><span style="color:#D19A66;">False</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> result </span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;"> session.</span><span style="color:#61AFEF;">execute_query_statement</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"SHOW TIMESERIES"</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#56B6C2;"> print</span><span style="color:#ABB2BF;">(result)</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> session.</span><span style="color:#61AFEF;">close</span><span style="color:#ABB2BF;">()</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="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>默认情况下，它会拉取最新的 IoTDB 镜像 <code>apache/iotdb:latest</code>进行测试，如果您想指定待测 IoTDB 的版本，您只需要将版本信息像这样声明：<code>IoTDBContainer("apache/iotdb:0.12.0")</code>，此时，您就会得到一个<code>0.12.0</code>版本的 IoTDB 实例。</p><h2 id="iotdb-dbapi" tabindex="-1"><a class="header-anchor" href="#iotdb-dbapi"><span>IoTDB DBAPI</span></a></h2><p>IoTDB DBAPI 遵循 Python DB API 2.0 规范 (<a href="https://peps.python.org/pep-0249/" target="_blank" rel="noopener noreferrer">https://peps.python.org/pep-0249/</a>)，实现了通过Python语言访问数据库的通用接口。</p><h3 id="例子" tabindex="-1"><a class="header-anchor" href="#例子"><span>例子</span></a></h3><ul><li>初始化</li></ul><p>初始化的参数与Session部分保持一致（sqlalchemy_mode参数除外，该参数仅在SQLAlchemy方言中使用）</p><div class="language-python line-numbers-mode" data-highlighter="shiki" data-ext="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-python"><span class="line"><span style="color:#C678DD;">from</span><span style="color:#ABB2BF;"> iotdb.dbapi </span><span style="color:#C678DD;">import</span><span style="color:#ABB2BF;"> connect</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#ABB2BF;">ip </span><span style="color:#56B6C2;">=</span><span style="color:#98C379;"> "127.0.0.1"</span></span> |
| <span class="line"><span style="color:#ABB2BF;">port_ </span><span style="color:#56B6C2;">=</span><span style="color:#98C379;"> "6667"</span></span> |
| <span class="line"><span style="color:#ABB2BF;">username_ </span><span style="color:#56B6C2;">=</span><span style="color:#98C379;"> "root"</span></span> |
| <span class="line"><span style="color:#ABB2BF;">password_ </span><span style="color:#56B6C2;">=</span><span style="color:#98C379;"> "root"</span></span> |
| <span class="line"><span style="color:#ABB2BF;">conn </span><span style="color:#56B6C2;">=</span><span style="color:#61AFEF;"> connect</span><span style="color:#ABB2BF;">(ip, port_, username_, password_,</span><span style="color:#E06C75;font-style:italic;">fetch_size</span><span style="color:#56B6C2;">=</span><span style="color:#D19A66;">1024</span><span style="color:#ABB2BF;">,</span><span style="color:#E06C75;font-style:italic;">zone_id</span><span style="color:#56B6C2;">=</span><span style="color:#98C379;">"UTC+8"</span><span style="color:#ABB2BF;">,</span><span style="color:#E06C75;font-style:italic;">sqlalchemy_mode</span><span style="color:#56B6C2;">=</span><span style="color:#D19A66;">False</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#ABB2BF;">cursor </span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;"> conn.</span><span style="color:#61AFEF;">cursor</span><span style="color:#ABB2BF;">()</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>执行简单的SQL语句</li></ul><div class="language-python line-numbers-mode" data-highlighter="shiki" data-ext="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-python"><span class="line"><span style="color:#ABB2BF;">cursor.</span><span style="color:#61AFEF;">execute</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"SELECT ** FROM root"</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#C678DD;">for</span><span style="color:#ABB2BF;"> row </span><span style="color:#C678DD;">in</span><span style="color:#ABB2BF;"> cursor.</span><span style="color:#61AFEF;">fetchall</span><span style="color:#ABB2BF;">():</span></span> |
| <span class="line"><span style="color:#56B6C2;"> print</span><span style="color:#ABB2BF;">(row)</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><ul><li>执行带有参数的SQL语句</li></ul><p>IoTDB DBAPI 支持pyformat风格的参数</p><div class="language-python line-numbers-mode" data-highlighter="shiki" data-ext="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-python"><span class="line"><span style="color:#ABB2BF;">cursor.</span><span style="color:#61AFEF;">execute</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"SELECT ** FROM root WHERE time < </span><span style="color:#D19A66;">%(time)s</span><span style="color:#98C379;">"</span><span style="color:#ABB2BF;">,{</span><span style="color:#98C379;">"time"</span><span style="color:#ABB2BF;">:</span><span style="color:#98C379;">"2017-11-01T00:08:00.000"</span><span style="color:#ABB2BF;">})</span></span> |
| <span class="line"><span style="color:#C678DD;">for</span><span style="color:#ABB2BF;"> row </span><span style="color:#C678DD;">in</span><span style="color:#ABB2BF;"> cursor.</span><span style="color:#61AFEF;">fetchall</span><span style="color:#ABB2BF;">():</span></span> |
| <span class="line"><span style="color:#56B6C2;"> print</span><span style="color:#ABB2BF;">(row)</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><ul><li>批量执行带有参数的SQL语句</li></ul><div class="language-python line-numbers-mode" data-highlighter="shiki" data-ext="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-python"><span class="line"><span style="color:#ABB2BF;">seq_of_parameters </span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> {</span><span style="color:#98C379;">"timestamp"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">1</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"temperature"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">1</span><span style="color:#ABB2BF;">},</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> {</span><span style="color:#98C379;">"timestamp"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">2</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"temperature"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">2</span><span style="color:#ABB2BF;">},</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> {</span><span style="color:#98C379;">"timestamp"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">3</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"temperature"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">3</span><span style="color:#ABB2BF;">},</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> {</span><span style="color:#98C379;">"timestamp"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">4</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"temperature"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">4</span><span style="color:#ABB2BF;">},</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> {</span><span style="color:#98C379;">"timestamp"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">5</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"temperature"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">5</span><span style="color:#ABB2BF;">},</span></span> |
| <span class="line"><span style="color:#ABB2BF;">]</span></span> |
| <span class="line"><span style="color:#ABB2BF;">sql </span><span style="color:#56B6C2;">=</span><span style="color:#98C379;"> "insert into root.cursor(timestamp,temperature) values(</span><span style="color:#D19A66;">%(timestamp)s</span><span style="color:#98C379;">,</span><span style="color:#D19A66;">%(temperature)s</span><span style="color:#98C379;">)"</span></span> |
| <span class="line"><span style="color:#ABB2BF;">cursor.</span><span style="color:#61AFEF;">executemany</span><span style="color:#ABB2BF;">(sql,seq_of_parameters)</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></div><ul><li>关闭连接</li></ul><div class="language-python line-numbers-mode" data-highlighter="shiki" data-ext="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-python"><span class="line"><span style="color:#ABB2BF;">cursor.</span><span style="color:#61AFEF;">close</span><span style="color:#ABB2BF;">()</span></span> |
| <span class="line"><span style="color:#ABB2BF;">conn.</span><span style="color:#61AFEF;">close</span><span style="color:#ABB2BF;">()</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div></div></div><h2 id="iotdb-sqlalchemy-dialect-实验性" tabindex="-1"><a class="header-anchor" href="#iotdb-sqlalchemy-dialect-实验性"><span>IoTDB SQLAlchemy Dialect（实验性）</span></a></h2><p>IoTDB的SQLAlchemy方言主要是为了适配Apache superset而编写的，该部分仍在完善中，请勿在生产环境中使用！</p><h3 id="元数据模型映射" tabindex="-1"><a class="header-anchor" href="#元数据模型映射"><span>元数据模型映射</span></a></h3><p>SQLAlchemy 所使用的数据模型为关系数据模型，这种数据模型通过表格来描述不同实体之间的关系。<br> 而 IoTDB 的数据模型为层次数据模型，通过树状结构来对数据进行组织。<br> 为了使 IoTDB 能够适配 SQLAlchemy 的方言，需要对 IoTDB 中原有的数据模型进行重新组织，<br> 把 IoTDB 的数据模型转换成 SQLAlchemy 的数据模型。</p><p>IoTDB 中的元数据有：</p><ol><li>Database：数据库</li><li>Path：存储路径</li><li>Entity：实体</li><li>Measurement：物理量</li></ol><p>SQLAlchemy 中的元数据有：</p><ol><li>Schema：数据模式</li><li>Table：数据表</li><li>Column：数据列</li></ol><p>它们之间的映射关系为：</p><table><thead><tr><th>SQLAlchemy中的元数据</th><th>IoTDB中对应的元数据</th></tr></thead><tbody><tr><td>Schema</td><td>Database</td></tr><tr><td>Table</td><td>Path ( from database to entity ) + Entity</td></tr><tr><td>Column</td><td>Measurement</td></tr></tbody></table><p>下图更加清晰的展示了二者的映射关系：</p><figure><img src="/img/UserGuide/API/IoTDB-SQLAlchemy/sqlalchemy-to-iotdb.png?raw=true" alt="sqlalchemy-to-iotdb" tabindex="0" loading="lazy"><figcaption>sqlalchemy-to-iotdb</figcaption></figure><h3 id="数据类型映射" tabindex="-1"><a class="header-anchor" href="#数据类型映射"><span>数据类型映射</span></a></h3><table><thead><tr><th>IoTDB 中的数据类型</th><th>SQLAlchemy 中的数据类型</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>BigInteger</td></tr><tr><td>FLOAT</td><td>Float</td></tr><tr><td>DOUBLE</td><td>Float</td></tr><tr><td>TEXT</td><td>Text</td></tr><tr><td>LONG</td><td>BigInteger</td></tr></tbody></table><h3 id="example" tabindex="-1"><a class="header-anchor" href="#example"><span>Example</span></a></h3><ul><li>执行语句</li></ul><div class="language-python line-numbers-mode" data-highlighter="shiki" data-ext="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-python"><span class="line"><span style="color:#C678DD;">from</span><span style="color:#ABB2BF;"> sqlalchemy </span><span style="color:#C678DD;">import</span><span style="color:#ABB2BF;"> create_engine</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#ABB2BF;">engine </span><span style="color:#56B6C2;">=</span><span style="color:#61AFEF;"> create_engine</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"iotdb://root:root@127.0.0.1:6667"</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#ABB2BF;">connect </span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;"> engine.</span><span style="color:#61AFEF;">connect</span><span style="color:#ABB2BF;">()</span></span> |
| <span class="line"><span style="color:#ABB2BF;">result </span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;"> connect.</span><span style="color:#61AFEF;">execute</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"SELECT ** FROM root"</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#C678DD;">for</span><span style="color:#ABB2BF;"> row </span><span style="color:#C678DD;">in</span><span style="color:#ABB2BF;"> result.</span><span style="color:#61AFEF;">fetchall</span><span style="color:#ABB2BF;">():</span></span> |
| <span class="line"><span style="color:#56B6C2;"> print</span><span style="color:#ABB2BF;">(row)</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><ul><li>ORM (目前只支持简单的查询)</li></ul><div class="language-python line-numbers-mode" data-highlighter="shiki" data-ext="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-python"><span class="line"><span style="color:#C678DD;">from</span><span style="color:#ABB2BF;"> sqlalchemy </span><span style="color:#C678DD;">import</span><span style="color:#ABB2BF;"> create_engine, Column, Float, BigInteger, MetaData</span></span> |
| <span class="line"><span style="color:#C678DD;">from</span><span style="color:#ABB2BF;"> sqlalchemy.ext.declarative </span><span style="color:#C678DD;">import</span><span style="color:#ABB2BF;"> declarative_base</span></span> |
| <span class="line"><span style="color:#C678DD;">from</span><span style="color:#ABB2BF;"> sqlalchemy.orm </span><span style="color:#C678DD;">import</span><span style="color:#ABB2BF;"> sessionmaker</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#ABB2BF;">metadata </span><span style="color:#56B6C2;">=</span><span style="color:#61AFEF;"> MetaData</span><span style="color:#ABB2BF;">(</span></span> |
| <span class="line"><span style="color:#E06C75;font-style:italic;"> schema</span><span style="color:#56B6C2;">=</span><span style="color:#98C379;">'root.factory'</span></span> |
| <span class="line"><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#ABB2BF;">Base </span><span style="color:#56B6C2;">=</span><span style="color:#61AFEF;"> declarative_base</span><span style="color:#ABB2BF;">(</span><span style="color:#E06C75;font-style:italic;">metadata</span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;">metadata)</span></span> |
| <span class="line"></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#C678DD;">class</span><span style="color:#E5C07B;"> Device</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">Base</span><span style="color:#ABB2BF;">):</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> __tablename__ </span><span style="color:#56B6C2;">=</span><span style="color:#98C379;"> "room2.device1"</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> Time </span><span style="color:#56B6C2;">=</span><span style="color:#61AFEF;"> Column</span><span style="color:#ABB2BF;">(BigInteger, </span><span style="color:#E06C75;font-style:italic;">primary_key</span><span style="color:#56B6C2;">=</span><span style="color:#D19A66;">True</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> temperature </span><span style="color:#56B6C2;">=</span><span style="color:#61AFEF;"> Column</span><span style="color:#ABB2BF;">(Float)</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> status </span><span style="color:#56B6C2;">=</span><span style="color:#61AFEF;"> Column</span><span style="color:#ABB2BF;">(Float)</span></span> |
| <span class="line"></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#ABB2BF;">engine </span><span style="color:#56B6C2;">=</span><span style="color:#61AFEF;"> create_engine</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"iotdb://root:root@127.0.0.1:6667"</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#ABB2BF;">DbSession </span><span style="color:#56B6C2;">=</span><span style="color:#61AFEF;"> sessionmaker</span><span style="color:#ABB2BF;">(</span><span style="color:#E06C75;font-style:italic;">bind</span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;">engine)</span></span> |
| <span class="line"><span style="color:#ABB2BF;">session </span><span style="color:#56B6C2;">=</span><span style="color:#61AFEF;"> DbSession</span><span style="color:#ABB2BF;">()</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#ABB2BF;">res </span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;"> session.</span><span style="color:#61AFEF;">query</span><span style="color:#ABB2BF;">(Device.status).</span><span style="color:#61AFEF;">filter</span><span style="color:#ABB2BF;">(Device.temperature </span><span style="color:#56B6C2;">></span><span style="color:#D19A66;"> 1</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#C678DD;">for</span><span style="color:#ABB2BF;"> row </span><span style="color:#C678DD;">in</span><span style="color:#ABB2BF;"> res:</span></span> |
| <span class="line"><span style="color:#56B6C2;"> print</span><span style="color:#ABB2BF;">(row)</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></div><h2 id="给开发人员" tabindex="-1"><a class="header-anchor" href="#给开发人员"><span>给开发人员</span></a></h2><h3 id="介绍" tabindex="-1"><a class="header-anchor" href="#介绍"><span>介绍</span></a></h3><p>这是一个使用 thrift rpc 接口连接到 IoTDB 的示例。在 Windows 和 Linux 上操作几乎是一样的，但要注意路径分隔符等不同之处。</p><h3 id="依赖-1" tabindex="-1"><a class="header-anchor" href="#依赖-1"><span>依赖</span></a></h3><p>首选 Python3.7 或更高版本。</p><p>必须安装 thrift（0.11.0 或更高版本）才能将 thrift 文件编译为 Python 代码。下面是官方的安装教程，最终，您应该得到一个 thrift 可执行文件。</p><div class="language- line-numbers-mode" data-highlighter="shiki" data-ext="" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-"><span class="line"><span>http://thrift.apache.org/docs/install/</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>在开始之前，您还需要在 Python 环境中安装<code>requirements_dev.txt</code>中的其他依赖：</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-shell"><span class="line"><span style="color:#61AFEF;">pip</span><span style="color:#98C379;"> install</span><span style="color:#D19A66;"> -r</span><span style="color:#98C379;"> requirements_dev.txt</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><h3 id="编译-thrift-库并调试" tabindex="-1"><a class="header-anchor" href="#编译-thrift-库并调试"><span>编译 thrift 库并调试</span></a></h3><p>在 IoTDB 源代码文件夹的根目录下，运行<code>mvn clean generate-sources -pl iotdb-client/client-py -am</code>，</p><p>这个指令将自动删除<code>iotdb/thrift</code>中的文件，并使用新生成的 thrift 文件重新填充该文件夹。</p><p>这个文件夹在 git 中会被忽略，并且<strong>永远不应该被推到 git 中！</strong></p><p><strong>注意</strong>不要将<code>iotdb/thrift</code>上传到 git 仓库中 ！</p><h3 id="session-客户端-使用示例" tabindex="-1"><a class="header-anchor" href="#session-客户端-使用示例"><span>Session 客户端 & 使用示例</span></a></h3><p>我们将 thrift 接口打包到<code>client-py/src/iotdb/session.py </code>中（与 Java 版本类似），还提供了一个示例文件<code>client-py/src/SessionExample.py</code>来说明如何使用 Session 模块。请仔细阅读。</p><p>另一个简单的例子：</p><div class="language-python line-numbers-mode" data-highlighter="shiki" data-ext="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-python"><span class="line"><span style="color:#C678DD;">from</span><span style="color:#ABB2BF;"> iotdb.Session </span><span style="color:#C678DD;">import</span><span style="color:#ABB2BF;"> Session</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#ABB2BF;">ip </span><span style="color:#56B6C2;">=</span><span style="color:#98C379;"> "127.0.0.1"</span></span> |
| <span class="line"><span style="color:#ABB2BF;">port_ </span><span style="color:#56B6C2;">=</span><span style="color:#98C379;"> "6667"</span></span> |
| <span class="line"><span style="color:#ABB2BF;">username_ </span><span style="color:#56B6C2;">=</span><span style="color:#98C379;"> "root"</span></span> |
| <span class="line"><span style="color:#ABB2BF;">password_ </span><span style="color:#56B6C2;">=</span><span style="color:#98C379;"> "root"</span></span> |
| <span class="line"><span style="color:#ABB2BF;">session </span><span style="color:#56B6C2;">=</span><span style="color:#61AFEF;"> Session</span><span style="color:#ABB2BF;">(ip, port_, username_, password_)</span></span> |
| <span class="line"><span style="color:#ABB2BF;">session.</span><span style="color:#61AFEF;">open</span><span style="color:#ABB2BF;">(</span><span style="color:#D19A66;">False</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#ABB2BF;">zone </span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;"> session.</span><span style="color:#61AFEF;">get_time_zone</span><span style="color:#ABB2BF;">()</span></span> |
| <span class="line"><span style="color:#ABB2BF;">session.</span><span style="color:#61AFEF;">close</span><span style="color:#ABB2BF;">()</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="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><p>请在<code>tests</code>文件夹中添加自定义测试。</p><p>要运行所有的测试，只需在根目录中运行<code>pytest . </code>即可。</p><p><strong>注意</strong>一些测试需要在您的系统上使用 docker，因为测试的 IoTDB 实例是使用 <a href="https://testcontainers-python.readthedocs.io/en/latest/index.html" target="_blank" rel="noopener noreferrer">testcontainers</a> 在 docker 容器中启动的。</p><h3 id="其他工具" tabindex="-1"><a class="header-anchor" href="#其他工具"><span>其他工具</span></a></h3><p><a href="https://pypi.org/project/black/" target="_blank" rel="noopener noreferrer">black</a> 和 <a href="https://pypi.org/project/flake8/" target="_blank" rel="noopener noreferrer">flake8</a> 分别用于自动格式化和 linting。<br> 它们可以通过 <code>black .</code> 或 <code>flake8 .</code> 分别运行。</p><h2 id="发版" tabindex="-1"><a class="header-anchor" href="#发版"><span>发版</span></a></h2><p>要进行发版，</p><p>只需确保您生成了正确的 thrift 代码，</p><p>运行了 linting 并进行了自动格式化，</p><p>然后，确保所有测试都正常通过（通过<code>pytest . </code>），</p><p>最后，您就可以将包发布到 pypi 了。</p><h3 id="准备您的环境" tabindex="-1"><a class="header-anchor" href="#准备您的环境"><span>准备您的环境</span></a></h3><p>首先，通过<code>pip install -r requirements_dev.txt</code>安装所有必要的开发依赖。</p><h3 id="发版-1" tabindex="-1"><a class="header-anchor" href="#发版-1"><span>发版</span></a></h3><p>有一个脚本<code>release.sh</code>可以用来执行发版的所有步骤。</p><p>这些步骤包括：</p><ul><li><p>删除所有临时目录（如果存在）</p></li><li><p>（重新）通过 mvn 生成所有必须的源代码</p></li><li><p>运行 linting （flke8）</p></li><li><p>通过 pytest 运行测试</p></li><li><p>Build</p></li><li><p>发布到 pypi</p></li></ul></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/V1.3.x/API/Programming-Python-Native-API.md" aria-label="发现错误？在 GitHub 上编辑此页" rel="noopener noreferrer" target="_blank"><!--[--><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><time class="vp-meta-info" datetime="2025-04-29T04:30:02.000Z" data-allow-mismatch>2025/4/29 04:30</time></div><!----></div></footer><nav class="vp-page-nav"><!----><a class="route-link auto-link next" href="/zh/UserGuide/V1.3.x/API/Programming-Cpp-Native-API.html" aria-label="C++原生接口"><div class="hint">下一页<span class="arrow end"></span></div><div class="link">C++原生接口<!----></div></a></nav><!----><!----><!--]--></main><!--]--><footer class="site-footer"><span id="doc-version" style="display:none;">V1.3.x</span><p class="copyright-text">版权所有 © 2026 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-pmkzp6TS.js" defer></script> |
| </body> |
| </html> |
