| <!doctype html> |
| <html lang="zh-CN" data-theme="light"> |
| <head> |
| <meta charset="utf-8" /> |
| <meta name="viewport" content="width=device-width,initial-scale=1" /> |
| <meta name="generator" content="VuePress 2.0.0-rc.19" /> |
| <meta name="theme" content="VuePress Theme Hope 2.0.0-rc.71" /> |
| <style> |
| :root { |
| --vp-c-bg: #fff; |
| } |
| |
| [data-theme="dark"] { |
| --vp-c-bg: #1b1b1f; |
| } |
| |
| html, |
| body { |
| background: var(--vp-c-bg); |
| } |
| </style> |
| <script> |
| const userMode = localStorage.getItem("vuepress-theme-hope-scheme"); |
| const systemDarkMode = |
| window.matchMedia && |
| window.matchMedia("(prefers-color-scheme: dark)").matches; |
| |
| if (userMode === "dark" || (userMode !== "light" && systemDarkMode)) { |
| document.documentElement.setAttribute("data-theme", "dark"); |
| } |
| </script> |
| <link rel="alternate" hreflang="en-us" href="https://tsfile.apache.org/UserGuide/develop/QuickStart/InterfaceDefinition/InterfaceDefinition-Python.html"><meta property="og:url" content="https://tsfile.apache.org/zh/UserGuide/develop/QuickStart/InterfaceDefinition/InterfaceDefinition-Python.html"><meta property="og:site_name" content="Apache TsFile"><meta property="og:title" content="接口定义 - Python"><meta property="og:description" content="接口定义 - Python 数据模式 写入接口 TsFileWriter Tablet definition dataframe_to_tsfile 配置 全局写入默认值——包括各类型的默认编码、默认压缩、时间列编码/压缩——以一个字典暴露。 请在创建写入器 之前 修改它们。 set_tsfile_config 会校验每个取值,且只更新你传入的键。编码..."><meta property="og:type" content="article"><meta property="og:locale" content="zh-CN"><meta property="og:locale:alternate" content="en-US"><meta property="og:updated_time" content="2026-08-05T08:07:22.000Z"><meta property="article:modified_time" content="2026-08-05T08:07:22.000Z"><script type="application/ld+json">{"@context":"https://schema.org","@type":"Article","headline":"接口定义 - Python","image":[""],"dateModified":"2026-08-05T08:07:22.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>接口定义 - Python | Apache TsFile</title><meta name="description" content="接口定义 - Python 数据模式 写入接口 TsFileWriter Tablet definition dataframe_to_tsfile 配置 全局写入默认值——包括各类型的默认编码、默认压缩、时间列编码/压缩——以一个字典暴露。 请在创建写入器 之前 修改它们。 set_tsfile_config 会校验每个取值,且只更新你传入的键。编码..."> |
| <link rel="preload" href="/assets/style-Dd4ncJh2.css" as="style"><link rel="stylesheet" href="/assets/style-Dd4ncJh2.css"> |
| <link rel="modulepreload" href="/assets/app-CJVB9bAA.js"><link rel="modulepreload" href="/assets/InterfaceDefinition-Python.html-C0dmQn-_.js"><link rel="modulepreload" href="/assets/plugin-vue_export-helper-DlAUqK2U.js"> |
| <link rel="prefetch" href="/assets/index.html-0TVlwEti.js" as="script"><link rel="prefetch" href="/assets/About.html-BNF8BG1p.js" as="script"><link rel="prefetch" href="/assets/Feedback.html-BZ-yzaeK.js" as="script"><link rel="prefetch" href="/assets/Community-Project-Committers.html-Cge-xq6m.js" as="script"><link rel="prefetch" href="/assets/Powered-By.html-Bv8SXPq_.js" as="script"><link rel="prefetch" href="/assets/index.html-ChLgTY_i.js" as="script"><link rel="prefetch" href="/assets/QuickStart.html-CDheJI4K.js" as="script"><link rel="prefetch" href="/assets/index.html-Dhl5cutl.js" as="script"><link rel="prefetch" href="/assets/About.html-B0grbAwv.js" as="script"><link rel="prefetch" href="/assets/Feedback.html-CDXBAD_7.js" as="script"><link rel="prefetch" href="/assets/Community-Project-Committers.html-ZcpHlfCe.js" as="script"><link rel="prefetch" href="/assets/Powered-By.html-BDOteP39.js" as="script"><link rel="prefetch" href="/assets/index.html-D1ZnA4cx.js" as="script"><link rel="prefetch" href="/assets/QuickStart.html-zEdi1aOO.js" as="script"><link rel="prefetch" href="/assets/TsFileDataFrame.html-71Ig0hr9.js" as="script"><link rel="prefetch" href="/assets/Flink-TsFile.html-DWJV_eUC.js" as="script"><link rel="prefetch" href="/assets/Hive-TsFile.html-BDCjvpg5.js" as="script"><link rel="prefetch" href="/assets/Spark-TsFile.html-DSafF5_f.js" as="script"><link rel="prefetch" href="/assets/Data-Model.html-Lg9ODDDh.js" as="script"><link rel="prefetch" href="/assets/Navigating_Time_Series_Data.html-CXfIiedq.js" as="script"><link rel="prefetch" href="/assets/QuickStart-C.html-C8LAeQOm.js" as="script"><link rel="prefetch" href="/assets/QuickStart-CPP.html-Rngc1aEr.js" as="script"><link rel="prefetch" href="/assets/QuickStart-JAVA.html-Bh6ghQEk.js" as="script"><link rel="prefetch" href="/assets/QuickStart-PYTHON.html-BKdqCnnP.js" as="script"><link rel="prefetch" href="/assets/Tsfile-CLI.html-5cjM6Vfv.js" as="script"><link rel="prefetch" href="/assets/Tsfile-Viewer.html-Do7PrqYs.js" as="script"><link rel="prefetch" href="/assets/TsFileDataFrame.html-Bv1PJBfF.js" as="script"><link rel="prefetch" href="/assets/Flink-TsFile.html-BJWxQyod.js" as="script"><link rel="prefetch" href="/assets/Hive-TsFile.html-3mRO0_5e.js" as="script"><link rel="prefetch" href="/assets/Spark-TsFile.html-BIPh4uo8.js" as="script"><link rel="prefetch" href="/assets/Data-Model.html-DEWfky3Q.js" as="script"><link rel="prefetch" href="/assets/Navigating_Time_Series_Data.html-Ddq6w_38.js" as="script"><link rel="prefetch" href="/assets/QuickStart-C.html-BlerZitb.js" as="script"><link rel="prefetch" href="/assets/QuickStart-CPP.html-D5Ye8YWz.js" as="script"><link rel="prefetch" href="/assets/QuickStart-PYTHON.html-DVMZQ8j9.js" as="script"><link rel="prefetch" href="/assets/QuickStart.html-DMEe1duh.js" as="script"><link rel="prefetch" href="/assets/Tsfile-CLI.html-BM8MML4f.js" as="script"><link rel="prefetch" href="/assets/Tsfile-Viewer.html-BmJIN1wV.js" as="script"><link rel="prefetch" href="/assets/Flink-TsFile.html--tcoYW8j.js" as="script"><link rel="prefetch" href="/assets/Hive-TsFile.html-Cpix7Tos.js" as="script"><link rel="prefetch" href="/assets/Spark-TsFile.html-DjTg1OxJ.js" as="script"><link rel="prefetch" href="/assets/Data-Model.html-6HM7nVAy.js" as="script"><link rel="prefetch" href="/assets/Navigating_Time_Series_Data.html-BHExmkQ4.js" as="script"><link rel="prefetch" href="/assets/QuickStart.html-BcH2OTgf.js" as="script"><link rel="prefetch" href="/assets/InterfaceDefinition-C.html-BUwo1prX.js" as="script"><link rel="prefetch" href="/assets/InterfaceDefinition-CPP.html-COuynvBy.js" as="script"><link rel="prefetch" href="/assets/InterfaceDefinition-Java.html-CQgkhSHU.js" as="script"><link rel="prefetch" href="/assets/InterfaceDefinition-Python.html-3I1TY7w1.js" as="script"><link rel="prefetch" href="/assets/InterfaceDefinition-C.html-C9pwXkTj.js" as="script"><link rel="prefetch" href="/assets/InterfaceDefinition-CPP.html-BWwNeSF5.js" as="script"><link rel="prefetch" href="/assets/InterfaceDefinition-Java.html-Dnyn-wDr.js" as="script"><link rel="prefetch" href="/assets/InterfaceDefinition-Python.html-C2D5gk8m.js" as="script"><link rel="prefetch" href="/assets/TsFileDataFrame.html-BOhA2xWv.js" as="script"><link rel="prefetch" href="/assets/Flink-TsFile.html-CLMVRwLZ.js" as="script"><link rel="prefetch" href="/assets/Hive-TsFile.html-Bk0vdcY1.js" as="script"><link rel="prefetch" href="/assets/Spark-TsFile.html-u7gTFYb6.js" as="script"><link rel="prefetch" href="/assets/Data-Model.html--_EypQ_m.js" as="script"><link rel="prefetch" href="/assets/Interface-Definitions.html-BKaki8JK.js" as="script"><link rel="prefetch" href="/assets/Navigating_Time_Series_Data.html-B7hwn4XW.js" as="script"><link rel="prefetch" href="/assets/QuickStart-C.html-D-TmarFT.js" as="script"><link rel="prefetch" href="/assets/QuickStart-CPP.html-CDLiX5ch.js" as="script"><link rel="prefetch" href="/assets/QuickStart-JAVA.html-CWwUARHi.js" as="script"><link rel="prefetch" href="/assets/QuickStart-PYTHON.html-BsBGa-pc.js" as="script"><link rel="prefetch" href="/assets/Tsfile-CLI.html-rNoRd51e.js" as="script"><link rel="prefetch" href="/assets/Tsfile-Viewer.html-C4L30Rv3.js" as="script"><link rel="prefetch" href="/assets/TsFileDataFrame.html-D2JogZ6b.js" as="script"><link rel="prefetch" href="/assets/Flink-TsFile.html-vTZO-p6X.js" as="script"><link rel="prefetch" href="/assets/Hive-TsFile.html-BvLy-UiF.js" as="script"><link rel="prefetch" href="/assets/Spark-TsFile.html-7pDO5lak.js" as="script"><link rel="prefetch" href="/assets/Data-Model.html-DUeKphXu.js" as="script"><link rel="prefetch" href="/assets/Navigating_Time_Series_Data.html-DCMJxQcf.js" as="script"><link rel="prefetch" href="/assets/QuickStart-C.html-DRwbjQnE.js" as="script"><link rel="prefetch" href="/assets/QuickStart-CPP.html-CX-xReGz.js" as="script"><link rel="prefetch" href="/assets/QuickStart-PYTHON.html-C8iuEFmM.js" as="script"><link rel="prefetch" href="/assets/QuickStart.html-C0Tk8ZLE.js" as="script"><link rel="prefetch" href="/assets/Tsfile-CLI.html-BqGrJ1zv.js" as="script"><link rel="prefetch" href="/assets/Tsfile-Viewer.html-yBnjtKNY.js" as="script"><link rel="prefetch" href="/assets/Flink-TsFile.html-n6qQv3eF.js" as="script"><link rel="prefetch" href="/assets/Hive-TsFile.html-8oXXWTyJ.js" as="script"><link rel="prefetch" href="/assets/Spark-TsFile.html-BDtLFAIw.js" as="script"><link rel="prefetch" href="/assets/Data-Model.html-BVTFaEhW.js" as="script"><link rel="prefetch" href="/assets/Navigating_Time_Series_Data.html-Bk13_laP.js" as="script"><link rel="prefetch" href="/assets/QuickStart.html-D1La1TUl.js" as="script"><link rel="prefetch" href="/assets/InterfaceDefinition-C.html-yNZoagTc.js" as="script"><link rel="prefetch" href="/assets/InterfaceDefinition-CPP.html-DlCaSXpC.js" as="script"><link rel="prefetch" href="/assets/InterfaceDefinition-Java.html-B823U97o.js" as="script"><link rel="prefetch" href="/assets/InterfaceDefinition-C.html-Dn2f4WbX.js" as="script"><link rel="prefetch" href="/assets/InterfaceDefinition-CPP.html-BtOgI1nl.js" as="script"><link rel="prefetch" href="/assets/InterfaceDefinition-Java.html-BmLmvSwW.js" as="script"><link rel="prefetch" href="/assets/InterfaceDefinition-Python.html-OUhzFFNM.js" as="script"><link rel="prefetch" href="/assets/404.html-DJJEDYeG.js" as="script"><link rel="prefetch" href="/assets/index.html-BV2d8wR7.js" as="script"><link rel="prefetch" href="/assets/index.html-q_HC08AM.js" as="script"><link rel="prefetch" href="/assets/index.html-BlI3FCg0.js" as="script"><link rel="prefetch" href="/assets/index.html-CyobIVws.js" as="script"><link rel="prefetch" href="/assets/index.html-BF05tDLn.js" as="script"><link rel="prefetch" href="/assets/index.html-DYh9So-3.js" as="script"><link rel="prefetch" href="/assets/index.html-uC6pfUPP.js" as="script"><link rel="prefetch" href="/assets/index.html-AP1snd-E.js" as="script"><link rel="prefetch" href="/assets/index.html-CNjtA6Qj.js" as="script"><link rel="prefetch" href="/assets/index.html-e00vibCd.js" as="script"><link rel="prefetch" href="/assets/index.html-D86pkZbn.js" as="script"><link rel="prefetch" href="/assets/index.html-DIpXIRD2.js" as="script"><link rel="prefetch" href="/assets/index.html-Dxxn45WF.js" as="script"><link rel="prefetch" href="/assets/index.html-c7TcB6iw.js" as="script"><link rel="prefetch" href="/assets/index.html-1xyfe9ZM.js" as="script"><link rel="prefetch" href="/assets/index.html-nTH2Qq6G.js" as="script"><link rel="prefetch" href="/assets/index.html-CV1zwwC-.js" as="script"><link rel="prefetch" href="/assets/index.html-B9zVB9_L.js" as="script"><link rel="prefetch" href="/assets/index.html-B7sisXfO.js" as="script"><link rel="prefetch" href="/assets/index.html-DUjSjo_3.js" as="script"><link rel="prefetch" href="/assets/index.html-5v6Wav39.js" as="script"><link rel="prefetch" href="/assets/index.html-BpXFTscG.js" as="script"><link rel="prefetch" href="/assets/index.html-DXifcwsD.js" as="script"><link rel="prefetch" href="/assets/index.html-CoYMj1kJ.js" as="script"><link rel="prefetch" href="/assets/index.html-BeLjBvXt.js" as="script"><link rel="prefetch" href="/assets/index.html-CRWR8z02.js" as="script"><link rel="prefetch" href="/assets/index.html-CqmfpaIF.js" as="script"><link rel="prefetch" href="/assets/index.html-DjilmAch.js" as="script"><link rel="prefetch" href="/assets/index.html-BRzmfSfa.js" as="script"><link rel="prefetch" href="/assets/index.html-BGq__07l.js" as="script"><link rel="prefetch" href="/assets/index.html-CEdyJxnz.js" as="script"><link rel="prefetch" href="/assets/index.html-CUPzmFNc.js" as="script"><link rel="prefetch" href="/assets/index.html-CC_SDwRT.js" as="script"><link rel="prefetch" href="/assets/index.html-PaGyK6Wd.js" as="script"><link rel="prefetch" href="/assets/index.html-u3gdBelw.js" as="script"><link rel="prefetch" href="/assets/index.html-D9vdaoxp.js" as="script"><link rel="prefetch" href="/assets/index.html-NBvieHUY.js" as="script"><link rel="prefetch" href="/assets/index.html-DJGaf1uf.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">跳至主要內容</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="/zh/" aria-label="带我回家"><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="搜索文档"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">搜索文档</span></span><span class="DocSearch-Button-Keys"><kbd class="DocSearch-Button-Key"><svg width="15" height="15" class="DocSearch-Control-Key-Icon"><path d="M4.505 4.496h2M5.505 5.496v5M8.216 4.496l.055 5.993M10 7.5c.333.333.5.667.5 1v2M12.326 4.5v5.996M8.384 4.496c1.674 0 2.116 0 2.116 1.5s-.442 1.5-2.116 1.5M3.205 9.303c-.09.448-.277 1.21-1.241 1.203C1 10.5.5 9.513.5 8V7c0-1.57.5-2.5 1.464-2.494.964.006 1.134.598 1.24 1.342M12.553 10.5h1.953" stroke-width="1.2" stroke="currentColor" fill="none" stroke-linecap="square"></path></svg></kbd><kbd class="DocSearch-Button-Key">K</kbd></span></button></div><!--]--><nav class="vp-nav-links"><div class="vp-nav-item hide-in-mobile"><div class="vp-dropdown-wrapper"><button type="button" class="vp-dropdown-title" aria-label="文档"><!--[--><!---->文档<!--]--><span class="arrow"></span><ul class="vp-dropdown"><li class="vp-dropdown-item"><a class="route-link auto-link" href="/zh/UserGuide/latest/QuickStart/QuickStart.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="/zh/Download/" aria-label="下载" iconsizing="height"><!---->下载<!----></a></div><div class="vp-nav-item hide-in-mobile"><div class="vp-dropdown-wrapper"><button type="button" class="vp-dropdown-title" aria-label="社区"><!--[--><!---->社区<!--]--><span class="arrow"></span><ul class="vp-dropdown"><li class="vp-dropdown-item"><a class="route-link auto-link" href="/zh/Community/About.html" aria-label="关于社区" iconsizing="both"><!---->关于社区<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/zh/Community/Feedback.html" aria-label="交流与反馈" iconsizing="both"><!---->交流与反馈<!----></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="开发"><!--[--><!---->开发<!--]--><span class="arrow"></span><ul class="vp-dropdown"><li class="vp-dropdown-item"><a class="route-link auto-link" href="/zh/Development/Community-Project-Committers.html" aria-label="成为开发者" iconsizing="both"><!---->成为开发者<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/zh/Development/Powered-By.html" aria-label="Power by" iconsizing="both"><!---->Power by<!----></a></li></ul></button></div></div><div class="vp-nav-item hide-in-mobile"><div class="vp-dropdown-wrapper"><button type="button" class="vp-dropdown-title" aria-label="ASF"><!--[--><!---->ASF<!--]--><span class="arrow"></span><ul class="vp-dropdown"><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/" aria-label="基金会" rel="noopener noreferrer" target="_blank" iconsizing="both"><!---->基金会<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/licenses/" aria-label="许可证" rel="noopener noreferrer" target="_blank" iconsizing="both"><!---->许可证<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/security/" aria-label="安全" rel="noopener noreferrer" target="_blank" iconsizing="both"><!---->安全<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/foundation/sponsorship.html" aria-label="赞助" rel="noopener noreferrer" target="_blank" iconsizing="both"><!---->赞助<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/foundation/thanks.html" aria-label="致谢" rel="noopener noreferrer" target="_blank" iconsizing="both"><!---->致谢<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/events/current-event" aria-label="活动" rel="noopener noreferrer" target="_blank" iconsizing="both"><!---->活动<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://privacy.apache.org/policies/privacy-policy-public.html" aria-label="隐私" rel="noopener noreferrer" target="_blank" iconsizing="both"><!---->隐私<!----></a></li></ul></button></div></div></nav><div class="vp-nav-item"><div class="vp-dropdown-wrapper"><button type="button" class="vp-dropdown-title" aria-label="选择语言"><!--[--><svg xmlns="http://www.w3.org/2000/svg" class="icon i18n-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="i18n icon" name="i18n" style="width:1rem;height:1rem;vertical-align:middle;"><path d="M379.392 460.8 494.08 575.488l-42.496 102.4L307.2 532.48 138.24 701.44l-71.68-72.704L234.496 460.8l-45.056-45.056c-27.136-27.136-51.2-66.56-66.56-108.544h112.64c7.68 14.336 16.896 27.136 26.112 35.84l45.568 46.08 45.056-45.056C382.976 312.32 409.6 247.808 409.6 204.8H0V102.4h256V0h102.4v102.4h256v102.4H512c0 70.144-37.888 161.28-87.04 210.944L378.88 460.8zM576 870.4 512 1024H409.6l256-614.4H768l256 614.4H921.6l-64-153.6H576zM618.496 768h196.608L716.8 532.48 618.496 768z"></path></svg><!--]--><span class="arrow"></span><ul class="vp-dropdown"><li class="vp-dropdown-item"><a class="route-link auto-link" href="/UserGuide/develop/QuickStart/InterfaceDefinition/InterfaceDefinition-Python.html" aria-label="English" iconsizing="both"><!---->English<!----></a></li><li class="vp-dropdown-item"><a class="route-link route-link-active auto-link" href="/zh/UserGuide/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><!---->接口定义 - Python</h1><div class="page-info"><!----><!----><span class="page-date-info" aria-label="写作日期📅" data-balloon-pos="up"><svg xmlns="http://www.w3.org/2000/svg" class="icon calendar-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="calendar icon" name="calendar"><path d="M716.4 110.137c0-18.753-14.72-33.473-33.472-33.473-18.753 0-33.473 14.72-33.473 33.473v33.473h66.993v-33.473zm-334.87 0c0-18.753-14.72-33.473-33.473-33.473s-33.52 14.72-33.52 33.473v33.473h66.993v-33.473zm468.81 33.52H716.4v100.465c0 18.753-14.72 33.473-33.472 33.473a33.145 33.145 0 01-33.473-33.473V143.657H381.53v100.465c0 18.753-14.72 33.473-33.473 33.473a33.145 33.145 0 01-33.473-33.473V143.657H180.6A134.314 134.314 0 0046.66 277.595v535.756A134.314 134.314 0 00180.6 947.289h669.74a134.36 134.36 0 00133.94-133.938V277.595a134.314 134.314 0 00-133.94-133.938zm33.473 267.877H147.126a33.145 33.145 0 01-33.473-33.473c0-18.752 14.72-33.473 33.473-33.473h736.687c18.752 0 33.472 14.72 33.472 33.473a33.145 33.145 0 01-33.472 33.473z"></path></svg><span data-allow-mismatch="text">2026年8月5日</span><meta property="datePublished" content="2026-08-05T08:07:22.000Z"></span><!----><span class="page-reading-time-info" aria-label="阅读时间⌛" data-balloon-pos="up"><svg xmlns="http://www.w3.org/2000/svg" class="icon timer-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="timer icon" name="timer"><path d="M799.387 122.15c4.402-2.978 7.38-7.897 7.38-13.463v-1.165c0-8.933-7.38-16.312-16.312-16.312H256.33c-8.933 0-16.311 7.38-16.311 16.312v1.165c0 5.825 2.977 10.874 7.637 13.592 4.143 194.44 97.22 354.963 220.201 392.763-122.204 37.542-214.893 196.511-220.2 389.397-4.661 5.049-7.638 11.651-7.638 19.03v5.825h566.49v-5.825c0-7.379-2.849-13.981-7.509-18.9-5.049-193.016-97.867-351.985-220.2-389.527 123.24-37.67 216.446-198.453 220.588-392.892zM531.16 450.445v352.632c117.674 1.553 211.787 40.778 211.787 88.676H304.097c0-48.286 95.149-87.382 213.728-88.676V450.445c-93.077-3.107-167.901-81.297-167.901-177.093 0-8.803 6.99-15.793 15.793-15.793 8.803 0 15.794 6.99 15.794 15.793 0 80.261 63.69 145.635 142.01 145.635s142.011-65.374 142.011-145.635c0-8.803 6.99-15.793 15.794-15.793s15.793 6.99 15.793 15.793c0 95.019-73.789 172.82-165.96 177.093z"></path></svg><span>大约 7 分钟</span><meta property="timeRequired" content="PT7M"></span><!----><!----></div><hr></div><div class="vp-toc-placeholder"><aside id="toc" vp-toc><!----><!--[--><div class="vp-toc-header">此页内容<button type="button" class="print-button" title="打印"><svg xmlns="http://www.w3.org/2000/svg" class="icon print-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="print icon" name="print"><path d="M819.2 364.8h-44.8V128c0-17.067-14.933-32-32-32H281.6c-17.067 0-32 14.933-32 32v236.8h-44.8C145.067 364.8 96 413.867 96 473.6v192c0 59.733 49.067 108.8 108.8 108.8h44.8V896c0 17.067 14.933 32 32 32h460.8c17.067 0 32-14.933 32-32V774.4h44.8c59.733 0 108.8-49.067 108.8-108.8v-192c0-59.733-49.067-108.8-108.8-108.8zM313.6 160h396.8v204.8H313.6V160zm396.8 704H313.6V620.8h396.8V864zM864 665.6c0 25.6-19.2 44.8-44.8 44.8h-44.8V588.8c0-17.067-14.933-32-32-32H281.6c-17.067 0-32 14.933-32 32v121.6h-44.8c-25.6 0-44.8-19.2-44.8-44.8v-192c0-25.6 19.2-44.8 44.8-44.8h614.4c25.6 0 44.8 19.2 44.8 44.8v192z"></path></svg></button><div class="arrow end"></div></div><div class="vp-toc-wrapper"><ul class="vp-toc-list"><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level2" href="#数据模式">数据模式</a></li><!----><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level2" href="#写入接口">写入接口</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><!----><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level3" href="#dataframe-to-tsfile">dataframe_to_tsfile</a></li><!----><!--]--></ul></li><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level2" href="#配置">配置</a></li><!----><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level2" href="#读取接口">读取接口</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><!----><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level3" href="#to-dataframe">to_dataframe</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="接口定义-python" tabindex="-1"><a class="header-anchor" href="#接口定义-python"><span>接口定义 - Python</span></a></h1><h2 id="数据模式" tabindex="-1"><a class="header-anchor" href="#数据模式"><span>数据模式</span></a></h2><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;"> 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;"> 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;"> TIMESTAMP</span><span style="color:#56B6C2;"> =</span><span style="color:#D19A66;"> 8</span></span> |
| <span class="line"><span style="color:#D19A66;"> DATE</span><span style="color:#56B6C2;"> =</span><span style="color:#D19A66;"> 9</span></span> |
| <span class="line"><span style="color:#D19A66;"> BLOB</span><span style="color:#56B6C2;"> =</span><span style="color:#D19A66;"> 10</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;"> TSEncoding</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;"> 写入器支持的值编码。每个成员后的注释列出其可用于哪些数据类型。</span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#D19A66;"> PLAIN</span><span style="color:#56B6C2;"> =</span><span style="color:#D19A66;"> 0</span><span style="color:#7F848E;font-style:italic;"> # 所有类型</span></span> |
| <span class="line"><span style="color:#D19A66;"> DICTIONARY</span><span style="color:#56B6C2;"> =</span><span style="color:#D19A66;"> 1</span><span style="color:#7F848E;font-style:italic;"> # STRING、TEXT</span></span> |
| <span class="line"><span style="color:#D19A66;"> RLE</span><span style="color:#56B6C2;"> =</span><span style="color:#D19A66;"> 2</span><span style="color:#7F848E;font-style:italic;"> # INT32、INT64、TIMESTAMP、DATE</span></span> |
| <span class="line"><span style="color:#D19A66;"> TS_2DIFF</span><span style="color:#56B6C2;"> =</span><span style="color:#D19A66;"> 4</span><span style="color:#7F848E;font-style:italic;"> # INT32、INT64、TIMESTAMP、DATE、FLOAT、DOUBLE</span></span> |
| <span class="line"><span style="color:#D19A66;"> GORILLA</span><span style="color:#56B6C2;"> =</span><span style="color:#D19A66;"> 8</span><span style="color:#7F848E;font-style:italic;"> # INT32、INT64、TIMESTAMP、DATE、FLOAT、DOUBLE</span></span> |
| <span class="line"><span style="color:#D19A66;"> ZIGZAG</span><span style="color:#56B6C2;"> =</span><span style="color:#D19A66;"> 9</span><span style="color:#7F848E;font-style:italic;"> # INT32、INT64</span></span> |
| <span class="line"><span style="color:#D19A66;"> SPRINTZ</span><span style="color:#56B6C2;"> =</span><span style="color:#D19A66;"> 12</span><span style="color:#7F848E;font-style:italic;"> # INT32、INT64、FLOAT、DOUBLE</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#C678DD;">class</span><span style="color:#E5C07B;"> Compressor</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;"> 写入器支持的压缩,默认值为 LZ4。</span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#D19A66;"> UNCOMPRESSED</span><span style="color:#56B6C2;"> =</span><span style="color:#D19A66;"> 0</span></span> |
| <span class="line"><span style="color:#D19A66;"> SNAPPY</span><span style="color:#56B6C2;"> =</span><span style="color:#D19A66;"> 1</span></span> |
| <span class="line"><span style="color:#D19A66;"> GZIP</span><span style="color:#56B6C2;"> =</span><span style="color:#D19A66;"> 2</span></span> |
| <span class="line"><span style="color:#D19A66;"> LZO</span><span style="color:#56B6C2;"> =</span><span style="color:#D19A66;"> 3</span></span> |
| <span class="line"><span style="color:#D19A66;"> LZ4</span><span style="color:#56B6C2;"> =</span><span style="color:#D19A66;"> 7</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;"> TsFile 中的列类别枚举。</span></span> |
| <span class="line"><span style="color:#98C379;"> TAG:标签列</span></span> |
| <span class="line"><span style="color:#98C379;"> FIELD:测点列,存储测量值。</span></span> |
| <span class="line"><span style="color:#98C379;"> ATTRIBUTE / TIME:保留的列角色。</span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></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 style="color:#D19A66;"> ATTRIBUTE</span><span style="color:#56B6C2;"> =</span><span style="color:#D19A66;"> 2</span></span> |
| <span class="line"><span style="color:#D19A66;"> TIME</span><span style="color:#56B6C2;"> =</span><span style="color:#D19A66;"> 3</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;"> """定义表中某一列的模式(名称、数据类型、类别)。"""</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;"> """表结构的模式定义。"""</span></span> |
| <span class="line"></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 style="color:#C678DD;">class</span><span style="color:#E5C07B;"> ResultSetMetaData</span><span style="color:#ABB2BF;">:</span></span> |
| <span class="line"><span style="color:#98C379;"> """查询结果集的元数据容器(列名、类型、表名)。"""</span></span> |
| <span class="line"></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 class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h2 id="写入接口" tabindex="-1"><a class="header-anchor" href="#写入接口"><span>写入接口</span></a></h2><h3 id="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;"> 用于将结构化表格数据写入具有指定模式的 TsFile。</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;"> :param path: tsfile 文件路径,如果不存在则会创建。</span></span> |
| <span class="line"><span style="color:#98C379;"> :param table_schema: 描述要写入表的结构信息。</span></span> |
| <span class="line"><span style="color:#98C379;"> :param memory_threshold: 触发自动刷盘前缓冲的字节数(默认 128MB)。</span></span> |
| <span class="line"><span style="color:#98C379;"> :return: 无返回值。</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 style="color:#D19A66;font-style:italic;"> memory_threshold</span><span style="color:#ABB2BF;">: </span><span style="color:#56B6C2;">int</span><span style="color:#56B6C2;"> =</span><span style="color:#D19A66;"> 128</span><span style="color:#56B6C2;"> *</span><span style="color:#D19A66;"> 1024</span><span style="color:#56B6C2;"> *</span><span style="color:#D19A66;"> 1024</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#98C379;"> 将一个 Tablet 写入 TsFile 中的表中。</span></span> |
| <span class="line"><span style="color:#98C379;"> :param tablet: 存储表的批量数据。</span></span> |
| <span class="line"><span style="color:#98C379;"> :return: 无返回值。</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> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#98C379;"> 将一个 pandas DataFrame 写入表中。列的编码/压缩遵循表 schema(或引擎默认值)。</span></span> |
| <span class="line"><span style="color:#98C379;"> :param dataframe: 要写入的数据。</span></span> |
| <span class="line"><span style="color:#98C379;"> :return: 无返回值。</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_dataframe</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;">dataframe</span><span style="color:#ABB2BF;">: pandas.DataFrame)</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#98C379;"> 将缓冲数据刷新到磁盘。</span></span> |
| <span class="line"><span style="color:#98C379;"> :return: 无返回值。</span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#C678DD;"> def</span><span style="color:#61AFEF;"> flush</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> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#98C379;"> 关闭 TsFileTableWriter,并自动刷新数据。</span></span> |
| <span class="line"><span style="color:#98C379;"> :return: 无返回值。</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> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> # 可作为上下文管理器使用:</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> # with TsFileTableWriter(path, schema) as w:</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> # w.write_table(tablet)</span></span> |
| <span class="line"><span style="color:#C678DD;"> def</span><span style="color:#56B6C2;"> __enter__</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;font-style:italic;">self</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#C678DD;"> def</span><span style="color:#56B6C2;"> __exit__</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;">exc_type</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;font-style:italic;">exc_val</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;font-style:italic;">exc_tb</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></div><h3 id="tablet-definition" tabindex="-1"><a class="header-anchor" href="#tablet-definition"><span>Tablet definition</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;"> 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;"> 一个为批量数据预分配的列式数据容器</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;">具有类型约束</span><span style="color:#ABB2BF;">。</span></span> |
| <span class="line"><span style="color:#E5C07B;"> 它会创建时间戳缓冲区和带类型的数据列</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;">并对数值类型执行有效值范围校验</span><span style="color:#ABB2BF;">。</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#E5C07B;"> 初始化参数</span><span style="color:#ABB2BF;">:</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> :param column_name_list: 数据列的名称列表。</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> :param type_list: 每列允许的数据类型(TSDataType 枚举值)。</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> :param max_row_num: 预分配的最大行数(默认值为 </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;">: 无返回值。</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></div><h3 id="dataframe-to-tsfile" tabindex="-1"><a class="header-anchor" href="#dataframe-to-tsfile"><span>dataframe_to_tsfile</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;">def</span><span style="color:#61AFEF;"> dataframe_to_tsfile</span><span style="color:#ABB2BF;">(</span><span style="color:#D19A66;font-style:italic;">dataframe</span><span style="color:#ABB2BF;">: pd.DataFrame,</span></span> |
| <span class="line"><span style="color:#D19A66;font-style:italic;"> file_path</span><span style="color:#ABB2BF;">: </span><span style="color:#56B6C2;">str</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;font-style:italic;"> table_name</span><span style="color:#ABB2BF;">: Optional[</span><span style="color:#56B6C2;">str</span><span style="color:#ABB2BF;">] </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;"> time_column</span><span style="color:#ABB2BF;">: Optional[</span><span style="color:#56B6C2;">str</span><span style="color:#ABB2BF;">] </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;"> tag_column</span><span style="color:#ABB2BF;">: Optional[list[</span><span style="color:#56B6C2;">str</span><span style="color:#ABB2BF;">]] </span><span style="color:#56B6C2;">=</span><span style="color:#D19A66;"> None</span><span style="color:#ABB2BF;">)</span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#98C379;"> 将 pandas DataFrame 写入 TsFile。</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> :param dataframe: 要写入的数据。</span></span> |
| <span class="line"><span style="color:#98C379;"> :param file_path: 目标 .tsfile 路径。</span></span> |
| <span class="line"><span style="color:#98C379;"> :param table_name: 输出表名。</span></span> |
| <span class="line"><span style="color:#98C379;"> :param time_column: 用作时间戳列的列名。</span></span> |
| <span class="line"><span style="color:#98C379;"> :param tag_column: 作为 TAG 列处理的列名列表。</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></div><h2 id="配置" tabindex="-1"><a class="header-anchor" href="#配置"><span>配置</span></a></h2><p>全局写入默认值——包括各类型的默认编码、默认压缩、时间列编码/压缩——以一个字典暴露。<br> 请在创建写入器 <strong>之前</strong> 修改它们。</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;">from</span><span style="color:#ABB2BF;"> tsfile </span><span style="color:#C678DD;">import</span><span style="color:#ABB2BF;"> get_tsfile_config, set_tsfile_config</span></span> |
| <span class="line"><span style="color:#C678DD;">from</span><span style="color:#ABB2BF;"> tsfile </span><span style="color:#C678DD;">import</span><span style="color:#ABB2BF;"> TSEncoding, Compressor</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#ABB2BF;">cfg </span><span style="color:#56B6C2;">=</span><span style="color:#61AFEF;"> get_tsfile_config</span><span style="color:#ABB2BF;">() </span><span style="color:#7F848E;font-style:italic;"># -> 包含所有配置项的 dict</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"># 例如 cfg["default_compression_type_"]、cfg["int64_encoding_type_"]、</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"># cfg["time_encoding_type_"]、cfg["time_compress_type_"] 等。</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#61AFEF;">set_tsfile_config</span><span style="color:#ABB2BF;">({</span></span> |
| <span class="line"><span style="color:#98C379;"> "default_compression_type_"</span><span style="color:#ABB2BF;">: Compressor.</span><span style="color:#D19A66;">LZ4</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "int64_encoding_type_"</span><span style="color:#ABB2BF;">: TSEncoding.</span><span style="color:#D19A66;">TS_2DIFF</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#ABB2BF;">})</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p><code>set_tsfile_config</code> 会校验每个取值,且只更新你传入的键。编码/压缩取值为 <code>TSEncoding</code> / <code>Compressor</code><br> 成员。各数据类型允许的编码,以及不修改时使用的默认值:</p><table><thead><tr><th>数据类型</th><th>允许的编码</th><th>默认值</th></tr></thead><tbody><tr><td><code>BOOLEAN</code></td><td><code>PLAIN</code></td><td><code>PLAIN</code></td></tr><tr><td><code>INT32</code>、<code>INT64</code>、<code>DATE</code></td><td><code>PLAIN</code>、<code>TS_2DIFF</code>、<code>GORILLA</code>、<code>ZIGZAG</code>、<code>RLE</code>、<code>SPRINTZ</code></td><td><code>TS_2DIFF</code></td></tr><tr><td><code>FLOAT</code>、<code>DOUBLE</code></td><td><code>PLAIN</code>、<code>TS_2DIFF</code>、<code>GORILLA</code>、<code>SPRINTZ</code></td><td><code>GORILLA</code></td></tr><tr><td><code>STRING</code>、<code>TEXT</code></td><td><code>PLAIN</code>、<code>DICTIONARY</code></td><td><code>PLAIN</code></td></tr></tbody></table><p>压缩适用于所有数据类型:<code>UNCOMPRESSED</code>、<code>SNAPPY</code>、<code>GZIP</code>、<code>LZO</code>、<code>LZ4</code>(默认 <code>LZ4</code>)。</p><h2 id="读取接口" tabindex="-1"><a class="header-anchor" href="#读取接口"><span>读取接口</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;"> 从 TsFile 中查询表格数据。</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;"> 初始化指定路径的 TsFile 读取器。</span></span> |
| <span class="line"><span style="color:#98C379;"> :param pathname: TsFile 文件的路径。</span></span> |
| <span class="line"><span style="color:#98C379;"> :return: 无返回值。</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 style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#98C379;"> 对指定的表和列执行时间范围查询。</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> :param table_name: 要查询的表名。</span></span> |
| <span class="line"><span style="color:#98C379;"> :param column_names: 要检索的列名列表。</span></span> |
| <span class="line"><span style="color:#98C379;"> :param start_time: 查询范围的起始时间(默认:int64 最小值)。</span></span> |
| <span class="line"><span style="color:#98C379;"> :param end_time: 查询范围的结束时间(默认:int64 最大值)。</span></span> |
| <span class="line"><span style="color:#98C379;"> :return: 查询结果集处理器。</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;"> 按行查询表,支持偏移量/行数限制下推与可选的标签过滤。标签谓词把查询限定到</span></span> |
| <span class="line"><span style="color:#98C379;"> 标签列取值满足条件的设备。用 tsfile.tag_filter 中的辅助函数构造过滤器</span></span> |
| <span class="line"><span style="color:#98C379;"> (tag_eq、tag_neq、tag_lt、tag_lteq、tag_gt、tag_gteq、tag_between 等),</span></span> |
| <span class="line"><span style="color:#98C379;"> 并用 &、| 和 ~ 组合。</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> :param table_name: 要查询的表名。</span></span> |
| <span class="line"><span style="color:#98C379;"> :param column_names: 要检索的列名列表。</span></span> |
| <span class="line"><span style="color:#98C379;"> :param offset: 需要跳过的起始行数(默认 0)。</span></span> |
| <span class="line"><span style="color:#98C379;"> :param limit: 最多返回的行数;< 0 表示不限制。</span></span> |
| <span class="line"><span style="color:#98C379;"> :param tag_filter: 可选的标签谓词(TagFilter),None 表示不过滤。</span></span> |
| <span class="line"><span style="color:#98C379;"> :param batch_size: <= 0 逐行返回;> 0 按该大小返回数据块。</span></span> |
| <span class="line"><span style="color:#98C379;"> :return: 查询结果集处理器。</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_by_row</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;">, column_names : List[</span><span style="color:#56B6C2;">str</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> offset : </span><span style="color:#E06C75;font-style:italic;">int</span><span style="color:#56B6C2;"> =</span><span style="color:#D19A66;"> 0</span><span style="color:#ABB2BF;">, limit : </span><span style="color:#E06C75;font-style:italic;">int</span><span style="color:#56B6C2;"> =</span><span style="color:#56B6C2;"> -</span><span style="color:#D19A66;">1</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;font-style:italic;"> tag_filter</span><span style="color:#56B6C2;"> =</span><span style="color:#D19A66;"> None</span><span style="color:#ABB2BF;">, batch_size : </span><span style="color:#E06C75;font-style:italic;">int</span><span style="color:#56B6C2;"> =</span><span style="color:#D19A66;"> 0</span><span style="color:#ABB2BF;">) </span><span style="color:#FFFFFF;">-></span><span style="color:#ABB2BF;"> ResultSet</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#98C379;"> 获取指定表的模式信息。</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> :param table_name: 表名。</span></span> |
| <span class="line"><span style="color:#98C379;"> :return: 指定表的模式信息。</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 style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#98C379;"> 获取 TsFile 中所有表的模式信息。</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> :return: 一个将表名映射到其模式的字典。</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 style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#98C379;"> 关闭 TsFile 读取器。如果读取器中有活动的结果集,它们将失效。</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></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;"> 用于从查询结果集中获取数据。当执行查询时,将返回一个结果集处理器。</span></span> |
| <span class="line"><span style="color:#98C379;"> 如果读取器被关闭,该结果集将失效。</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;"> 检查并移动到查询结果集中的下一行。</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> :return: 如果存在下一行则返回 True,否则返回 False。</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 style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#98C379;"> 获取结果集的列信息。</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> :return: 一个字典,键为列名,值为对应的数据类型。</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:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#98C379;"> 从查询结果集中读取下一个 DataFrame。</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> :param max_row_num: 要读取的最大行数,默认值为 1024。</span></span> |
| <span class="line"><span style="color:#98C379;"> :return: 包含查询结果数据的 DataFrame。</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_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:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#98C379;"> 从查询结果集中按索引获取值。</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> :param index: 要获取值的索引,1 <= index <= column_num。</span></span> |
| <span class="line"><span style="color:#98C379;"> :return: 指定索引处的值。</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:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#98C379;"> 从查询结果集中按列名获取值。</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> :param column_name: 要获取值的列名。</span></span> |
| <span class="line"><span style="color:#98C379;"> :return: 指定列的值。</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:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#98C379;"> 获取结果集的元数据信息。</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> :return: 结果集的元数据,类型为 ResultSetMetadata 对象。</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> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#98C379;"> 检查结果集中指定索引位置的字段是否为 null。</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> :param index: 要检查的字段索引,1 <= index <= column_num。</span></span> |
| <span class="line"><span style="color:#98C379;"> :return: 若字段为 null 返回 True,否则返回 False。</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:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#98C379;"> 检查结果集中指定列名的字段是否为 null。</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> :param name: 要检查的列名。</span></span> |
| <span class="line"><span style="color:#98C379;"> :return: 若字段为 null 返回 True,否则返回 False。</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:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#98C379;"> 关闭结果集并释放相关资源。</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></div><h3 id="to-dataframe" tabindex="-1"><a class="header-anchor" href="#to-dataframe"><span>to_dataframe</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> |
| <span class="line"><span style="color:#C678DD;">def</span><span style="color:#61AFEF;"> to_dataframe</span><span style="color:#ABB2BF;">(</span><span style="color:#D19A66;font-style:italic;">file_path</span><span style="color:#ABB2BF;">: </span><span style="color:#56B6C2;">str</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;font-style:italic;"> table_name</span><span style="color:#ABB2BF;">: Optional[</span><span style="color:#56B6C2;">str</span><span style="color:#ABB2BF;">] </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;"> column_names</span><span style="color:#ABB2BF;">: Optional[list[</span><span style="color:#56B6C2;">str</span><span style="color:#ABB2BF;">]] </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;"> start_time</span><span style="color:#ABB2BF;">: Optional[</span><span style="color:#56B6C2;">int</span><span style="color:#ABB2BF;">] </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;"> end_time</span><span style="color:#ABB2BF;">: Optional[</span><span style="color:#56B6C2;">int</span><span style="color:#ABB2BF;">] </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_row_num</span><span style="color:#ABB2BF;">: Optional[</span><span style="color:#56B6C2;">int</span><span style="color:#ABB2BF;">] </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;"> as_iterator</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;">) -> Union[pd.DataFrame, Iterator[pd.DataFrame]]:</span></span> |
| <span class="line"><span style="color:#98C379;"> """</span></span> |
| <span class="line"><span style="color:#98C379;"> 从 TsFile 中读取数据,并将其转换为 Pandas DataFrame</span></span> |
| <span class="line"><span style="color:#98C379;"> 或 DataFrame 迭代器。</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> 用户可以通过表名、列名、时间范围以及最大行数对数据进行过滤。</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> Parameters</span></span> |
| <span class="line"><span style="color:#98C379;"> ----------</span></span> |
| <span class="line"><span style="color:#98C379;"> file_path : str</span></span> |
| <span class="line"><span style="color:#98C379;"> 要读取的 TsFile 文件路径。</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> table_name : Optional[str], default None</span></span> |
| <span class="line"><span style="color:#98C379;"> 表模型 TsFile 中要查询的表名。</span></span> |
| <span class="line"><span style="color:#98C379;"> 如果为 None 且文件为表模型,</span></span> |
| <span class="line"><span style="color:#98C379;"> 将使用 schema 中找到的第一个表。</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> column_names : Optional[list[str]], default None</span></span> |
| <span class="line"><span style="color:#98C379;"> 要查询的列名/测点名列表。</span></span> |
| <span class="line"><span style="color:#98C379;"> - 如果为 None,则返回所有列。</span></span> |
| <span class="line"><span style="color:#98C379;"> - 在表模型 TsFile 中会校验列是否存在。</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> start_time : Optional[int], default None</span></span> |
| <span class="line"><span style="color:#98C379;"> 查询的起始时间戳。</span></span> |
| <span class="line"><span style="color:#98C379;"> 如果为 None,则使用 int64 的最小值。</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> end_time : Optional[int], default None</span></span> |
| <span class="line"><span style="color:#98C379;"> 查询的结束时间戳。</span></span> |
| <span class="line"><span style="color:#98C379;"> 如果为 None,则使用 int64 的最大值。</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> max_row_num : Optional[int], default None</span></span> |
| <span class="line"><span style="color:#98C379;"> 读取的最大行数。</span></span> |
| <span class="line"><span style="color:#98C379;"> - 如果为 None,则返回所有可用数据。</span></span> |
| <span class="line"><span style="color:#98C379;"> - 当 `as_iterator` 为 False 时,</span></span> |
| <span class="line"><span style="color:#98C379;"> 若结果行数超过该值,DataFrame 将被截断。</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> as_iterator : bool, default False</span></span> |
| <span class="line"><span style="color:#98C379;"> 是否返回 DataFrame 迭代器,而不是单个合并后的 DataFrame。</span></span> |
| <span class="line"><span style="color:#98C379;"> - True:返回按批次生成 DataFrame 的迭代器</span></span> |
| <span class="line"><span style="color:#98C379;"> - False:返回单个 Pandas DataFrame</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> Returns</span></span> |
| <span class="line"><span style="color:#98C379;"> -------</span></span> |
| <span class="line"><span style="color:#98C379;"> Union[pandas.DataFrame, Iterator[pandas.DataFrame]]</span></span> |
| <span class="line"><span style="color:#98C379;"> - 当 `as_iterator` 为 False 时,返回 Pandas DataFrame</span></span> |
| <span class="line"><span style="color:#98C379;"> - 当 `as_iterator` 为 True 时,返回 Pandas DataFrame 迭代器</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> Raises</span></span> |
| <span class="line"><span style="color:#98C379;"> ------</span></span> |
| <span class="line"><span style="color:#98C379;"> TableNotExistError</span></span> |
| <span class="line"><span style="color:#98C379;"> 当指定的表名在表模型 TsFile 中不存在时抛出。</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#98C379;"> ColumnNotExistError</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 class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="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/zh/UserGuide/develop/QuickStart/InterfaceDefinition/InterfaceDefinition-Python.md" aria-label="发现错误?在 GitHub 上编辑此页" rel="noopener noreferrer" target="_blank" iconsizing="both"><!--[--><svg xmlns="http://www.w3.org/2000/svg" class="icon edit-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="edit icon" name="edit"><path d="M430.818 653.65a60.46 60.46 0 0 1-50.96-93.281l71.69-114.012 7.773-10.365L816.038 80.138A60.46 60.46 0 0 1 859.225 62a60.46 60.46 0 0 1 43.186 18.138l43.186 43.186a60.46 60.46 0 0 1 0 86.373L588.879 565.55l-8.637 8.637-117.466 68.234a60.46 60.46 0 0 1-31.958 11.229z"></path><path d="M728.802 962H252.891A190.883 190.883 0 0 1 62.008 771.98V296.934a190.883 190.883 0 0 1 190.883-192.61h267.754a60.46 60.46 0 0 1 0 120.92H252.891a69.962 69.962 0 0 0-69.098 69.099V771.98a69.962 69.962 0 0 0 69.098 69.098h475.911A69.962 69.962 0 0 0 797.9 771.98V503.363a60.46 60.46 0 1 1 120.922 0V771.98A190.883 190.883 0 0 1 728.802 962z"></path></svg><!--]-->发现错误?在 GitHub 上编辑此页<!----></a></div><div class="vp-meta-item git-info"><div class="update-time"><span class="vp-meta-label">上次编辑于: </span><span class="vp-meta-info" data-allow-mismatch="text">2026/8/5 08:07:22</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 © 2026 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-CJVB9bAA.js" defer></script> |
| </body> |
| </html> |