| <!doctype html> |
| <html lang="en-US" data-theme="light"> |
| <head> |
| <meta charset="utf-8" /> |
| <meta name="viewport" content="width=device-width,initial-scale=1" /> |
| <meta name="generator" content="VuePress 2.0.0-rc.19" /> |
| <meta name="theme" content="VuePress Theme Hope 2.0.0-rc.71" /> |
| <style> |
| :root { |
| --vp-c-bg: #fff; |
| } |
| |
| [data-theme="dark"] { |
| --vp-c-bg: #1b1b1f; |
| } |
| |
| html, |
| body { |
| background: var(--vp-c-bg); |
| } |
| </style> |
| <script> |
| const userMode = localStorage.getItem("vuepress-theme-hope-scheme"); |
| const systemDarkMode = |
| window.matchMedia && |
| window.matchMedia("(prefers-color-scheme: dark)").matches; |
| |
| if (userMode === "dark" || (userMode !== "light" && systemDarkMode)) { |
| document.documentElement.setAttribute("data-theme", "dark"); |
| } |
| </script> |
| <link rel="alternate" hreflang="zh-cn" href="https://tsfile.apache.org/zh/UserGuide/develop/QuickStart/InterfaceDefinition/InterfaceDefinition-Python.html"><meta property="og:url" content="https://tsfile.apache.org/UserGuide/develop/QuickStart/InterfaceDefinition/InterfaceDefinition-Python.html"><meta property="og:site_name" content="Apache TsFile"><meta property="og:title" content="Interface Definitions - Python"><meta property="og:description" content="Interface Definitions - Python Schema Write interface TsFileWriter Tablet definition You can use Tablet to insert data into TsFile in batches. Read Interface TsFileReader ResultSet"><meta property="og:type" content="article"><meta property="og:locale" content="en-US"><meta property="og:locale:alternate" content="zh-CN"><meta property="og:updated_time" content="2025-07-21T08:27:12.000Z"><meta property="article:modified_time" content="2025-07-21T08:27:12.000Z"><script type="application/ld+json">{"@context":"https://schema.org","@type":"Article","headline":"Interface Definitions - Python","image":[""],"dateModified":"2025-07-21T08:27:12.000Z","author":[]}</script><link rel="icon" href="/favicon.ico"><script type="text/javascript"> |
| var _paq = window._paq = window._paq || []; |
| /* tracker methods like "setCustomDimension" should be called before "trackPageView" */ |
| _paq.push(["setDoNotTrack", true]); |
| _paq.push(["disableCookies"]); |
| _paq.push(['trackPageView']); |
| _paq.push(['enableLinkTracking']); |
| (function() { |
| var u="https://analytics.apache.org/"; |
| _paq.push(['setTrackerUrl', u+'matomo.php']); |
| _paq.push(['setSiteId', '53']); |
| var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; |
| g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s); |
| })(); |
| </script><title>Interface Definitions - Python | Apache TsFile</title><meta name="description" content="Interface Definitions - Python Schema Write interface TsFileWriter Tablet definition You can use Tablet to insert data into TsFile in batches. Read Interface TsFileReader ResultSet"> |
| <link rel="preload" href="/assets/style-CEbf5DCT.css" as="style"><link rel="stylesheet" href="/assets/style-CEbf5DCT.css"> |
| <link rel="modulepreload" href="/assets/app-CQ7n-jLB.js"><link rel="modulepreload" href="/assets/InterfaceDefinition-Python.html-Cg5mEmwI.js"><link rel="modulepreload" href="/assets/plugin-vue_export-helper-DlAUqK2U.js"> |
| <link rel="prefetch" href="/assets/index.html-CRV8CAAj.js" as="script"><link rel="prefetch" href="/assets/About.html-BVMJKDoa.js" as="script"><link rel="prefetch" href="/assets/Feedback.html-BRcDmlfY.js" as="script"><link rel="prefetch" href="/assets/Community-Project-Committers.html-DtyyDlXw.js" as="script"><link rel="prefetch" href="/assets/Powered-By.html-BDrhpyQl.js" as="script"><link rel="prefetch" href="/assets/index.html-8-5vU1S1.js" as="script"><link rel="prefetch" href="/assets/QuickStart.html-IzLpDhnr.js" as="script"><link rel="prefetch" href="/assets/index.html-FdyzGhn5.js" as="script"><link rel="prefetch" href="/assets/About.html-B0BWRUFZ.js" as="script"><link rel="prefetch" href="/assets/Feedback.html-p586Gc-s.js" as="script"><link rel="prefetch" href="/assets/Community-Project-Committers.html-CBN93qde.js" as="script"><link rel="prefetch" href="/assets/Powered-By.html-DmJxT7UE.js" as="script"><link rel="prefetch" href="/assets/index.html-DfIrQ9Wt.js" as="script"><link rel="prefetch" href="/assets/QuickStart.html-DEH36vuz.js" as="script"><link rel="prefetch" href="/assets/Flink-TsFile.html-DmZ1S2L3.js" as="script"><link rel="prefetch" href="/assets/Hive-TsFile.html-CM20JTuK.js" as="script"><link rel="prefetch" href="/assets/Spark-TsFile.html-CybZalT2.js" as="script"><link rel="prefetch" href="/assets/Data-Model.html-B0PLqz3h.js" as="script"><link rel="prefetch" href="/assets/Navigating_Time_Series_Data.html-DEmAMGWE.js" as="script"><link rel="prefetch" href="/assets/QuickStart-C.html-0HSh1lcY.js" as="script"><link rel="prefetch" href="/assets/QuickStart-CPP.html-V8Qw2CRW.js" as="script"><link rel="prefetch" href="/assets/QuickStart-JAVA.html-vnKvKPmT.js" as="script"><link rel="prefetch" href="/assets/QuickStart-PYTHON.html-BMWtbbXg.js" as="script"><link rel="prefetch" href="/assets/Flink-TsFile.html-CVQyO_Vy.js" as="script"><link rel="prefetch" href="/assets/Hive-TsFile.html-DhEEw9H5.js" as="script"><link rel="prefetch" href="/assets/Spark-TsFile.html-DYL4K_5o.js" as="script"><link rel="prefetch" href="/assets/Data-Model.html-CxogA-Dr.js" as="script"><link rel="prefetch" href="/assets/Interface-Definitions.html-BYVcpxnG.js" as="script"><link rel="prefetch" href="/assets/Navigating_Time_Series_Data.html-IDWExq8r.js" as="script"><link rel="prefetch" href="/assets/QuickStart.html-Bt1U62Ol.js" as="script"><link rel="prefetch" href="/assets/Flink-TsFile.html-CJQ1GZsf.js" as="script"><link rel="prefetch" href="/assets/Hive-TsFile.html-BzeF9rGT.js" as="script"><link rel="prefetch" href="/assets/Spark-TsFile.html-CWsx6s5c.js" as="script"><link rel="prefetch" href="/assets/Data-Model.html-DxZ4jqhe.js" as="script"><link rel="prefetch" href="/assets/Navigating_Time_Series_Data.html-Cjp96o2H.js" as="script"><link rel="prefetch" href="/assets/QuickStart.html-D-ZDO8GI.js" as="script"><link rel="prefetch" href="/assets/InterfaceDefinition-C.html-CMkLEMlB.js" as="script"><link rel="prefetch" href="/assets/InterfaceDefinition-CPP.html-CLncj0rP.js" as="script"><link rel="prefetch" href="/assets/InterfaceDefinition-Java.html-IdYcTZBV.js" as="script"><link rel="prefetch" href="/assets/Flink-TsFile.html-E1U4X7zc.js" as="script"><link rel="prefetch" href="/assets/Hive-TsFile.html-3VIg35bo.js" as="script"><link rel="prefetch" href="/assets/Spark-TsFile.html-BqjzpL2n.js" as="script"><link rel="prefetch" href="/assets/Data-Model.html-C3IFli7M.js" as="script"><link rel="prefetch" href="/assets/Interface-Definitions.html-CHQhd0pT.js" as="script"><link rel="prefetch" href="/assets/Navigating_Time_Series_Data.html-BpP1NFiX.js" as="script"><link rel="prefetch" href="/assets/QuickStart-C.html-h9v6kdg3.js" as="script"><link rel="prefetch" href="/assets/QuickStart-CPP.html-DPehOLsq.js" as="script"><link rel="prefetch" href="/assets/QuickStart-JAVA.html-YH_LTFjl.js" as="script"><link rel="prefetch" href="/assets/QuickStart-PYTHON.html-D8uPZFZ_.js" as="script"><link rel="prefetch" href="/assets/Flink-TsFile.html-Didj2rO5.js" as="script"><link rel="prefetch" href="/assets/Hive-TsFile.html-CjpCA1yi.js" as="script"><link rel="prefetch" href="/assets/Spark-TsFile.html-BwnyCVj9.js" as="script"><link rel="prefetch" href="/assets/Data-Model.html-66Jmq6jG.js" as="script"><link rel="prefetch" href="/assets/Interface-Definitions.html-mvds8K31.js" as="script"><link rel="prefetch" href="/assets/Navigating_Time_Series_Data.html-bco8OsHS.js" as="script"><link rel="prefetch" href="/assets/QuickStart.html-CkYFBn6c.js" as="script"><link rel="prefetch" href="/assets/Flink-TsFile.html-BtrUSRlL.js" as="script"><link rel="prefetch" href="/assets/Hive-TsFile.html-qNa4lFjO.js" as="script"><link rel="prefetch" href="/assets/Spark-TsFile.html-Dsy0LPIg.js" as="script"><link rel="prefetch" href="/assets/Data-Model.html-CNRCsJQp.js" as="script"><link rel="prefetch" href="/assets/Navigating_Time_Series_Data.html-COa51QjP.js" as="script"><link rel="prefetch" href="/assets/QuickStart.html-C4DYgOaz.js" as="script"><link rel="prefetch" href="/assets/InterfaceDefinition-C.html-DOmV_IcM.js" as="script"><link rel="prefetch" href="/assets/InterfaceDefinition-CPP.html-BaSPuY9e.js" as="script"><link rel="prefetch" href="/assets/InterfaceDefinition-Java.html-G2rVA4Z_.js" as="script"><link rel="prefetch" href="/assets/InterfaceDefinition-Python.html-BKxcR-7u.js" as="script"><link rel="prefetch" href="/assets/404.html-DyOtPa6p.js" as="script"><link rel="prefetch" href="/assets/index.html-CBSW3X9U.js" as="script"><link rel="prefetch" href="/assets/index.html-DorWk77w.js" as="script"><link rel="prefetch" href="/assets/index.html-Bn4Sdbwu.js" as="script"><link rel="prefetch" href="/assets/index.html-DKDCigJJ.js" as="script"><link rel="prefetch" href="/assets/index.html-OdtkQjLm.js" as="script"><link rel="prefetch" href="/assets/index.html-CY_ImEBJ.js" as="script"><link rel="prefetch" href="/assets/index.html-BkasnENy.js" as="script"><link rel="prefetch" href="/assets/index.html-DnboXY-z.js" as="script"><link rel="prefetch" href="/assets/index.html-Ck46eUdf.js" as="script"><link rel="prefetch" href="/assets/index.html-Do3BtHvf.js" as="script"><link rel="prefetch" href="/assets/index.html-CInf9Cms.js" as="script"><link rel="prefetch" href="/assets/index.html-BNL7_OQF.js" as="script"><link rel="prefetch" href="/assets/index.html-rNIuWeJa.js" as="script"><link rel="prefetch" href="/assets/index.html-Bl9nLu42.js" as="script"><link rel="prefetch" href="/assets/index.html-BsSLlSq7.js" as="script"><link rel="prefetch" href="/assets/index.html-Dv7Tacbu.js" as="script"><link rel="prefetch" href="/assets/index.html-DZkhucdy.js" as="script"><link rel="prefetch" href="/assets/index.html-By1P6-1w.js" as="script"><link rel="prefetch" href="/assets/index.html-QHbHOK9v.js" as="script"><link rel="prefetch" href="/assets/index.html-D58sfp4h.js" as="script"><link rel="prefetch" href="/assets/index.html-DjbPChG2.js" as="script"><link rel="prefetch" href="/assets/index.html-DaUB_s7B.js" as="script"><link rel="prefetch" href="/assets/index.html-Xodo6J-f.js" as="script"><link rel="prefetch" href="/assets/index.html-CxSOSwUm.js" as="script"><link rel="prefetch" href="/assets/index.html-BvIRK6Qn.js" as="script"><link rel="prefetch" href="/assets/index.html-N9ZVWWuN.js" as="script"><link rel="prefetch" href="/assets/index.html-DHBGJpjf.js" as="script"><link rel="prefetch" href="/assets/index.html-V063GCyG.js" as="script"><link rel="prefetch" href="/assets/photoswipe.esm-D2Nf-uDI.js" as="script"><link rel="prefetch" href="/assets/index-B-M8YVCw.js" as="script"> |
| </head> |
| <body> |
| <div id="app"><!--[--><!--[--><!--[--><span tabindex="-1"></span><a href="#main-content" class="vp-skip-link sr-only">Skip to main content</a><!--]--><!--[--><div class="theme-container no-sidebar external-link-icon has-toc" vp-container><!--[--><header id="navbar" class="vp-navbar" vp-navbar><div class="vp-navbar-start"><button type="button" class="vp-toggle-sidebar-button" title="Toggle Sidebar"><span class="icon"></span></button><!--[--><a class="route-link vp-brand" href="/" aria-label="Take me home"><img class="vp-nav-logo" src="/logo.svg" alt><!----><span class="vp-site-name hide-in-pad">Apache TsFile</span></a><!--]--></div><div class="vp-navbar-center"><!--[--><!--]--></div><div class="vp-navbar-end"><!--[--><!--[--><div id="docsearch-container" style="display:none;"></div><div><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"><kbd class="DocSearch-Button-Key"><svg width="15" height="15" class="DocSearch-Control-Key-Icon"><path d="M4.505 4.496h2M5.505 5.496v5M8.216 4.496l.055 5.993M10 7.5c.333.333.5.667.5 1v2M12.326 4.5v5.996M8.384 4.496c1.674 0 2.116 0 2.116 1.5s-.442 1.5-2.116 1.5M3.205 9.303c-.09.448-.277 1.21-1.241 1.203C1 10.5.5 9.513.5 8V7c0-1.57.5-2.5 1.464-2.494.964.006 1.134.598 1.24 1.342M12.553 10.5h1.953" stroke-width="1.2" stroke="currentColor" fill="none" stroke-linecap="square"></path></svg></kbd><kbd class="DocSearch-Button-Key">K</kbd></span></button></div><!--]--><nav class="vp-nav-links"><div class="vp-nav-item hide-in-mobile"><div class="vp-dropdown-wrapper"><button type="button" class="vp-dropdown-title" aria-label="Documentation"><!--[--><!---->Documentation<!--]--><span class="arrow"></span><ul class="vp-dropdown"><li class="vp-dropdown-item"><a class="route-link auto-link" href="/zh/UserGuide/latest/QuickStart/QuickStart.html" aria-label="v2.x" iconsizing="both"><!---->v2.x<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/zh/UserGuide/v1.x/QuickStart/QuickStart.html" aria-label="v1.x" iconsizing="both"><!---->v1.x<!----></a></li></ul></button></div></div><div class="vp-nav-item hide-in-mobile"><a class="route-link auto-link" href="/Download/" aria-label="Download" iconsizing="height"><!---->Download<!----></a></div><div class="vp-nav-item hide-in-mobile"><div class="vp-dropdown-wrapper"><button type="button" class="vp-dropdown-title" aria-label="ASF"><!--[--><!---->ASF<!--]--><span class="arrow"></span><ul class="vp-dropdown"><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/" aria-label="Foundation" target="_self" iconsizing="both"><!---->Foundation<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/licenses/" aria-label="License" target="_self" iconsizing="both"><!---->License<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/security/" aria-label="Security" rel="noopener noreferrer" target="_blank" iconsizing="both"><!---->Security<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/foundation/sponsorship.html" aria-label="Sponsorship" rel="noopener noreferrer" target="_blank" iconsizing="both"><!---->Sponsorship<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/foundation/thanks.html" aria-label="Thanks" target="_self" iconsizing="both"><!---->Thanks<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/events/current-event" aria-label="Current Events" rel="noopener noreferrer" target="_blank" iconsizing="both"><!---->Current Events<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://privacy.apache.org/policies/privacy-policy-public.html" aria-label="Privacy" rel="noopener noreferrer" target="_blank" iconsizing="both"><!---->Privacy<!----></a></li></ul></button></div></div></nav><div class="vp-nav-item"><div class="vp-dropdown-wrapper"><button type="button" class="vp-dropdown-title" aria-label="Select language"><!--[--><svg xmlns="http://www.w3.org/2000/svg" class="icon i18n-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="i18n icon" name="i18n" style="width:1rem;height:1rem;vertical-align:middle;"><path d="M379.392 460.8 494.08 575.488l-42.496 102.4L307.2 532.48 138.24 701.44l-71.68-72.704L234.496 460.8l-45.056-45.056c-27.136-27.136-51.2-66.56-66.56-108.544h112.64c7.68 14.336 16.896 27.136 26.112 35.84l45.568 46.08 45.056-45.056C382.976 312.32 409.6 247.808 409.6 204.8H0V102.4h256V0h102.4v102.4h256v102.4H512c0 70.144-37.888 161.28-87.04 210.944L378.88 460.8zM576 870.4 512 1024H409.6l256-614.4H768l256 614.4H921.6l-64-153.6H576zM618.496 768h196.608L716.8 532.48 618.496 768z"></path></svg><!--]--><span class="arrow"></span><ul class="vp-dropdown"><li class="vp-dropdown-item"><a class="route-link route-link-active auto-link" href="/UserGuide/develop/QuickStart/InterfaceDefinition/InterfaceDefinition-Python.html" aria-label="English" iconsizing="both"><!---->English<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/zh/UserGuide/develop/QuickStart/InterfaceDefinition/InterfaceDefinition-Python.html" aria-label="简体中文" iconsizing="both"><!---->简体中文<!----></a></li></ul></button></div></div><div class="vp-nav-item hide-in-mobile"><button type="button" class="vp-color-mode-switch" id="color-mode-switch"><svg xmlns="http://www.w3.org/2000/svg" class="icon auto-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="auto icon" name="auto" style="display:none;"><path d="M512 992C246.92 992 32 777.08 32 512S246.92 32 512 32s480 214.92 480 480-214.92 480-480 480zm0-840c-198.78 0-360 161.22-360 360 0 198.84 161.22 360 360 360s360-161.16 360-360c0-198.78-161.22-360-360-360zm0 660V212c165.72 0 300 134.34 300 300 0 165.72-134.28 300-300 300z"></path></svg><svg xmlns="http://www.w3.org/2000/svg" class="icon dark-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="dark icon" name="dark" style="display:none;"><path d="M524.8 938.667h-4.267a439.893 439.893 0 0 1-313.173-134.4 446.293 446.293 0 0 1-11.093-597.334A432.213 432.213 0 0 1 366.933 90.027a42.667 42.667 0 0 1 45.227 9.386 42.667 42.667 0 0 1 10.24 42.667 358.4 358.4 0 0 0 82.773 375.893 361.387 361.387 0 0 0 376.747 82.774 42.667 42.667 0 0 1 54.187 55.04 433.493 433.493 0 0 1-99.84 154.88 438.613 438.613 0 0 1-311.467 128z"></path></svg><svg xmlns="http://www.w3.org/2000/svg" class="icon light-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="light icon" name="light" style="display:block;"><path d="M952 552h-80a40 40 0 0 1 0-80h80a40 40 0 0 1 0 80zM801.88 280.08a41 41 0 0 1-57.96-57.96l57.96-58a41.04 41.04 0 0 1 58 58l-58 57.96zM512 752a240 240 0 1 1 0-480 240 240 0 0 1 0 480zm0-560a40 40 0 0 1-40-40V72a40 40 0 0 1 80 0v80a40 40 0 0 1-40 40zm-289.88 88.08-58-57.96a41.04 41.04 0 0 1 58-58l57.96 58a41 41 0 0 1-57.96 57.96zM192 512a40 40 0 0 1-40 40H72a40 40 0 0 1 0-80h80a40 40 0 0 1 40 40zm30.12 231.92a41 41 0 0 1 57.96 57.96l-57.96 58a41.04 41.04 0 0 1-58-58l58-57.96zM512 832a40 40 0 0 1 40 40v80a40 40 0 0 1-80 0v-80a40 40 0 0 1 40-40zm289.88-88.08 58 57.96a41.04 41.04 0 0 1-58 58l-57.96-58a41 41 0 0 1 57.96-57.96z"></path></svg></button></div><div class="vp-nav-item vp-action"><a class="vp-action-link" href="https://github.com/apache/tsfile" target="_blank" rel="noopener noreferrer" aria-label="GitHub"><svg xmlns="http://www.w3.org/2000/svg" class="icon github-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="github icon" name="github" style="width:1.25rem;height:1.25rem;vertical-align:middle;"><path d="M511.957 21.333C241.024 21.333 21.333 240.981 21.333 512c0 216.832 140.544 400.725 335.574 465.664 24.49 4.395 32.256-10.07 32.256-23.083 0-11.69.256-44.245 0-85.205-136.448 29.61-164.736-64.64-164.736-64.64-22.315-56.704-54.4-71.765-54.4-71.765-44.587-30.464 3.285-29.824 3.285-29.824 49.195 3.413 75.179 50.517 75.179 50.517 43.776 75.008 114.816 53.333 142.762 40.79 4.523-31.66 17.152-53.377 31.19-65.537-108.971-12.458-223.488-54.485-223.488-242.602 0-53.547 19.114-97.323 50.517-131.67-5.035-12.33-21.93-62.293 4.779-129.834 0 0 41.258-13.184 134.912 50.346a469.803 469.803 0 0 1 122.88-16.554c41.642.213 83.626 5.632 122.88 16.554 93.653-63.488 134.784-50.346 134.784-50.346 26.752 67.541 9.898 117.504 4.864 129.834 31.402 34.347 50.474 78.123 50.474 131.67 0 188.586-114.73 230.016-224.042 242.09 17.578 15.232 33.578 44.672 33.578 90.454v135.85c0 13.142 7.936 27.606 32.854 22.87C862.25 912.597 1002.667 728.747 1002.667 512c0-271.019-219.648-490.667-490.71-490.667z"></path></svg></a></div><!--]--><button type="button" class="vp-toggle-navbar-button" aria-label="Toggle Navbar" aria-expanded="false" aria-controls="nav-screen"><span><span class="vp-top"></span><span class="vp-middle"></span><span class="vp-bottom"></span></span></button></div></header><!----><!--]--><!----><div class="toggle-sidebar-wrapper"><span class="arrow start"></span></div><aside id="sidebar" class="vp-sidebar" vp-sidebar><!----><ul class="vp-sidebar-links"></ul><!----></aside><!--[--><main id="main-content" class="vp-page"><!--[--><!----><!----><nav class="vp-breadcrumb disable"></nav><div class="vp-page-title"><h1><!---->Interface Definitions - Python</h1><div class="page-info"><!----><!----><span class="page-date-info" aria-label="Writing Date📅" data-balloon-pos="up"><svg xmlns="http://www.w3.org/2000/svg" class="icon calendar-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="calendar icon" name="calendar"><path d="M716.4 110.137c0-18.753-14.72-33.473-33.472-33.473-18.753 0-33.473 14.72-33.473 33.473v33.473h66.993v-33.473zm-334.87 0c0-18.753-14.72-33.473-33.473-33.473s-33.52 14.72-33.52 33.473v33.473h66.993v-33.473zm468.81 33.52H716.4v100.465c0 18.753-14.72 33.473-33.472 33.473a33.145 33.145 0 01-33.473-33.473V143.657H381.53v100.465c0 18.753-14.72 33.473-33.473 33.473a33.145 33.145 0 01-33.473-33.473V143.657H180.6A134.314 134.314 0 0046.66 277.595v535.756A134.314 134.314 0 00180.6 947.289h669.74a134.36 134.36 0 00133.94-133.938V277.595a134.314 134.314 0 00-133.94-133.938zm33.473 267.877H147.126a33.145 33.145 0 01-33.473-33.473c0-18.752 14.72-33.473 33.473-33.473h736.687c18.752 0 33.472 14.72 33.472 33.473a33.145 33.145 0 01-33.472 33.473z"></path></svg><span data-allow-mismatch="text">July 21, 2025</span><meta property="datePublished" content="2025-07-21T08:27:12.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 3 min</span><meta property="timeRequired" content="PT3M"></span><!----><!----></div><hr></div><div class="vp-toc-placeholder"><aside id="toc" vp-toc><!----><!--[--><div class="vp-toc-header">On This Page<button type="button" class="print-button" title="Print"><svg xmlns="http://www.w3.org/2000/svg" class="icon print-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="print icon" name="print"><path d="M819.2 364.8h-44.8V128c0-17.067-14.933-32-32-32H281.6c-17.067 0-32 14.933-32 32v236.8h-44.8C145.067 364.8 96 413.867 96 473.6v192c0 59.733 49.067 108.8 108.8 108.8h44.8V896c0 17.067 14.933 32 32 32h460.8c17.067 0 32-14.933 32-32V774.4h44.8c59.733 0 108.8-49.067 108.8-108.8v-192c0-59.733-49.067-108.8-108.8-108.8zM313.6 160h396.8v204.8H313.6V160zm396.8 704H313.6V620.8h396.8V864zM864 665.6c0 25.6-19.2 44.8-44.8 44.8h-44.8V588.8c0-17.067-14.933-32-32-32H281.6c-17.067 0-32 14.933-32 32v121.6h-44.8c-25.6 0-44.8-19.2-44.8-44.8v-192c0-25.6 19.2-44.8 44.8-44.8h614.4c25.6 0 44.8 19.2 44.8 44.8v192z"></path></svg></button><div class="arrow end"></div></div><div class="vp-toc-wrapper"><ul class="vp-toc-list"><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level2" href="#schema">Schema</a></li><!----><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level2" href="#write-interface">Write interface</a></li><li><ul class="vp-toc-list"><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level3" href="#tsfilewriter">TsFileWriter</a></li><!----><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level3" href="#tablet-definition">Tablet definition</a></li><!----><!--]--></ul></li><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level2" href="#read-interface">Read Interface</a></li><li><ul class="vp-toc-list"><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level3" href="#tsfilereader">TsFileReader</a></li><!----><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level3" href="#resultset">ResultSet</a></li><!----><!--]--></ul></li><!--]--></ul><div class="vp-toc-marker" style="top:-1.7rem;"></div></div><!--]--><!----></aside></div><!----><div class="theme-hope-content" vp-content><h1 id="interface-definitions-python" tabindex="-1"><a class="header-anchor" href="#interface-definitions-python"><span>Interface Definitions - Python</span></a></h1><h2 id="schema" tabindex="-1"><a class="header-anchor" href="#schema"><span>Schema</span></a></h2><div class="language-python line-numbers-mode" data-highlighter="shiki" data-ext="python" data-title="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"></span> |
| <span class="line"><span style="color:#C678DD;">class</span><span style="color:#E5C07B;"> TSDataType</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">IntEnum</span><span style="color:#ABB2BF;">):</span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#98C379;"> Enumeration of data types currently supported by TsFile.</span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#D19A66;"> BOOLEAN</span><span style="color:#56B6C2;"> =</span><span style="color:#D19A66;"> 0</span></span> |
| <span class="line"><span style="color:#D19A66;"> INT32</span><span style="color:#56B6C2;"> =</span><span style="color:#D19A66;"> 1</span></span> |
| <span class="line"><span style="color:#D19A66;"> INT64</span><span style="color:#56B6C2;"> =</span><span style="color:#D19A66;"> 2</span></span> |
| <span class="line"><span style="color:#D19A66;"> FLOAT</span><span style="color:#56B6C2;"> =</span><span style="color:#D19A66;"> 3</span></span> |
| <span class="line"><span style="color:#D19A66;"> DOUBLE</span><span style="color:#56B6C2;"> =</span><span style="color:#D19A66;"> 4</span></span> |
| <span class="line"><span style="color:#D19A66;"> TEXT</span><span style="color:#56B6C2;"> =</span><span style="color:#D19A66;"> 5</span></span> |
| <span class="line"><span style="color:#D19A66;"> STRING</span><span style="color:#56B6C2;"> =</span><span style="color:#D19A66;"> 11</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#C678DD;">class</span><span style="color:#E5C07B;"> ColumnCategory</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">IntEnum</span><span style="color:#ABB2BF;">):</span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#98C379;"> Enumeration of column categories in TsFile.</span></span> |
| <span class="line"><span style="color:#98C379;"> TAG: Represents a tag column, used for metadata.</span></span> |
| <span class="line"><span style="color:#98C379;"> FIELD: Represents a field column, used for storing actual data values.</span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#D19A66;"> TAG</span><span style="color:#56B6C2;"> =</span><span style="color:#D19A66;"> 0</span></span> |
| <span class="line"><span style="color:#D19A66;"> FIELD</span><span style="color:#56B6C2;"> =</span><span style="color:#D19A66;"> 1</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#C678DD;">class</span><span style="color:#E5C07B;"> ColumnSchema</span><span style="color:#ABB2BF;">:</span></span> |
| <span class="line"><span style="color:#98C379;"> """Defines schema for a table column (name, datatype, category)."""</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#ABB2BF;"> column_name </span><span style="color:#56B6C2;">=</span><span style="color:#D19A66;"> None</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> data_type </span><span style="color:#56B6C2;">=</span><span style="color:#D19A66;"> None</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> category </span><span style="color:#56B6C2;">=</span><span style="color:#D19A66;"> None</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 style="color:#E5C07B;font-style:italic;">self</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;font-style:italic;">column_name</span><span style="color:#ABB2BF;">: </span><span style="color:#56B6C2;">str</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;font-style:italic;">data_type</span><span style="color:#ABB2BF;">: TSDataType, </span></span> |
| <span class="line"><span style="color:#D19A66;font-style:italic;"> category</span><span style="color:#ABB2BF;">: ColumnCategory </span><span style="color:#56B6C2;">=</span><span style="color:#ABB2BF;"> ColumnCategory.</span><span style="color:#D19A66;">FIELD</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#C678DD;">class</span><span style="color:#E5C07B;"> TableSchema</span><span style="color:#ABB2BF;">:</span></span> |
| <span class="line"><span style="color:#98C379;"> """Schema definition for a table structure."""</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> </span></span> |
| <span class="line"><span style="color:#ABB2BF;"> table_name </span><span style="color:#56B6C2;">=</span><span style="color:#D19A66;"> None</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> columns </span><span style="color:#56B6C2;">=</span><span style="color:#D19A66;"> None</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 style="color:#E5C07B;font-style:italic;">self</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;font-style:italic;">table_name</span><span style="color:#ABB2BF;">: </span><span style="color:#56B6C2;">str</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;font-style:italic;">columns</span><span style="color:#ABB2BF;">: List[ColumnSchema])</span></span> |
| <span class="line"></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#C678DD;">class</span><span style="color:#E5C07B;"> ResultSetMetaData</span><span style="color:#ABB2BF;">:</span></span> |
| <span class="line"><span style="color:#98C379;"> """Metadata container for query result sets (columns, types, table name)."""</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> </span></span> |
| <span class="line"><span style="color:#ABB2BF;"> column_list </span><span style="color:#56B6C2;">=</span><span style="color:#D19A66;"> None</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> data_types </span><span style="color:#56B6C2;">=</span><span style="color:#D19A66;"> None</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> table_name </span><span style="color:#56B6C2;">=</span><span style="color:#D19A66;"> None</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 style="color:#E5C07B;font-style:italic;">self</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;font-style:italic;">column_list</span><span style="color:#ABB2BF;">: List[</span><span style="color:#56B6C2;">str</span><span style="color:#ABB2BF;">], </span><span style="color:#D19A66;font-style:italic;">data_types</span><span style="color:#ABB2BF;">: List[TSDataType])</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></div><h2 id="write-interface" tabindex="-1"><a class="header-anchor" href="#write-interface"><span>Write interface</span></a></h2><h3 id="tsfilewriter" tabindex="-1"><a class="header-anchor" href="#tsfilewriter"><span>TsFileWriter</span></a></h3><div class="language-python line-numbers-mode" data-highlighter="shiki" data-ext="python" data-title="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">class</span><span style="color:#E5C07B;"> TsFileTableWriter</span><span style="color:#ABB2BF;">:</span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#98C379;"> Facilitates writing structured table data into a TsFile with a specified schema.</span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"></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;"> :param path: The path of tsfile, will create if it doesn't exist.</span></span> |
| <span class="line"><span style="color:#98C379;"> :param table_schema: describes the schema of the tables want to write.</span></span> |
| <span class="line"><span style="color:#98C379;"> :return: no return value.</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 style="color:#E5C07B;font-style:italic;">self</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;font-style:italic;">path</span><span style="color:#ABB2BF;">: </span><span style="color:#56B6C2;">str</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;font-style:italic;">table_schema</span><span style="color:#ABB2BF;">: TableSchema)</span></span> |
| <span class="line"></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#98C379;"> Write a tablet into table in tsfile.</span></span> |
| <span class="line"><span style="color:#98C379;"> :param tablet: stored batch data of a table.</span></span> |
| <span class="line"><span style="color:#98C379;"> :return: no return value.</span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#C678DD;"> def</span><span style="color:#61AFEF;"> write_table</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;">: Tablet)</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;"> Close TsFileTableWriter and flush data automatically.</span></span> |
| <span class="line"><span style="color:#98C379;"> :return: no return value.</span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></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></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h3 id="tablet-definition" tabindex="-1"><a class="header-anchor" href="#tablet-definition"><span>Tablet definition</span></a></h3><p>You can use Tablet to insert data into TsFile in batches.</p><div class="language-python line-numbers-mode" data-highlighter="shiki" data-ext="python" data-title="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">class</span><span style="color:#E5C07B;"> Tablet</span><span style="color:#ABB2BF;">(</span><span style="color:#56B6C2;">object</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> """</span></span> |
| <span class="line"><span style="color:#E5C07B;"> A</span><span style="color:#E5C07B;"> pre</span><span style="color:#ABB2BF;">-</span><span style="color:#E5C07B;">allocated</span><span style="color:#E5C07B;"> columnar</span><span style="color:#E5C07B;"> data</span><span style="color:#E5C07B;"> container</span><span style="color:#C678DD;"> for</span><span style="color:#E5C07B;"> batch</span><span style="color:#E5C07B;"> data</span><span style="color:#C678DD;"> with</span><span style="color:#56B6C2;"> type</span><span style="color:#E5C07B;"> constraints</span><span style="color:#ABB2BF;">.</span></span> |
| <span class="line"><span style="color:#E5C07B;"> Creates</span><span style="color:#E5C07B;"> timestamp</span><span style="color:#E5C07B;"> buffer</span><span style="color:#C678DD;"> and</span><span style="color:#E5C07B;"> typed</span><span style="color:#E5C07B;"> data</span><span style="color:#E5C07B;"> columns</span><span style="color:#ABB2BF;">, </span><span style="color:#C678DD;">with</span><span style="color:#E5C07B;"> value</span><span style="color:#56B6C2;"> range</span><span style="color:#E5C07B;"> validation</span><span style="color:#E5C07B;"> ranges</span></span> |
| <span class="line"><span style="color:#C678DD;"> for</span><span style="color:#E5C07B;"> numeric</span><span style="color:#E5C07B;"> types</span><span style="color:#ABB2BF;">.</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#E5C07B;"> Initializes</span><span style="color:#ABB2BF;">:</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> :param column_name_list: name </span><span style="color:#56B6C2;">list</span><span style="color:#C678DD;"> for</span><span style="color:#ABB2BF;"> data columns.</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> :param type_list: TSDataType values specifying allowed types per column.</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> :param max_row_num: Pre</span><span style="color:#56B6C2;">-</span><span style="color:#ABB2BF;">allocated row </span><span style="color:#61AFEF;">capacity</span><span style="color:#ABB2BF;"> (default </span><span style="color:#D19A66;">1024</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> :</span><span style="color:#C678DD;">return</span><span style="color:#ABB2BF;">: no </span><span style="color:#C678DD;">return</span><span style="color:#ABB2BF;"> value.</span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> def __init__(self, column_name_list: list[str], type_list: list[TSDataType],</span></span> |
| <span class="line"><span style="color:#98C379;"> max_row_num: int = 1024)</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></div><h2 id="read-interface" tabindex="-1"><a class="header-anchor" href="#read-interface"><span>Read Interface</span></a></h2><h3 id="tsfilereader" tabindex="-1"><a class="header-anchor" href="#tsfilereader"><span>TsFileReader</span></a></h3><div class="language-python line-numbers-mode" data-highlighter="shiki" data-ext="python" data-title="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">class</span><span style="color:#E5C07B;"> TsFileReader</span><span style="color:#ABB2BF;">:</span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#98C379;"> Query table data from a TsFile.</span></span> |
| <span class="line"><span style="color:#98C379;"> """</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 TsFile reader for the specified file path.</span></span> |
| <span class="line"><span style="color:#98C379;"> :param pathname: The path to the TsFile.</span></span> |
| <span class="line"><span style="color:#98C379;"> :return no return value.</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 style="color:#E5C07B;font-style:italic;">self</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;font-style:italic;">pathname</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#98C379;"> Executes a time range query on the specified table and columns.</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> :param table_name: The name of the table to query.</span></span> |
| <span class="line"><span style="color:#98C379;"> :param column_names: A list of column names to retrieve.</span></span> |
| <span class="line"><span style="color:#98C379;"> :param start_time: The start time of the query range (default: minimum int64 value).</span></span> |
| <span class="line"><span style="color:#98C379;"> :param end_time: The end time of the query range (default: maximum int64 value).</span></span> |
| <span class="line"><span style="color:#98C379;"> :return: A query result set handler.</span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#C678DD;"> def</span><span style="color:#61AFEF;"> query_table</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;">table_name</span><span style="color:#ABB2BF;"> : </span><span style="color:#56B6C2;">str</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;font-style:italic;">column_names</span><span style="color:#ABB2BF;"> : List[</span><span style="color:#56B6C2;">str</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#D19A66;font-style:italic;"> start_time</span><span style="color:#ABB2BF;"> : </span><span style="color:#56B6C2;">int</span><span style="color:#56B6C2;"> =</span><span style="color:#ABB2BF;"> np.</span><span style="color:#61AFEF;">iinfo</span><span style="color:#ABB2BF;">(np.int64).min, </span></span> |
| <span class="line"><span style="color:#D19A66;font-style:italic;"> end_time</span><span style="color:#ABB2BF;">: </span><span style="color:#56B6C2;">int</span><span style="color:#56B6C2;"> =</span><span style="color:#ABB2BF;"> np.</span><span style="color:#61AFEF;">iinfo</span><span style="color:#ABB2BF;">(np.int64).max) -> ResultSet</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#98C379;"> Retrieves the schema of the specified table.</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> :param table_name: The name of the table.</span></span> |
| <span class="line"><span style="color:#98C379;"> :return: The schema of the specified table.</span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#C678DD;"> def</span><span style="color:#61AFEF;"> get_table_schema</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">self</span><span style="color:#ABB2BF;">, table_name : </span><span style="color:#56B6C2;">str</span><span style="color:#ABB2BF;">)</span><span style="color:#FFFFFF;">-></span><span style="color:#ABB2BF;"> TableSchema</span></span> |
| <span class="line"></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#98C379;"> Retrieves the schemas of all tables in the TsFile.</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> :return: A dictionary mapping table names to their schemas.</span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#C678DD;"> def</span><span style="color:#61AFEF;"> get_all_table_schemas</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">self</span><span style="color:#ABB2BF;">) </span><span style="color:#FFFFFF;">-></span><span style="color:#ABB2BF;">dict[</span><span style="color:#56B6C2;">str</span><span style="color:#ABB2BF;">, TableSchema]</span></span> |
| <span class="line"></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#98C379;"> Closes the TsFile reader. If the reader has active result sets, they will be invalidated.</span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></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;">self</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></div><h3 id="resultset" tabindex="-1"><a class="header-anchor" href="#resultset"><span>ResultSet</span></a></h3><div class="language-python line-numbers-mode" data-highlighter="shiki" data-ext="python" data-title="python" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">class</span><span style="color:#E5C07B;"> ResultSet</span><span style="color:#ABB2BF;">:</span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#98C379;"> Retrieves data from a query result set. When a query is executed, a query handler is returned.</span></span> |
| <span class="line"><span style="color:#98C379;"> If the reader is closed, the result set will become invalid.</span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#98C379;"> Checks and moves to the next row in the query result set.</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> :return: True if the next row exists, False otherwise.</span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#C678DD;"> def</span><span style="color:#56B6C2;"> next</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;font-style:italic;">self</span><span style="color:#ABB2BF;">) -> </span><span style="color:#56B6C2;">bool</span></span> |
| <span class="line"></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#98C379;"> Retrieves the column information of the result set.</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> :return: A dictionary containing column names as keys and their data types as values.</span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#C678DD;"> def</span><span style="color:#61AFEF;"> get_result_column_info</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">self</span><span style="color:#ABB2BF;">) </span><span style="color:#FFFFFF;">-></span><span style="color:#ABB2BF;"> dict[</span><span style="color:#56B6C2;">str</span><span style="color:#ABB2BF;">, TsDataType]</span></span> |
| <span class="line"></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;"> Fetches the next DataFrame from the query result set.</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> :param max_row_num: The maximum number of rows to retrieve. Default is 1024.</span></span> |
| <span class="line"><span style="color:#98C379;"> :return: A DataFrame containing data from the query result set.</span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#C678DD;"> def</span><span style="color:#61AFEF;"> read_next_data_frame</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">self</span><span style="color:#ABB2BF;">, max_row_num : </span><span style="color:#E06C75;font-style:italic;">int</span><span style="color:#56B6C2;"> =</span><span style="color:#D19A66;"> 1024</span><span style="color:#ABB2BF;">) </span><span style="color:#FFFFFF;">-></span><span style="color:#ABB2BF;"> DataFrame</span></span> |
| <span class="line"></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;"> Retrieves the value at the specified index from the query result set.</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> :param index: The index of the value to retrieve, 1 <= index <= column_num.</span></span> |
| <span class="line"><span style="color:#98C379;"> :return: The value at the specified index.</span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#C678DD;"> def</span><span style="color:#61AFEF;"> get_value_by_index</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">self</span><span style="color:#ABB2BF;">, index : </span><span style="color:#56B6C2;">int</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"></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;"> Retrieves the value for the specified column name from the query result set.</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> :param column_name: The name of the column to retrieve the value from.</span></span> |
| <span class="line"><span style="color:#98C379;"> :return: The value of the specified column.</span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#C678DD;"> def</span><span style="color:#61AFEF;"> get_value_by_name</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">self</span><span style="color:#ABB2BF;">, column_name : </span><span style="color:#56B6C2;">str</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#ABB2BF;"> </span></span> |
| <span class="line"><span style="color:#ABB2BF;"> </span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#98C379;"> Retrieves the metadata of the result set.</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> :return: The metadata of the result set as a ResultSetMetadata object.</span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#C678DD;"> def</span><span style="color:#61AFEF;"> get_metadata</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">self</span><span style="color:#ABB2BF;">) </span><span style="color:#FFFFFF;">-></span><span style="color:#ABB2BF;"> ResultSetMetadata</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> </span></span> |
| <span class="line"><span style="color:#ABB2BF;"> </span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#98C379;"> Checks whether the field at the specified index in the result set is null.</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> :param index: The index of the field to check. 1 <= index <= column_num.</span></span> |
| <span class="line"><span style="color:#98C379;"> :return: True if the field is null, False otherwise.</span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#C678DD;"> def</span><span style="color:#61AFEF;"> is_null_by_index</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">self</span><span style="color:#ABB2BF;">, index : </span><span style="color:#56B6C2;">int</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#ABB2BF;"> </span></span> |
| <span class="line"><span style="color:#ABB2BF;"> </span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#98C379;"> Checks whether the field with the specified column name in the result set is null.</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> :param name: The name of the column to check.</span></span> |
| <span class="line"><span style="color:#98C379;"> :return: True if the field is null, False otherwise.</span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#C678DD;"> def</span><span style="color:#61AFEF;"> is_null_by_name</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">self</span><span style="color:#ABB2BF;">, name : </span><span style="color:#56B6C2;">str</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"></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;"> Closes the result set and releases any associated resources.</span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></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;">self</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></div></div><!----><footer class="vp-page-meta"><div class="vp-meta-item edit-link"><a class="auto-link external-link vp-meta-label" href="https://github.com/apache/tsfile/edit/docs/dev/src/UserGuide/develop/QuickStart/InterfaceDefinition/InterfaceDefinition-Python.md" aria-label="Found Error? Edit this page on GitHub" rel="noopener noreferrer" target="_blank" iconsizing="both"><!--[--><svg xmlns="http://www.w3.org/2000/svg" class="icon edit-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="edit icon" name="edit"><path d="M430.818 653.65a60.46 60.46 0 0 1-50.96-93.281l71.69-114.012 7.773-10.365L816.038 80.138A60.46 60.46 0 0 1 859.225 62a60.46 60.46 0 0 1 43.186 18.138l43.186 43.186a60.46 60.46 0 0 1 0 86.373L588.879 565.55l-8.637 8.637-117.466 68.234a60.46 60.46 0 0 1-31.958 11.229z"></path><path d="M728.802 962H252.891A190.883 190.883 0 0 1 62.008 771.98V296.934a190.883 190.883 0 0 1 190.883-192.61h267.754a60.46 60.46 0 0 1 0 120.92H252.891a69.962 69.962 0 0 0-69.098 69.099V771.98a69.962 69.962 0 0 0 69.098 69.098h475.911A69.962 69.962 0 0 0 797.9 771.98V503.363a60.46 60.46 0 1 1 120.922 0V771.98A190.883 190.883 0 0 1 728.802 962z"></path></svg><!--]-->Found Error? Edit this page on GitHub<!----></a></div><div class="vp-meta-item git-info"><div class="update-time"><span class="vp-meta-label">Last update: </span><span class="vp-meta-info" data-allow-mismatch="text">7/21/2025, 8:27:12 AM</span></div><!----></div></footer><!----><!----><!----><!--]--></main><!--]--><footer style="padding-bottom:1rem;padding-top:1rem;"><span id="doc-version" style="display:none;">latest</span><p style="text-align:center;color:#909399;font-size:12px;margin:0 30px;">Copyright © 2025 The Apache Software Foundation.<br> Apache and the Apache feather logo are trademarks of The Apache Software Foundation</p><p style="text-align:center;margin-top:10px;color:#909399;font-size:12px;margin:0 30px;"><strong>Have a question?</strong> Connect with us on issues. </p></footer></div><!--]--><!--]--><!--[--><!----><!--[--><!--]--><!--]--><!--]--></div> |
| <script type="module" src="/assets/app-CQ7n-jLB.js" defer></script> |
| </body> |
| </html> |
