blob: e4abcf604206f49867fa3614b7c9b2ee821902f5 [file] [log] [blame]
import{_ as t,c as a,b as e,o}from"./app-C8175JBb.js";const l={};function n(p,s){return o(),a("div",null,s[0]||(s[0]=[e(`<h1 id="data-export" tabindex="-1"><a class="header-anchor" href="#data-export"><span>Data Export</span></a></h1><h2 id="_1-overview" tabindex="-1"><a class="header-anchor" href="#_1-overview"><span>1. Overview</span></a></h2><p>The data export tool, <a href="http://export-data.sh" target="_blank" rel="noopener noreferrer">export-data.sh</a> (Unix/OS X) or export-data.bat (Windows), located in the tools directory, allows users to export query results from specified SQL statements into CSV, SQL, or TsFile (open-source time-series file format) formats. The specific functionalities are as follows:</p><table style="text-align:left;"><tbody><tr><th>File Format</th><th>IoTDB Tool</th><th>Description</th></tr><tr><td>CSV</td><td rowspan="3">export-data.sh/bat</td><td>Plain text format for storing structured data. Must follow the CSV format specified below.</td></tr><tr><td>SQL</td><td>File containing custom SQL statements.</td></tr><tr><td>TsFile</td><td>Open-source time-series file format.</td></tr></tbody></table><h2 id="_2-detailed-functionality" tabindex="-1"><a class="header-anchor" href="#_2-detailed-functionality"><span>2. Detailed Functionality</span></a></h2><h3 id="_2-1-common-parameters" tabindex="-1"><a class="header-anchor" href="#_2-1-common-parameters"><span>2.1 Common Parameters</span></a></h3><table><thead><tr><th>Short</th><th>Full Parameter</th><th>Description</th><th>Required</th><th>Default</th></tr></thead><tbody><tr><td><code>-ft</code></td><td><code>--file_type</code></td><td>Export file type: <code>csv</code>, <code>sql</code>, <code>tsfile</code>.</td><td>​<strong>Yes</strong></td><td>-</td></tr><tr><td><code>-h</code></td><td><code>--host</code></td><td>Hostname of the IoTDB server.</td><td>No</td><td><code>127.0.0.1</code></td></tr><tr><td><code>-p</code></td><td><code>--port</code></td><td>Port number of the IoTDB server.</td><td>No</td><td><code>6667</code></td></tr><tr><td><code>-u</code></td><td><code>--username</code></td><td>Username for authentication.</td><td>No</td><td><code>root</code></td></tr><tr><td><code>-pw</code></td><td><code>--password</code></td><td>Password for authentication.</td><td>No</td><td><code>root</code></td></tr><tr><td><code>-t</code></td><td><code>--target</code></td><td>Target directory for the output files. If the path does not exist, it will be created.</td><td>​<strong>Yes</strong></td><td>-</td></tr><tr><td><code>-pfn</code></td><td><code>--prefix_file_name</code></td><td>Prefix for the exported file names. For example, <code>abc</code> will generate files like <code>abc_0.tsfile</code>, <code>abc_1.tsfile</code>.</td><td>No</td><td><code>dump_0.tsfile</code></td></tr><tr><td><code>-q</code></td><td><code>--query</code></td><td>SQL query command to execute.</td><td>No</td><td>-</td></tr><tr><td><code>-timeout</code></td><td><code>--query_timeout</code></td><td>Query timeout in milliseconds (ms).</td><td>No</td><td><code>-1</code> (Range: -1~Long max=9223372036854775807)</td></tr><tr><td><code>-help</code></td><td><code>--help</code></td><td>Display help information.</td><td>No</td><td>-</td></tr></tbody></table><h3 id="_2-2-csv-format" tabindex="-1"><a class="header-anchor" href="#_2-2-csv-format"><span>2.2 CSV Format</span></a></h3><h4 id="_2-2-1-command" tabindex="-1"><a class="header-anchor" href="#_2-2-1-command"><span>2.2.1 Command</span></a></h4><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#7F848E;font-style:italic;"># Unix/OS X</span></span>
<span class="line"><span style="color:#ABB2BF;">&gt; tools/export-data.sh -ft&lt;format&gt; [-h </span><span style="color:#56B6C2;">&lt;</span><span style="color:#ABB2BF;">host</span><span style="color:#56B6C2;">&gt;</span><span style="color:#ABB2BF;">] [-p </span><span style="color:#56B6C2;">&lt;</span><span style="color:#ABB2BF;">port</span><span style="color:#56B6C2;">&gt;</span><span style="color:#ABB2BF;">] [-u </span><span style="color:#56B6C2;">&lt;</span><span style="color:#ABB2BF;">username</span><span style="color:#56B6C2;">&gt;</span><span style="color:#ABB2BF;">] [-pw </span><span style="color:#56B6C2;">&lt;</span><span style="color:#ABB2BF;">password</span><span style="color:#56B6C2;">&gt;</span><span style="color:#ABB2BF;">] -t &lt;target_directory&gt; </span></span>
<span class="line"><span style="color:#ABB2BF;"> [-pfn </span><span style="color:#56B6C2;">&lt;</span><span style="color:#ABB2BF;">prefix_file_name</span><span style="color:#56B6C2;">&gt;</span><span style="color:#ABB2BF;">] [-dt </span><span style="color:#56B6C2;">&lt;</span><span style="color:#ABB2BF;">datatype</span><span style="color:#56B6C2;">&gt;</span><span style="color:#ABB2BF;">] [-lpf </span><span style="color:#56B6C2;">&lt;</span><span style="color:#ABB2BF;">lines_per_file</span><span style="color:#56B6C2;">&gt;</span><span style="color:#ABB2BF;">] [-tf </span><span style="color:#56B6C2;">&lt;</span><span style="color:#ABB2BF;">time_format</span><span style="color:#56B6C2;">&gt;</span><span style="color:#ABB2BF;">] </span></span>
<span class="line"><span style="color:#ABB2BF;"> [-tz </span><span style="color:#56B6C2;">&lt;</span><span style="color:#ABB2BF;">timezone</span><span style="color:#56B6C2;">&gt;</span><span style="color:#ABB2BF;">] [-q </span><span style="color:#56B6C2;">&lt;</span><span style="color:#ABB2BF;">query_command</span><span style="color:#56B6C2;">&gt;</span><span style="color:#ABB2BF;">] [-timeout </span><span style="color:#56B6C2;">&lt;</span><span style="color:#ABB2BF;">query_timeout</span><span style="color:#56B6C2;">&gt;</span><span style="color:#ABB2BF;">]</span></span>
<span class="line"><span style="color:#7F848E;font-style:italic;"># Windows</span></span>
<span class="line"><span style="color:#ABB2BF;">&gt; tools</span><span style="color:#56B6C2;">\\e</span><span style="color:#ABB2BF;">xport-data.bat -ft&lt;format&gt; [-h </span><span style="color:#56B6C2;">&lt;</span><span style="color:#ABB2BF;">host</span><span style="color:#56B6C2;">&gt;</span><span style="color:#ABB2BF;">] [-p </span><span style="color:#56B6C2;">&lt;</span><span style="color:#ABB2BF;">port</span><span style="color:#56B6C2;">&gt;</span><span style="color:#ABB2BF;">] [-u </span><span style="color:#56B6C2;">&lt;</span><span style="color:#ABB2BF;">username</span><span style="color:#56B6C2;">&gt;</span><span style="color:#ABB2BF;">] [-pw </span><span style="color:#56B6C2;">&lt;</span><span style="color:#ABB2BF;">password</span><span style="color:#56B6C2;">&gt;</span><span style="color:#ABB2BF;">] -t &lt;target_directory&gt; </span></span>
<span class="line"><span style="color:#ABB2BF;"> [-pfn </span><span style="color:#56B6C2;">&lt;</span><span style="color:#ABB2BF;">prefix_file_name</span><span style="color:#56B6C2;">&gt;</span><span style="color:#ABB2BF;">] [-dt </span><span style="color:#56B6C2;">&lt;</span><span style="color:#ABB2BF;">datatype</span><span style="color:#56B6C2;">&gt;</span><span style="color:#ABB2BF;">] [-lpf </span><span style="color:#56B6C2;">&lt;</span><span style="color:#ABB2BF;">lines_per_file</span><span style="color:#56B6C2;">&gt;</span><span style="color:#ABB2BF;">] [-tf </span><span style="color:#56B6C2;">&lt;</span><span style="color:#ABB2BF;">time_format</span><span style="color:#56B6C2;">&gt;</span><span style="color:#ABB2BF;">] </span></span>
<span class="line"><span style="color:#ABB2BF;"> [-tz </span><span style="color:#56B6C2;">&lt;</span><span style="color:#ABB2BF;">timezone</span><span style="color:#56B6C2;">&gt;</span><span style="color:#ABB2BF;">] [-q </span><span style="color:#56B6C2;">&lt;</span><span style="color:#ABB2BF;">query_command</span><span style="color:#56B6C2;">&gt;</span><span style="color:#ABB2BF;">] [-timeout </span><span style="color:#56B6C2;">&lt;</span><span style="color:#ABB2BF;">query_timeout</span><span style="color:#56B6C2;">&gt;</span><span style="color:#ABB2BF;">]</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h4 id="_2-2-2-csv-specific-parameters" tabindex="-1"><a class="header-anchor" href="#_2-2-2-csv-specific-parameters"><span>2.2.2 CSV-Specific Parameters</span></a></h4><table><thead><tr><th>Short</th><th>Full Parameter</th><th>Description</th><th>Required</th><th>Default</th></tr></thead><tbody><tr><td><code>-dt</code></td><td><code>--datatype</code></td><td>Whether to include data types in the CSV file header (<code>true</code> or <code>false</code>).</td><td>No</td><td><code>false</code></td></tr><tr><td><code>-lpf</code></td><td><code>--lines_per_file</code></td><td>Number of rows per exported file.</td><td>No</td><td><code>10000</code> (Range:0~Integer.Max=2147483647)</td></tr><tr><td><code>-tf</code></td><td><code>--time_format</code></td><td>Time format for the CSV file. Options: 1) Timestamp (numeric, long), 2) ISO8601 (default), 3) Custom pattern (e.g., <code>yyyy-MM-dd HH:mm:ss</code>). SQL file timestamps are unaffected by this setting.</td><td>No</td><td><code>ISO8601</code></td></tr><tr><td><code>-tz</code></td><td><code>--timezone</code></td><td>Timezone setting (e.g., <code>+08:00</code>, <code>-01:00</code>).</td><td>No</td><td>System default</td></tr></tbody></table><h4 id="_2-2-3-examples" tabindex="-1"><a class="header-anchor" href="#_2-2-3-examples"><span>2.2.3 Examples</span></a></h4><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#7F848E;font-style:italic;"># Valid Example</span></span>
<span class="line"><span style="color:#ABB2BF;">&gt; tools/export-data.sh -ft csv -h 127.0.0.1 -p 6667 -u root -pw root -t /path/export/dir </span></span>
<span class="line"><span style="color:#61AFEF;"> -pfn</span><span style="color:#98C379;"> exported-data.csv</span><span style="color:#D19A66;"> -dt</span><span style="color:#D19A66;"> true</span><span style="color:#D19A66;"> -lpf</span><span style="color:#D19A66;"> 1000</span><span style="color:#D19A66;"> -tf</span><span style="color:#98C379;"> &quot;yyyy-MM-dd HH:mm:ss&quot;</span></span>
<span class="line"><span style="color:#61AFEF;"> -tz</span><span style="color:#98C379;"> +08:00</span><span style="color:#D19A66;"> -q</span><span style="color:#98C379;"> &quot;SELECT * FROM root.ln&quot;</span><span style="color:#D19A66;"> -timeout</span><span style="color:#D19A66;"> 20000</span><span style="color:#ABB2BF;"> </span></span>
<span class="line"><span style="color:#ABB2BF;"> </span></span>
<span class="line"><span style="color:#7F848E;font-style:italic;"># Error Example</span></span>
<span class="line"><span style="color:#ABB2BF;">&gt; tools/export-data.sh -ft csv -h 127.0.0.1 -p 6667 -u root -pw root</span></span>
<span class="line"><span style="color:#61AFEF;">Parse</span><span style="color:#98C379;"> error:</span><span style="color:#98C379;"> Missing</span><span style="color:#98C379;"> required</span><span style="color:#98C379;"> option:</span><span style="color:#98C379;"> t</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></div><h2 id="_2-3-sql-format" tabindex="-1"><a class="header-anchor" href="#_2-3-sql-format"><span>2.3 SQL Format</span></a></h2><h4 id="_2-3-1-command" tabindex="-1"><a class="header-anchor" href="#_2-3-1-command"><span>2.3.1 Command</span></a></h4><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#7F848E;font-style:italic;"># Unix/OS X</span></span>
<span class="line"><span style="color:#ABB2BF;">&gt; tools/export-data.sh -ft&lt;format&gt; [-h </span><span style="color:#56B6C2;">&lt;</span><span style="color:#ABB2BF;">host</span><span style="color:#56B6C2;">&gt;</span><span style="color:#ABB2BF;">] [-p </span><span style="color:#56B6C2;">&lt;</span><span style="color:#ABB2BF;">port</span><span style="color:#56B6C2;">&gt;</span><span style="color:#ABB2BF;">] [-u </span><span style="color:#56B6C2;">&lt;</span><span style="color:#ABB2BF;">username</span><span style="color:#56B6C2;">&gt;</span><span style="color:#ABB2BF;">] [-pw </span><span style="color:#56B6C2;">&lt;</span><span style="color:#ABB2BF;">password</span><span style="color:#56B6C2;">&gt;</span><span style="color:#ABB2BF;">] </span></span>
<span class="line"><span style="color:#61AFEF;"> -t</span><span style="color:#ABB2BF;"> &lt;</span><span style="color:#98C379;">target_director</span><span style="color:#ABB2BF;">y&gt; [-pfn &lt;</span><span style="color:#98C379;">prefix_file_nam</span><span style="color:#ABB2BF;">e&gt;</span><span style="color:#98C379;">]</span><span style="color:#ABB2BF;"> [-aligned &lt;</span><span style="color:#98C379;">export</span><span style="color:#98C379;"> aligned</span><span style="color:#98C379;"> insert</span><span style="color:#98C379;"> sq</span><span style="color:#ABB2BF;">l&gt;</span><span style="color:#98C379;">]</span></span>
<span class="line"><span style="color:#61AFEF;"> -lpf</span><span style="color:#ABB2BF;"> &lt;</span><span style="color:#98C379;">lines_per_fil</span><span style="color:#ABB2BF;">e&gt; </span><span style="color:#98C379;">-</span><span style="color:#ABB2BF;"> [-tf &lt;</span><span style="color:#98C379;">time_forma</span><span style="color:#ABB2BF;">t&gt;</span><span style="color:#98C379;">]</span><span style="color:#ABB2BF;"> [-tz &lt;</span><span style="color:#98C379;">timezon</span><span style="color:#ABB2BF;">e&gt;</span><span style="color:#98C379;">]</span><span style="color:#ABB2BF;"> [-q &lt;</span><span style="color:#98C379;">query_comman</span><span style="color:#ABB2BF;">d&gt;</span><span style="color:#98C379;">]</span><span style="color:#ABB2BF;"> [-timeout &lt;</span><span style="color:#98C379;">query_timeou</span><span style="color:#ABB2BF;">t&gt;</span><span style="color:#98C379;">]</span></span>
<span class="line"><span style="color:#ABB2BF;"> </span></span>
<span class="line"><span style="color:#7F848E;font-style:italic;"># Windows</span></span>
<span class="line"><span style="color:#ABB2BF;">&gt; tools</span><span style="color:#56B6C2;">\\e</span><span style="color:#ABB2BF;">xport-data.bat -ft&lt;format&gt; [-h </span><span style="color:#56B6C2;">&lt;</span><span style="color:#ABB2BF;">host</span><span style="color:#56B6C2;">&gt;</span><span style="color:#56B6C2;"> -p</span><span style="color:#56B6C2;"> &lt;</span><span style="color:#ABB2BF;">port</span><span style="color:#56B6C2;">&gt;</span><span style="color:#56B6C2;"> -u</span><span style="color:#56B6C2;"> &lt;</span><span style="color:#ABB2BF;">username</span><span style="color:#56B6C2;">&gt;</span><span style="color:#ABB2BF;"> -pw </span><span style="color:#56B6C2;">&lt;</span><span style="color:#ABB2BF;">password</span><span style="color:#56B6C2;">&gt;</span><span style="color:#ABB2BF;">] </span></span>
<span class="line"><span style="color:#61AFEF;"> -t</span><span style="color:#ABB2BF;"> &lt;</span><span style="color:#98C379;">target_director</span><span style="color:#ABB2BF;">y&gt; [-pfn &lt;</span><span style="color:#98C379;">prefix_file_nam</span><span style="color:#ABB2BF;">e&gt; </span><span style="color:#D19A66;">-aligned</span><span style="color:#ABB2BF;"> &lt;</span><span style="color:#98C379;">export</span><span style="color:#98C379;"> aligned</span><span style="color:#98C379;"> insert</span><span style="color:#98C379;"> sq</span><span style="color:#ABB2BF;">l&gt; </span></span>
<span class="line"><span style="color:#61AFEF;"> -lpf</span><span style="color:#ABB2BF;"> &lt;</span><span style="color:#98C379;">lines_per_fil</span><span style="color:#ABB2BF;">e&gt; </span><span style="color:#D19A66;">-tf</span><span style="color:#ABB2BF;"> &lt;</span><span style="color:#98C379;">time_forma</span><span style="color:#ABB2BF;">t&gt; </span><span style="color:#D19A66;">-tz</span><span style="color:#ABB2BF;"> &lt;</span><span style="color:#98C379;">timezon</span><span style="color:#ABB2BF;">e&gt; </span><span style="color:#D19A66;">-q</span><span style="color:#ABB2BF;"> &lt;</span><span style="color:#98C379;">query_comman</span><span style="color:#ABB2BF;">d&gt; </span><span style="color:#D19A66;">-timeout</span><span style="color:#ABB2BF;"> &lt;</span><span style="color:#98C379;">query_timeou</span><span style="color:#ABB2BF;">t&gt;</span><span style="color:#98C379;">]</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h4 id="_2-3-2-sql-specific-parameters" tabindex="-1"><a class="header-anchor" href="#_2-3-2-sql-specific-parameters"><span>2.3.2 SQL-Specific Parameters</span></a></h4><table><thead><tr><th>Short</th><th>Full Parameter</th><th>Description</th><th>Required</th><th>Default</th></tr></thead><tbody><tr><td><code>-aligned</code></td><td><code>--use_aligned</code></td><td>Whether to export as aligned SQL format (<code>true</code> or <code>false</code>).</td><td>No</td><td><code>true</code></td></tr><tr><td><code>-lpf</code></td><td><code>--lines_per_file</code></td><td>Number of rows per exported file.</td><td>No</td><td><code>10000</code> (Range:0~Integer.Max=2147483647)</td></tr><tr><td><code>-tf</code></td><td><code>--time_format</code></td><td>Time format for the CSV file. Options: 1) Timestamp (numeric, long), 2) ISO8601 (default), 3) Custom pattern (e.g., <code>yyyy-MM-dd HH:mm:ss</code>). SQL file timestamps are unaffected by this setting.</td><td>No</td><td><code>ISO8601</code></td></tr><tr><td><code>-tz</code></td><td><code>--timezone</code></td><td>Timezone setting (e.g., <code>+08:00</code>, <code>-01:00</code>).</td><td>No</td><td>System default</td></tr></tbody></table><h4 id="_2-3-3-examples" tabindex="-1"><a class="header-anchor" href="#_2-3-3-examples"><span>2.3.3 Examples</span></a></h4><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#7F848E;font-style:italic;"># Valid Example</span></span>
<span class="line"><span style="color:#ABB2BF;">&gt; tools/export-data.sh -ft sql -h 127.0.0.1 -p 6667 -u root -pw root -t /path/export/dir </span></span>
<span class="line"><span style="color:#61AFEF;"> -pfn</span><span style="color:#98C379;"> exported-data.csv</span><span style="color:#D19A66;"> -aligned</span><span style="color:#D19A66;"> true</span><span style="color:#D19A66;"> -lpf</span><span style="color:#D19A66;"> 1000</span><span style="color:#D19A66;"> -tf</span><span style="color:#98C379;"> &quot;yyyy-MM-dd HH:mm:ss&quot;</span></span>
<span class="line"><span style="color:#61AFEF;"> -tz</span><span style="color:#98C379;"> +08:00</span><span style="color:#D19A66;"> -q</span><span style="color:#98C379;"> &quot;SELECT * FROM root.ln&quot;</span><span style="color:#D19A66;"> -timeout</span><span style="color:#D19A66;"> 20000</span><span style="color:#ABB2BF;"> </span></span>
<span class="line"><span style="color:#ABB2BF;"> </span></span>
<span class="line"><span style="color:#7F848E;font-style:italic;"># Error Example</span></span>
<span class="line"><span style="color:#ABB2BF;">&gt; tools/export-data.sh -ft sql -h 127.0.0.1 -p 6667 -u root -pw root</span></span>
<span class="line"><span style="color:#61AFEF;">Parse</span><span style="color:#98C379;"> error:</span><span style="color:#98C379;"> Missing</span><span style="color:#98C379;"> required</span><span style="color:#98C379;"> option:</span><span style="color:#98C379;"> t</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></div><h3 id="_2-4-tsfile-format" tabindex="-1"><a class="header-anchor" href="#_2-4-tsfile-format"><span>2.4 TsFile Format</span></a></h3><h4 id="_2-4-1-command" tabindex="-1"><a class="header-anchor" href="#_2-4-1-command"><span>2.4.1 Command</span></a></h4><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#7F848E;font-style:italic;"># Unix/OS X</span></span>
<span class="line"><span style="color:#ABB2BF;">&gt; tools/export-data.sh -ft&lt;format&gt; [-h </span><span style="color:#56B6C2;">&lt;</span><span style="color:#ABB2BF;">host</span><span style="color:#56B6C2;">&gt;</span><span style="color:#ABB2BF;">] [-p </span><span style="color:#56B6C2;">&lt;</span><span style="color:#ABB2BF;">port</span><span style="color:#56B6C2;">&gt;</span><span style="color:#ABB2BF;">] [-u </span><span style="color:#56B6C2;">&lt;</span><span style="color:#ABB2BF;">username</span><span style="color:#56B6C2;">&gt;</span><span style="color:#ABB2BF;">] [-pw </span><span style="color:#56B6C2;">&lt;</span><span style="color:#ABB2BF;">password</span><span style="color:#56B6C2;">&gt;</span><span style="color:#ABB2BF;">]</span></span>
<span class="line"><span style="color:#61AFEF;"> -t</span><span style="color:#ABB2BF;"> &lt;</span><span style="color:#98C379;">target_director</span><span style="color:#ABB2BF;">y&gt; [-pfn &lt;</span><span style="color:#98C379;">prefix_file_nam</span><span style="color:#ABB2BF;">e&gt;</span><span style="color:#98C379;">]</span><span style="color:#ABB2BF;"> [-q &lt;</span><span style="color:#98C379;">query_comman</span><span style="color:#ABB2BF;">d&gt;</span><span style="color:#98C379;">]</span><span style="color:#ABB2BF;"> [-timeout &lt;</span><span style="color:#98C379;">query_timeou</span><span style="color:#ABB2BF;">t&gt;</span><span style="color:#98C379;">]</span></span>
<span class="line"><span style="color:#ABB2BF;"> </span></span>
<span class="line"><span style="color:#7F848E;font-style:italic;"># Windows</span></span>
<span class="line"><span style="color:#ABB2BF;">&gt; tools</span><span style="color:#56B6C2;">\\e</span><span style="color:#ABB2BF;">xport-data.bat -ft&lt;format&gt; [-h </span><span style="color:#56B6C2;">&lt;</span><span style="color:#ABB2BF;">host</span><span style="color:#56B6C2;">&gt;</span><span style="color:#ABB2BF;">] [-p </span><span style="color:#56B6C2;">&lt;</span><span style="color:#ABB2BF;">port</span><span style="color:#56B6C2;">&gt;</span><span style="color:#ABB2BF;">] [-u </span><span style="color:#56B6C2;">&lt;</span><span style="color:#ABB2BF;">username</span><span style="color:#56B6C2;">&gt;</span><span style="color:#ABB2BF;">] [-pw </span><span style="color:#56B6C2;">&lt;</span><span style="color:#ABB2BF;">password</span><span style="color:#56B6C2;">&gt;</span><span style="color:#ABB2BF;">]</span></span>
<span class="line"><span style="color:#61AFEF;"> -t</span><span style="color:#ABB2BF;"> &lt;</span><span style="color:#98C379;">target_director</span><span style="color:#ABB2BF;">y&gt; [-pfn &lt;</span><span style="color:#98C379;">prefix_file_nam</span><span style="color:#ABB2BF;">e&gt;</span><span style="color:#98C379;">]</span><span style="color:#ABB2BF;"> [-q &lt;</span><span style="color:#98C379;">query_comman</span><span style="color:#ABB2BF;">d&gt;</span><span style="color:#98C379;">]</span><span style="color:#ABB2BF;"> [-timeout &lt;</span><span style="color:#98C379;">query_timeou</span><span style="color:#ABB2BF;">t&gt;</span><span style="color:#98C379;">]</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h4 id="_2-4-2-tsfile-specific-parameters" tabindex="-1"><a class="header-anchor" href="#_2-4-2-tsfile-specific-parameters"><span>2.4.2 TsFile-Specific Parameters</span></a></h4><ul><li>None</li></ul><h4 id="_2-4-3-examples" tabindex="-1"><a class="header-anchor" href="#_2-4-3-examples"><span>2.4.3 Examples</span></a></h4><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#7F848E;font-style:italic;"># Valid Example</span></span>
<span class="line"><span style="color:#ABB2BF;">&gt; tools/export-data.sh -ft tsfile -h 127.0.0.1 -p 6667 -u root -pw root -t /path/export/dir </span></span>
<span class="line"><span style="color:#61AFEF;"> -pfn</span><span style="color:#98C379;"> export-data.tsfile</span><span style="color:#D19A66;"> -q</span><span style="color:#98C379;"> &quot;SELECT * FROM root.ln&quot;</span><span style="color:#D19A66;"> -timeout</span><span style="color:#D19A66;"> 10000</span></span>
<span class="line"><span style="color:#ABB2BF;"> </span></span>
<span class="line"><span style="color:#7F848E;font-style:italic;"># Error Example</span></span>
<span class="line"><span style="color:#ABB2BF;">&gt; tools/export-data.sh -ft tsfile -h 127.0.0.1 -p 6667 -u root -pw root</span></span>
<span class="line"><span style="color:#61AFEF;">Parse</span><span style="color:#98C379;"> error:</span><span style="color:#98C379;"> Missing</span><span style="color:#98C379;"> required</span><span style="color:#98C379;"> option:</span><span style="color:#98C379;"> t</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></div>`,28)]))}const c=t(l,[["render",n],["__file","Data-Export-Tool-1-3-4.html.vue"]]),d=JSON.parse('{"path":"/UserGuide/V1.3.x/Tools-System/Data-Export-Tool-1-3-4.html","title":"Data Export","lang":"en-US","frontmatter":{"description":"Data Export 1. Overview The data export tool, export-data.sh (Unix/OS X) or export-data.bat (Windows), located in the tools directory, allows users to export query results from ...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://iotdb.apache.org/zh/UserGuide/V1.3.x/Tools-System/Data-Export-Tool-1-3-4.html"}],["meta",{"property":"og:url","content":"https://iotdb.apache.org/UserGuide/V1.3.x/Tools-System/Data-Export-Tool-1-3-4.html"}],["meta",{"property":"og:site_name","content":"IoTDB Website"}],["meta",{"property":"og:title","content":"Data Export"}],["meta",{"property":"og:description","content":"Data Export 1. Overview The data export tool, export-data.sh (Unix/OS X) or export-data.bat (Windows), located in the tools directory, allows users to export query results from ..."}],["meta",{"property":"og:type","content":"article"}],["meta",{"property":"og:locale","content":"en-US"}],["meta",{"property":"og:locale:alternate","content":"zh-CN"}],["meta",{"property":"og:updated_time","content":"2025-04-03T02:32:58.000Z"}],["meta",{"property":"article:modified_time","content":"2025-04-03T02:32:58.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Data Export\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2025-04-03T02:32:58.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"1. Overview","slug":"_1-overview","link":"#_1-overview","children":[]},{"level":2,"title":"2. Detailed Functionality","slug":"_2-detailed-functionality","link":"#_2-detailed-functionality","children":[{"level":3,"title":"2.1 Common Parameters","slug":"_2-1-common-parameters","link":"#_2-1-common-parameters","children":[]},{"level":3,"title":"2.2 CSV Format","slug":"_2-2-csv-format","link":"#_2-2-csv-format","children":[]}]},{"level":2,"title":"2.3 SQL Format","slug":"_2-3-sql-format","link":"#_2-3-sql-format","children":[{"level":3,"title":"2.4 TsFile Format","slug":"_2-4-tsfile-format","link":"#_2-4-tsfile-format","children":[]}]}],"git":{"createdTime":1741839104000,"updatedTime":1743647578000,"contributors":[{"name":"leto-b","username":"leto-b","email":"bingqian.bai@timecho.com","commits":2,"url":"https://github.com/leto-b"}]},"readingTime":{"minutes":2.64,"words":791},"filePathRelative":"UserGuide/V1.3.x/Tools-System/Data-Export-Tool-1-3-4.md","localizedDate":"March 13, 2025","autoDesc":true}');export{c as comp,d as data};