| <!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://iotdb.apache.org/zh/UserGuide/latest/Tools-System/Data-Import-Tool.html"><meta property="og:url" content="https://iotdb.apache.org/UserGuide/latest/Tools-System/Data-Import-Tool.html"><meta property="og:site_name" content="IoTDB Website"><meta property="og:title" content="Data Import"><meta property="og:description" content="Data Import 1. Overview IoTDB supports two methods for data import: Data Import Tool: Use the import-data.sh (Unix/OS X) or import-data.bat (Windows) script in the tools directo..."><meta property="og:type" content="article"><meta property="og:image" content="https://iotdb.apache.org/img/Data-import2.png"><meta property="og:locale" content="en-US"><meta property="og:locale:alternate" content="zh-CN"><meta property="og:updated_time" content="2025-03-13T04:27:49.000Z"><meta property="article:modified_time" content="2025-03-13T04:27:49.000Z"><script type="application/ld+json">{"@context":"https://schema.org","@type":"Article","headline":"Data Import","image":["https://iotdb.apache.org/img/Data-import2.png"],"dateModified":"2025-03-13T04:27:49.000Z","author":[]}</script><link rel="icon" href="/favicon.ico"><meta name="Description" content="Apache IoTDB: Time Series Database for IoT"><meta name="Keywords" content="TSDB, time series, time series database, IoTDB, IoT database, IoT data management, 时序数据库, 时间序列管理, IoTDB, 物联网数据库, 实时数据库, 物联网数据管理, 物联网数据"><meta name="baidu-site-verification" content="wfKETzB3OT"><meta name="google-site-verification" content="mZWAoRY0yj_HAr-s47zHCGHzx5Ju-RVm5wDbPnwQYFo"><script type="text/javascript">var _paq = window._paq = window._paq || []; |
| /* tracker methods like "setCustomDimension" should be called before "trackPageView" */ |
| _paq.push(["setDoNotTrack", true]); |
| _paq.push(["disableCookies"]); |
| _paq.push(['trackPageView']); |
| _paq.push(['enableLinkTracking']); |
| (function() { |
| var u="https://analytics.apache.org/"; |
| _paq.push(['setTrackerUrl', u+'matomo.php']); |
| _paq.push(['setSiteId', '56']); |
| var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; |
| g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s); |
| })(); |
| </script><title>Data Import | IoTDB Website</title><meta name="description" content="Data Import 1. Overview IoTDB supports two methods for data import: Data Import Tool: Use the import-data.sh (Unix/OS X) or import-data.bat (Windows) script in the tools directo..."> |
| <link rel="preload" href="/assets/style-CI4qIzxp.css" as="style"><link rel="stylesheet" href="/assets/style-CI4qIzxp.css"> |
| <link rel="modulepreload" href="/assets/app-C-fAkKj6.js"><link rel="modulepreload" href="/assets/Data-Import-Tool.html-EI7c9zhQ.js"><link rel="modulepreload" href="/assets/Data-import2-BZF6IR58.js"> |
| |
| </head> |
| <body> |
| <div id="app"><!--[--><!--[--><!--[--><span tabindex="-1"></span><a href="#main-content" class="vp-skip-link sr-only">Skip to main content</a><!--]--><!--[--><div class="theme-container external-link-icon has-toc" vp-container><!--[--><header id="navbar" class="vp-navbar" vp-navbar><div class="vp-navbar-start"><button type="button" class="vp-toggle-sidebar-button" title="Toggle Sidebar"><span class="icon"></span></button><!--[--><a class="route-link vp-brand" href="/" aria-label="Take me home"><img class="vp-nav-logo" src="/logo.png" alt><!----><!----></a><!--]--></div><div class="vp-navbar-center"><!--[--><!--]--></div><div class="vp-navbar-end"><!--[--><!--[--><div id="docsearch-container" style="display:none;"></div><div><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="/UserGuide/latest/QuickStart/QuickStart_apache.html" aria-label="v2.0.x" iconsizing="both"><!---->v2.0.x<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/UserGuide/V1.3.x/QuickStart/QuickStart_apache.html" aria-label="v1.3.x" iconsizing="both"><!---->v1.3.x<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/UserGuide/V1.2.x/QuickStart/QuickStart.html" aria-label="v1.2.x" iconsizing="both"><!---->v1.2.x<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/UserGuide/V0.13.x/QuickStart/QuickStart.html" aria-label="v0.13.x" iconsizing="both"><!---->v0.13.x<!----></a></li></ul></button></div></div><div class="vp-nav-item hide-in-mobile"><a class="auto-link external-link" href="https://cwiki.apache.org/confluence/display/IOTDB/System+Design" aria-label="Design" rel="noopener noreferrer" target="_blank" iconsizing="height"><!---->Design<!----></a></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="Community"><!--[--><!---->Community<!--]--><span class="arrow"></span><ul class="vp-dropdown"><li class="vp-dropdown-item"><a class="route-link auto-link" href="/Community/About-the-Community.html" aria-label="About the Community" iconsizing="both"><!---->About the Community<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/Community/Development-Guide.html" aria-label="Development Guide" iconsizing="both"><!---->Development Guide<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/Community/Community-Partners.html" aria-label="Community Partners" iconsizing="both"><!---->Community Partners<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/Community/Communication-Channels.html" aria-label="Communication Channels" iconsizing="both"><!---->Communication Channels<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/Community/Events-and-Reports.html" aria-label="Events and Reports" iconsizing="both"><!---->Events and Reports<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/Community/Committers.html" aria-label="Committers" iconsizing="both"><!---->Committers<!----></a></li></ul></button></div></div><div class="vp-nav-item hide-in-mobile"><div class="vp-dropdown-wrapper"><button type="button" class="vp-dropdown-title" aria-label="ASF"><!--[--><!---->ASF<!--]--><span class="arrow"></span><ul class="vp-dropdown"><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/" aria-label="Foundation" rel="noopener noreferrer" target="_blank" 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" rel="noopener noreferrer" target="_blank" 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" rel="noopener noreferrer" target="_blank" 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/latest/Tools-System/Data-Import-Tool.html" aria-label="English" iconsizing="both"><!---->English<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/zh/UserGuide/latest/Tools-System/Data-Import-Tool.html" aria-label="简体中文" iconsizing="both"><!---->简体中文<!----></a></li></ul></button></div></div><div class="vp-nav-item hide-in-mobile"><button type="button" class="vp-color-mode-switch" id="color-mode-switch"><svg xmlns="http://www.w3.org/2000/svg" class="icon auto-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="auto icon" name="auto" style="display:none;"><path d="M512 992C246.92 992 32 777.08 32 512S246.92 32 512 32s480 214.92 480 480-214.92 480-480 480zm0-840c-198.78 0-360 161.22-360 360 0 198.84 161.22 360 360 360s360-161.16 360-360c0-198.78-161.22-360-360-360zm0 660V212c165.72 0 300 134.34 300 300 0 165.72-134.28 300-300 300z"></path></svg><svg xmlns="http://www.w3.org/2000/svg" class="icon dark-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="dark icon" name="dark" style="display:none;"><path d="M524.8 938.667h-4.267a439.893 439.893 0 0 1-313.173-134.4 446.293 446.293 0 0 1-11.093-597.334A432.213 432.213 0 0 1 366.933 90.027a42.667 42.667 0 0 1 45.227 9.386 42.667 42.667 0 0 1 10.24 42.667 358.4 358.4 0 0 0 82.773 375.893 361.387 361.387 0 0 0 376.747 82.774 42.667 42.667 0 0 1 54.187 55.04 433.493 433.493 0 0 1-99.84 154.88 438.613 438.613 0 0 1-311.467 128z"></path></svg><svg xmlns="http://www.w3.org/2000/svg" class="icon light-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="light icon" name="light" style="display:block;"><path d="M952 552h-80a40 40 0 0 1 0-80h80a40 40 0 0 1 0 80zM801.88 280.08a41 41 0 0 1-57.96-57.96l57.96-58a41.04 41.04 0 0 1 58 58l-58 57.96zM512 752a240 240 0 1 1 0-480 240 240 0 0 1 0 480zm0-560a40 40 0 0 1-40-40V72a40 40 0 0 1 80 0v80a40 40 0 0 1-40 40zm-289.88 88.08-58-57.96a41.04 41.04 0 0 1 58-58l57.96 58a41 41 0 0 1-57.96 57.96zM192 512a40 40 0 0 1-40 40H72a40 40 0 0 1 0-80h80a40 40 0 0 1 40 40zm30.12 231.92a41 41 0 0 1 57.96 57.96l-57.96 58a41.04 41.04 0 0 1-58-58l58-57.96zM512 832a40 40 0 0 1 40 40v80a40 40 0 0 1-80 0v-80a40 40 0 0 1 40-40zm289.88-88.08 58 57.96a41.04 41.04 0 0 1-58 58l-57.96-58a41 41 0 0 1 57.96-57.96z"></path></svg></button></div><div class="vp-nav-item vp-action"><a class="vp-action-link" href="https://github.com/apache/iotdb" target="_blank" rel="noopener noreferrer" aria-label="GitHub"><svg xmlns="http://www.w3.org/2000/svg" class="icon github-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="github icon" name="github" style="width:1.25rem;height:1.25rem;vertical-align:middle;"><path d="M511.957 21.333C241.024 21.333 21.333 240.981 21.333 512c0 216.832 140.544 400.725 335.574 465.664 24.49 4.395 32.256-10.07 32.256-23.083 0-11.69.256-44.245 0-85.205-136.448 29.61-164.736-64.64-164.736-64.64-22.315-56.704-54.4-71.765-54.4-71.765-44.587-30.464 3.285-29.824 3.285-29.824 49.195 3.413 75.179 50.517 75.179 50.517 43.776 75.008 114.816 53.333 142.762 40.79 4.523-31.66 17.152-53.377 31.19-65.537-108.971-12.458-223.488-54.485-223.488-242.602 0-53.547 19.114-97.323 50.517-131.67-5.035-12.33-21.93-62.293 4.779-129.834 0 0 41.258-13.184 134.912 50.346a469.803 469.803 0 0 1 122.88-16.554c41.642.213 83.626 5.632 122.88 16.554 93.653-63.488 134.784-50.346 134.784-50.346 26.752 67.541 9.898 117.504 4.864 129.834 31.402 34.347 50.474 78.123 50.474 131.67 0 188.586-114.73 230.016-224.042 242.09 17.578 15.232 33.578 44.672 33.578 90.454v135.85c0 13.142 7.936 27.606 32.854 22.87C862.25 912.597 1002.667 728.747 1002.667 512c0-271.019-219.648-490.667-490.71-490.667z"></path></svg></a></div><!--]--><button type="button" class="vp-toggle-navbar-button" aria-label="Toggle Navbar" aria-expanded="false" aria-controls="nav-screen"><span><span class="vp-top"></span><span class="vp-middle"></span><span class="vp-bottom"></span></span></button></div></header><!----><!--]--><!----><div class="toggle-sidebar-wrapper"><span class="arrow start"></span></div><aside id="sidebar" class="vp-sidebar iotdb-sidebar" vp-sidebar><!--[--><p class="vp-sidebar-header iotdb-sidebar-header"><span class="vp-sidebar-title">IoTDB User Guide (V2.0.x)</span></p><div class="sidebar-top-wrapper"><ul class="switch-list"><li class="switch-type switch-active">Tree</li><li class="switch-type">Table</li></ul></div><!--]--><ul class="vp-sidebar-links"><li><section class="vp-sidebar-group"><p class="vp-sidebar-header"><!----><span class="vp-sidebar-title">IoTDB User Guide (V2.0.x)</span><!----></p><ul class="vp-sidebar-links"></ul></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">About IoTDB</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Background knowledge</span><span class="vp-arrow end"></span></button><!----></section></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/latest/QuickStart/QuickStart_apache.html" aria-label="Quick Start" iconsizing="both"><!---->Quick Start<!----></a></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Deployment & Maintenance</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Basic Functions</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Advanced Features</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">AI capability</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable active" type="button"><!----><span class="vp-sidebar-title">Tools System</span><span class="vp-arrow down"></span></button><ul class="vp-sidebar-links"><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/latest/Tools-System/CLI.html" aria-label="Command Line Interface (CLI)" iconsizing="both"><!---->Command Line Interface (CLI)<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/latest/Tools-System/Monitor-Tool_apache.html" aria-label="Monitor Tool" iconsizing="both"><!---->Monitor Tool<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/latest/Tools-System/Benchmark.html" aria-label="Benchmark Tool" iconsizing="both"><!---->Benchmark Tool<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/latest/Tools-System/Maintenance-Tool_apache.html" aria-label="Cluster Management Tool" iconsizing="both"><!---->Cluster Management Tool<!----></a></li><li><a class="route-link route-link-active auto-link vp-sidebar-link active" href="/UserGuide/latest/Tools-System/Data-Import-Tool.html" aria-label="Data Import" iconsizing="both"><!---->Data Import<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/latest/Tools-System/Data-Export-Tool.html" aria-label="Data Export" iconsizing="both"><!---->Data Export<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/latest/Tools-System/Backup-Tool.html" aria-label="Full Backup Tool" iconsizing="both"><!---->Full Backup Tool<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/latest/Tools-System/Health-Check-Tool.html" aria-label="Health Check Tool" iconsizing="both"><!---->Health Check Tool<!----></a></li></ul></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">API</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Ecosystem Integration</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">SQL Manual</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Technical Insider</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Reference</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">FAQ</span><span class="vp-arrow end"></span></button><!----></section></li></ul><!----></aside><!--[--><main id="main-content" class="vp-page"><!--[--><!----><!----><nav class="vp-breadcrumb disable"></nav><div class="vp-page-title"><h1><!---->Data Import</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">November 19, 2024</span><meta property="datePublished" content="2024-11-19T07:34:27.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 5 min</span><meta property="timeRequired" content="PT5M"></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="#_1-overview">1. Overview</a></li><!----><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level2" href="#_2-data-import-tool">2. Data Import Tool</a></li><li><ul class="vp-toc-list"><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level3" href="#_2-1-common-parameters">2.1 Common Parameters</a></li><!----><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level3" href="#_2-2-csv-format">2.2 CSV Format</a></li><!----><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level3" href="#_2-3-sql-format">2.3 SQL Format</a></li><!----><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level3" href="#_2-4-tsfile-format">2.4 TsFile Format</a></li><!----><!--]--></ul></li><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level2" href="#_3-tsfile-auto-loading">3. TsFile Auto-Loading</a></li><li><ul class="vp-toc-list"><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level3" href="#_3-1-configuration">3.1 Configuration</a></li><!----><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level3" href="#_3-2-notes">3.2 Notes</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="data-import" tabindex="-1"><a class="header-anchor" href="#data-import"><span>Data Import</span></a></h1><h2 id="_1-overview" tabindex="-1"><a class="header-anchor" href="#_1-overview"><span>1. Overview</span></a></h2><p>IoTDB supports two methods for data import:</p><ul><li>Data Import Tool: Use the <a href="http://import-data.sh" target="_blank" rel="noopener noreferrer">import-data.sh</a> (Unix/OS X) or import-data.bat (Windows) script in the tools directory to manually import CSV, SQL, or TsFile (open-source time-series file format) data into IoTDB.</li><li>TsFile Auto-Loading Feature</li></ul><table style="text-align:left;"><tbody><tr><th>File Format</th><th>IoTDB Tool</th><th>Description</th></tr><tr><td>CSV</td><td rowspan="3">import-data.sh/bat</td><td>Can be used for single or batch import of CSV files into IoTDB</td></tr><tr><td>SQL</td><td>Can be used for single or batch import of SQL files into IoTDB</td></tr><tr><td rowspan="2">TsFile</td><td>Can be used for single or batch import of TsFile files into IoTDB</td></tr><tr><td>TsFile Auto-Loading Feature</td><td>Can automatically monitor a specified directory for newly generated TsFiles and load them into IoTDB.</td></tr></tbody></table><h2 id="_2-data-import-tool" tabindex="-1"><a class="header-anchor" href="#_2-data-import-tool"><span>2. Data Import Tool</span></a></h2><h3 id="_2-1-common-parameters" tabindex="-1"><a class="header-anchor" href="#_2-1-common-parameters"><span>2.1 Common Parameters</span></a></h3><table><thead><tr><th>Short</th><th>Full Parameter</th><th>Description</th><th>Required</th><th>Default</th></tr></thead><tbody><tr><td><code>-ft</code></td><td><code>--file_type</code></td><td>File type: <code>csv</code>, <code>sql</code>, <code>tsfile</code>.</td><td><strong>Yes</strong></td><td>-</td></tr><tr><td><code>-h</code></td><td><code>--host</code></td><td>IoTDB server hostname.</td><td>No</td><td><code>127.0.0.1</code></td></tr><tr><td><code>-p</code></td><td><code>--port</code></td><td>IoTDB server port.</td><td>No</td><td><code>6667</code></td></tr><tr><td><code>-u</code></td><td><code>--username</code></td><td>Username.</td><td>No</td><td><code>root</code></td></tr><tr><td><code>-pw</code></td><td><code>--password</code></td><td>Password.</td><td>No</td><td><code>root</code></td></tr><tr><td><code>-s</code></td><td><code>--source</code></td><td>Local path to the file/directory to import. <strong>Supported formats</strong>: CSV, SQL, TsFile. Unsupported formats trigger error: <code>The file name must end with "csv", "sql", or "tsfile"!</code></td><td><strong>Yes</strong></td><td>-</td></tr><tr><td><code>-tn</code></td><td><code>--thread_num</code></td><td>Maximum parallel threads</td><td>No</td><td><code>8</code> <br> Range: 0 to Integer.Max(2147483647).</td></tr><tr><td><code>-tz</code></td><td><code>--timezone</code></td><td>Timezone (e.g., <code>+08:00</code>, <code>-01:00</code>).</td><td>No</td><td>System default</td></tr><tr><td><code>-help</code></td><td><code>--help</code></td><td>Display help (general or format-specific: <code>-help csv</code>).</td><td>No</td><td>-</td></tr></tbody></table><h3 id="_2-2-csv-format" tabindex="-1"><a class="header-anchor" href="#_2-2-csv-format"><span>2.2 CSV Format</span></a></h3><h4 id="_2-2-1-command" tabindex="-1"><a class="header-anchor" href="#_2-2-1-command"><span>2.2.1 Command</span></a></h4><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#7F848E;font-style:italic;"># Unix/OS X</span></span> |
| <span class="line"><span style="color:#ABB2BF;">> tools/import-data.sh -ft<format> [-h </span><span style="color:#56B6C2;"><</span><span style="color:#ABB2BF;">host</span><span style="color:#56B6C2;">></span><span style="color:#ABB2BF;">] [-p </span><span style="color:#56B6C2;"><</span><span style="color:#ABB2BF;">port</span><span style="color:#56B6C2;">></span><span style="color:#ABB2BF;">] [-u </span><span style="color:#56B6C2;"><</span><span style="color:#ABB2BF;">username</span><span style="color:#56B6C2;">></span><span style="color:#ABB2BF;">] [-pw </span><span style="color:#56B6C2;"><</span><span style="color:#ABB2BF;">password</span><span style="color:#56B6C2;">></span><span style="color:#ABB2BF;">]</span></span> |
| <span class="line"><span style="color:#61AFEF;"> -s</span><span style="color:#ABB2BF;"> <</span><span style="color:#98C379;">sourc</span><span style="color:#ABB2BF;">e> [-fd <</span><span style="color:#98C379;">fail_di</span><span style="color:#ABB2BF;">r></span><span style="color:#98C379;">]</span><span style="color:#ABB2BF;"> [-lpf <</span><span style="color:#98C379;">lines_per_failed_fil</span><span style="color:#ABB2BF;">e></span><span style="color:#98C379;">]</span><span style="color:#ABB2BF;"> [-aligned <</span><span style="color:#98C379;">use</span><span style="color:#98C379;"> the</span><span style="color:#98C379;"> aligned</span><span style="color:#98C379;"> interfac</span><span style="color:#ABB2BF;">e></span><span style="color:#98C379;">]</span><span style="color:#ABB2BF;"> </span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [-ti </span><span style="color:#56B6C2;"><</span><span style="color:#ABB2BF;">type_infer</span><span style="color:#56B6C2;">></span><span style="color:#ABB2BF;">] [-tp </span><span style="color:#56B6C2;"><</span><span style="color:#ABB2BF;">timestamp precision (</span><span style="color:#E06C75;">ms</span><span style="color:#56B6C2;">/</span><span style="color:#E06C75;">us</span><span style="color:#56B6C2;">/</span><span style="color:#E06C75;">ns</span><span style="color:#ABB2BF;">)</span><span style="color:#56B6C2;">></span><span style="color:#ABB2BF;">] [-tz </span><span style="color:#56B6C2;"><</span><span style="color:#ABB2BF;">timezone</span><span style="color:#56B6C2;">></span><span style="color:#ABB2BF;">] [-batch </span><span style="color:#56B6C2;"><</span><span style="color:#ABB2BF;">batch_size</span><span style="color:#56B6C2;">></span><span style="color:#ABB2BF;">] </span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [-tn </span><span style="color:#56B6C2;"><</span><span style="color:#ABB2BF;">thread_num</span><span style="color:#56B6C2;">></span><span style="color:#ABB2BF;">]</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> </span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"># Windows</span></span> |
| <span class="line"><span style="color:#ABB2BF;">> tools</span><span style="color:#56B6C2;">\i</span><span style="color:#ABB2BF;">mport-data.bat -ft<format> [-h </span><span style="color:#56B6C2;"><</span><span style="color:#ABB2BF;">host</span><span style="color:#56B6C2;">></span><span style="color:#ABB2BF;">] [-p </span><span style="color:#56B6C2;"><</span><span style="color:#ABB2BF;">port</span><span style="color:#56B6C2;">></span><span style="color:#ABB2BF;">] [-u </span><span style="color:#56B6C2;"><</span><span style="color:#ABB2BF;">username</span><span style="color:#56B6C2;">></span><span style="color:#ABB2BF;">] [-pw </span><span style="color:#56B6C2;"><</span><span style="color:#ABB2BF;">password</span><span style="color:#56B6C2;">></span><span style="color:#ABB2BF;">]</span></span> |
| <span class="line"><span style="color:#61AFEF;"> -s</span><span style="color:#ABB2BF;"> <</span><span style="color:#98C379;">sourc</span><span style="color:#ABB2BF;">e> [-fd <</span><span style="color:#98C379;">fail_di</span><span style="color:#ABB2BF;">r></span><span style="color:#98C379;">]</span><span style="color:#ABB2BF;"> [-lpf <</span><span style="color:#98C379;">lines_per_failed_fil</span><span style="color:#ABB2BF;">e></span><span style="color:#98C379;">]</span><span style="color:#ABB2BF;"> [-aligned <</span><span style="color:#98C379;">use</span><span style="color:#98C379;"> the</span><span style="color:#98C379;"> aligned</span><span style="color:#98C379;"> interfac</span><span style="color:#ABB2BF;">e></span><span style="color:#98C379;">]</span><span style="color:#ABB2BF;"> </span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [-ti </span><span style="color:#56B6C2;"><</span><span style="color:#ABB2BF;">type_infer</span><span style="color:#56B6C2;">></span><span style="color:#ABB2BF;">] [-tp </span><span style="color:#56B6C2;"><</span><span style="color:#ABB2BF;">timestamp precision (</span><span style="color:#E06C75;">ms</span><span style="color:#56B6C2;">/</span><span style="color:#E06C75;">us</span><span style="color:#56B6C2;">/</span><span style="color:#E06C75;">ns</span><span style="color:#ABB2BF;">)</span><span style="color:#56B6C2;">></span><span style="color:#ABB2BF;">] [-tz </span><span style="color:#56B6C2;"><</span><span style="color:#ABB2BF;">timezone</span><span style="color:#56B6C2;">></span><span style="color:#ABB2BF;">] [-batch </span><span style="color:#56B6C2;"><</span><span style="color:#ABB2BF;">batch_size</span><span style="color:#56B6C2;">></span><span style="color:#ABB2BF;">] </span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [-tn </span><span style="color:#56B6C2;"><</span><span style="color:#ABB2BF;">thread_num</span><span style="color:#56B6C2;">></span><span style="color:#ABB2BF;">]</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h4 id="_2-2-2-csv-specific-parameters" tabindex="-1"><a class="header-anchor" href="#_2-2-2-csv-specific-parameters"><span>2.2.2 CSV-Specific Parameters</span></a></h4><table><thead><tr><th>Short</th><th>Full Parameter</th><th>Description</th><th>Required</th><th>Default</th></tr></thead><tbody><tr><td><code>-fd</code></td><td><code>--fail_dir</code></td><td>Directory to save failed files.</td><td>No</td><td>YOUR_CSV_FILE_PATH</td></tr><tr><td><code>-lpf</code></td><td><code>--lines_per_failed_file</code></td><td>Max lines per failed file.</td><td>No</td><td><code>100000</code> <br> Range: 0 to Integer.Max(2147483647).</td></tr><tr><td><code>-aligned</code></td><td><code>--use_aligned</code></td><td>Import as aligned time series.</td><td>No</td><td><code>false</code></td></tr><tr><td><code>-batch</code></td><td><code>--batch_size</code></td><td>Rows processed per API call.</td><td>No</td><td><code>100000</code> <br> Range: 0 to Integer.Max(2147483647).</td></tr><tr><td><code>-ti</code></td><td><code>--type_infer</code></td><td>Type mapping (e.g., <code>BOOLEAN=text,INT=long</code>).</td><td>No</td><td>-</td></tr><tr><td><code>-tp</code></td><td><code>--timestamp_precision</code></td><td>Timestamp precision: <code>ms</code>, <code>us</code>, <code>ns</code>.</td><td>No</td><td><code>ms</code></td></tr></tbody></table><h4 id="_2-2-3-examples" tabindex="-1"><a class="header-anchor" href="#_2-2-3-examples"><span>2.2.3 Examples</span></a></h4><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#7F848E;font-style:italic;"># Valid Example</span></span> |
| <span class="line"><span style="color:#ABB2BF;">> tools/import-data.sh -ft csv -h 127.0.0.1 -p 6667 -u root -pw root -s /path/sql </span></span> |
| <span class="line"><span style="color:#61AFEF;"> -fd</span><span style="color:#98C379;"> /path/failure/dir</span><span style="color:#D19A66;"> -lpf</span><span style="color:#D19A66;"> 100</span><span style="color:#D19A66;"> -aligned</span><span style="color:#D19A66;"> true</span><span style="color:#D19A66;"> -ti</span><span style="color:#98C379;"> "BOOLEAN=text,INT=long,FLOAT=double"</span><span style="color:#ABB2BF;"> </span></span> |
| <span class="line"><span style="color:#61AFEF;"> -tp</span><span style="color:#98C379;"> ms</span><span style="color:#D19A66;"> -tz</span><span style="color:#98C379;"> +08:00</span><span style="color:#D19A66;"> -batch</span><span style="color:#D19A66;"> 5000</span><span style="color:#D19A66;"> -tn</span><span style="color:#D19A66;"> 4</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> </span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"># Error Example</span></span> |
| <span class="line"><span style="color:#ABB2BF;">> tools/import-data.sh -ft csv -s /non_path</span></span> |
| <span class="line"><span style="color:#61AFEF;">error:</span><span style="color:#98C379;"> Source</span><span style="color:#98C379;"> file</span><span style="color:#98C379;"> or</span><span style="color:#98C379;"> directory</span><span style="color:#98C379;"> /non_path</span><span style="color:#98C379;"> does</span><span style="color:#98C379;"> not</span><span style="color:#98C379;"> exist</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#ABB2BF;">> tools/import-data.sh -ft csv -s /path/sql -tn 0</span></span> |
| <span class="line"><span style="color:#61AFEF;">error:</span><span style="color:#98C379;"> Invalid</span><span style="color:#98C379;"> thread</span><span style="color:#98C379;"> number</span><span style="color:#98C379;"> '0'.</span><span style="color:#98C379;"> Please</span><span style="color:#98C379;"> set</span><span style="color:#98C379;"> a</span><span style="color:#98C379;"> positive</span><span style="color:#98C379;"> integer.</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h3 id="_2-3-sql-format" tabindex="-1"><a class="header-anchor" href="#_2-3-sql-format"><span>2.3 SQL Format</span></a></h3><h4 id="_2-3-1-command" tabindex="-1"><a class="header-anchor" href="#_2-3-1-command"><span>2.3.1 Command</span></a></h4><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#7F848E;font-style:italic;"># Unix/OS X</span></span> |
| <span class="line"><span style="color:#ABB2BF;">> tools/import-data.sh -ft<format> [-h </span><span style="color:#56B6C2;"><</span><span style="color:#ABB2BF;">host</span><span style="color:#56B6C2;">></span><span style="color:#ABB2BF;">] [-p </span><span style="color:#56B6C2;"><</span><span style="color:#ABB2BF;">port</span><span style="color:#56B6C2;">></span><span style="color:#ABB2BF;">] [-u </span><span style="color:#56B6C2;"><</span><span style="color:#ABB2BF;">username</span><span style="color:#56B6C2;">></span><span style="color:#ABB2BF;">] [-pw </span><span style="color:#56B6C2;"><</span><span style="color:#ABB2BF;">password</span><span style="color:#56B6C2;">></span><span style="color:#ABB2BF;">] </span></span> |
| <span class="line"><span style="color:#61AFEF;"> -s</span><span style="color:#ABB2BF;"><source> [-fd <</span><span style="color:#98C379;">fail_di</span><span style="color:#ABB2BF;">r></span><span style="color:#98C379;">]</span><span style="color:#ABB2BF;"> [-lpf <</span><span style="color:#98C379;">lines_per_failed_fil</span><span style="color:#ABB2BF;">e></span><span style="color:#98C379;">]</span><span style="color:#ABB2BF;"> [-tz <</span><span style="color:#98C379;">timezon</span><span style="color:#ABB2BF;">e></span><span style="color:#98C379;">]</span><span style="color:#ABB2BF;"> </span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [-batch </span><span style="color:#56B6C2;"><</span><span style="color:#ABB2BF;">batch_size</span><span style="color:#56B6C2;">></span><span style="color:#ABB2BF;">] [-tn </span><span style="color:#56B6C2;"><</span><span style="color:#ABB2BF;">thread_num</span><span style="color:#56B6C2;">></span><span style="color:#ABB2BF;">]</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> </span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"># Windows</span></span> |
| <span class="line"><span style="color:#ABB2BF;">> tools</span><span style="color:#56B6C2;">\i</span><span style="color:#ABB2BF;">mport-data.bat -ft<format> [-h </span><span style="color:#56B6C2;"><</span><span style="color:#ABB2BF;">host</span><span style="color:#56B6C2;">></span><span style="color:#ABB2BF;">] [-p </span><span style="color:#56B6C2;"><</span><span style="color:#ABB2BF;">port</span><span style="color:#56B6C2;">></span><span style="color:#ABB2BF;">] [-u </span><span style="color:#56B6C2;"><</span><span style="color:#ABB2BF;">username</span><span style="color:#56B6C2;">></span><span style="color:#ABB2BF;">] [-pw </span><span style="color:#56B6C2;"><</span><span style="color:#ABB2BF;">password</span><span style="color:#56B6C2;">></span><span style="color:#ABB2BF;">] </span></span> |
| <span class="line"><span style="color:#61AFEF;"> -s</span><span style="color:#ABB2BF;"><source> [-fd <</span><span style="color:#98C379;">fail_di</span><span style="color:#ABB2BF;">r></span><span style="color:#98C379;">]</span><span style="color:#ABB2BF;"> [-lpf <</span><span style="color:#98C379;">lines_per_failed_fil</span><span style="color:#ABB2BF;">e></span><span style="color:#98C379;">]</span><span style="color:#ABB2BF;"> [-tz <</span><span style="color:#98C379;">timezon</span><span style="color:#ABB2BF;">e></span><span style="color:#98C379;">]</span><span style="color:#ABB2BF;"> </span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [-batch </span><span style="color:#56B6C2;"><</span><span style="color:#ABB2BF;">batch_size</span><span style="color:#56B6C2;">></span><span style="color:#ABB2BF;">] [-tn </span><span style="color:#56B6C2;"><</span><span style="color:#ABB2BF;">thread_num</span><span style="color:#56B6C2;">></span><span style="color:#ABB2BF;">]</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h4 id="_2-3-2-sql-specific-parameters" tabindex="-1"><a class="header-anchor" href="#_2-3-2-sql-specific-parameters"><span>2.3.2 SQL-Specific Parameters</span></a></h4><table><thead><tr><th>Short</th><th>Full Parameter</th><th>Description</th><th>Required</th><th>Default</th></tr></thead><tbody><tr><td><code>-fd</code></td><td><code>--fail_dir</code></td><td>Directory to save failed files.</td><td>No</td><td>YOUR_CSV_FILE_PATH</td></tr><tr><td><code>-lpf</code></td><td><code>--lines_per_failed_file</code></td><td>Max lines per failed file.</td><td>No</td><td><code>100000</code> <br> Range: 0 to Integer.Max(2147483647).</td></tr><tr><td><code>-batch</code></td><td><code>--batch_size</code></td><td>Rows processed per API call.</td><td>No</td><td><code>100000</code> <br> Range: 0 to Integer.Max(2147483647).</td></tr></tbody></table><h4 id="_2-3-3-examples" tabindex="-1"><a class="header-anchor" href="#_2-3-3-examples"><span>2.3.3 Examples</span></a></h4><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#7F848E;font-style:italic;"># Valid Example</span></span> |
| <span class="line"><span style="color:#ABB2BF;">> tools/import-data.sh -ft sql -h 127.0.0.1 -p 6667 -u root -pw root -s /path/sql </span></span> |
| <span class="line"><span style="color:#61AFEF;"> -fd</span><span style="color:#98C379;"> /path/failure/dir</span><span style="color:#D19A66;"> -lpf</span><span style="color:#D19A66;"> 500</span><span style="color:#D19A66;"> -tz</span><span style="color:#98C379;"> +08:00</span><span style="color:#ABB2BF;"> </span></span> |
| <span class="line"><span style="color:#61AFEF;"> -batch</span><span style="color:#D19A66;"> 100000</span><span style="color:#D19A66;"> -tn</span><span style="color:#D19A66;"> 4</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> </span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"># Error Example</span></span> |
| <span class="line"><span style="color:#ABB2BF;">> tools/import-data.sh -ft sql -s /path/sql -fd /non_path</span></span> |
| <span class="line"><span style="color:#61AFEF;">error:</span><span style="color:#98C379;"> Source</span><span style="color:#98C379;"> file</span><span style="color:#98C379;"> or</span><span style="color:#98C379;"> directory</span><span style="color:#98C379;"> /path/sql</span><span style="color:#98C379;"> does</span><span style="color:#98C379;"> not</span><span style="color:#98C379;"> exist</span></span> |
| <span class="line"></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#ABB2BF;">> tools/import-data.sh -ft sql -s /path/sql -tn 0</span></span> |
| <span class="line"><span style="color:#61AFEF;">error:</span><span style="color:#98C379;"> Invalid</span><span style="color:#98C379;"> thread</span><span style="color:#98C379;"> number</span><span style="color:#98C379;"> '0'.</span><span style="color:#98C379;"> Please</span><span style="color:#98C379;"> set</span><span style="color:#98C379;"> a</span><span style="color:#98C379;"> positive</span><span style="color:#98C379;"> integer.</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></div><h3 id="_2-4-tsfile-format" tabindex="-1"><a class="header-anchor" href="#_2-4-tsfile-format"><span>2.4 TsFile Format</span></a></h3><h4 id="_2-4-1-command" tabindex="-1"><a class="header-anchor" href="#_2-4-1-command"><span>2.4.1 Command</span></a></h4><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#7F848E;font-style:italic;"># Unix/OS X</span></span> |
| <span class="line"><span style="color:#ABB2BF;">> tools/import-data.sh -ft <format> [-h </span><span style="color:#56B6C2;"><</span><span style="color:#ABB2BF;">host</span><span style="color:#56B6C2;">></span><span style="color:#ABB2BF;">] [-p </span><span style="color:#56B6C2;"><</span><span style="color:#ABB2BF;">port</span><span style="color:#56B6C2;">></span><span style="color:#ABB2BF;">] [-u </span><span style="color:#56B6C2;"><</span><span style="color:#ABB2BF;">username</span><span style="color:#56B6C2;">></span><span style="color:#ABB2BF;">] [-pw </span><span style="color:#56B6C2;"><</span><span style="color:#ABB2BF;">password</span><span style="color:#56B6C2;">></span><span style="color:#ABB2BF;">] </span></span> |
| <span class="line"><span style="color:#61AFEF;"> -s</span><span style="color:#ABB2BF;"> <</span><span style="color:#98C379;">sourc</span><span style="color:#ABB2BF;">e> </span><span style="color:#D19A66;">-os</span><span style="color:#ABB2BF;"> <</span><span style="color:#98C379;">on_succes</span><span style="color:#ABB2BF;">s> [-sd <</span><span style="color:#98C379;">success_di</span><span style="color:#ABB2BF;">r></span><span style="color:#98C379;">]</span><span style="color:#D19A66;"> -of</span><span style="color:#ABB2BF;"> <</span><span style="color:#98C379;">on_fai</span><span style="color:#ABB2BF;">l> [-fd <</span><span style="color:#98C379;">fail_di</span><span style="color:#ABB2BF;">r></span><span style="color:#98C379;">]</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [-tn </span><span style="color:#56B6C2;"><</span><span style="color:#ABB2BF;">thread_num</span><span style="color:#56B6C2;">></span><span style="color:#ABB2BF;"> ] [-tz </span><span style="color:#56B6C2;"><</span><span style="color:#ABB2BF;">timezone</span><span style="color:#56B6C2;">></span><span style="color:#ABB2BF;">] [-tp </span><span style="color:#56B6C2;"><</span><span style="color:#ABB2BF;">timestamp precision (</span><span style="color:#E06C75;">ms</span><span style="color:#56B6C2;">/</span><span style="color:#E06C75;">us</span><span style="color:#56B6C2;">/</span><span style="color:#E06C75;">ns</span><span style="color:#ABB2BF;">)</span><span style="color:#56B6C2;">></span><span style="color:#ABB2BF;">]</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> </span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"># Windows</span></span> |
| <span class="line"><span style="color:#ABB2BF;">> tools</span><span style="color:#56B6C2;">\i</span><span style="color:#ABB2BF;">mport-data.bat -ft <format> [-h </span><span style="color:#56B6C2;"><</span><span style="color:#ABB2BF;">host</span><span style="color:#56B6C2;">></span><span style="color:#ABB2BF;">] [-p </span><span style="color:#56B6C2;"><</span><span style="color:#ABB2BF;">port</span><span style="color:#56B6C2;">></span><span style="color:#ABB2BF;">] [-u </span><span style="color:#56B6C2;"><</span><span style="color:#ABB2BF;">username</span><span style="color:#56B6C2;">></span><span style="color:#ABB2BF;">] [-pw </span><span style="color:#56B6C2;"><</span><span style="color:#ABB2BF;">password</span><span style="color:#56B6C2;">></span><span style="color:#ABB2BF;">] </span></span> |
| <span class="line"><span style="color:#61AFEF;"> -s</span><span style="color:#ABB2BF;"> <</span><span style="color:#98C379;">sourc</span><span style="color:#ABB2BF;">e> </span><span style="color:#D19A66;">-os</span><span style="color:#ABB2BF;"> <</span><span style="color:#98C379;">on_succes</span><span style="color:#ABB2BF;">s> [-sd <</span><span style="color:#98C379;">success_di</span><span style="color:#ABB2BF;">r></span><span style="color:#98C379;">]</span><span style="color:#D19A66;"> -of</span><span style="color:#ABB2BF;"> <</span><span style="color:#98C379;">on_fai</span><span style="color:#ABB2BF;">l> [-fd <</span><span style="color:#98C379;">fail_di</span><span style="color:#ABB2BF;">r></span><span style="color:#98C379;">]</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [-tn </span><span style="color:#56B6C2;"><</span><span style="color:#ABB2BF;">thread_num</span><span style="color:#56B6C2;">></span><span style="color:#ABB2BF;"> ] [-tz </span><span style="color:#56B6C2;"><</span><span style="color:#ABB2BF;">timezone</span><span style="color:#56B6C2;">></span><span style="color:#ABB2BF;">] [-tp </span><span style="color:#56B6C2;"><</span><span style="color:#ABB2BF;">timestamp precision (</span><span style="color:#E06C75;">ms</span><span style="color:#56B6C2;">/</span><span style="color:#E06C75;">us</span><span style="color:#56B6C2;">/</span><span style="color:#E06C75;">ns</span><span style="color:#ABB2BF;">)</span><span style="color:#56B6C2;">></span><span style="color:#ABB2BF;">]</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h4 id="_2-4-2-tsfile-specific-parameters" tabindex="-1"><a class="header-anchor" href="#_2-4-2-tsfile-specific-parameters"><span>2.4.2 TsFile-Specific Parameters</span></a></h4><table><thead><tr><th>Short</th><th>Full Parameter</th><th>Description</th><th>Required</th><th>Default</th></tr></thead><tbody><tr><td><code>-os</code></td><td><code>--on_success</code></td><td>Action for successful files:<br> <code>none</code>: Do not delete the file.<br> <code>mv</code>: Move the successful file to the target directory.<br> <code>cp</code>:Create a hard link (copy) of the successful file to the target directory.<br> <code>delete</code>:Delete the file.</td><td><strong>Yes</strong></td><td>-</td></tr><tr><td><code>-sd</code></td><td><code>--success_dir</code></td><td>Target directory for <code>mv</code>/<code>cp</code> actions on success. Required if <code>-os</code> is <code>mv</code>/<code>cp</code>. The file name will be flattened and concatenated with the original file name.</td><td>Conditional</td><td><code>${EXEC_DIR}/success</code></td></tr><tr><td><code>-of</code></td><td><code>--on_fail</code></td><td>Action for failed files:<br> <code>none</code>:Skip the file.<br> <code>mv</code>:Move the failed file to the target directory.<br> <code>cp</code>:Create a hard link (copy) of the failed file to the target directory.<br> <code>delete</code>:Delete the file..</td><td><strong>Yes</strong></td><td>-</td></tr><tr><td><code>-fd</code></td><td><code>--fail_dir</code></td><td>Target directory for <code>mv</code>/<code>cp</code> actions on failure. Required if <code>-of</code> is <code>mv</code>/<code>cp</code>. The file name will be flattened and concatenated with the original file name.</td><td>Conditional</td><td><code>${EXEC_DIR}/fail</code></td></tr><tr><td><code>-tp</code></td><td><code>--timestamp_precision</code></td><td>TsFile timestamp precision: <code>ms</code>, <code>us</code>, <code>ns</code>. <br> For non-remote TsFile imports: Use -tp to specify the timestamp precision of the TsFile. The system will manually verify if the timestamp precision matches the server. If it does not match, an error will be returned. <br> For remote TsFile imports: Use -tp to specify the timestamp precision of the TsFile. The Pipe system will automatically verify if the timestamp precision matches. If it does not match, a Pipe error will be returned.</td><td>No</td><td><code>ms</code></td></tr></tbody></table><h4 id="_2-4-3-examples" tabindex="-1"><a class="header-anchor" href="#_2-4-3-examples"><span>2.4.3 Examples</span></a></h4><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#7F848E;font-style:italic;"># Valid Example</span></span> |
| <span class="line"><span style="color:#ABB2BF;">> tools/import-data.sh -ft tsfile -h 127.0.0.1 -p 6667 -u root -pw root </span></span> |
| <span class="line"><span style="color:#61AFEF;"> -s</span><span style="color:#98C379;"> /path/sql</span><span style="color:#D19A66;"> -os</span><span style="color:#98C379;"> mv</span><span style="color:#D19A66;"> -of</span><span style="color:#98C379;"> cp</span><span style="color:#D19A66;"> -sd</span><span style="color:#98C379;"> /path/success/dir</span><span style="color:#D19A66;"> -fd</span><span style="color:#98C379;"> /path/failure/dir</span><span style="color:#ABB2BF;"> </span></span> |
| <span class="line"><span style="color:#61AFEF;"> -tn</span><span style="color:#D19A66;"> 8</span><span style="color:#D19A66;"> -tz</span><span style="color:#98C379;"> +08:00</span><span style="color:#D19A66;"> -tp</span><span style="color:#98C379;"> ms</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> </span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"># Error Example</span></span> |
| <span class="line"><span style="color:#ABB2BF;">> tools/import-data.sh -ft tsfile -s /path/sql -os mv -of cp </span></span> |
| <span class="line"><span style="color:#61AFEF;"> -fd</span><span style="color:#98C379;"> /path/failure/dir</span><span style="color:#D19A66;"> -tn</span><span style="color:#D19A66;"> 8</span><span style="color:#ABB2BF;"> </span></span> |
| <span class="line"><span style="color:#61AFEF;">error:</span><span style="color:#98C379;"> Missing</span><span style="color:#98C379;"> option</span><span style="color:#D19A66;"> --success_dir</span><span style="color:#ABB2BF;"> (or </span><span style="color:#D19A66;">-sd</span><span style="color:#ABB2BF;">) when --on_success is </span><span style="color:#98C379;">'mv'</span><span style="color:#ABB2BF;"> or </span><span style="color:#98C379;">'cp'</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#ABB2BF;">> tools/import-data.sh -ft tsfile -s /path/sql -os mv -of cp </span></span> |
| <span class="line"><span style="color:#61AFEF;"> -sd</span><span style="color:#98C379;"> /path/success/dir</span><span style="color:#D19A66;"> -fd</span><span style="color:#98C379;"> /path/failure/dir</span><span style="color:#D19A66;"> -tn</span><span style="color:#D19A66;"> 0</span><span style="color:#ABB2BF;"> </span></span> |
| <span class="line"><span style="color:#61AFEF;">error:</span><span style="color:#98C379;"> Invalid</span><span style="color:#98C379;"> thread</span><span style="color:#98C379;"> number</span><span style="color:#98C379;"> '0'.</span><span style="color:#98C379;"> Please</span><span style="color:#98C379;"> set</span><span style="color:#98C379;"> a</span><span style="color:#98C379;"> positive</span><span style="color:#98C379;"> integer.</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></div><h2 id="_3-tsfile-auto-loading" tabindex="-1"><a class="header-anchor" href="#_3-tsfile-auto-loading"><span>3. TsFile Auto-Loading</span></a></h2><p>This feature enables IoTDB to automatically monitor a specified directory for new TsFiles and load them into the database without manual intervention.</p><figure><img src="/img/Data-import2.png" alt="" tabindex="0" loading="lazy"><figcaption></figcaption></figure><h3 id="_3-1-configuration" tabindex="-1"><a class="header-anchor" href="#_3-1-configuration"><span>3.1 Configuration</span></a></h3><p>Add the following parameters to <code>iotdb-system.properties</code> (template: <code>iotdb-system.properties.template</code>):</p><table><thead><tr><th>Parameter</th><th>Description</th><th>Value Range</th><th>Required</th><th>Default</th><th>Hot-Load?</th></tr></thead><tbody><tr><td><code>load_active_listening_enable</code></td><td>Enable auto-loading.</td><td><code>true</code>/<code>false</code></td><td>Optional</td><td><code>true</code></td><td>Yes</td></tr><tr><td><code>load_active_listening_dirs</code></td><td>Directories to monitor (subdirectories included). Multiple paths separated by commas.</td><td>String</td><td>Optional</td><td><code>ext/load/pending</code></td><td>Yes</td></tr><tr><td><code>load_active_listening_fail_dir</code></td><td>Directory to store failed TsFiles. Only can set one.</td><td>String</td><td>Optional</td><td><code>ext/load/failed</code></td><td>Yes</td></tr><tr><td><code>load_active_listening_max_thread_num</code></td><td>Maximum Threads for TsFile Loading Tasks:The default value for this parameter, when commented out, is max(1, CPU cores / 2). If the value set by the user falls outside the range [1, CPU cores / 2], it will be reset to the default value of max(1, CPU cores / 2).</td><td><code>1</code> to <code>Long.MAX_VALUE</code></td><td>Optional</td><td><code>max(1, CPU_CORES / 2)</code></td><td>No (restart required)</td></tr><tr><td><code>load_active_listening_check_interval_seconds</code></td><td>Active Listening Polling Interval (in seconds):The active listening feature for TsFiles is implemented through polling the target directory. This configuration specifies the time interval between two consecutive checks of the <code>load_active_listening_dirs</code>. After each check, the next check will be performed after <code>load_active_listening_check_interval_seconds</code> seconds. If the polling interval set by the user is less than 1, it will be reset to the default value of 5 seconds.</td><td><code>1</code> to <code>Long.MAX_VALUE</code></td><td>Optional</td><td><code>5</code></td><td>No (restart required)</td></tr></tbody></table><h3 id="_3-2-notes" tabindex="-1"><a class="header-anchor" href="#_3-2-notes"><span>3.2 Notes</span></a></h3><ol><li><strong>Mods Files</strong>: If TsFiles have associated <code>.mods</code> files, move <code>.mods</code> files to the monitored directory <strong>before</strong> their corresponding TsFiles. Ensure <code>.mods</code> and TsFiles are in the same directory.</li><li><strong>Restricted Directories</strong>: Do NOT set Pipe receiver directories, data directories, or other system paths as monitored directories.</li><li><strong>Directory Conflicts</strong>: Ensure <code>load_active_listening_fail_dir</code> does not overlap with <code>load_active_listening_dirs</code> or its subdirectories.</li><li><strong>Permissions</strong>: The monitored directory must have write permissions. Files are deleted after successful loading; insufficient permissions may cause duplicate loading.</li></ol></div><!----><footer class="vp-page-meta"><div class="vp-meta-item edit-link"><a class="auto-link external-link vp-meta-label" href="https://github.com/apache/iotdb-docs/edit/main/src/UserGuide/latest/Tools-System/Data-Import-Tool.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">3/13/2025, 4:27:49 AM</span></div><!----></div></footer><nav class="vp-page-nav"><a class="route-link auto-link prev" href="/UserGuide/latest/Tools-System/Maintenance-Tool_apache.html" aria-label="Cluster Management Tool" iconsizing="both"><div class="hint"><span class="arrow start"></span>Prev</div><div class="link"><!---->Cluster Management Tool</div></a><a class="route-link auto-link next" href="/UserGuide/latest/Tools-System/Data-Export-Tool.html" aria-label="Data Export" iconsizing="both"><div class="hint">Next<span class="arrow end"></span></div><div class="link">Data Export<!----></div></a></nav><!----><!----><!--]--></main><!--]--><footer class="site-footer"><span id="doc-version" style="display:none;">latest</span><p class="copyright-text">Copyright © 2025 The Apache Software Foundation. |
| Apache IoTDB, IoTDB, Apache, the Apache feather logo, and the Apache IoTDB project logo are either registered trademarks or trademarks of The Apache Software Foundation in all countries</p><p style="text-align:center;margin-top:10px;color:#909399;font-size:12px;margin:0 30px;"><strong>Having questions?</strong> Connect with us on QQ, WeChat, or Slack. <a href="https://github.com/apache/iotdb/issues/1995">Join the community</a></p></footer></div><!--]--><!--]--><!--[--><!----><!--]--><!--]--></div> |
| <script type="module" src="/assets/app-C-fAkKj6.js" defer></script> |
| </body> |
| </html> |
