| <!doctype html> |
| <html lang="en-US" data-theme="light"> |
| <head> |
| <meta charset="utf-8" /> |
| <meta name="viewport" content="width=device-width,initial-scale=1" /> |
| <meta name="generator" content="VuePress 2.0.0-rc.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 Native API","image":[""],"dateModified":"2026-04-15T10:39:00.000Z","author":[]}</script><meta property="og:url" content="https://iotdb.apache.org/UserGuide/latest-Table/API/Programming-Python-Native-API_apache.html"><meta property="og:site_name" content="IoTDB Website"><meta property="og:title" content="Python Native API"><meta property="og:description" content="Python Native API IoTDB provides a Python native client driver and a session pool management mechanism. These tools allow developers to interact with IoTDB in a programmatic and..."><meta property="og:type" content="article"><meta property="og:locale" content="en-US"><meta property="og:locale:alternate" content="zh-CN"><meta property="og:updated_time" content="2026-04-15T10:39:00.000Z"><meta property="article:modified_time" content="2026-04-15T10:39:00.000Z"><link rel="alternate" hreflang="zh-cn" href="https://iotdb.apache.org/zh/UserGuide/latest-Table/API/Programming-Python-Native-API_apache.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="This is a custom LLM for Apache IoTDB with access to all [documentation](iotdb.apache.org/docs/), [GitHub Open Issues, PRs and READMEs](github.com/apache/iotdb). |
| |
| If you encounter <Error in verifying browser for feedback submission. Captcha token could not be obtained.> please ensure that you can access Google services." data-user-analytics-fingerprint-enabled="true" data-consent-required="true" data-consent-screen-disclaimer="By clicking <I agree, let's chat>, you consent to the use of the AI assistant in accordance with kapa.ai's [Privacy Policy](https://www.kapa.ai/content/privacy-policy). This service uses reCAPTCHA, which requires your consent to Google's [Privacy Policy](https://policies.google.com/privacy) and [Terms of Service](https://policies.google.com/terms). By proceeding, you explicitly agree to both kapa.ai's and Google's privacy policies."></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 Native API | IoTDB Website</title><meta name="description" content="Python Native API IoTDB provides a Python native client driver and a session pool management mechanism. These tools allow developers to interact with IoTDB in a programmatic and..."> |
| <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_apache.html-Ch84D16N.js"> |
| |
| </head> |
| <body> |
| <div id="app"><!--[--><!--[--><!--[--><span tabindex="-1"></span><a href="#main-content" class="vp-skip-link sr-only">Skip to main content</a><!--]--><!--[--><div class="theme-container external-link-icon has-toc" vp-container><!--[--><header id="navbar" class="vp-navbar" vp-navbar><div class="vp-navbar-start"><button type="button" class="vp-toggle-sidebar-button" title="Toggle Sidebar"><span class="icon"></span></button><!--[--><a class="route-link vp-brand" href="/" aria-label="Take me home"><img class="vp-nav-logo" src="/logo.png" alt><!----><!----></a><!--]--></div><div class="vp-navbar-center"><!--[--><!--]--></div><div class="vp-navbar-end"><!--[--><!--[--><div id="docsearch-container" style="display:none;"></div><div class="docsearch-placeholder"><button type="button" aria-label="Search" 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">Search</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="Documentation"><!--[--><!---->Documentation<!--]--><span class="arrow"></span><ul class="vp-dropdown"><li class="vp-dropdown-item"><a class="route-link auto-link" href="/UserGuide/latest/QuickStart/QuickStart_apache.html" aria-label="v2.0.x"><!---->v2.0.x<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/UserGuide/V1.3.x/QuickStart/QuickStart_apache.html" aria-label="v1.3.x"><!---->v1.3.x<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/UserGuide/V1.2.x/QuickStart/QuickStart.html" aria-label="v1.2.x"><!---->v1.2.x<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/UserGuide/V0.13.x/QuickStart/QuickStart.html" aria-label="v0.13.x"><!---->v0.13.x<!----></a></li></ul></button></div></div><div class="vp-nav-item hide-in-mobile"><a class="auto-link external-link" href="https://cwiki.apache.org/confluence/display/IOTDB/System+Design" aria-label="Design" rel="noopener noreferrer" target="_blank"><!---->Design<!----></a></div><div class="vp-nav-item hide-in-mobile"><a class="route-link auto-link" href="/Download/" aria-label="Download"><!---->Download<!----></a></div><div class="vp-nav-item hide-in-mobile"><div class="vp-dropdown-wrapper"><button type="button" class="vp-dropdown-title" aria-label="Community"><!--[--><!---->Community<!--]--><span class="arrow"></span><ul class="vp-dropdown"><li class="vp-dropdown-item"><a class="route-link auto-link" href="/Community/About-the-Community.html" aria-label="About the Community"><!---->About the Community<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/Community/Development-Guide.html" aria-label="Development Guide"><!---->Development Guide<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/Community/Community-Partners.html" aria-label="Community Partners"><!---->Community Partners<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/Community/Communication-Channels.html" aria-label="Communication Channels"><!---->Communication Channels<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/Community/Events-and-Reports.html" aria-label="Events and Reports"><!---->Events and Reports<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/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="Foundation" rel="noopener noreferrer" target="_blank"><!---->Foundation<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/licenses/" aria-label="License" rel="noopener noreferrer" target="_blank"><!---->License<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/security/" aria-label="Security" rel="noopener noreferrer" target="_blank"><!---->Security<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/foundation/sponsorship.html" aria-label="Sponsorship" rel="noopener noreferrer" target="_blank"><!---->Sponsorship<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/foundation/thanks.html" aria-label="Thanks" rel="noopener noreferrer" target="_blank"><!---->Thanks<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/events/current-event" aria-label="Current Events" rel="noopener noreferrer" target="_blank"><!---->Current Events<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://privacy.apache.org/policies/privacy-policy-public.html" aria-label="Privacy" rel="noopener noreferrer" target="_blank"><!---->Privacy<!----></a></li></ul></button></div></div></nav><div class="vp-nav-item"><div class="vp-dropdown-wrapper"><button type="button" class="vp-dropdown-title" aria-label="Select language"><!--[--><svg xmlns="http://www.w3.org/2000/svg" class="icon i18n-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="i18n icon" name="i18n" style="width:1rem;height:1rem;vertical-align:middle;"><path d="M379.392 460.8 494.08 575.488l-42.496 102.4L307.2 532.48 138.24 701.44l-71.68-72.704L234.496 460.8l-45.056-45.056c-27.136-27.136-51.2-66.56-66.56-108.544h112.64c7.68 14.336 16.896 27.136 26.112 35.84l45.568 46.08 45.056-45.056C382.976 312.32 409.6 247.808 409.6 204.8H0V102.4h256V0h102.4v102.4h256v102.4H512c0 70.144-37.888 161.28-87.04 210.944L378.88 460.8zM576 870.4 512 1024H409.6l256-614.4H768l256 614.4H921.6l-64-153.6H576zM618.496 768h196.608L716.8 532.48 618.496 768z"></path></svg><!--]--><span class="arrow"></span><ul class="vp-dropdown"><li class="vp-dropdown-item"><a class="route-link route-link-active auto-link" href="/UserGuide/latest-Table/API/Programming-Python-Native-API_apache.html" aria-label="English"><!---->English<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/zh/UserGuide/latest-Table/API/Programming-Python-Native-API_apache.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 User Guide (V2.0.x)</span></p><div class="sidebar-top-wrapper"><ul class="switch-list"><li class="switch-type">Tree</li><li class="switch-type switch-active">Table</li></ul><div class="help-icon-wrapper"><div class="help-icon"><span>Description</span></div></div></div><!--]--><ul class="vp-sidebar-links"><li><section class="vp-sidebar-group"><p class="vp-sidebar-header"><!----><span class="vp-sidebar-title">IoTDB User Guide (V2.0.x)</span><!----></p><ul class="vp-sidebar-links"></ul></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">About IoTDB</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Background knowledge</span><span class="vp-arrow end"></span></button><!----></section></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/latest-Table/QuickStart/QuickStart_apache.html" aria-label="Quick Start"><!---->Quick Start<!----></a></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Installation and Deployment</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Basic Functions</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Advanced Features</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">AI capability</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Tools System</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable active" type="button"><!----><span class="vp-sidebar-title">API</span><span class="vp-arrow down"></span></button><ul class="vp-sidebar-links"><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/latest-Table/API/Programming-Java-Native-API_apache.html" aria-label="Java Native API"><!---->Java Native API<!----></a></li><li><a class="route-link route-link-active auto-link vp-sidebar-link active" href="/UserGuide/latest-Table/API/Programming-Python-Native-API_apache.html" aria-label="Python Native API"><!---->Python Native API<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/latest-Table/API/Programming-Cpp-Native-API_apache.html" aria-label="C++ Native API"><!---->C++ Native API<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/latest-Table/API/Programming-Go-Native-API_apache.html" aria-label="GO Native API"><!---->GO Native API<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/latest-Table/API/Programming-CSharp-Native-API_apache.html" aria-label="C# Native API"><!---->C# Native API<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/latest-Table/API/Programming-JDBC_apache.html" aria-label="JDBC"><!---->JDBC<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/latest-Table/API/Programming-MQTT_apache.html" aria-label="MQTT Protocol"><!---->MQTT Protocol<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/latest-Table/API/RestAPI-V1_apache.html" aria-label="RESTAPI V1 "><!---->RESTAPI V1 <!----></a></li></ul></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Ecosystem Integration</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">SQL Manual</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Technical Insider</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Reference</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">FAQ</span><span class="vp-arrow end"></span></button><!----></section></li></ul><!----></aside><!--[--><main id="main-content" class="vp-page"><!--[--><!----><!----><nav class="vp-breadcrumb disable"></nav><div class="vp-page-title"><h1><!---->Python Native API</h1><div class="page-info"><!----><!----><span class="page-date-info" aria-label="Writing Date📅" data-balloon-pos="up"><svg xmlns="http://www.w3.org/2000/svg" class="icon calendar-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="calendar icon" name="calendar"><path d="M716.4 110.137c0-18.753-14.72-33.473-33.472-33.473-18.753 0-33.473 14.72-33.473 33.473v33.473h66.993v-33.473zm-334.87 0c0-18.753-14.72-33.473-33.473-33.473s-33.52 14.72-33.52 33.473v33.473h66.993v-33.473zm468.81 33.52H716.4v100.465c0 18.753-14.72 33.473-33.472 33.473a33.145 33.145 0 01-33.473-33.473V143.657H381.53v100.465c0 18.753-14.72 33.473-33.473 33.473a33.145 33.145 0 01-33.473-33.473V143.657H180.6A134.314 134.314 0 0046.66 277.595v535.756A134.314 134.314 0 00180.6 947.289h669.74a134.36 134.36 0 00133.94-133.938V277.595a134.314 134.314 0 00-133.94-133.938zm33.473 267.877H147.126a33.145 33.145 0 01-33.473-33.473c0-18.752 14.72-33.473 33.473-33.473h736.687c18.752 0 33.472 14.72 33.472 33.473a33.145 33.145 0 01-33.472 33.473z"></path></svg><span data-allow-mismatch="text">1/3/25</span><meta property="datePublished" content="2025-01-03T10:29:25.000Z"></span><!----><span class="page-reading-time-info" aria-label="Reading Time⌛" data-balloon-pos="up"><svg xmlns="http://www.w3.org/2000/svg" class="icon timer-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="timer icon" name="timer"><path d="M799.387 122.15c4.402-2.978 7.38-7.897 7.38-13.463v-1.165c0-8.933-7.38-16.312-16.312-16.312H256.33c-8.933 0-16.311 7.38-16.311 16.312v1.165c0 5.825 2.977 10.874 7.637 13.592 4.143 194.44 97.22 354.963 220.201 392.763-122.204 37.542-214.893 196.511-220.2 389.397-4.661 5.049-7.638 11.651-7.638 19.03v5.825h566.49v-5.825c0-7.379-2.849-13.981-7.509-18.9-5.049-193.016-97.867-351.985-220.2-389.527 123.24-37.67 216.446-198.453 220.588-392.892zM531.16 450.445v352.632c117.674 1.553 211.787 40.778 211.787 88.676H304.097c0-48.286 95.149-87.382 213.728-88.676V450.445c-93.077-3.107-167.901-81.297-167.901-177.093 0-8.803 6.99-15.793 15.793-15.793 8.803 0 15.794 6.99 15.794 15.793 0 80.261 63.69 145.635 142.01 145.635s142.011-65.374 142.011-145.635c0-8.803 6.99-15.793 15.794-15.793s15.793 6.99 15.793 15.793c0 95.019-73.789 172.82-165.96 177.093z"></path></svg><span>About 7 min</span><meta property="timeRequired" content="PT7M"></span><!----><!----></div><hr></div><!----><div class="" vp-content><!----><div id="markdown-content"><h1 id="python-native-api" tabindex="-1"><a class="header-anchor" href="#python-native-api"><span>Python Native API</span></a></h1><p>IoTDB provides a Python native client driver and a session pool management mechanism. These tools allow developers to interact with IoTDB in a programmatic and efficient manner. Using the Python API, developers can encapsulate time-series data into objects (e.g., <code>Tablet</code>, <code>NumpyTablet</code>) and insert them into the database directly, without the need to manually construct SQL statements. For multi-threaded operations, the <code>TableSessionPool</code> is recommended to optimize resource utilization and enhance performance.</p><h2 id="_1-prerequisites" tabindex="-1"><a class="header-anchor" href="#_1-prerequisites"><span>1. Prerequisites</span></a></h2><p>To use the IoTDB Python API, install the required package using pip:</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;">pip3</span><span style="color:#98C379;"> install</span><span style="color:#98C379;"> apache-iotd</span><span style="color:#ABB2BF;">b></span><span style="color:#98C379;">=</span><span style="color:#D19A66;">2.0</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>Note: Do not use a newer client to connect to an older server, as this may cause connection failures or unexpected errors.</p><h2 id="_2-read-and-write-operations" tabindex="-1"><a class="header-anchor" href="#_2-read-and-write-operations"><span>2. Read and Write Operations</span></a></h2><h3 id="_2-1-tablesession" tabindex="-1"><a class="header-anchor" href="#_2-1-tablesession"><span>2.1 TableSession</span></a></h3><p><code>TableSession</code> is a core class in IoTDB, enabling users to interact with the IoTDB database. It provides methods to execute SQL statements, insert data, and manage database sessions.</p><h4 id="method-overview" tabindex="-1"><a class="header-anchor" href="#method-overview"><span>Method Overview</span></a></h4><table><thead><tr><th><strong>Method Name</strong></th><th><strong>Descripton</strong></th><th><strong>Parameter Type</strong></th><th><strong>Return Type</strong></th></tr></thead><tbody><tr><td>insert</td><td>Inserts data into the database.</td><td>tablet: <code>Union[Tablet, NumpyTablet]</code></td><td>None</td></tr><tr><td>execute_non_query_statement</td><td>Executes non-query SQL statements like DDL/DML.</td><td>sql: <code>str</code></td><td>None</td></tr><tr><td>execute_query_statement</td><td>Executes a query SQL statement and retrieves results.</td><td>sql: <code>str</code></td><td><code>SessionDataSet</code></td></tr><tr><td>close</td><td>Closes the session and releases resources.</td><td>None</td><td>None</td></tr></tbody></table><p><strong>Since V2.0.8</strong>, <code>SessionDataSet</code> provides methods for batch DataFrame retrieval to efficiently handle large-volume queries:</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:#7F848E;font-style:italic;"># Batch DataFrame retrieval</span></span> |
| <span class="line"><span style="color:#ABB2BF;">has_next </span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;"> result.</span><span style="color:#61AFEF;">has_next_df</span><span style="color:#ABB2BF;">()</span></span> |
| <span class="line"><span style="color:#C678DD;">if</span><span style="color:#ABB2BF;"> has_next:</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;">next_df</span><span style="color:#ABB2BF;">()</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> # Process DataFrame</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><p><strong>Method Details:</strong></p><ul><li><code>has_next_df()</code>: Returns <code>True</code>/<code>False</code> indicating whether ore data exists</li><li><code>next_df()</code>: Returns a <code>DataFrame</code> or <code>None</code>. Each call returns <code>fetchSize</code> rows (default: 5000 rows, controlled by Session's <code>fetch_size</code> parameter): <ul><li>If remaining data ≥ <code>fetchSize</code>: returns <code>fetchSize</code> rows</li><li>If remaining data < <code>fetchSize</code>: returns all remaining rows</li><li>If traversal completes: returns <code>None</code></li></ul></li><li>Session validates <code>fetchSize</code> at initialization: if ≤0, resets to 5000 and logs warning: <code>fetch_size xxx is illegal, use default fetch_size 5000</code></li></ul><p><strong>Note:</strong> Avoid mixing different traversal methods (e.g., combining <code>todf()</code> with <code>next_df()</code>), which may cause unexpected errors.</p><h4 id="sample-code" tabindex="-1"><a class="header-anchor" href="#sample-code"><span>Sample Code</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:#C678DD;">class</span><span style="color:#E5C07B;"> TableSession</span><span style="color:#ABB2BF;">(</span><span style="color:#56B6C2;">object</span><span style="color:#ABB2BF;">):</span></span> |
| <span class="line"><span style="color:#C678DD;">def</span><span style="color:#61AFEF;"> insert</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;font-style:italic;">self</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;font-style:italic;">tablet</span><span style="color:#ABB2BF;">: Union[Tablet, NumpyTablet]):</span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#98C379;"> Insert data into the database.</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> Parameters:</span></span> |
| <span class="line"><span style="color:#98C379;"> tablet (Tablet | NumpyTablet): The tablet containing the data to be inserted.</span></span> |
| <span class="line"><span style="color:#98C379;"> Accepts either a `Tablet` or `NumpyTablet`.</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> Raises:</span></span> |
| <span class="line"><span style="color:#98C379;"> IoTDBConnectionException: If there is an issue with the database connection.</span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#C678DD;"> pass</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#C678DD;">def</span><span style="color:#61AFEF;"> execute_non_query_statement</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;font-style:italic;">self</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;font-style:italic;">sql</span><span style="color:#ABB2BF;">: </span><span style="color:#56B6C2;">str</span><span style="color:#ABB2BF;">):</span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#98C379;"> Execute a non-query SQL statement.</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> Parameters:</span></span> |
| <span class="line"><span style="color:#98C379;"> sql (str): The SQL statement to execute. Typically used for commands</span></span> |
| <span class="line"><span style="color:#98C379;"> such as INSERT, DELETE, or UPDATE.</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> Raises:</span></span> |
| <span class="line"><span style="color:#98C379;"> IoTDBConnectionException: If there is an issue with the database connection.</span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#C678DD;"> pass</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#C678DD;">def</span><span style="color:#61AFEF;"> execute_query_statement</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;font-style:italic;">self</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;font-style:italic;">sql</span><span style="color:#ABB2BF;">: </span><span style="color:#56B6C2;">str</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;font-style:italic;">timeout_in_ms</span><span style="color:#ABB2BF;">: </span><span style="color:#56B6C2;">int</span><span style="color:#56B6C2;"> =</span><span style="color:#D19A66;"> 0</span><span style="color:#ABB2BF;">) -> </span><span style="color:#98C379;">"SessionDataSet"</span><span style="color:#ABB2BF;">:</span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#98C379;"> Execute a query SQL statement and return the result set.</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> Parameters:</span></span> |
| <span class="line"><span style="color:#98C379;"> sql (str): The SQL query to execute.</span></span> |
| <span class="line"><span style="color:#98C379;"> timeout_in_ms (int, optional): Timeout for the query in milliseconds. Defaults to 0,</span></span> |
| <span class="line"><span style="color:#98C379;"> which means no timeout.</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> Returns:</span></span> |
| <span class="line"><span style="color:#98C379;"> SessionDataSet: The result set of the query.</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> Raises:</span></span> |
| <span class="line"><span style="color:#98C379;"> IoTDBConnectionException: If there is an issue with the database connection.</span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#C678DD;"> pass</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#C678DD;">def</span><span style="color:#61AFEF;"> close</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:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#98C379;"> Close the session and release resources.</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> Raises:</span></span> |
| <span class="line"><span style="color:#98C379;"> IoTDBConnectionException: If there is an issue closing the connection.</span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#C678DD;"> pass</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></div><h3 id="_2-2-tablesessionconfig" tabindex="-1"><a class="header-anchor" href="#_2-2-tablesessionconfig"><span>2.2 TableSessionConfig</span></a></h3><p><code>TableSessionConfig</code> is a configuration class that sets parameters for creating a <code>TableSession</code> instance, defining essential settings for connecting to the IoTDB database.</p><h4 id="parameter-configuration" tabindex="-1"><a class="header-anchor" href="#parameter-configuration"><span>Parameter Configuration</span></a></h4><table><thead><tr><th><strong>Parameter</strong></th><th><strong>Description</strong></th><th><strong>Type</strong></th><th><strong>Default Value</strong></th></tr></thead><tbody><tr><td>node_urls</td><td>List of database node URLs.</td><td><code>list</code></td><td><code>["localhost:6667"]</code></td></tr><tr><td>username</td><td>Username for the database connection.</td><td><code>str</code></td><td><code>"root"</code></td></tr><tr><td>password</td><td>Password for the database connection.</td><td><code>str</code></td><td><code>"root"</code></td></tr><tr><td>database</td><td>Target database to connect to.</td><td><code>str</code></td><td><code>None</code></td></tr><tr><td>fetch_size</td><td>Number of rows to fetch per query.</td><td><code>int</code></td><td><code>5000</code></td></tr><tr><td>time_zone</td><td>Default session time zone.</td><td><code>str</code></td><td><code>Session.DEFAULT_ZONE_ID</code></td></tr><tr><td>enable_compression</td><td>Enable data compression.</td><td><code>bool</code></td><td><code>False</code></td></tr></tbody></table><h4 id="sample-code-1" tabindex="-1"><a class="header-anchor" href="#sample-code-1"><span>Sample Code</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:#C678DD;">class</span><span style="color:#E5C07B;"> TableSessionConfig</span><span style="color:#ABB2BF;">(</span><span style="color:#56B6C2;">object</span><span style="color:#ABB2BF;">):</span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#98C379;"> Configuration class for a TableSession. </span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> This class defines various parameters for connecting to and interacting </span></span> |
| <span class="line"><span style="color:#98C379;"> with the IoTDB tables.</span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#C678DD;"> def</span><span style="color:#56B6C2;"> __init__</span><span style="color:#ABB2BF;">(</span></span> |
| <span class="line"><span style="color:#E5C07B;font-style:italic;"> self</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;font-style:italic;"> node_urls</span><span style="color:#ABB2BF;">: </span><span style="color:#56B6C2;">list</span><span style="color:#56B6C2;"> =</span><span style="color:#D19A66;"> None</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;font-style:italic;"> username</span><span style="color:#ABB2BF;">: </span><span style="color:#56B6C2;">str</span><span style="color:#56B6C2;"> =</span><span style="color:#ABB2BF;"> Session.</span><span style="color:#D19A66;">DEFAULT_USER</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;font-style:italic;"> password</span><span style="color:#ABB2BF;">: </span><span style="color:#56B6C2;">str</span><span style="color:#56B6C2;"> =</span><span style="color:#ABB2BF;"> Session.</span><span style="color:#D19A66;">DEFAULT_PASSWORD</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;font-style:italic;"> database</span><span style="color:#ABB2BF;">: </span><span style="color:#56B6C2;">str</span><span style="color:#56B6C2;"> =</span><span style="color:#D19A66;"> None</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;font-style:italic;"> fetch_size</span><span style="color:#ABB2BF;">: </span><span style="color:#56B6C2;">int</span><span style="color:#56B6C2;"> =</span><span style="color:#D19A66;"> 5000</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;font-style:italic;"> time_zone</span><span style="color:#ABB2BF;">: </span><span style="color:#56B6C2;">str</span><span style="color:#56B6C2;"> =</span><span style="color:#ABB2BF;"> Session.</span><span style="color:#D19A66;">DEFAULT_ZONE_ID</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;font-style:italic;"> enable_compression</span><span style="color:#ABB2BF;">: </span><span style="color:#56B6C2;">bool</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;"> ):</span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#98C379;"> Initialize a TableSessionConfig object with the provided parameters.</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> Parameters:</span></span> |
| <span class="line"><span style="color:#98C379;"> node_urls (list, optional): A list of node URLs for the database connection.</span></span> |
| <span class="line"><span style="color:#98C379;"> Defaults to ["localhost:6667"].</span></span> |
| <span class="line"><span style="color:#98C379;"> username (str, optional): The username for the database connection. </span></span> |
| <span class="line"><span style="color:#98C379;"> Defaults to "root".</span></span> |
| <span class="line"><span style="color:#98C379;"> password (str, optional): The password for the database connection. </span></span> |
| <span class="line"><span style="color:#98C379;"> Defaults to "root".</span></span> |
| <span class="line"><span style="color:#98C379;"> database (str, optional): The target database to connect to. Defaults to None.</span></span> |
| <span class="line"><span style="color:#98C379;"> fetch_size (int, optional): The number of rows to fetch per query. Defaults to 5000.</span></span> |
| <span class="line"><span style="color:#98C379;"> time_zone (str, optional): The default time zone for the session. </span></span> |
| <span class="line"><span style="color:#98C379;"> Defaults to Session.DEFAULT_ZONE_ID.</span></span> |
| <span class="line"><span style="color:#98C379;"> enable_compression (bool, optional): Whether to enable data compression. </span></span> |
| <span class="line"><span style="color:#98C379;"> Defaults to False.</span></span> |
| <span class="line"><span style="color:#98C379;"> """</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></div><p><strong>Note:</strong> After using a <code>TableSession</code>, make sure to call the <code>close</code> method to release resources.</p><h2 id="_3-session-pool" tabindex="-1"><a class="header-anchor" href="#_3-session-pool"><span>3. Session Pool</span></a></h2><h3 id="_3-1-tablesessionpool" tabindex="-1"><a class="header-anchor" href="#_3-1-tablesessionpool"><span>3.1 TableSessionPool</span></a></h3><p><code>TableSessionPool</code> is a session pool management class designed for creating and managing <code>TableSession</code> instances. It provides functionality to retrieve sessions from the pool and close the pool when it is no longer needed.</p><h4 id="method-overview-1" tabindex="-1"><a class="header-anchor" href="#method-overview-1"><span>Method Overview</span></a></h4><table><thead><tr><th><strong>Method Name</strong></th><th><strong>Description</strong></th><th><strong>Return Type</strong></th><th><strong>Exceptions</strong></th></tr></thead><tbody><tr><td>get_session</td><td>Retrieves a new <code>TableSession</code> instance from the pool.</td><td><code>TableSession</code></td><td>None</td></tr><tr><td>close</td><td>Closes the session pool and releases all resources.</td><td>None</td><td>None</td></tr></tbody></table><h4 id="sample-code-2" tabindex="-1"><a class="header-anchor" href="#sample-code-2"><span>Sample Code</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:#C678DD;">def</span><span style="color:#61AFEF;"> get_session</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;font-style:italic;">self</span><span style="color:#ABB2BF;">) -> TableSession:</span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#98C379;"> Retrieve a new TableSession instance.</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> Returns:</span></span> |
| <span class="line"><span style="color:#98C379;"> TableSession: A new session object configured with the session pool.</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> Notes:</span></span> |
| <span class="line"><span style="color:#98C379;"> The session is initialized with the underlying session pool for managing</span></span> |
| <span class="line"><span style="color:#98C379;"> connections. Ensure proper usage of the session's lifecycle.</span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#C678DD;">def</span><span style="color:#61AFEF;"> close</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:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#98C379;"> Close the session pool and release all resources.</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> This method closes the underlying session pool, ensuring that all</span></span> |
| <span class="line"><span style="color:#98C379;"> resources associated with it are properly released.</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> Notes:</span></span> |
| <span class="line"><span style="color:#98C379;"> After calling this method, the session pool cannot be used to retrieve</span></span> |
| <span class="line"><span style="color:#98C379;"> new sessions, and any attempt to do so may raise an exception.</span></span> |
| <span class="line"><span style="color:#98C379;"> """</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><h3 id="_3-2-tablesessionpoolconfig" tabindex="-1"><a class="header-anchor" href="#_3-2-tablesessionpoolconfig"><span>3.2 TableSessionPoolConfig</span></a></h3><p><code>TableSessionPoolConfig</code> is a configuration class used to define parameters for initializing and managing a <code>TableSessionPool</code> instance. It specifies the settings needed for efficient session pool management in IoTDB.</p><h4 id="parameter-configuration-1" tabindex="-1"><a class="header-anchor" href="#parameter-configuration-1"><span>Parameter Configuration</span></a></h4><table><thead><tr><th><strong>Paramater</strong></th><th><strong>Description</strong></th><th><strong>Type</strong></th><th><strong>Default Value</strong></th></tr></thead><tbody><tr><td>node_urls</td><td>List of IoTDB cluster node URLs.</td><td><code>list</code></td><td>None</td></tr><tr><td>max_pool_size</td><td>Maximum size of the session pool, i.e., the maximum number of sessions allowed in the pool.</td><td><code>int</code></td><td><code>5</code></td></tr><tr><td>username</td><td>Username for the connection.</td><td><code>str</code></td><td><code>Session.DEFAULT_USER</code></td></tr><tr><td>password</td><td>Password for the connection.</td><td><code>str</code></td><td><code>Session.DEFAULT_PASSWORD</code></td></tr><tr><td>database</td><td>Target database to connect to.</td><td><code>str</code></td><td>None</td></tr><tr><td>fetch_size</td><td>Fetch size for query results</td><td><code>int</code></td><td><code>5000</code></td></tr><tr><td>time_zone</td><td>Timezone-related <code>ZoneId</code></td><td><code>str</code></td><td><code>Session.DEFAULT_ZONE_ID</code></td></tr><tr><td>enable_redirection</td><td>Whether to enable redirection.</td><td><code>bool</code></td><td><code>False</code></td></tr><tr><td>enable_compression</td><td>Whether to enable data compression.</td><td><code>bool</code></td><td><code>False</code></td></tr><tr><td>wait_timeout_in_ms</td><td>Sets the connection timeout in milliseconds.</td><td><code>int</code></td><td><code>10000</code></td></tr><tr><td>max_retry</td><td>Maximum number of connection retry attempts.</td><td><code>int</code></td><td><code>3</code></td></tr></tbody></table><h4 id="sample-code-3" tabindex="-1"><a class="header-anchor" href="#sample-code-3"><span>Sample Code</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:#C678DD;">class</span><span style="color:#E5C07B;"> TableSessionPoolConfig</span><span style="color:#ABB2BF;">(</span><span style="color:#56B6C2;">object</span><span style="color:#ABB2BF;">):</span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#98C379;"> Configuration class for a TableSessionPool.</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> This class defines the parameters required to initialize and manage</span></span> |
| <span class="line"><span style="color:#98C379;"> a session pool for interacting with the IoTDB database.</span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#C678DD;"> def</span><span style="color:#56B6C2;"> __init__</span><span style="color:#ABB2BF;">(</span></span> |
| <span class="line"><span style="color:#E5C07B;font-style:italic;"> self</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;font-style:italic;"> node_urls</span><span style="color:#ABB2BF;">: </span><span style="color:#56B6C2;">list</span><span style="color:#56B6C2;"> =</span><span style="color:#D19A66;"> None</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;font-style:italic;"> max_pool_size</span><span style="color:#ABB2BF;">: </span><span style="color:#56B6C2;">int</span><span style="color:#56B6C2;"> =</span><span style="color:#D19A66;"> 5</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;font-style:italic;"> username</span><span style="color:#ABB2BF;">: </span><span style="color:#56B6C2;">str</span><span style="color:#56B6C2;"> =</span><span style="color:#ABB2BF;"> Session.</span><span style="color:#D19A66;">DEFAULT_USER</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;font-style:italic;"> password</span><span style="color:#ABB2BF;">: </span><span style="color:#56B6C2;">str</span><span style="color:#56B6C2;"> =</span><span style="color:#ABB2BF;"> Session.</span><span style="color:#D19A66;">DEFAULT_PASSWORD</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;font-style:italic;"> database</span><span style="color:#ABB2BF;">: </span><span style="color:#56B6C2;">str</span><span style="color:#56B6C2;"> =</span><span style="color:#D19A66;"> None</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;font-style:italic;"> fetch_size</span><span style="color:#ABB2BF;">: </span><span style="color:#56B6C2;">int</span><span style="color:#56B6C2;"> =</span><span style="color:#D19A66;"> 5000</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;font-style:italic;"> time_zone</span><span style="color:#ABB2BF;">: </span><span style="color:#56B6C2;">str</span><span style="color:#56B6C2;"> =</span><span style="color:#ABB2BF;"> Session.</span><span style="color:#D19A66;">DEFAULT_ZONE_ID</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;font-style:italic;"> enable_redirection</span><span style="color:#ABB2BF;">: </span><span style="color:#56B6C2;">bool</span><span style="color:#56B6C2;"> =</span><span style="color:#D19A66;"> False</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;font-style:italic;"> enable_compression</span><span style="color:#ABB2BF;">: </span><span style="color:#56B6C2;">bool</span><span style="color:#56B6C2;"> =</span><span style="color:#D19A66;"> False</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;font-style:italic;"> wait_timeout_in_ms</span><span style="color:#ABB2BF;">: </span><span style="color:#56B6C2;">int</span><span style="color:#56B6C2;"> =</span><span style="color:#D19A66;"> 10000</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;font-style:italic;"> max_retry</span><span style="color:#ABB2BF;">: </span><span style="color:#56B6C2;">int</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;"> ):</span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#98C379;"> Initialize a TableSessionPoolConfig object with the provided parameters.</span></span> |
| <span class="line"><span style="color:#98C379;"> </span></span> |
| <span class="line"><span style="color:#98C379;"> Parameters:</span></span> |
| <span class="line"><span style="color:#98C379;"> node_urls (list, optional): A list of node URLs for the database connection.</span></span> |
| <span class="line"><span style="color:#98C379;"> Defaults to None.</span></span> |
| <span class="line"><span style="color:#98C379;"> max_pool_size (int, optional): The maximum number of sessions in the pool.</span></span> |
| <span class="line"><span style="color:#98C379;"> Defaults to 5.</span></span> |
| <span class="line"><span style="color:#98C379;"> username (str, optional): The username for the database connection.</span></span> |
| <span class="line"><span style="color:#98C379;"> Defaults to Session.DEFAULT_USER.</span></span> |
| <span class="line"><span style="color:#98C379;"> password (str, optional): The password for the database connection.</span></span> |
| <span class="line"><span style="color:#98C379;"> Defaults to Session.DEFAULT_PASSWORD.</span></span> |
| <span class="line"><span style="color:#98C379;"> database (str, optional): The target database to connect to. Defaults to None.</span></span> |
| <span class="line"><span style="color:#98C379;"> fetch_size (int, optional): The number of rows to fetch per query. Defaults to 5000.</span></span> |
| <span class="line"><span style="color:#98C379;"> time_zone (str, optional): The default time zone for the session pool.</span></span> |
| <span class="line"><span style="color:#98C379;"> Defaults to Session.DEFAULT_ZONE_ID.</span></span> |
| <span class="line"><span style="color:#98C379;"> enable_redirection (bool, optional): Whether to enable redirection.</span></span> |
| <span class="line"><span style="color:#98C379;"> Defaults to False.</span></span> |
| <span class="line"><span style="color:#98C379;"> enable_compression (bool, optional): Whether to enable data compression.</span></span> |
| <span class="line"><span style="color:#98C379;"> Defaults to False.</span></span> |
| <span class="line"><span style="color:#98C379;"> wait_timeout_in_ms (int, optional): The maximum time (in milliseconds) to wait for a session</span></span> |
| <span class="line"><span style="color:#98C379;"> to become available. Defaults to 10000.</span></span> |
| <span class="line"><span style="color:#98C379;"> max_retry (int, optional): The maximum number of retry attempts for operations. Defaults to 3.</span></span> |
| <span class="line"><span style="color:#98C379;"> </span></span> |
| <span class="line"><span style="color:#98C379;"> """</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></div><p><strong>Notes:</strong></p><ul><li>Ensure that <code>TableSession</code> instances retrieved from the <code>TableSessionPool</code> are properly closed after use.</li><li>After closing the <code>TableSessionPool</code>, it will no longer be possible to retrieve new sessions.</li></ul><h3 id="_3-3-ssl-connection" tabindex="-1"><a class="header-anchor" href="#_3-3-ssl-connection"><span>3.3 SSL Connection</span></a></h3><h4 id="_3-3-1-server-certificate-configuration" tabindex="-1"><a class="header-anchor" href="#_3-3-1-server-certificate-configuration"><span>3.3.1 Server Certificate Configuration</span></a></h4><p>In the <code>conf/iotdb-system.properties</code> configuration file, locate or add the following configuration items:</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>enable_thrift_ssl=true</span></span> |
| <span class="line"><span>key_store_path=/path/to/your/server_keystore.jks</span></span> |
| <span class="line"><span>key_store_pwd=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="_3-3-2-configure-python-client-certificate" tabindex="-1"><a class="header-anchor" href="#_3-3-2-configure-python-client-certificate"><span>3.3.2 Configure Python Client Certificate</span></a></h4><ul><li>Set <code>use_ssl</code> to True to enable SSL.</li><li>Specify the client certificate path using the <code>ca_certs</code> parameter.</li></ul><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>use_ssl = True</span></span> |
| <span class="line"><span>ca_certs = "/path/to/your/server.crt" # 或 ca_certs = "/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>Example Code: Using SSL to Connect to IoTDB</strong></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:#7F848E;font-style:italic;"># Licensed to the Apache Software Foundation (ASF) under one</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"># or more contributor license agreements. See the NOTICE file</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"># distributed with this work for additional information</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"># regarding copyright ownership. The ASF licenses this file</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"># to you under the Apache License, Version 2.0 (the</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"># "License"); you may not use this file except in compliance</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"># with the License. You may obtain a copy of the License at</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">#</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"># http://www.apache.org/licenses/LICENSE-2.0</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">#</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"># Unless required by applicable law or agreed to in writing,</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"># software distributed under the License is distributed on an</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"># "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"># KIND, either express or implied. See the License for the</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"># specific language governing permissions and limitations</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"># under the License.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">#</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#C678DD;">from</span><span style="color:#ABB2BF;"> iotdb.SessionPool </span><span style="color:#C678DD;">import</span><span style="color:#ABB2BF;"> PoolConfig, SessionPool</span></span> |
| <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:#7F848E;font-style:italic;"># Configure SSL enabled</span></span> |
| <span class="line"><span style="color:#ABB2BF;">use_ssl </span><span style="color:#56B6C2;">=</span><span style="color:#D19A66;"> True</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"># Configure certificate path</span></span> |
| <span class="line"><span style="color:#ABB2BF;">ca_certs </span><span style="color:#56B6C2;">=</span><span style="color:#98C379;"> "/path/server.crt"</span></span> |
| <span class="line"></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#C678DD;">def</span><span style="color:#61AFEF;"> get_data</span><span style="color:#ABB2BF;">():</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> |
| <span class="line"><span style="color:#ABB2BF;"> ip, port_, username_, password_, </span><span style="color:#E06C75;font-style:italic;">use_ssl</span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;">use_ssl, </span><span style="color:#E06C75;font-style:italic;">ca_certs</span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;">ca_certs</span></span> |
| <span class="line"><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:#C678DD;"> with</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 DATABASES"</span><span style="color:#ABB2BF;">) </span><span style="color:#C678DD;">as</span><span style="color:#ABB2BF;"> session_data_set:</span></span> |
| <span class="line"><span style="color:#56B6C2;"> print</span><span style="color:#ABB2BF;">(session_data_set.</span><span style="color:#61AFEF;">get_column_names</span><span style="color:#ABB2BF;">())</span></span> |
| <span class="line"><span style="color:#C678DD;"> while</span><span style="color:#ABB2BF;"> session_data_set.</span><span style="color:#61AFEF;">has_next</span><span style="color:#ABB2BF;">():</span></span> |
| <span class="line"><span style="color:#56B6C2;"> print</span><span style="color:#ABB2BF;">(session_data_set.</span><span style="color:#61AFEF;">next</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> |
| <span class="line"><span style="color:#C678DD;">def</span><span style="color:#61AFEF;"> get_data2</span><span style="color:#ABB2BF;">():</span></span> |
| <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> |
| <span class="line"><span style="color:#E06C75;font-style:italic;"> host</span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;">ip,</span></span> |
| <span class="line"><span style="color:#E06C75;font-style:italic;"> port</span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;">port_,</span></span> |
| <span class="line"><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> |
| <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;"> time_zone</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;"> 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:#E06C75;font-style:italic;"> use_ssl</span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;">use_ssl,</span></span> |
| <span class="line"><span style="color:#E06C75;font-style:italic;"> ca_certs</span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;">ca_certs,</span></span> |
| <span class="line"><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 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> |
| <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:#C678DD;"> with</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 DATABASES"</span><span style="color:#ABB2BF;">) </span><span style="color:#C678DD;">as</span><span style="color:#ABB2BF;"> session_data_set:</span></span> |
| <span class="line"><span style="color:#56B6C2;"> print</span><span style="color:#ABB2BF;">(session_data_set.</span><span style="color:#61AFEF;">get_column_names</span><span style="color:#ABB2BF;">())</span></span> |
| <span class="line"><span style="color:#C678DD;"> while</span><span style="color:#ABB2BF;"> session_data_set.</span><span style="color:#61AFEF;">has_next</span><span style="color:#ABB2BF;">():</span></span> |
| <span class="line"><span style="color:#56B6C2;"> print</span><span style="color:#ABB2BF;">(session_data_set.</span><span style="color:#61AFEF;">next</span><span style="color:#ABB2BF;">())</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:#ABB2BF;"> session_pool.</span><span style="color:#61AFEF;">close</span><span style="color:#ABB2BF;">()</span></span> |
| <span class="line"></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#C678DD;">if</span><span style="color:#E06C75;"> __name__</span><span style="color:#56B6C2;"> ==</span><span style="color:#98C379;"> "__main__"</span><span style="color:#ABB2BF;">:</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> df </span><span style="color:#56B6C2;">=</span><span style="color:#61AFEF;"> get_data</span><span style="color:#ABB2BF;">()</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="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="_4-sample-code" tabindex="-1"><a class="header-anchor" href="#_4-sample-code"><span>4. Sample Code</span></a></h2><p><strong>Session</strong> Example: You can find the full example code at <a href="https://github.com/apache/iotdb/blob/master/iotdb-client/client-py/table_model_session_example.py" target="_blank" rel="noopener noreferrer">Session Example</a>.</p><p><strong>Session Pool</strong> Example: You can find the full example code at <a href="https://github.com/apache/iotdb/blob/master/iotdb-client/client-py/table_model_session_pool_example.py" target="_blank" rel="noopener noreferrer">SessionPool Example</a>.</p><p>Here is an excerpt of the sample code:</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:#7F848E;font-style:italic;"># Licensed to the Apache Software Foundation (ASF) under one</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"># or more contributor license agreements. See the NOTICE file</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"># distributed with this work for additional information</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"># regarding copyright ownership. The ASF licenses this file</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"># to you under the Apache License, Version 2.0 (the</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"># "License"); you may not use this file except in compliance</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"># with the License. You may obtain a copy of the License at</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">#</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"># http://www.apache.org/licenses/LICENSE-2.0</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">#</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"># Unless required by applicable law or agreed to in writing,</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"># software distributed under the License is distributed on an</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"># "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"># KIND, either express or implied. See the License for the</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"># specific language governing permissions and limitations</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"># under the License.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">#</span></span> |
| <span class="line"><span style="color:#C678DD;">import</span><span style="color:#ABB2BF;"> threading</span></span> |
| <span class="line"></span> |
| <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> |
| <span class="line"><span style="color:#C678DD;">from</span><span style="color:#ABB2BF;"> iotdb.table_session_pool </span><span style="color:#C678DD;">import</span><span style="color:#ABB2BF;"> TableSessionPool, TableSessionPoolConfig</span></span> |
| <span class="line"><span style="color:#C678DD;">from</span><span style="color:#ABB2BF;"> iotdb.utils.IoTDBConstants </span><span style="color:#C678DD;">import</span><span style="color:#ABB2BF;"> TSDataType</span></span> |
| <span class="line"><span style="color:#C678DD;">from</span><span style="color:#ABB2BF;"> iotdb.utils.NumpyTablet </span><span style="color:#C678DD;">import</span><span style="color:#ABB2BF;"> NumpyTablet</span></span> |
| <span class="line"><span style="color:#C678DD;">from</span><span style="color:#ABB2BF;"> iotdb.utils.Tablet </span><span style="color:#C678DD;">import</span><span style="color:#ABB2BF;"> ColumnType, Tablet</span></span> |
| <span class="line"></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#C678DD;">def</span><span style="color:#61AFEF;"> prepare_data</span><span style="color:#ABB2BF;">():</span></span> |
| <span class="line"><span style="color:#56B6C2;"> print</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"create database"</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> # Get a session from the pool</span></span> |
| <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;">execute_non_query_statement</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"CREATE DATABASE IF NOT EXISTS db1"</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> session.</span><span style="color:#61AFEF;">execute_non_query_statement</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">'USE "db1"'</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> session.</span><span style="color:#61AFEF;">execute_non_query_statement</span><span style="color:#ABB2BF;">(</span></span> |
| <span class="line"><span style="color:#98C379;"> "CREATE TABLE table0 (id1 string id, attr1 string attribute, "</span></span> |
| <span class="line"><span style="color:#56B6C2;"> +</span><span style="color:#98C379;"> "m1 double "</span></span> |
| <span class="line"><span style="color:#56B6C2;"> +</span><span style="color:#98C379;"> "field)"</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> )</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> session.</span><span style="color:#61AFEF;">execute_non_query_statement</span><span style="color:#ABB2BF;">(</span></span> |
| <span class="line"><span style="color:#98C379;"> "CREATE TABLE table1 (id1 string tag, attr1 string attribute, "</span></span> |
| <span class="line"><span style="color:#56B6C2;"> +</span><span style="color:#98C379;"> "m1 double "</span></span> |
| <span class="line"><span style="color:#56B6C2;"> +</span><span style="color:#98C379;"> "field)"</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> )</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#56B6C2;"> print</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"now the tables are:"</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> # show result</span></span> |
| <span class="line"><span style="color:#C678DD;"> with</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 TABLES"</span><span style="color:#ABB2BF;">) </span><span style="color:#C678DD;">as</span><span style="color:#ABB2BF;"> res:</span></span> |
| <span class="line"><span style="color:#C678DD;"> while</span><span style="color:#ABB2BF;"> res.</span><span style="color:#61AFEF;">has_next</span><span style="color:#ABB2BF;">():</span></span> |
| <span class="line"><span style="color:#56B6C2;"> print</span><span style="color:#ABB2BF;">(res.</span><span style="color:#61AFEF;">next</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> |
| <span class="line"><span style="color:#C678DD;">def</span><span style="color:#61AFEF;"> insert_data</span><span style="color:#ABB2BF;">(</span><span style="color:#D19A66;font-style:italic;">num</span><span style="color:#ABB2BF;">: </span><span style="color:#56B6C2;">int</span><span style="color:#ABB2BF;">):</span></span> |
| <span class="line"><span style="color:#56B6C2;"> print</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"insert data for table"</span><span style="color:#56B6C2;"> +</span><span style="color:#56B6C2;"> str</span><span style="color:#ABB2BF;">(num))</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> # Get a session from the pool</span></span> |
| <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;"> column_names </span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#98C379;"> "id1"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "attr1"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "m1"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ]</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;">STRING</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> TSDataType.</span><span style="color:#D19A66;">STRING</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;"> ]</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> column_types </span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;"> [ColumnType.</span><span style="color:#D19A66;">TAG</span><span style="color:#ABB2BF;">, ColumnType.</span><span style="color:#D19A66;">ATTRIBUTE</span><span style="color:#ABB2BF;">, ColumnType.</span><span style="color:#D19A66;">FIELD</span><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> |
| <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:#C678DD;"> for</span><span style="color:#ABB2BF;"> row </span><span style="color:#C678DD;">in</span><span style="color:#56B6C2;"> range</span><span style="color:#ABB2BF;">(</span><span style="color:#D19A66;">15</span><span style="color:#ABB2BF;">):</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> timestamps.</span><span style="color:#61AFEF;">append</span><span style="color:#ABB2BF;">(row)</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> values.</span><span style="color:#61AFEF;">append</span><span style="color:#ABB2BF;">([</span><span style="color:#98C379;">"id:"</span><span style="color:#56B6C2;"> +</span><span style="color:#56B6C2;"> str</span><span style="color:#ABB2BF;">(row), </span><span style="color:#98C379;">"attr:"</span><span style="color:#56B6C2;"> +</span><span style="color:#56B6C2;"> str</span><span style="color:#ABB2BF;">(row), row </span><span style="color:#56B6C2;">*</span><span style="color:#D19A66;"> 1.0</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:#98C379;"> "table"</span><span style="color:#56B6C2;"> +</span><span style="color:#56B6C2;"> str</span><span style="color:#ABB2BF;">(num), column_names, data_types, values, timestamps, column_types</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</span><span style="color:#ABB2BF;">(tablet)</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> session.</span><span style="color:#61AFEF;">execute_non_query_statement</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"FLush"</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"></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;">arange</span><span style="color:#ABB2BF;">(</span><span style="color:#D19A66;">15</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">30</span><span style="color:#ABB2BF;">, </span><span style="color:#E06C75;font-style:italic;">dtype</span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;">np.</span><span style="color:#61AFEF;">dtype</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">">i8"</span><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:#98C379;">"id:</span><span style="color:#D19A66;">{}</span><span style="color:#98C379;">"</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">format</span><span style="color:#ABB2BF;">(i) </span><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:#D19A66;">15</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">30</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;">"attr:</span><span style="color:#D19A66;">{}</span><span style="color:#98C379;">"</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">format</span><span style="color:#ABB2BF;">(i) </span><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:#D19A66;">15</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">30</span><span style="color:#ABB2BF;">)]),</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> np.</span><span style="color:#61AFEF;">linspace</span><span style="color:#ABB2BF;">(</span><span style="color:#D19A66;">15.0</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">29.0</span><span style="color:#ABB2BF;">, </span><span style="color:#E06C75;font-style:italic;">num</span><span style="color:#56B6C2;">=</span><span style="color:#D19A66;">15</span><span style="color:#ABB2BF;">, </span><span style="color:#E06C75;font-style:italic;">dtype</span><span style="color:#56B6C2;">=</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;"> ]</span></span> |
| <span class="line"></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:#98C379;"> "table"</span><span style="color:#56B6C2;"> +</span><span style="color:#56B6C2;"> str</span><span style="color:#ABB2BF;">(num),</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> column_names,</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> data_types,</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> np_values,</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> np_timestamps,</span></span> |
| <span class="line"><span style="color:#E06C75;font-style:italic;"> column_types</span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;">column_types,</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</span><span style="color:#ABB2BF;">(np_tablet)</span></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> |
| <span class="line"><span style="color:#C678DD;">def</span><span style="color:#61AFEF;"> query_data</span><span style="color:#ABB2BF;">():</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> # Get a session from the pool</span></span> |
| <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> |
| <span class="line"><span style="color:#56B6C2;"> print</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"get data from table0"</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#C678DD;"> with</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 table0"</span><span style="color:#ABB2BF;">) </span><span style="color:#C678DD;">as</span><span style="color:#ABB2BF;"> res:</span></span> |
| <span class="line"><span style="color:#C678DD;"> while</span><span style="color:#ABB2BF;"> res.</span><span style="color:#61AFEF;">has_next</span><span style="color:#ABB2BF;">():</span></span> |
| <span class="line"><span style="color:#56B6C2;"> print</span><span style="color:#ABB2BF;">(res.</span><span style="color:#61AFEF;">next</span><span style="color:#ABB2BF;">())</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#56B6C2;"> print</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"get data from table1"</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#C678DD;"> with</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 table1"</span><span style="color:#ABB2BF;">) </span><span style="color:#C678DD;">as</span><span style="color:#ABB2BF;"> res:</span></span> |
| <span class="line"><span style="color:#C678DD;"> while</span><span style="color:#ABB2BF;"> res.</span><span style="color:#61AFEF;">has_next</span><span style="color:#ABB2BF;">():</span></span> |
| <span class="line"><span style="color:#56B6C2;"> print</span><span style="color:#ABB2BF;">(res.</span><span style="color:#61AFEF;">next</span><span style="color:#ABB2BF;">())</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> # Querying Table Data Using Batch DataFrame (Recommended for Large Datasets)</span></span> |
| <span class="line"><span style="color:#56B6C2;"> print</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"get data from table0 using batch DataFrame"</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#C678DD;"> with</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 table0"</span><span style="color:#ABB2BF;">) </span><span style="color:#C678DD;">as</span><span style="color:#ABB2BF;"> res: </span></span> |
| <span class="line"><span style="color:#C678DD;"> while</span><span style="color:#ABB2BF;"> res.</span><span style="color:#61AFEF;">has_next_df</span><span style="color:#ABB2BF;">(): </span></span> |
| <span class="line"><span style="color:#56B6C2;"> print</span><span style="color:#ABB2BF;">(res.</span><span style="color:#61AFEF;">next_df</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;">close</span><span style="color:#ABB2BF;">()</span></span> |
| <span class="line"></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#C678DD;">def</span><span style="color:#61AFEF;"> delete_data</span><span style="color:#ABB2BF;">():</span></span> |
| <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;">execute_non_query_statement</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"drop database db1"</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#56B6C2;"> print</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"data has been deleted. now the databases are:"</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#C678DD;"> with</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 databases"</span><span style="color:#ABB2BF;">) </span><span style="color:#C678DD;">as</span><span style="color:#ABB2BF;"> res:</span></span> |
| <span class="line"><span style="color:#C678DD;"> while</span><span style="color:#ABB2BF;"> res.</span><span style="color:#61AFEF;">has_next</span><span style="color:#ABB2BF;">():</span></span> |
| <span class="line"><span style="color:#56B6C2;"> print</span><span style="color:#ABB2BF;">(res.</span><span style="color:#61AFEF;">next</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> |
| <span class="line"></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"># Create a session pool</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;">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:#ABB2BF;">fetch_size </span><span style="color:#56B6C2;">=</span><span style="color:#D19A66;"> 1024</span></span> |
| <span class="line"><span style="color:#ABB2BF;">database </span><span style="color:#56B6C2;">=</span><span style="color:#98C379;"> "db1"</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 style="color:#ABB2BF;">config </span><span style="color:#56B6C2;">=</span><span style="color:#61AFEF;"> TableSessionPoolConfig</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;">node_urls,</span></span> |
| <span class="line"><span style="color:#E06C75;font-style:italic;"> username</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> |
| <span class="line"><span style="color:#E06C75;font-style:italic;"> database</span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;">database,</span></span> |
| <span class="line"><span style="color:#E06C75;font-style:italic;"> max_pool_size</span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;">max_pool_size,</span></span> |
| <span class="line"><span style="color:#E06C75;font-style:italic;"> fetch_size</span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;">fetch_size,</span></span> |
| <span class="line"><span style="color:#E06C75;font-style:italic;"> wait_timeout_in_ms</span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;">wait_timeout_in_ms,</span></span> |
| <span class="line"><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#ABB2BF;">session_pool </span><span style="color:#56B6C2;">=</span><span style="color:#61AFEF;"> TableSessionPool</span><span style="color:#ABB2BF;">(config)</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#61AFEF;">prepare_data</span><span style="color:#ABB2BF;">()</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#ABB2BF;">insert_thread1 </span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;"> threading.</span><span style="color:#61AFEF;">Thread</span><span style="color:#ABB2BF;">(</span><span style="color:#E06C75;font-style:italic;">target</span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;">insert_data, </span><span style="color:#E06C75;font-style:italic;">args</span><span style="color:#56B6C2;">=</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;">insert_thread2 </span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;"> threading.</span><span style="color:#61AFEF;">Thread</span><span style="color:#ABB2BF;">(</span><span style="color:#E06C75;font-style:italic;">target</span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;">insert_data, </span><span style="color:#E06C75;font-style:italic;">args</span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;">(</span><span style="color:#D19A66;">1</span><span style="color:#ABB2BF;">,))</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#ABB2BF;">insert_thread1.</span><span style="color:#61AFEF;">start</span><span style="color:#ABB2BF;">()</span></span> |
| <span class="line"><span style="color:#ABB2BF;">insert_thread2.</span><span style="color:#61AFEF;">start</span><span style="color:#ABB2BF;">()</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#ABB2BF;">insert_thread1.</span><span style="color:#61AFEF;">join</span><span style="color:#ABB2BF;">()</span></span> |
| <span class="line"><span style="color:#ABB2BF;">insert_thread2.</span><span style="color:#61AFEF;">join</span><span style="color:#ABB2BF;">()</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#61AFEF;">query_data</span><span style="color:#ABB2BF;">()</span></span> |
| <span class="line"><span style="color:#61AFEF;">delete_data</span><span style="color:#ABB2BF;">()</span></span> |
| <span class="line"><span style="color:#ABB2BF;">session_pool.</span><span style="color:#61AFEF;">close</span><span style="color:#ABB2BF;">()</span></span> |
| <span class="line"><span style="color:#56B6C2;">print</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"example is finished!"</span><span style="color:#ABB2BF;">)</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div></div><!----><!----><!----></div><footer class="vp-page-meta"><div class="vp-meta-item edit-link"><a class="auto-link external-link vp-meta-label" href="https://github.com/apache/iotdb-docs/edit/main/src/UserGuide/latest-Table/API/Programming-Python-Native-API_apache.md" aria-label="Found Error? Edit this page on 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><!--]-->Found Error? Edit this page on GitHub<!----></a></div><div class="vp-meta-item git-info"><div class="update-time"><span class="vp-meta-label">Last Updated: </span><time class="vp-meta-info" datetime="2026-04-15T10:39:00.000Z" data-allow-mismatch>4/15/26, 10:39 AM</time></div><!----></div></footer><nav class="vp-page-nav"><a class="route-link auto-link prev" href="/UserGuide/latest-Table/API/Programming-Java-Native-API_apache.html" aria-label="Java Native API"><div class="hint"><span class="arrow start"></span>Prev</div><div class="link"><!---->Java Native API</div></a><a class="route-link auto-link next" href="/UserGuide/latest-Table/API/Programming-Cpp-Native-API_apache.html" aria-label="C++ Native API"><div class="hint">Next<span class="arrow end"></span></div><div class="link">C++ Native API<!----></div></a></nav><!----><!----><!--]--></main><!--]--><footer class="site-footer"><span id="doc-version" style="display:none;">latest-Table</span><p class="copyright-text">Copyright © 2026 The Apache Software Foundation. |
| Apache IoTDB, IoTDB, Apache, the Apache feather logo, and the Apache IoTDB project logo are either registered trademarks or trademarks of The Apache Software Foundation in all countries</p><p style="text-align:center;margin-top:10px;color:#909399;font-size:12px;margin:0 30px;"><strong>Having questions?</strong> Connect with us on QQ, WeChat, or Slack. <a href="https://github.com/apache/iotdb/issues/1995">Join the community</a></p></footer></div><!--]--><!--]--><!--[--><!----><!--]--><!--]--></div> |
| <script type="module" src="/assets/app-pmkzp6TS.js" defer></script> |
| </body> |
| </html> |
