| <!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-beta.61" /> |
| <meta name="theme" content="VuePress Theme Hope" /> |
| <link rel="alternate" hreflang="zh-cn" href="https://iotdb.apache.org/zh/UserGuide/V0.13.x/Cluster/Cluster-Setup.html"><meta property="og:url" content="https://iotdb.apache.org/UserGuide/V0.13.x/Cluster/Cluster-Setup.html"><meta property="og:site_name" content="IoTDB Website"><meta property="og:description" content="Cluster setup You can follow this document to start an IoTDB cluster. Prerequisite To use IoTDB, you need to have: 1. Java >= 1.8 (Please make sure the environment path has been..."><meta property="og:type" content="article"><meta property="og:locale" content="en-US"><meta property="og:locale:alternate" content="zh-CN"><script type="application/ld+json">{"@context":"https://schema.org","@type":"Article","headline":"","image":[""],"dateModified":null,"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"><title>IoTDB Website</title><meta name="description" content="Cluster setup You can follow this document to start an IoTDB cluster. Prerequisite To use IoTDB, you need to have: 1. Java >= 1.8 (Please make sure the environment path has been..."> |
| <style> |
| :root { |
| --bg-color: #fff; |
| } |
| |
| html[data-theme="dark"] { |
| --bg-color: #1d1e1f; |
| } |
| |
| html, |
| body { |
| background: var(--bg-color); |
| } |
| </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="preload" href="/assets/style-13611a3c.css" as="style"><link rel="stylesheet" href="/assets/style-13611a3c.css"> |
| <link rel="modulepreload" href="/assets/app-f2ec2f8e.js"><link rel="modulepreload" href="/assets/framework-5638dcb2.js"><link rel="modulepreload" href="/assets/Cluster-Setup.html-9adee4d8.js"><link rel="modulepreload" href="/assets/Cluster-Setup.html-53fdbcfd.js"> |
| </head> |
| <body> |
| <div id="app"><!--[--><!--[--><!--[--><span tabindex="-1"></span><a href="#main-content" class="skip-link sr-only">Skip to main content</a><!--]--><!--[--><div class="theme-container has-toc"><!--[--><header class="navbar hide-icon" id="navbar"><div class="navbar-start"><button class="toggle-sidebar-button" title="Toggle Sidebar"><span class="icon"></span></button><!--[--><!----><!--]--><a href="/" class="brand"><img class="logo" src="/logo.png" alt="IoTDB Website"><!----><span class="site-name hide-in-pad">IoTDB Website</span></a><!--[--><!----><!--]--></div><div class="navbar-center"><!--[--><!----><!--]--><!--[--><!----><!--]--></div><div class="navbar-end"><!--[--><!----><!--]--><div id="docsearch-container"></div><nav class="nav-links"><div class="nav-item hide-in-mobile"><div class="dropdown-wrapper"><button class="dropdown-title" type="button" aria-label="Documentation"><span class="title"><!---->Documentation</span><span class="arrow"></span><ul class="nav-dropdown"><li class="dropdown-item"><a href="/UserGuide/Master/QuickStart/QuickStart.html" class="nav-link" aria-label="latest"><!---->latest<!----></a></li><li class="dropdown-item"><a href="/UserGuide/V1.1.x/QuickStart/QuickStart.html" class="nav-link" aria-label="v1.1.x"><!---->v1.1.x<!----></a></li><li class="dropdown-item"><a href="/UserGuide/V1.0.x/QuickStart/QuickStart.html" class="nav-link" aria-label="v1.0.x"><!---->v1.0.x<!----></a></li><li class="dropdown-item"><a href="/UserGuide/V0.13.x/QuickStart/QuickStart.html" class="nav-link" aria-label="v0.13.x"><!---->v0.13.x<!----></a></li></ul></button></div></div><div class="nav-item hide-in-mobile"><a href="https://cwiki.apache.org/confluence/display/IOTDB/System+Design" rel="noopener noreferrer" target="_blank" aria-label="Design" class="nav-link"><!---->Design<span><svg class="external-link-icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg><span class="external-link-icon-sr-only">open in new window</span></span><!----></a></div><div class="nav-item hide-in-mobile"><a href="/Download/" class="nav-link" aria-label="Download"><!---->Download<!----></a></div><div class="nav-item hide-in-mobile"><div class="dropdown-wrapper"><button class="dropdown-title" type="button" aria-label="Community"><span class="title"><!---->Community</span><span class="arrow"></span><ul class="nav-dropdown"><li class="dropdown-item"><a href="/Community/About.html" class="nav-link" aria-label="About"><!---->About<!----></a></li><li class="dropdown-item"><a href="https://cwiki.apache.org/confluence/display/iotdb" rel="noopener noreferrer" target="_blank" aria-label="Wiki" class="nav-link"><!---->Wiki<span><svg class="external-link-icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg><span class="external-link-icon-sr-only">open in new window</span></span><!----></a></li><li class="dropdown-item"><a href="/Community/Community-Project-Committers.html" class="nav-link" aria-label="People"><!---->People<!----></a></li><li class="dropdown-item"><a href="/Community/Community-Powered-By.html" class="nav-link" aria-label="Powered By"><!---->Powered By<!----></a></li><li class="dropdown-item"><a href="/Community/Materials.html" class="nav-link" aria-label="Resources"><!---->Resources<!----></a></li><li class="dropdown-item"><a href="/Community/Feedback.html" class="nav-link" aria-label="Feedback"><!---->Feedback<!----></a></li></ul></button></div></div><div class="nav-item hide-in-mobile"><div class="dropdown-wrapper"><button class="dropdown-title" type="button" aria-label="Development"><span class="title"><!---->Development</span><span class="arrow"></span><ul class="nav-dropdown"><li class="dropdown-item"><a href="/Development/VoteRelease.html" class="nav-link" aria-label="How to vote"><!---->How to vote<!----></a></li><li class="dropdown-item"><a href="/Development/HowToCommit.html" class="nav-link" aria-label="How to Commit"><!---->How to Commit<!----></a></li><li class="dropdown-item"><a href="/Development/HowToJoin.html" class="nav-link" aria-label="Become a Contributor"><!---->Become a Contributor<!----></a></li><li class="dropdown-item"><a href="/Development/Committer.html" class="nav-link" aria-label="Become a Committer"><!---->Become a Committer<!----></a></li><li class="dropdown-item"><a href="/Development/ContributeGuide.html" class="nav-link" aria-label="ContributeGuide"><!---->ContributeGuide<!----></a></li><li class="dropdown-item"><a href="/Development/HowtoContributeCode.html" class="nav-link" aria-label="How to Contribute Code"><!---->How to Contribute Code<!----></a></li><li class="dropdown-item"><a href="/Development/format-changelist.html" class="nav-link" aria-label="Changelist of TsFile"><!---->Changelist of TsFile<!----></a></li><li class="dropdown-item"><a href="/Development/rpc-changelist.html" class="nav-link" aria-label="Changelist of RPC"><!---->Changelist of RPC<!----></a></li></ul></button></div></div><div class="nav-item hide-in-mobile"><div class="dropdown-wrapper"><button class="dropdown-title" type="button" aria-label="ASF"><span class="title"><!---->ASF</span><span class="arrow"></span><ul class="nav-dropdown"><li class="dropdown-item"><a href="https://www.apache.org/" rel="noopener noreferrer" target="_blank" aria-label="Foundation" class="nav-link"><!---->Foundation<span><svg class="external-link-icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg><span class="external-link-icon-sr-only">open in new window</span></span><!----></a></li><li class="dropdown-item"><a href="https://www.apache.org/licenses/" rel="noopener noreferrer" target="_blank" aria-label="License" class="nav-link"><!---->License<span><svg class="external-link-icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg><span class="external-link-icon-sr-only">open in new window</span></span><!----></a></li><li class="dropdown-item"><a href="https://www.apache.org/security/" rel="noopener noreferrer" target="_blank" aria-label="Security" class="nav-link"><!---->Security<span><svg class="external-link-icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg><span class="external-link-icon-sr-only">open in new window</span></span><!----></a></li><li class="dropdown-item"><a href="https://www.apache.org/foundation/sponsorship.html" rel="noopener noreferrer" target="_blank" aria-label="Sponsorship" class="nav-link"><!---->Sponsorship<span><svg class="external-link-icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg><span class="external-link-icon-sr-only">open in new window</span></span><!----></a></li><li class="dropdown-item"><a href="https://www.apache.org/foundation/thanks.html" rel="noopener noreferrer" target="_blank" aria-label="Thanks" class="nav-link"><!---->Thanks<span><svg class="external-link-icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg><span class="external-link-icon-sr-only">open in new window</span></span><!----></a></li><li class="dropdown-item"><a href="https://www.apache.org/events/current-event" rel="noopener noreferrer" target="_blank" aria-label="Current Events" class="nav-link"><!---->Current Events<span><svg class="external-link-icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg><span class="external-link-icon-sr-only">open in new window</span></span><!----></a></li></ul></button></div></div></nav><div class="nav-item"><div class="dropdown-wrapper i18n-dropdown"><button class="dropdown-title" type="button" 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" 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="nav-dropdown"><li class="dropdown-item"><a aria-current="page" href="/UserGuide/V0.13.x/Cluster/Cluster-Setup.html" class="router-link-active router-link-exact-active nav-link active" aria-label="English"><!---->English<!----></a></li><li class="dropdown-item"><a href="/zh/UserGuide/V0.13.x/Cluster/Cluster-Setup.html" class="nav-link" aria-label="简体中文"><!---->简体中文<!----></a></li></ul></button></div></div><div class="nav-item hide-in-mobile"><button id="appearance-switch"><svg xmlns="http://www.w3.org/2000/svg" class="icon auto-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="auto icon" style="display:block;"><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" 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" style="display:none;"><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="nav-item"><a class="repo-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" 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 class="toggle-navbar-button" aria-label="Toggle Navbar" aria-expanded="false" aria-controls="nav-screen"><span class="button-container"><span class="button-top"></span><span class="button-middle"></span><span class="button-bottom"></span></span></button></div></header><!----><!--]--><!----><div class="toggle-sidebar-wrapper"><span class="arrow start"></span></div><aside class="sidebar" id="sidebar"><!--[--><!----><!--]--><ul class="sidebar-links"><li><section class="sidebar-group"><p class="sidebar-heading"><!----><span class="title">IoTDB User Guide (V0.13.x)</span><!----></p><ul class="sidebar-links"></ul></section></li><li><section class="sidebar-group"><button class="sidebar-heading clickable"><!----><span class="title">IoTDB Introduction</span><span class="arrow end"></span></button><!----></section></li><li><section class="sidebar-group"><button class="sidebar-heading clickable"><!----><span class="title">Quick Start</span><span class="arrow end"></span></button><!----></section></li><li><section class="sidebar-group"><button class="sidebar-heading clickable"><!----><span class="title">Data Concept</span><span class="arrow end"></span></button><!----></section></li><li><section class="sidebar-group"><button class="sidebar-heading clickable"><!----><span class="title">Syntax Conventions</span><span class="arrow end"></span></button><!----></section></li><li><section class="sidebar-group"><button class="sidebar-heading clickable"><!----><span class="title">API</span><span class="arrow end"></span></button><!----></section></li><li><section class="sidebar-group"><button class="sidebar-heading clickable"><!----><span class="title">Operate Metadata</span><span class="arrow end"></span></button><!----></section></li><li><section class="sidebar-group"><button class="sidebar-heading clickable"><!----><span class="title">Write and Delete Data</span><span class="arrow end"></span></button><!----></section></li><li><section class="sidebar-group"><button class="sidebar-heading clickable"><!----><span class="title">Query Data</span><span class="arrow end"></span></button><!----></section></li><li><section class="sidebar-group"><button class="sidebar-heading clickable"><!----><span class="title">Process Data</span><span class="arrow end"></span></button><!----></section></li><li><section class="sidebar-group"><button class="sidebar-heading clickable"><!----><span class="title">Administration Management</span><span class="arrow end"></span></button><!----></section></li><li><section class="sidebar-group"><button class="sidebar-heading clickable"><!----><span class="title">Maintenance Tools</span><span class="arrow end"></span></button><!----></section></li><li><section class="sidebar-group"><button class="sidebar-heading clickable"><!----><span class="title">Ecosystem Integration</span><span class="arrow end"></span></button><!----></section></li><li><section class="sidebar-group"><button class="sidebar-heading clickable"><!----><span class="title">UDF Library</span><span class="arrow end"></span></button><!----></section></li><li><section class="sidebar-group"><button class="sidebar-heading clickable"><!----><span class="title">Reference</span><span class="arrow end"></span></button><!----></section></li></ul><!--[--><!----><!--]--></aside><!--[--><main class="page" id="main-content"><!--[--><!----><nav class="breadcrumb disable"></nav><div class="page-title"><h1><!----></h1><div class="page-info"><!----><!----><!----><!----><span class="page-reading-time-info" aria-label="Reading Time"><svg xmlns="http://www.w3.org/2000/svg" class="icon timer-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="timer icon"><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 8 min</span><meta property="timeRequired" content="PT8M"></span><!----><!----></div><hr></div><div class="toc-place-holder"><aside id="toc"><!--[--><!----><!--]--><div class="toc-header">On This Page<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"><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><div class="toc-wrapper"><ul class="toc-list"><!--[--><li class="toc-item"><a aria-current="page" href="/UserGuide/V0.13.x/Cluster/Cluster-Setup.html#cluster-setup" class="router-link-active router-link-exact-active toc-link level2">Cluster setup</a></li><!----><!--]--><!--[--><li class="toc-item"><a aria-current="page" href="/UserGuide/V0.13.x/Cluster/Cluster-Setup.html#prerequisite" class="router-link-active router-link-exact-active toc-link level2">Prerequisite</a></li><!----><!--]--><!--[--><li class="toc-item"><a aria-current="page" href="/UserGuide/V0.13.x/Cluster/Cluster-Setup.html#installation" class="router-link-active router-link-exact-active toc-link level2">Installation</a></li><ul class="toc-list"><!--[--><li class="toc-item"><a aria-current="page" href="/UserGuide/V0.13.x/Cluster/Cluster-Setup.html#build-from-source" class="router-link-active router-link-exact-active toc-link level3">Build from source</a></li><!----><!--]--><!--[--><li class="toc-item"><a aria-current="page" href="/UserGuide/V0.13.x/Cluster/Cluster-Setup.html#download" class="router-link-active router-link-exact-active toc-link level3">Download</a></li><!----><!--]--></ul><!--]--><!--[--><li class="toc-item"><a aria-current="page" href="/UserGuide/V0.13.x/Cluster/Cluster-Setup.html#directory" class="router-link-active router-link-exact-active toc-link level2">Directory</a></li><!----><!--]--><!--[--><li class="toc-item"><a aria-current="page" href="/UserGuide/V0.13.x/Cluster/Cluster-Setup.html#configurations" class="router-link-active router-link-exact-active toc-link level2">Configurations</a></li><ul class="toc-list"><!--[--><li class="toc-item"><a aria-current="page" href="/UserGuide/V0.13.x/Cluster/Cluster-Setup.html#overwrite-the-configurations-of-stand-alone-node" class="router-link-active router-link-exact-active toc-link level3">OverWrite the configurations of Stand-alone node</a></li><!----><!--]--></ul><!--]--><!--[--><li class="toc-item"><a aria-current="page" href="/UserGuide/V0.13.x/Cluster/Cluster-Setup.html#start-service" class="router-link-active router-link-exact-active toc-link level2">Start Service</a></li><ul class="toc-list"><!--[--><li class="toc-item"><a aria-current="page" href="/UserGuide/V0.13.x/Cluster/Cluster-Setup.html#start-cluster" class="router-link-active router-link-exact-active toc-link level3">Start Cluster</a></li><!----><!--]--><!--[--><li class="toc-item"><a aria-current="page" href="/UserGuide/V0.13.x/Cluster/Cluster-Setup.html#cluster-scalability" class="router-link-active router-link-exact-active toc-link level3">Cluster scalability</a></li><!----><!--]--><!--[--><li class="toc-item"><a aria-current="page" href="/UserGuide/V0.13.x/Cluster/Cluster-Setup.html#use-cli" class="router-link-active router-link-exact-active toc-link level3">Use Cli</a></li><!----><!--]--><!--[--><li class="toc-item"><a aria-current="page" href="/UserGuide/V0.13.x/Cluster/Cluster-Setup.html#stop-cluster" class="router-link-active router-link-exact-active toc-link level3">Stop Cluster</a></li><!----><!--]--></ul><!--]--><!--[--><li class="toc-item"><a aria-current="page" href="/UserGuide/V0.13.x/Cluster/Cluster-Setup.html#appendix" class="router-link-active router-link-exact-active toc-link level2">Appendix</a></li><ul class="toc-list"><!--[--><li class="toc-item"><a aria-current="page" href="/UserGuide/V0.13.x/Cluster/Cluster-Setup.html#cluster-configuration" class="router-link-active router-link-exact-active toc-link level3">Cluster Configuration</a></li><!----><!--]--></ul><!--]--></ul></div><!--[--><!----><!--]--></aside></div><!----><div class="theme-hope-content"><!-- |
| |
| Licensed to the Apache Software Foundation (ASF) under one |
| or more contributor license agreements. See the NOTICE file |
| distributed with this work for additional information |
| regarding copyright ownership. The ASF licenses this file |
| to you under the Apache License, Version 2.0 (the |
| "License"); you may not use this file except in compliance |
| with the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, |
| software distributed under the License is distributed on an |
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| KIND, either express or implied. See the License for the |
| specific language governing permissions and limitations |
| under the License. |
| |
| --><h2 id="cluster-setup" tabindex="-1"><a class="header-anchor" href="#cluster-setup" aria-hidden="true">#</a> Cluster setup</h2><p>You can follow this document to start an IoTDB cluster.</p><h2 id="prerequisite" tabindex="-1"><a class="header-anchor" href="#prerequisite" aria-hidden="true">#</a> Prerequisite</h2><p>To use IoTDB, you need to have:</p><ol><li><p>Java >= 1.8 (Please make sure the environment path has been set)</p></li><li><p>Set the max open files num as 65535 to avoid "too many open files" problem.</p></li></ol><h2 id="installation" tabindex="-1"><a class="header-anchor" href="#installation" aria-hidden="true">#</a> Installation</h2><p>IoTDB provides you three installation methods, you can refer to the following suggestions, choose one of them:</p><ul><li>Installation from source code. If you need to modify the code yourself, you can use this method.</li><li>Installation from binary files. Download the binary files from the official website.</li><li>Using Docker：The path to the dockerfile is <a href="https://github.com/apache/iotdb/blob/master/docker/src/main" target="_blank" rel="noopener noreferrer">github<span><svg class="external-link-icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg><span class="external-link-icon-sr-only">open in new window</span></span></a></li></ul><h3 id="build-from-source" tabindex="-1"><a class="header-anchor" href="#build-from-source" aria-hidden="true">#</a> Build from source</h3><p>You can download the source code from:</p><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>git clone https://github.com/apache/iotdb.git |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><p>The default dev branch is the master branch, If you want to use a released version, for example:</p><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>git checkout rel/0.12 |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><p>Under the root path of iotdb:</p><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>> mvn clean package -pl cluster -am -DskipTests |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><p>Then the cluster binary version can be found at <strong>cluster/target/{iotdb-project.version}</strong></p><h3 id="download" tabindex="-1"><a class="header-anchor" href="#download" aria-hidden="true">#</a> Download</h3><p>You can download the binary file from: <a href="https://iotdb.apache.org/Download/" target="_blank" rel="noopener noreferrer">Download Page<span><svg class="external-link-icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg><span class="external-link-icon-sr-only">open in new window</span></span></a></p><h2 id="directory" tabindex="-1"><a class="header-anchor" href="#directory" aria-hidden="true">#</a> Directory</h2><p>After installation, the following directories will be generated by default under the root directory of the iotdb cluster:</p><table><thead><tr><th>Directory</th><th><strong>Description</strong></th></tr></thead><tbody><tr><td>conf</td><td>Configuration file directory</td></tr><tr><td>data</td><td>Default data file directory, which can be modified in the configuration file</td></tr><tr><td>ext</td><td>Default udf directory, which can be modified in the configuration file</td></tr><tr><td>lib</td><td>Library directory</td></tr><tr><td>logs</td><td>Execution log directory</td></tr><tr><td>sbin</td><td>Script directory</td></tr><tr><td>tools</td><td>System tool directory</td></tr></tbody></table><h2 id="configurations" tabindex="-1"><a class="header-anchor" href="#configurations" aria-hidden="true">#</a> Configurations</h2><p>Before starting to use IoTDB, you need to config the configuration files first. For your convenience, we have already set the default config in the files.</p><p>In total, we provide users four kinds of configurations module:</p><ul><li>environment configuration file (<code>iotdb-env.bat</code>, <code>iotdb-env.sh</code>). The default configuration file for the environment configuration item. Users can configure the relevant system configuration items of JAVA-JVM in the file.</li><li>system configuration file (<code>iotdb-engine.properties</code>). The default configuration file for the IoTDB engine layer configuration item. Users can configure the IoTDB engine related parameters in the file, such as the precision of timestamp(<code>timestamp_precision</code>), etc. What's more, Users can configure settings of TsFile (the data files), such as the data size written to the disk per time(<code>group_size_in_byte</code>).</li><li>log configuration file (<code>logback.xml</code>). The default log configuration file, such as the log levels.</li><li><code>iotdb-cluster.properties</code>. Some configurations required by IoTDB cluster. Such as replication number(<code>default_replica_num</code>), etc.</li></ul><p>For detailed description of the two configuration files <code>iotdb-engine.properties</code>, <code>iotdb-env.sh</code>/<code>iotdb-env.bat</code>, please refer to <a href="https://github.com/apache/iotdb/blob/master/docs/UserGuide/Appendix/Config-Manual.md" target="_blank" rel="noopener noreferrer">Configuration Manual<span><svg class="external-link-icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg><span class="external-link-icon-sr-only">open in new window</span></span></a>. The configuration items of IoTDB cluster are in the <code>iotdb-cluster.properties</code> file, you can also review the comments in the <a href="https://github.com/apache/iotdb/blob/master/cluster/src/assembly/resources/conf/iotdb-cluster.properties" target="_blank" rel="noopener noreferrer">configuration file<span><svg class="external-link-icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg><span class="external-link-icon-sr-only">open in new window</span></span></a> directly or you can refer to [Cluster Configuration](#Cluster Configuration).</p><p>Configuration files are located at <strong>{cluster_root_dir}/conf</strong></p><p><strong>You are necessary to modify the following configuration items of each node to start your IoTDB cluster</strong>：</p><ul><li><p>iotdb-engine.properties:</p><ul><li>rpc_address</li></ul><ul><li><p>rpc_port</p></li><li><p>base_dir</p></li><li><p>data_dirs</p></li><li><p>wal_dir</p></li></ul></li><li><p>iotdb-cluster.properties</p><ul><li><p>internal_ip</p></li><li><p>internal_meta_port</p></li><li><p>internal_data_port</p></li><li><p>cluster_info_public_port</p></li><li><p>seed_nodes</p></li><li><p>default_replica_num</p></li></ul></li></ul><h3 id="overwrite-the-configurations-of-stand-alone-node" tabindex="-1"><a class="header-anchor" href="#overwrite-the-configurations-of-stand-alone-node" aria-hidden="true">#</a> OverWrite the configurations of Stand-alone node</h3><p>Some configurations in the iotdb-engines.properties will be ignored</p><ul><li><p><code>enable_auto_create_schema</code> is always considered as <code>false</code>. Use <code>enable_auto_create_schema</code> in iotdb-cluster.properties to enable it, instead.</p></li><li><p><code>is_sync_enable</code> is always considered as <code>false</code>.</p></li></ul><h2 id="start-service" tabindex="-1"><a class="header-anchor" href="#start-service" aria-hidden="true">#</a> Start Service</h2><h3 id="start-cluster" tabindex="-1"><a class="header-anchor" href="#start-cluster" aria-hidden="true">#</a> Start Cluster</h3><p>You can deploy a distributed cluster on multiple nodes or on a single machine, the main difference being that the latter needs to handle conflicts between ports and file directories. For detail descriptions, please refer to <a href="#Configurations">Configurations</a>.</p><p>To start the service of one of the nodes, you need to execute the following commands:</p><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code># Unix/OS X |
| > nohup sbin/start-node.sh [printgc] [<conf_path>] >/dev/null 2>&1 & |
| |
| # Windows |
| > sbin\start-node.bat [printgc] [<conf_path>] |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p><code>printgc</code> means whether enable the gc and print gc logs when start the node, <code><conf_path></code> use the configuration file in the <code>conf_path</code> folder to override the default configuration file.</p><p><strong>If you start all the seed nodes, and all the seed nodes can contact each other without ip/port and file directory conflicts, the cluster has successfully started.</strong></p><h3 id="cluster-scalability" tabindex="-1"><a class="header-anchor" href="#cluster-scalability" aria-hidden="true">#</a> Cluster scalability</h3><p>In the process of cluster running, users can add new nodes to the cluster or delete existing nodes. At present, it only supports node by node cluster scalability, and multi node cluster scalability can be transformed into a series of single node cluster scalability operations. The cluster will hanlde new cluster extension operations only after the last cluster scalability operation is completed.</p><p><strong>Start the following script on the new node to join the cluster to add a new node:</strong></p><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code># Unix/OS X |
| > nohup sbin/add-node.sh [printgc] [<conf_path>] >/dev/null 2>&1 & |
| ; |
| # Windows |
| > sbin\add-node.bat [printgc] [<conf_path>] |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p><code>printgc</code> means whether enable the gc and print gc logs when start the node, <code><conf_path></code> use the configuration file in the <code>conf_path</code> folder to override the default configuration file. GC log is off by default. For performance tuning, you may want to collect the GC info. GC log is stored at <code>IOTDB_HOME/logs/gc.log</code>.</p><p><strong>Start the following script on any node in the cluster to delete a node:</strong></p><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code># Unix/OS X |
| > sbin/remove-node.sh <internal_ip> <internal_meta_port> |
| |
| # Windows |
| > sbin\remove-node.bat <internal_ip> <internal_meta_port> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p><code>internal_ip</code> means the IP address of the node to be deleted <code>internal_meta_port</code> means the meta port of the node to be deleted</p><h3 id="use-cli" tabindex="-1"><a class="header-anchor" href="#use-cli" aria-hidden="true">#</a> Use Cli</h3><p>please refer to <a href="https://github.com/apache/iotdb/blob/master/docs/UserGuide/QuickStart/QuickStart.md" target="_blank" rel="noopener noreferrer">QuickStart<span><svg class="external-link-icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg><span class="external-link-icon-sr-only">open in new window</span></span></a>. You can establish a connection with any node in the cluster according to the rpc_address and rpc_port.</p><h3 id="stop-cluster" tabindex="-1"><a class="header-anchor" href="#stop-cluster" aria-hidden="true">#</a> <strong>Stop Cluster</strong></h3><p>To stop the services of all the nodes on a single machine, you need to execute the following commands:</p><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code># Unix/OS X |
| > sbin/stop-node.sh |
| |
| # Windows |
| > sbin\stop-node.bat |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="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="appendix" tabindex="-1"><a class="header-anchor" href="#appendix" aria-hidden="true">#</a> Appendix</h2><h3 id="cluster-configuration" tabindex="-1"><a class="header-anchor" href="#cluster-configuration" aria-hidden="true">#</a> Cluster Configuration</h3><ul><li>internal_ip</li></ul><table><thead><tr><th>Name</th><th>internal_ip</th></tr></thead><tbody><tr><td>Description</td><td>IP address of internal communication between nodes in IOTDB cluster, such as heartbeat, snapshot, raft log, etc. <strong><code>internal_ip</code> is a private ip.</strong></td></tr><tr><td>Type</td><td>String</td></tr><tr><td>Default</td><td>127.0.0.1</td></tr><tr><td>Effective</td><td>After restart system, shall NOT change after cluster is up</td></tr></tbody></table><ul><li>internal_meta_port</li></ul><table><thead><tr><th>Name</th><th>internal_meta_port</th></tr></thead><tbody><tr><td>Description</td><td>IoTDB meta service port, for meta group's communication, which involves all nodes and manages the cluster configuration and storage groups. <strong>IoTDB will automatically create a heartbeat port for each meta service. The default meta service heartbeat port is <code>internal_meta_port+1</code>, please confirm that these two ports are not reserved by the system and are not occupied</strong></td></tr><tr><td>Type</td><td>Int32</td></tr><tr><td>Default</td><td>9003</td></tr><tr><td>Effective</td><td>After restart system, shall NOT change after cluster is up</td></tr></tbody></table><ul><li>internal_data_port</li></ul><table><thead><tr><th>Name</th><th>internal_data_port</th></tr></thead><tbody><tr><td>Description</td><td>IoTDB data service port, for data groups' communication, each consists of one node and its replicas, managing timeseries schemas and data. <strong>IoTDB will automatically create a heartbeat port for each data service. The default data service heartbeat port is <code>internal_data_port+1</code>. Please confirm that these two ports are not reserved by the system and are not occupied</strong></td></tr><tr><td>Type</td><td>Int32</td></tr><tr><td>Default</td><td>40010</td></tr><tr><td>Effective</td><td>After restart system, shall NOT change after cluster is up</td></tr></tbody></table><ul><li>cluster_info_public_port</li></ul><table><thead><tr><th>Name</th><th>cluster_info_public_port</th></tr></thead><tbody><tr><td>Description</td><td>The port of RPC service that getting the cluster info (e.g., data partition)</td></tr><tr><td>Type</td><td>Int32</td></tr><tr><td>Default</td><td>6567</td></tr><tr><td>Effective</td><td>After restart system</td></tr></tbody></table><ul><li>open_server_rpc_port</li></ul><table><thead><tr><th>Name</th><th>open_server_rpc_port</th></tr></thead><tbody><tr><td>Description</td><td>whether open port for server module (for debug purpose), if true, the single's server rpc_port will be changed to <code>rpc_port (in iotdb-engines.properties) + 1</code></td></tr><tr><td>Type</td><td>Boolean</td></tr><tr><td>Default</td><td>False</td></tr><tr><td>Effective</td><td>After restart system</td></tr></tbody></table><ul><li>seed_nodes</li></ul><table><thead><tr><th>Name</th><th>seed_nodes</th></tr></thead><tbody><tr><td>Description</td><td>The address(internal ip) of the nodes in the cluster, <code>{IP/DOMAIN}:internal_meta_port</code> format, separated by commas; for the pseudo-distributed mode, you can fill in <code>localhost</code>, or <code>127.0.0.1</code> or mixed, but the real ip address cannot appear; for the distributed mode, real ip or hostname is supported, but <code>localhost</code> or <code>127.0.0.1</code> cannot appear. When used by <code>start-node.sh(.bat)</code>, this configuration means the nodes that will form the initial cluster, so every node that use <code>start-node.sh(.bat)</code> should have the same <code>seed\_nodes</code>, or the building of the initial cluster will fail. WARNING: if the initial cluster is built, this should not be changed before the environment is cleaned. When used by <code>add-node.sh(.bat)</code>, this means the nodes to which that the application of joining the cluster will be sent, as all nodes can respond to a request, this configuration can be any nodes that already in the cluster, unnecessary to be the nodes that were used to build the initial cluster by <code>start-node.sh(.bat)</code>. Several nodes will be picked randomly to send the request, the number of nodes picked depends on the number of retries.</td></tr><tr><td>Type</td><td>String</td></tr><tr><td>Default</td><td>127.0.0.1:9003,127.0.0.1:9005,127.0.0.1:9007</td></tr><tr><td>Effective</td><td>After restart system</td></tr></tbody></table><ul><li>rpc_thrift_compression_enable</li></ul><table><thead><tr><th>Name</th><th>rpc_thrift_compression_enable</th></tr></thead><tbody><tr><td>Description</td><td>Whether to enable thrift compression, <strong>Note that this parameter should be consistent with each node and with the client, and also consistent with the <code>rpc_thrift_compression_enable</code> parameter in <code>iotdb-engine.properties</code></strong></td></tr><tr><td>Type</td><td>Boolean</td></tr><tr><td>Default</td><td>false</td></tr><tr><td>Effective</td><td>After restart system, must be changed with all other nodes</td></tr></tbody></table><ul><li>default_replica_num</li></ul><table><thead><tr><th>Name</th><th>default_replica_num</th></tr></thead><tbody><tr><td>Description</td><td>Number of cluster replicas of timeseries schema and data. Storage group info is always fully replicated in all nodes.</td></tr><tr><td>Type</td><td>Int32</td></tr><tr><td>Default</td><td>3</td></tr><tr><td>Effective</td><td>After restart system, shall NOT change after cluster is up</td></tr></tbody></table><ul><li>multi_raft_factor</li></ul><table><thead><tr><th>Name</th><th>multi_raft_factor</th></tr></thead><tbody><tr><td>Description</td><td>Number of raft group instances started by each data group. By default, each data group starts one raft group</td></tr><tr><td>Type</td><td>Int32</td></tr><tr><td>Default</td><td>1</td></tr><tr><td>Effective</td><td>After restart system, shall NOT change after cluster is up</td></tr></tbody></table><ul><li>cluster_name</li></ul><table><thead><tr><th>Name</th><th>cluster_name</th></tr></thead><tbody><tr><td>Description</td><td>Cluster name is used to identify different clusters, <strong><code>cluster_name</code> of all nodes in a cluster must be the same</strong></td></tr><tr><td>Type</td><td>String</td></tr><tr><td>Default</td><td>default</td></tr><tr><td>Effective</td><td>After restart system</td></tr></tbody></table><ul><li>connection_timeout_ms</li></ul><table><thead><tr><th>Name</th><th>connection_timeout_ms</th></tr></thead><tbody><tr><td>Description</td><td>Thrift socket and connection timeout between raft nodes, in milliseconds. <strong>Note that the timeout of the connection used for sending heartbeats and requesting votes will be adjust to min(heartbeat_interval_ms, connection_timeout_ms).</strong></td></tr><tr><td>Type</td><td>Int32</td></tr><tr><td>Default</td><td>20000</td></tr><tr><td>Effective</td><td>After restart system</td></tr></tbody></table><ul><li>heartbeat_interval_ms</li></ul><table><thead><tr><th>Name</th><th>heartbeat_interval_ms</th></tr></thead><tbody><tr><td>Description</td><td>The time period between heartbeat broadcasts in leader, in milliseconds</td></tr><tr><td>Type</td><td>Int64</td></tr><tr><td>Default</td><td>1000</td></tr><tr><td>Effective</td><td>After restart system</td></tr></tbody></table><ul><li>election_timeout_ms</li></ul><table><thead><tr><th>Name</th><th>election_timeout_ms</th></tr></thead><tbody><tr><td>Description</td><td>The election timeout in follower, or the time waiting for request votes in elector, in milliseconds</td></tr><tr><td>Type</td><td>Int64</td></tr><tr><td>Default</td><td>20000</td></tr><tr><td>Effective</td><td>After restart system</td></tr></tbody></table><ul><li>read_operation_timeout_ms</li></ul><table><thead><tr><th>Name</th><th>read_operation_timeout_ms</th></tr></thead><tbody><tr><td>Description</td><td>Read operation timeout time period, for internal communication only, not for the entire operation, in milliseconds</td></tr><tr><td>Type</td><td>Int32</td></tr><tr><td>Default</td><td>30000</td></tr><tr><td>Effective</td><td>After restart system</td></tr></tbody></table><ul><li>write_operation_timeout_ms</li></ul><table><thead><tr><th>Name</th><th>write_operation_timeout_ms</th></tr></thead><tbody><tr><td>Description</td><td>The write operation timeout period, for internal communication only, not for the entire operation, in milliseconds</td></tr><tr><td>Type</td><td>Int32</td></tr><tr><td>Default</td><td>30000</td></tr><tr><td>Effective</td><td>After restart system</td></tr></tbody></table><ul><li>min_num_of_logs_in_mem</li></ul><table><thead><tr><th>Name</th><th>min_num_of_logs_in_mem</th></tr></thead><tbody><tr><td>Description</td><td>The minimum number of committed logs in memory, after each log deletion, at most such number of logs will remain in memory. Increasing the number will reduce the chance to use snapshot in catch-ups, but will also increase the memory footprint</td></tr><tr><td>Type</td><td>Int32</td></tr><tr><td>Default</td><td>100</td></tr><tr><td>Effective</td><td>After restart system</td></tr></tbody></table><ul><li>max_num_of_logs_in_mem</li></ul><table><thead><tr><th>Name</th><th>max_num_of_logs_in_mem</th></tr></thead><tbody><tr><td>Description</td><td>Maximum number of committed logs in memory, when reached, a log deletion will be triggered. Increasing the number will reduce the chance to use snapshot in catch-ups, but will also increase memory footprint</td></tr><tr><td>Type</td><td>Int32</td></tr><tr><td>Default</td><td>1000</td></tr><tr><td>Effective</td><td>After restart system</td></tr></tbody></table><ul><li>log_deletion_check_interval_second</li></ul><table><thead><tr><th>Name</th><th>log_deletion_check_interval_second</th></tr></thead><tbody><tr><td>Description</td><td>The interval for checking and deleting the committed log task, which removes oldest in-memory committed logs when their size exceeds <code>min_num_of_logs_in_mem</code> , in seconds</td></tr><tr><td>Type</td><td>Int32</td></tr><tr><td>Default</td><td>60</td></tr><tr><td>Effective</td><td>After restart system</td></tr></tbody></table><ul><li>enable_auto_create_schema</li></ul><table><thead><tr><th>Name</th><th>enable_auto_create_schema</th></tr></thead><tbody><tr><td>Description</td><td>Whether creating schema automatically is enabled, this will replace the one in <code>iotdb-engine.properties</code></td></tr><tr><td>Type</td><td>BOOLEAN</td></tr><tr><td>Default</td><td>true</td></tr><tr><td>Effective</td><td>After restart system</td></tr></tbody></table><ul><li>consistency_level</li></ul><table><thead><tr><th>Name</th><th>consistency_level</th></tr></thead><tbody><tr><td>Description</td><td>Consistency level, now three consistency levels are supported: strong, mid, and weak. Strong consistency means the server will first try to synchronize with the leader to get the newest data, if failed(timeout), directly report an error to the user; While mid consistency means the server will first try to synchronize with the leader, but if failed(timeout), it will give up and just use current data it has cached before; Weak consistency does not synchronize with the leader and simply use the local data</td></tr><tr><td>Type</td><td>strong, mid, weak</td></tr><tr><td>Default</td><td>mid</td></tr><tr><td>Effective</td><td>After restart system</td></tr></tbody></table><ul><li>is_enable_raft_log_persistence</li></ul><table><thead><tr><th>Name</th><th>is_enable_raft_log_persistence</th></tr></thead><tbody><tr><td>Description</td><td>Whether to enable raft log persistence</td></tr><tr><td>Type</td><td>BOOLEAN</td></tr><tr><td>Default</td><td>true</td></tr><tr><td>Effective</td><td>After restart system</td></tr></tbody></table></div><!----><footer class="page-meta"><div class="meta-item edit-link"><a href="https://github.com/apache/iotdb/edit/rel/0.13/docs/UserGuide/Cluster/Cluster-Setup.md" rel="noopener noreferrer" target="_blank" aria-label="Found Error? Edit this page on GitHub" class="nav-link label"><!--[--><svg xmlns="http://www.w3.org/2000/svg" class="icon edit-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="edit icon"><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<span><svg class="external-link-icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg><span class="external-link-icon-sr-only">open in new window</span></span><!----></a></div><div class="meta-item git-info"><!----><!----></div></footer><!----><!----><!----><!--]--></main><!--]--><footer style="padding-bottom:2rem;"><span id="doc-version" style="display:none;">rel/0.13</span><p style="text-align:center;color:#909399;font-size:12px;margin:0 30px;">Copyright © 2023 The Apache Software Foundation.<br> Apache and the Apache feather logo are trademarks of The Apache Software Foundation</p><p style="text-align:center;margin-top:10px;color:#909399;font-size:12px;margin:0 30px;"><strong>Have a question?</strong> Connect with us on QQ, WeChat, or Slack. <a href="https://github.com/apache/iotdb/issues/1995">Join the community</a> now.</p><p style="text-align:center;margin-top:10px;color:#909399;font-size:12px;margin:0 30px;"> We use <a href="https://analytics.google.com">Google Analytics</a> to collect anonymous, aggregated usage information. </p></footer></div><!--]--><!--]--><!----><!--]--></div> |
| <script type="module" src="/assets/app-f2ec2f8e.js" defer></script> |
| </body> |
| </html> |
