| <!doctype html> |
| <html lang="en-US" data-theme="light"> |
| <head> |
| <meta charset="utf-8" /> |
| <meta name="viewport" content="width=device-width,initial-scale=1" /> |
| <meta name="generator" content="VuePress 2.0.0-rc.26" /> |
| <meta name="theme" content="VuePress Theme Hope 2.0.0-rc.99" /> |
| <style> |
| :root { |
| --vp-c-bg: #fff; |
| } |
| |
| [data-theme="dark"] { |
| --vp-c-bg: #1b1b1f; |
| } |
| |
| html, |
| body { |
| background: var(--vp-c-bg); |
| } |
| </style> |
| <script> |
| const userMode = localStorage.getItem("vuepress-theme-hope-scheme"); |
| const systemDarkMode = |
| window.matchMedia && |
| window.matchMedia("(prefers-color-scheme: dark)").matches; |
| |
| if (userMode === "dark" || (userMode !== "light" && systemDarkMode)) { |
| document.documentElement.setAttribute("data-theme", "dark"); |
| } |
| </script> |
| <script type="application/ld+json">{"@context":"https://schema.org","@type":"Article","headline":"Command Line Interface (CLI)","image":[""],"dateModified":"2026-03-26T11:09:19.000Z","author":[]}</script><meta property="og:url" content="https://iotdb.apache.org/UserGuide/V1.3.x/Tools-System/CLI_apache.html"><meta property="og:site_name" content="IoTDB Website"><meta property="og:title" content="Command Line Interface (CLI)"><meta property="og:description" content="Command Line Interface (CLI) IoTDB provides Cli/shell tools for users to interact with IoTDB server in command lines. This document shows how Cli/shell tool works and the meanin..."><meta property="og:type" content="article"><meta property="og:locale" content="en-US"><meta property="og:locale:alternate" content="zh-CN"><meta property="og:updated_time" content="2026-03-26T11:09:19.000Z"><meta property="article:modified_time" content="2026-03-26T11:09:19.000Z"><link rel="alternate" hreflang="zh-cn" href="https://iotdb.apache.org/zh/UserGuide/V1.3.x/Tools-System/CLI_apache.html"><script async src="https://widget.kapa.ai/kapa-widget.bundle.js" data-website-id="2d37bfdd-8d98-40ba-9223-9d4f81bfb327" data-project-name="Apache IoTDB" data-project-color="#FFFFFF" data-button-z-index="1999" data-button-padding="4px" data-button-border-radius="4px" data-button-image-height="24px" data-button-image-width="20px" data-button-text-color="#9E2878" data-project-logo="https://iotdb.apache.org/img/logo.svg" data-button-position-right="16px" data-button-position-bottom="8px" data-button-height="56px" data-button-width="48px" data-button-text="Ask" data-modal-override-open-selector="#custom-ask-ai-button" data-modal-image-width="150px" data-modal-title="AI Docs" data-modal-title-color="#9E2878" data-deep-thinking-button-active-bg-color="#F6F7F8" data-deep-thinking-button-active-text-color="#9E2878" data-deep-thinking-button-active-hover-text-color="#9E2878" data-modal-disclaimer="This is a custom LLM for Apache IoTDB with access to all [documentation](iotdb.apache.org/docs/), [GitHub Open Issues, PRs and READMEs](github.com/apache/iotdb). |
| |
| If you encounter <Error in verifying browser for feedback submission. Captcha token could not be obtained.> please ensure that you can access Google services." data-user-analytics-fingerprint-enabled="true" data-consent-required="true" data-consent-screen-disclaimer="By clicking <I agree, let's chat>, you consent to the use of the AI assistant in accordance with kapa.ai's [Privacy Policy](https://www.kapa.ai/content/privacy-policy). This service uses reCAPTCHA, which requires your consent to Google's [Privacy Policy](https://policies.google.com/privacy) and [Terms of Service](https://policies.google.com/terms). By proceeding, you explicitly agree to both kapa.ai's and Google's privacy policies."></script><link rel="icon" href="/favicon.ico"><meta name="Description" content="Apache IoTDB: Time Series Database for IoT"><meta name="Keywords" content="TSDB, time series, time series database, IoTDB, IoT database, IoT data management, 时序数据库, 时间序列管理, IoTDB, 物联网数据库, 实时数据库, 物联网数据管理, 物联网数据"><meta name="baidu-site-verification" content="wfKETzB3OT"><meta name="google-site-verification" content="mZWAoRY0yj_HAr-s47zHCGHzx5Ju-RVm5wDbPnwQYFo"><script type="text/javascript">var _paq = window._paq = window._paq || []; |
| /* tracker methods like "setCustomDimension" should be called before "trackPageView" */ |
| _paq.push(["setDoNotTrack", true]); |
| _paq.push(["disableCookies"]); |
| _paq.push(['trackPageView']); |
| _paq.push(['enableLinkTracking']); |
| (function() { |
| var u="https://analytics.apache.org/"; |
| _paq.push(['setTrackerUrl', u+'matomo.php']); |
| _paq.push(['setSiteId', '56']); |
| var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; |
| g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s); |
| })(); |
| </script><title>Command Line Interface (CLI) | IoTDB Website</title><meta name="description" content="Command Line Interface (CLI) IoTDB provides Cli/shell tools for users to interact with IoTDB server in command lines. This document shows how Cli/shell tool works and the meanin..."> |
| <link rel="preload" href="/assets/style-JraSdRX4.css" as="style"><link rel="stylesheet" href="/assets/style-JraSdRX4.css"> |
| <link rel="modulepreload" href="/assets/app-pmkzp6TS.js"><link rel="modulepreload" href="/assets/CLI_apache.html-CoXVqSIb.js"> |
| |
| </head> |
| <body> |
| <div id="app"><!--[--><!--[--><!--[--><span tabindex="-1"></span><a href="#main-content" class="vp-skip-link sr-only">Skip to main content</a><!--]--><!--[--><div class="theme-container external-link-icon has-toc" vp-container><!--[--><header id="navbar" class="vp-navbar" vp-navbar><div class="vp-navbar-start"><button type="button" class="vp-toggle-sidebar-button" title="Toggle Sidebar"><span class="icon"></span></button><!--[--><a class="route-link vp-brand" href="/" aria-label="Take me home"><img class="vp-nav-logo" src="/logo.png" alt><!----><!----></a><!--]--></div><div class="vp-navbar-center"><!--[--><!--]--></div><div class="vp-navbar-end"><!--[--><!--[--><div id="docsearch-container" style="display:none;"></div><div class="docsearch-placeholder"><button type="button" aria-label="Search" aria-keyshortcuts="Control+k" class="DocSearch DocSearch-Button"><span class="DocSearch-Button-Container"><svg width="20" height="20" viewBox="0 0 24 24" aria-hidden="true" class="DocSearch-Search-Icon"><circle cx="11" cy="11" r="8" stroke="currentColor" fill="none" stroke-width="1.4"></circle><path d="m21 21-4.3-4.3" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"><kbd class="DocSearch-Button-Key DocSearch-Button-Key--ctrl">Ctrl</kbd><kbd class="DocSearch-Button-Key">K</kbd></span></button></div><!--]--><div><button id="custom-ask-ai-button"> ✨ Ask AI </button></div><nav class="vp-nav-links"><div class="vp-nav-item hide-in-mobile"><div class="vp-dropdown-wrapper"><button type="button" class="vp-dropdown-title" aria-label="Documentation"><!--[--><!---->Documentation<!--]--><span class="arrow"></span><ul class="vp-dropdown"><li class="vp-dropdown-item"><a class="route-link auto-link" href="/UserGuide/latest/QuickStart/QuickStart_apache.html" aria-label="v2.0.x"><!---->v2.0.x<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/UserGuide/V1.3.x/QuickStart/QuickStart_apache.html" aria-label="v1.3.x"><!---->v1.3.x<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/UserGuide/V1.2.x/QuickStart/QuickStart.html" aria-label="v1.2.x"><!---->v1.2.x<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/UserGuide/V0.13.x/QuickStart/QuickStart.html" aria-label="v0.13.x"><!---->v0.13.x<!----></a></li></ul></button></div></div><div class="vp-nav-item hide-in-mobile"><a class="auto-link external-link" href="https://cwiki.apache.org/confluence/display/IOTDB/System+Design" aria-label="Design" rel="noopener noreferrer" target="_blank"><!---->Design<!----></a></div><div class="vp-nav-item hide-in-mobile"><a class="route-link auto-link" href="/Download/" aria-label="Download"><!---->Download<!----></a></div><div class="vp-nav-item hide-in-mobile"><div class="vp-dropdown-wrapper"><button type="button" class="vp-dropdown-title" aria-label="Community"><!--[--><!---->Community<!--]--><span class="arrow"></span><ul class="vp-dropdown"><li class="vp-dropdown-item"><a class="route-link auto-link" href="/Community/About-the-Community.html" aria-label="About the Community"><!---->About the Community<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/Community/Development-Guide.html" aria-label="Development Guide"><!---->Development Guide<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/Community/Community-Partners.html" aria-label="Community Partners"><!---->Community Partners<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/Community/Communication-Channels.html" aria-label="Communication Channels"><!---->Communication Channels<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/Community/Events-and-Reports.html" aria-label="Events and Reports"><!---->Events and Reports<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/Community/Committers.html" aria-label="Committers"><!---->Committers<!----></a></li></ul></button></div></div><div class="vp-nav-item hide-in-mobile"><div class="vp-dropdown-wrapper"><button type="button" class="vp-dropdown-title" aria-label="ASF"><!--[--><!---->ASF<!--]--><span class="arrow"></span><ul class="vp-dropdown"><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/" aria-label="Foundation" rel="noopener noreferrer" target="_blank"><!---->Foundation<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/licenses/" aria-label="License" rel="noopener noreferrer" target="_blank"><!---->License<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/security/" aria-label="Security" rel="noopener noreferrer" target="_blank"><!---->Security<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/foundation/sponsorship.html" aria-label="Sponsorship" rel="noopener noreferrer" target="_blank"><!---->Sponsorship<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/foundation/thanks.html" aria-label="Thanks" rel="noopener noreferrer" target="_blank"><!---->Thanks<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/events/current-event" aria-label="Current Events" rel="noopener noreferrer" target="_blank"><!---->Current Events<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://privacy.apache.org/policies/privacy-policy-public.html" aria-label="Privacy" rel="noopener noreferrer" target="_blank"><!---->Privacy<!----></a></li></ul></button></div></div></nav><div class="vp-nav-item"><div class="vp-dropdown-wrapper"><button type="button" class="vp-dropdown-title" aria-label="Select language"><!--[--><svg xmlns="http://www.w3.org/2000/svg" class="icon i18n-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="i18n icon" name="i18n" style="width:1rem;height:1rem;vertical-align:middle;"><path d="M379.392 460.8 494.08 575.488l-42.496 102.4L307.2 532.48 138.24 701.44l-71.68-72.704L234.496 460.8l-45.056-45.056c-27.136-27.136-51.2-66.56-66.56-108.544h112.64c7.68 14.336 16.896 27.136 26.112 35.84l45.568 46.08 45.056-45.056C382.976 312.32 409.6 247.808 409.6 204.8H0V102.4h256V0h102.4v102.4h256v102.4H512c0 70.144-37.888 161.28-87.04 210.944L378.88 460.8zM576 870.4 512 1024H409.6l256-614.4H768l256 614.4H921.6l-64-153.6H576zM618.496 768h196.608L716.8 532.48 618.496 768z"></path></svg><!--]--><span class="arrow"></span><ul class="vp-dropdown"><li class="vp-dropdown-item"><a class="route-link route-link-active auto-link" href="/UserGuide/V1.3.x/Tools-System/CLI_apache.html" aria-label="English"><!---->English<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/zh/UserGuide/V1.3.x/Tools-System/CLI_apache.html" aria-label="简体中文"><!---->简体中文<!----></a></li></ul></button></div></div><div class="vp-nav-item hide-in-mobile"><button type="button" class="vp-color-mode-switch" id="color-mode-switch"><svg xmlns="http://www.w3.org/2000/svg" class="icon auto-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="auto icon" name="auto" style="display:none;"><path d="M512 992C246.92 992 32 777.08 32 512S246.92 32 512 32s480 214.92 480 480-214.92 480-480 480zm0-840c-198.78 0-360 161.22-360 360 0 198.84 161.22 360 360 360s360-161.16 360-360c0-198.78-161.22-360-360-360zm0 660V212c165.72 0 300 134.34 300 300 0 165.72-134.28 300-300 300z"></path></svg><svg xmlns="http://www.w3.org/2000/svg" class="icon dark-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="dark icon" name="dark" style="display:none;"><path d="M524.8 938.667h-4.267a439.893 439.893 0 0 1-313.173-134.4 446.293 446.293 0 0 1-11.093-597.334A432.213 432.213 0 0 1 366.933 90.027a42.667 42.667 0 0 1 45.227 9.386 42.667 42.667 0 0 1 10.24 42.667 358.4 358.4 0 0 0 82.773 375.893 361.387 361.387 0 0 0 376.747 82.774 42.667 42.667 0 0 1 54.187 55.04 433.493 433.493 0 0 1-99.84 154.88 438.613 438.613 0 0 1-311.467 128z"></path></svg><svg xmlns="http://www.w3.org/2000/svg" class="icon light-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="light icon" name="light" style="display:block;"><path d="M952 552h-80a40 40 0 0 1 0-80h80a40 40 0 0 1 0 80zM801.88 280.08a41 41 0 0 1-57.96-57.96l57.96-58a41.04 41.04 0 0 1 58 58l-58 57.96zM512 752a240 240 0 1 1 0-480 240 240 0 0 1 0 480zm0-560a40 40 0 0 1-40-40V72a40 40 0 0 1 80 0v80a40 40 0 0 1-40 40zm-289.88 88.08-58-57.96a41.04 41.04 0 0 1 58-58l57.96 58a41 41 0 0 1-57.96 57.96zM192 512a40 40 0 0 1-40 40H72a40 40 0 0 1 0-80h80a40 40 0 0 1 40 40zm30.12 231.92a41 41 0 0 1 57.96 57.96l-57.96 58a41.04 41.04 0 0 1-58-58l58-57.96zM512 832a40 40 0 0 1 40 40v80a40 40 0 0 1-80 0v-80a40 40 0 0 1 40-40zm289.88-88.08 58 57.96a41.04 41.04 0 0 1-58 58l-57.96-58a41 41 0 0 1 57.96-57.96z"></path></svg></button></div><div class="vp-nav-item vp-action"><a class="vp-action-link" href="https://github.com/apache/iotdb" target="_blank" rel="noopener noreferrer" aria-label="GitHub"><svg xmlns="http://www.w3.org/2000/svg" class="icon github-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="github icon" name="github" style="width:1.25rem;height:1.25rem;vertical-align:middle;"><path d="M511.957 21.333C241.024 21.333 21.333 240.981 21.333 512c0 216.832 140.544 400.725 335.574 465.664 24.49 4.395 32.256-10.07 32.256-23.083 0-11.69.256-44.245 0-85.205-136.448 29.61-164.736-64.64-164.736-64.64-22.315-56.704-54.4-71.765-54.4-71.765-44.587-30.464 3.285-29.824 3.285-29.824 49.195 3.413 75.179 50.517 75.179 50.517 43.776 75.008 114.816 53.333 142.762 40.79 4.523-31.66 17.152-53.377 31.19-65.537-108.971-12.458-223.488-54.485-223.488-242.602 0-53.547 19.114-97.323 50.517-131.67-5.035-12.33-21.93-62.293 4.779-129.834 0 0 41.258-13.184 134.912 50.346a469.803 469.803 0 0 1 122.88-16.554c41.642.213 83.626 5.632 122.88 16.554 93.653-63.488 134.784-50.346 134.784-50.346 26.752 67.541 9.898 117.504 4.864 129.834 31.402 34.347 50.474 78.123 50.474 131.67 0 188.586-114.73 230.016-224.042 242.09 17.578 15.232 33.578 44.672 33.578 90.454v135.85c0 13.142 7.936 27.606 32.854 22.87C862.25 912.597 1002.667 728.747 1002.667 512c0-271.019-219.648-490.667-490.71-490.667z"></path></svg></a></div><!--]--><button type="button" class="vp-toggle-navbar-button" aria-label="Toggle Navbar" aria-expanded="false" aria-controls="nav-screen"><span><span class="vp-top"></span><span class="vp-middle"></span><span class="vp-bottom"></span></span></button></div></header><!----><!--]--><!----><div class="toggle-sidebar-wrapper"><span class="arrow start"></span></div><aside id="sidebar" class="vp-sidebar" vp-sidebar><!--[--><p class="vp-sidebar-header iotdb-sidebar-header"><span class="vp-sidebar-title">IoTDB User Guide (V1.3.x)</span></p><!----><!--]--><ul class="vp-sidebar-links"><li><section class="vp-sidebar-group"><p class="vp-sidebar-header"><!----><span class="vp-sidebar-title">IoTDB User Guide (V1.3.x)</span><!----></p><ul class="vp-sidebar-links"></ul></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">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/V1.3.x/QuickStart/QuickStart_apache.html" aria-label="Quick Start"><!---->Quick Start<!----></a></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Installation and Deployment</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Basic Functions</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Advanced Features</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">AI capability</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable 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 route-link-active auto-link vp-sidebar-link active" href="/UserGuide/V1.3.x/Tools-System/CLI_apache.html" aria-label="Command Line Interface (CLI)"><!---->Command Line Interface (CLI)<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/V1.3.x/Tools-System/Monitor-Tool_apache.html" aria-label="Monitor Tool"><!---->Monitor Tool<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/V1.3.x/Tools-System/Benchmark.html" aria-label="Benchmark Tool"><!---->Benchmark Tool<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/V1.3.x/Tools-System/Maintenance-Tool_apache.html" aria-label="Cluster Management Tool"><!---->Cluster Management Tool<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/V1.3.x/Tools-System/Data-Import-Export-Tool.html" aria-label="Data Import Export(V1.3.0/1/2)"><!---->Data Import Export(V1.3.0/1/2)<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/V1.3.x/Tools-System/TsFile-Import-Export-Tool.html" aria-label="TsFile Import Export(V1.3.0/1/2)"><!---->TsFile Import Export(V1.3.0/1/2)<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/V1.3.x/Tools-System/Data-Import-Tool.html" aria-label="Data Import(V1.3.3)"><!---->Data Import(V1.3.3)<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/V1.3.x/Tools-System/Data-Import-Tool-1-3-4.html" aria-label="Data Import(V1.3.4)"><!---->Data Import(V1.3.4)<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/V1.3.x/Tools-System/Data-Export-Tool.html" aria-label="Data Export(V1.3.3)"><!---->Data Export(V1.3.3)<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/V1.3.x/Tools-System/Data-Export-Tool-1-3-4.html" aria-label="Data Export(V1.3.4)"><!---->Data Export(V1.3.4)<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/V1.3.x/Tools-System/Backup-Tool.html" aria-label="Full Backup Tool(V1.3.2)"><!---->Full Backup Tool(V1.3.2)<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/V1.3.x/Tools-System/Health-Check-Tool.html" aria-label="Health Check Tool(V1.3.2)"><!---->Health Check Tool(V1.3.2)<!----></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><!---->Command Line Interface (CLI)</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">7/10/23</span><meta property="datePublished" content="2023-07-10T03:11:17.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 4 min</span><meta property="timeRequired" content="PT4M"></span><!----><!----></div><hr></div><!----><div class="" vp-content><!----><div id="markdown-content"><h1 id="command-line-interface-cli" tabindex="-1"><a class="header-anchor" href="#command-line-interface-cli"><span>Command Line Interface (CLI)</span></a></h1><p>IoTDB provides Cli/shell tools for users to interact with IoTDB server in command lines. This document shows how Cli/shell tool works and the meaning of its parameters.</p><blockquote><p>Note: In this document, $IOTDB_HOME represents the path of the IoTDB installation directory.</p></blockquote><h2 id="installation" tabindex="-1"><a class="header-anchor" href="#installation"><span>Installation</span></a></h2><p>If you use the source code version of IoTDB, then under the root path of IoTDB, execute:</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-shell"><span class="line"><span style="color:#ABB2BF;">> mvn clean package -pl iotdb-client/cli -am -DskipTests -P get-jar-with-dependencies</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>After build, the IoTDB Cli will be in the folder "cli/target/iotdb-cli-{project.version}".</p><p>If you download the binary version, then the Cli can be used directly in sbin folder.</p><h2 id="running" tabindex="-1"><a class="header-anchor" href="#running"><span>Running</span></a></h2><h3 id="running-cli" tabindex="-1"><a class="header-anchor" href="#running-cli"><span>Running Cli</span></a></h3><p>After installation, there is a default user in IoTDB: <code>root</code>, and the<br> default password is <code>root</code>. Users can use this username to try IoTDB Cli/Shell tool. The cli startup script is the <code>start-cli</code> file under the $IOTDB_HOME/bin folder. When starting the script, you need to specify the IP and PORT. (Make sure the IoTDB cluster is running properly when you use Cli/Shell tool to connect to it.)</p><p>Here is an example where the cluster is started locally and the user has not changed the running port. The default rpc port is<br> 6667 <br><br> If you need to connect to the remote DataNode or changes<br> the rpc port number of the DataNode running, set the specific IP and RPC PORT at -h and -p.<br><br> You also can set your own environment variable at the front of the start script ("/sbin/start-cli.sh" for linux and "/sbin/start-cli.bat" for windows)</p><p>The Linux and MacOS system startup commands are as follows:</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-shell"><span class="line"><span style="color:#61AFEF;">Shell</span><span style="color:#ABB2BF;"> > </span><span style="color:#98C379;">bash</span><span style="color:#98C379;"> sbin/start-cli.sh</span><span style="color:#D19A66;"> -h</span><span style="color:#D19A66;"> 127.0.0.1</span><span style="color:#D19A66;"> -p</span><span style="color:#D19A66;"> 6667</span><span style="color:#D19A66;"> -u</span><span style="color:#98C379;"> root</span><span style="color:#D19A66;"> -pw</span><span style="color:#98C379;"> root</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>The Windows system startup commands are as follows:</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-shell"><span class="line"><span style="color:#61AFEF;">Shell</span><span style="color:#ABB2BF;"> > </span><span style="color:#98C379;">sbin</span><span style="color:#56B6C2;">\s</span><span style="color:#98C379;">tart-cli.bat</span><span style="color:#D19A66;"> -h</span><span style="color:#D19A66;"> 127.0.0.1</span><span style="color:#D19A66;"> -p</span><span style="color:#D19A66;"> 6667</span><span style="color:#D19A66;"> -u</span><span style="color:#98C379;"> root</span><span style="color:#D19A66;"> -pw</span><span style="color:#98C379;"> root</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>After operating these commands, the cli can be started successfully. The successful status will be as follows:</p><div class="language- line-numbers-mode" data-highlighter="shiki" data-ext="" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-"><span class="line"><span> _____ _________ ______ ______</span></span> |
| <span class="line"><span>|_ _| | _ _ ||_ _ `.|_ _ \</span></span> |
| <span class="line"><span> | | .--.|_/ | | \_| | | `. \ | |_) |</span></span> |
| <span class="line"><span> | | / .'`\ \ | | | | | | | __'.</span></span> |
| <span class="line"><span> _| |_| \__. | _| |_ _| |_.' /_| |__) |</span></span> |
| <span class="line"><span>|_____|'.__.' |_____| |______.'|_______/ version <version></span></span> |
| <span class="line"><span></span></span> |
| <span class="line"><span></span></span> |
| <span class="line"><span>Successfully login at 127.0.0.1:6667</span></span> |
| <span class="line"><span>IoTDB></span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>Enter <code>quit</code> or <code>exit</code> can exit Cli.</p><h3 id="cli-parameters" tabindex="-1"><a class="header-anchor" href="#cli-parameters"><span>Cli Parameters</span></a></h3><table><thead><tr><th><strong>Parameter</strong></th><th><strong>Type</strong></th><th><strong>Required</strong></th><th><strong>Description</strong></th><th><strong>Example</strong></th></tr></thead><tbody><tr><td>-h <code><host></code></td><td>string</td><td>No</td><td>The IP address of the IoTDB server. (Default: 127.0.0.1)</td><td>-h 127.0.0.1</td></tr><tr><td>-p <code><rpcPort></code></td><td>int</td><td>No</td><td>The RPC port of the IoTDB server. (Default: 6667)</td><td>-p 6667</td></tr><tr><td>-u <code><username></code></td><td>string</td><td>No</td><td>The username to connect to the IoTDB server. (Default: root)</td><td>-u root</td></tr><tr><td>-pw <code><password></code></td><td>string</td><td>No</td><td>The password to connect to the IoTDB server. (Default: root)</td><td>-pw root</td></tr><tr><td>-e <code><execute></code></td><td>string</td><td>No</td><td>Batch operations in non-interactive mode.</td><td>-e "show databases"</td></tr><tr><td>-c</td><td>Flag</td><td>No</td><td>Required if rpc_thrift_compression_enable=true on the server.</td><td>-c</td></tr><tr><td>-disableISO8601</td><td>Flag</td><td>No</td><td>If set, timestamps will be displayed as numeric values instead of ISO8601 format.</td><td>-disableISO8601</td></tr><tr><td>-usessl <code><use_ssl></code></td><td>Boolean</td><td>No</td><td>Enable SSL connection</td><td>-usessl true</td></tr><tr><td>-ts <code><trust_store></code></td><td>string</td><td>No</td><td>SSL certificate store path</td><td>-ts /path/to/truststore</td></tr><tr><td>-tpw <code><trust_store_pwd></code></td><td>string</td><td>No</td><td>SSL certificate store password</td><td>-tpw myTrustPassword</td></tr><tr><td>-timeout <code><queryTimeout></code></td><td>int</td><td>No</td><td>Query timeout (seconds). If not set, the server's configuration will be used.</td><td>-timeout 30</td></tr><tr><td>-help</td><td>Flag</td><td>No</td><td>Displays help information for the CLI tool.</td><td>-help</td></tr></tbody></table><p>Following is a cli command which connects the host with IP<br> 10.129.187.21, rpc port 6667, username "root", password "root", and prints the timestamp in digital form. The maximum number of lines displayed on the IoTDB command line is 10.</p><p>The Linux and MacOS system startup commands are as follows:</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-shell"><span class="line"><span style="color:#61AFEF;">Shell</span><span style="color:#ABB2BF;"> > </span><span style="color:#98C379;">bash</span><span style="color:#98C379;"> sbin/start-cli.sh</span><span style="color:#D19A66;"> -h</span><span style="color:#D19A66;"> 10.129.187.21</span><span style="color:#D19A66;"> -p</span><span style="color:#D19A66;"> 6667</span><span style="color:#D19A66;"> -u</span><span style="color:#98C379;"> root</span><span style="color:#D19A66;"> -pw</span><span style="color:#98C379;"> root</span><span style="color:#D19A66;"> -disableISO8601</span><span style="color:#D19A66;"> -maxPRC</span><span style="color:#D19A66;"> 10</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>The Windows system startup commands are as follows:</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-shell"><span class="line"><span style="color:#61AFEF;">Shell</span><span style="color:#ABB2BF;"> > </span><span style="color:#98C379;">sbin</span><span style="color:#56B6C2;">\s</span><span style="color:#98C379;">tart-cli.bat</span><span style="color:#D19A66;"> -h</span><span style="color:#D19A66;"> 10.129.187.21</span><span style="color:#D19A66;"> -p</span><span style="color:#D19A66;"> 6667</span><span style="color:#D19A66;"> -u</span><span style="color:#98C379;"> root</span><span style="color:#D19A66;"> -pw</span><span style="color:#98C379;"> root</span><span style="color:#D19A66;"> -disableISO8601</span><span style="color:#D19A66;"> -maxPRC</span><span style="color:#D19A66;"> 10</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><h3 id="cli-special-command" tabindex="-1"><a class="header-anchor" href="#cli-special-command"><span>CLI Special Command</span></a></h3><p>Special commands of Cli are below.</p><table><thead><tr><th style="text-align:left;">Command</th><th style="text-align:left;">Description / Example</th></tr></thead><tbody><tr><td style="text-align:left;"><code>set time_display_type=xxx</code></td><td style="text-align:left;">eg. long, default, ISO8601, yyyy-MM-dd HH:mm:ss</td></tr><tr><td style="text-align:left;"><code>show time_display_type</code></td><td style="text-align:left;">show time display type</td></tr><tr><td style="text-align:left;"><code>set time_zone=xxx</code></td><td style="text-align:left;">eg. +08:00, Asia/Shanghai</td></tr><tr><td style="text-align:left;"><code>show time_zone</code></td><td style="text-align:left;">show cli time zone</td></tr><tr><td style="text-align:left;"><code>set fetch_size=xxx</code></td><td style="text-align:left;">set fetch size when querying data from server</td></tr><tr><td style="text-align:left;"><code>show fetch_size</code></td><td style="text-align:left;">show fetch size</td></tr><tr><td style="text-align:left;"><code>set max_display_num=xxx</code></td><td style="text-align:left;">set max lines for cli to output, -1 equals to unlimited</td></tr><tr><td style="text-align:left;"><code>help</code></td><td style="text-align:left;">Get hints for CLI special commands</td></tr><tr><td style="text-align:left;"><code>exit/quit</code></td><td style="text-align:left;">Exit CLI</td></tr></tbody></table><h3 id="batch-operation-of-cli" tabindex="-1"><a class="header-anchor" href="#batch-operation-of-cli"><span>Batch Operation of Cli</span></a></h3><p>-e parameter is designed for the Cli/shell tool in the situation where you would like to manipulate IoTDB in batches through scripts. By using the -e parameter, you can operate IoTDB without entering the cli's input mode.</p><p>In order to avoid confusion between statements and other parameters, the current version only supports the -e parameter as the last parameter.</p><p>The usage of -e parameter for Cli/shell is as follows:</p><p>The Linux and MacOS system commands:</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-shell"><span class="line"><span style="color:#61AFEF;">Shell</span><span style="color:#ABB2BF;"> > </span><span style="color:#98C379;">bash</span><span style="color:#98C379;"> sbin/start-cli.sh</span><span style="color:#D19A66;"> -h</span><span style="color:#98C379;"> {host}</span><span style="color:#D19A66;"> -p</span><span style="color:#98C379;"> {rpcPort}</span><span style="color:#D19A66;"> -u</span><span style="color:#98C379;"> {user}</span><span style="color:#D19A66;"> -pw</span><span style="color:#98C379;"> {password}</span><span style="color:#D19A66;"> -e</span><span style="color:#98C379;"> {sql</span><span style="color:#98C379;"> for</span><span style="color:#98C379;"> iotdb}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>The Windows system commands:</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-shell"><span class="line"><span style="color:#61AFEF;">Shell</span><span style="color:#ABB2BF;"> > </span><span style="color:#98C379;">sbin</span><span style="color:#56B6C2;">\s</span><span style="color:#98C379;">tart-cli.bat</span><span style="color:#D19A66;"> -h</span><span style="color:#98C379;"> {host}</span><span style="color:#D19A66;"> -p</span><span style="color:#98C379;"> {rpcPort}</span><span style="color:#D19A66;"> -u</span><span style="color:#98C379;"> {user}</span><span style="color:#D19A66;"> -pw</span><span style="color:#98C379;"> {password}</span><span style="color:#D19A66;"> -e</span><span style="color:#98C379;"> {sql</span><span style="color:#98C379;"> for</span><span style="color:#98C379;"> iotdb}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>In the Windows environment, the SQL statement of the -e parameter needs to use <code>``</code> to replace <code>" "</code></p><p>In order to better explain the use of -e parameter, take following as an example(On linux system).</p><p>Suppose you want to create a database root.demo to a newly launched IoTDB, create a timeseries root.demo.s1 and insert three data points into it. With -e parameter, you could write a shell like this:</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-shell"><span class="line"><span style="color:#7F848E;font-style:italic;"># !/bin/bash</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#E06C75;">host</span><span style="color:#56B6C2;">=</span><span style="color:#98C379;">127.0.0.1</span></span> |
| <span class="line"><span style="color:#E06C75;">rpcPort</span><span style="color:#56B6C2;">=</span><span style="color:#98C379;">6667</span></span> |
| <span class="line"><span style="color:#E06C75;">user</span><span style="color:#56B6C2;">=</span><span style="color:#98C379;">root</span></span> |
| <span class="line"><span style="color:#E06C75;">pass</span><span style="color:#56B6C2;">=</span><span style="color:#98C379;">root</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#61AFEF;">bash</span><span style="color:#98C379;"> ./sbin/start-cli.sh</span><span style="color:#D19A66;"> -h</span><span style="color:#ABB2BF;"> ${</span><span style="color:#E06C75;">host</span><span style="color:#ABB2BF;">} </span><span style="color:#D19A66;">-p</span><span style="color:#ABB2BF;"> ${</span><span style="color:#E06C75;">rpcPort</span><span style="color:#ABB2BF;">} </span><span style="color:#D19A66;">-u</span><span style="color:#ABB2BF;"> ${</span><span style="color:#E06C75;">user</span><span style="color:#ABB2BF;">} </span><span style="color:#D19A66;">-pw</span><span style="color:#ABB2BF;"> ${</span><span style="color:#E06C75;">pass</span><span style="color:#ABB2BF;">} </span><span style="color:#D19A66;">-e</span><span style="color:#98C379;"> "create database root.demo"</span></span> |
| <span class="line"><span style="color:#61AFEF;">bash</span><span style="color:#98C379;"> ./sbin/start-cli.sh</span><span style="color:#D19A66;"> -h</span><span style="color:#ABB2BF;"> ${</span><span style="color:#E06C75;">host</span><span style="color:#ABB2BF;">} </span><span style="color:#D19A66;">-p</span><span style="color:#ABB2BF;"> ${</span><span style="color:#E06C75;">rpcPort</span><span style="color:#ABB2BF;">} </span><span style="color:#D19A66;">-u</span><span style="color:#ABB2BF;"> ${</span><span style="color:#E06C75;">user</span><span style="color:#ABB2BF;">} </span><span style="color:#D19A66;">-pw</span><span style="color:#ABB2BF;"> ${</span><span style="color:#E06C75;">pass</span><span style="color:#ABB2BF;">} </span><span style="color:#D19A66;">-e</span><span style="color:#98C379;"> "create timeseries root.demo.s1 WITH DATATYPE=INT32, ENCODING=RLE"</span></span> |
| <span class="line"><span style="color:#61AFEF;">bash</span><span style="color:#98C379;"> ./sbin/start-cli.sh</span><span style="color:#D19A66;"> -h</span><span style="color:#ABB2BF;"> ${</span><span style="color:#E06C75;">host</span><span style="color:#ABB2BF;">} </span><span style="color:#D19A66;">-p</span><span style="color:#ABB2BF;"> ${</span><span style="color:#E06C75;">rpcPort</span><span style="color:#ABB2BF;">} </span><span style="color:#D19A66;">-u</span><span style="color:#ABB2BF;"> ${</span><span style="color:#E06C75;">user</span><span style="color:#ABB2BF;">} </span><span style="color:#D19A66;">-pw</span><span style="color:#ABB2BF;"> ${</span><span style="color:#E06C75;">pass</span><span style="color:#ABB2BF;">} </span><span style="color:#D19A66;">-e</span><span style="color:#98C379;"> "insert into root.demo(timestamp,s1) values(1,10)"</span></span> |
| <span class="line"><span style="color:#61AFEF;">bash</span><span style="color:#98C379;"> ./sbin/start-cli.sh</span><span style="color:#D19A66;"> -h</span><span style="color:#ABB2BF;"> ${</span><span style="color:#E06C75;">host</span><span style="color:#ABB2BF;">} </span><span style="color:#D19A66;">-p</span><span style="color:#ABB2BF;"> ${</span><span style="color:#E06C75;">rpcPort</span><span style="color:#ABB2BF;">} </span><span style="color:#D19A66;">-u</span><span style="color:#ABB2BF;"> ${</span><span style="color:#E06C75;">user</span><span style="color:#ABB2BF;">} </span><span style="color:#D19A66;">-pw</span><span style="color:#ABB2BF;"> ${</span><span style="color:#E06C75;">pass</span><span style="color:#ABB2BF;">} </span><span style="color:#D19A66;">-e</span><span style="color:#98C379;"> "insert into root.demo(timestamp,s1) values(2,11)"</span></span> |
| <span class="line"><span style="color:#61AFEF;">bash</span><span style="color:#98C379;"> ./sbin/start-cli.sh</span><span style="color:#D19A66;"> -h</span><span style="color:#ABB2BF;"> ${</span><span style="color:#E06C75;">host</span><span style="color:#ABB2BF;">} </span><span style="color:#D19A66;">-p</span><span style="color:#ABB2BF;"> ${</span><span style="color:#E06C75;">rpcPort</span><span style="color:#ABB2BF;">} </span><span style="color:#D19A66;">-u</span><span style="color:#ABB2BF;"> ${</span><span style="color:#E06C75;">user</span><span style="color:#ABB2BF;">} </span><span style="color:#D19A66;">-pw</span><span style="color:#ABB2BF;"> ${</span><span style="color:#E06C75;">pass</span><span style="color:#ABB2BF;">} </span><span style="color:#D19A66;">-e</span><span style="color:#98C379;"> "insert into root.demo(timestamp,s1) values(3,12)"</span></span> |
| <span class="line"><span style="color:#61AFEF;">bash</span><span style="color:#98C379;"> ./sbin/start-cli.sh</span><span style="color:#D19A66;"> -h</span><span style="color:#ABB2BF;"> ${</span><span style="color:#E06C75;">host</span><span style="color:#ABB2BF;">} </span><span style="color:#D19A66;">-p</span><span style="color:#ABB2BF;"> ${</span><span style="color:#E06C75;">rpcPort</span><span style="color:#ABB2BF;">} </span><span style="color:#D19A66;">-u</span><span style="color:#ABB2BF;"> ${</span><span style="color:#E06C75;">user</span><span style="color:#ABB2BF;">} </span><span style="color:#D19A66;">-pw</span><span style="color:#ABB2BF;"> ${</span><span style="color:#E06C75;">pass</span><span style="color:#ABB2BF;">} </span><span style="color:#D19A66;">-e</span><span style="color:#98C379;"> "select s1 from root.demo"</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><p>The results are shown in the figure, which are consistent with the Cli and jdbc operations.</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-shell"><span class="line"><span style="color:#61AFEF;"> Shell</span><span style="color:#ABB2BF;"> > </span><span style="color:#98C379;">bash</span><span style="color:#98C379;"> ./shell.sh</span><span style="color:#ABB2BF;"> </span></span> |
| <span class="line"><span style="color:#61AFEF;">+-----------------------------+------------+</span></span> |
| <span class="line"><span style="color:#ABB2BF;">| </span><span style="color:#61AFEF;">Time</span><span style="color:#ABB2BF;">|</span><span style="color:#61AFEF;">root.demo.s1</span><span style="color:#ABB2BF;">|</span></span> |
| <span class="line"><span style="color:#61AFEF;">+-----------------------------+------------+</span></span> |
| <span class="line"><span style="color:#ABB2BF;">|</span><span style="color:#61AFEF;">1970-01-01T08:00:00.001+08:00</span><span style="color:#ABB2BF;">| </span><span style="color:#61AFEF;">10</span><span style="color:#ABB2BF;">|</span></span> |
| <span class="line"><span style="color:#ABB2BF;">|</span><span style="color:#61AFEF;">1970-01-01T08:00:00.002+08:00</span><span style="color:#ABB2BF;">| </span><span style="color:#61AFEF;">11</span><span style="color:#ABB2BF;">|</span></span> |
| <span class="line"><span style="color:#ABB2BF;">|</span><span style="color:#61AFEF;">1970-01-01T08:00:00.003+08:00</span><span style="color:#ABB2BF;">| </span><span style="color:#61AFEF;">12</span><span style="color:#ABB2BF;">|</span></span> |
| <span class="line"><span style="color:#61AFEF;">+-----------------------------+------------+</span></span> |
| <span class="line"><span style="color:#61AFEF;">Total</span><span style="color:#98C379;"> line</span><span style="color:#98C379;"> number</span><span style="color:#98C379;"> =</span><span style="color:#D19A66;"> 3</span></span> |
| <span class="line"><span style="color:#61AFEF;">It</span><span style="color:#98C379;"> costs</span><span style="color:#98C379;"> 0.267s</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>It should be noted that the use of the -e parameter in shell scripts requires attention to the escaping of special characters.</p></div><!----><!----><!----></div><footer class="vp-page-meta"><div class="vp-meta-item edit-link"><a class="auto-link external-link vp-meta-label" href="https://github.com/apache/iotdb-docs/edit/main/src/UserGuide/V1.3.x/Tools-System/CLI_apache.md" aria-label="Found Error? Edit this page on GitHub" rel="noopener noreferrer" target="_blank"><!--[--><svg xmlns="http://www.w3.org/2000/svg" class="icon edit-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="edit icon" name="edit"><path d="M430.818 653.65a60.46 60.46 0 0 1-50.96-93.281l71.69-114.012 7.773-10.365L816.038 80.138A60.46 60.46 0 0 1 859.225 62a60.46 60.46 0 0 1 43.186 18.138l43.186 43.186a60.46 60.46 0 0 1 0 86.373L588.879 565.55l-8.637 8.637-117.466 68.234a60.46 60.46 0 0 1-31.958 11.229z"></path><path d="M728.802 962H252.891A190.883 190.883 0 0 1 62.008 771.98V296.934a190.883 190.883 0 0 1 190.883-192.61h267.754a60.46 60.46 0 0 1 0 120.92H252.891a69.962 69.962 0 0 0-69.098 69.099V771.98a69.962 69.962 0 0 0 69.098 69.098h475.911A69.962 69.962 0 0 0 797.9 771.98V503.363a60.46 60.46 0 1 1 120.922 0V771.98A190.883 190.883 0 0 1 728.802 962z"></path></svg><!--]-->Found Error? Edit this page on GitHub<!----></a></div><div class="vp-meta-item git-info"><div class="update-time"><span class="vp-meta-label">Last Updated: </span><time class="vp-meta-info" datetime="2026-03-26T11:09:19.000Z" data-allow-mismatch>3/26/26, 11:09 AM</time></div><!----></div></footer><nav class="vp-page-nav"><!----><a class="route-link auto-link next" href="/UserGuide/V1.3.x/Tools-System/Monitor-Tool_apache.html" aria-label="Monitor Tool"><div class="hint">Next<span class="arrow end"></span></div><div class="link">Monitor Tool<!----></div></a></nav><!----><!----><!--]--></main><!--]--><footer class="site-footer"><span id="doc-version" style="display:none;">V1.3.x</span><p class="copyright-text">Copyright © 2026 The Apache Software Foundation. |
| Apache IoTDB, IoTDB, Apache, the Apache feather logo, and the Apache IoTDB project logo are either registered trademarks or trademarks of The Apache Software Foundation in all countries</p><p style="text-align:center;margin-top:10px;color:#909399;font-size:12px;margin:0 30px;"><strong>Having questions?</strong> Connect with us on QQ, WeChat, or Slack. <a href="https://github.com/apache/iotdb/issues/1995">Join the community</a></p></footer></div><!--]--><!--]--><!--[--><!----><!--]--><!--]--></div> |
| <script type="module" src="/assets/app-pmkzp6TS.js" defer></script> |
| </body> |
| </html> |
