Google Git
Sign in
apache / tsfile-website / ab340b013b1e6127dcc9aefa3ef06a53bac89034 / . / assets / InterfaceDefinition-Java.html-IdYcTZBV.js
blob: e3690f4027b2ab40528459f6673463e251c85c5d [file] [log] [blame]
import{_ as n}from"./plugin-vue_export-helper-DlAUqK2U.js";import{c as a,b as l,o as e}from"./app-CQ7n-jLB.js";const o={};function p(t,s){return e(),a("div",null,s[0]||(s[0]=[l(`<h1 id="interface-definitions-java" tabindex="-1"><a class="header-anchor" href="#interface-definitions-java"><span>Interface Definitions - Java</span></a></h1><h2 id="write-interface" tabindex="-1"><a class="header-anchor" href="#write-interface"><span>Write Interface</span></a></h2><h3 id="itsfilewriter" tabindex="-1"><a class="header-anchor" href="#itsfilewriter"><span>ITsFileWriter</span></a></h3><p>Used to write data to tsfile</p><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" data-title="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">interface</span><span style="color:#E5C07B;"> ITsFileWriter</span><span style="color:#C678DD;"> extends</span><span style="color:#E5C07B;"> AutoCloseable</span><span style="color:#ABB2BF;"> {</span></span>
<span class="line"><span style="color:#7F848E;font-style:italic;"> // Write data</span></span>
<span class="line"><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> write</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">Tablet</span><span style="color:#E06C75;font-style:italic;"> tablet</span><span style="color:#ABB2BF;">);</span></span>
<span class="line"><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#7F848E;font-style:italic;"> // Close Write</span></span>
<span class="line"><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> close</span><span style="color:#ABB2BF;">();</span></span>
<span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h3 id="tsfilewriterbuilder" tabindex="-1"><a class="header-anchor" href="#tsfilewriterbuilder"><span>TsFileWriterBuilder</span></a></h3><p>Used to construct ITsFileWriter</p><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" data-title="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">class</span><span style="color:#E5C07B;"> TsFileWriterBuilder</span><span style="color:#ABB2BF;"> {</span></span>
<span class="line"><span style="color:#7F848E;font-style:italic;"> // Build ITsFileWriter object</span></span>
<span class="line"><span style="color:#C678DD;"> public</span><span style="color:#E5C07B;"> ITsFileWriter</span><span style="color:#61AFEF;"> build</span><span style="color:#ABB2BF;">();</span></span>
<span class="line"><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#7F848E;font-style:italic;"> // target file</span></span>
<span class="line"><span style="color:#C678DD;"> public</span><span style="color:#E5C07B;"> TsFileWriterBuilder</span><span style="color:#61AFEF;"> file</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">File</span><span style="color:#E06C75;font-style:italic;"> file</span><span style="color:#ABB2BF;">);</span></span>
<span class="line"><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#7F848E;font-style:italic;"> // Used to construct table structures</span></span>
<span class="line"><span style="color:#C678DD;"> public</span><span style="color:#E5C07B;"> TsFileWriterBuilder</span><span style="color:#61AFEF;"> tableSchema</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">TableSchema</span><span style="color:#E06C75;font-style:italic;"> schema</span><span style="color:#ABB2BF;">);</span></span>
<span class="line"><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#7F848E;font-style:italic;"> // Used to limit the memory size of objects</span></span>
<span class="line"><span style="color:#C678DD;"> public</span><span style="color:#E5C07B;"> TsFileWriterBuilder</span><span style="color:#61AFEF;"> memoryThreshold</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">long</span><span style="color:#E06C75;font-style:italic;"> memoryThreshold</span><span style="color:#ABB2BF;">);</span></span>
<span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h3 id="tableschema" tabindex="-1"><a class="header-anchor" href="#tableschema"><span>TableSchema</span></a></h3><p>Describe the data structure of the table schema</p><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" data-title="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">class</span><span style="color:#E5C07B;"> TableSchema</span><span style="color:#ABB2BF;"> {</span></span>
<span class="line"><span style="color:#7F848E;font-style:italic;"> // Constructor function</span></span>
<span class="line"><span style="color:#C678DD;"> public</span><span style="color:#61AFEF;"> TableSchema</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;font-style:italic;"> tableName</span><span style="color:#ABB2BF;">, </span><span style="color:#E5C07B;">List</span><span style="color:#ABB2BF;">&lt;</span><span style="color:#E5C07B;">ColumnSchema</span><span style="color:#ABB2BF;">&gt; </span><span style="color:#E06C75;font-style:italic;">columnSchemaList</span><span style="color:#ABB2BF;">);</span></span>
<span class="line"><span style="color:#ABB2BF;">}</span></span>
<span class="line"></span>
<span class="line"><span style="color:#C678DD;">class</span><span style="color:#E5C07B;"> ColumnSchema</span><span style="color:#ABB2BF;"> {</span></span>
<span class="line"><span style="color:#7F848E;font-style:italic;"> // Constructor function</span></span>
<span class="line"><span style="color:#C678DD;"> public</span><span style="color:#61AFEF;"> ColumnSchema</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;font-style:italic;"> columnName</span><span style="color:#ABB2BF;">, </span><span style="color:#E5C07B;">TSDataType</span><span style="color:#E06C75;font-style:italic;"> dataType</span><span style="color:#ABB2BF;">, </span><span style="color:#E5C07B;">ColumnCategory</span><span style="color:#E06C75;font-style:italic;"> columnCategory</span><span style="color:#ABB2BF;">);</span></span>
<span class="line"><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#7F848E;font-style:italic;"> // Get column names</span></span>
<span class="line"><span style="color:#C678DD;"> public</span><span style="color:#E5C07B;"> String</span><span style="color:#61AFEF;"> getColumnName</span><span style="color:#ABB2BF;">();</span></span>
<span class="line"><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#7F848E;font-style:italic;"> // Get the data type of the column</span></span>
<span class="line"><span style="color:#C678DD;"> public</span><span style="color:#E5C07B;"> TSDataType</span><span style="color:#61AFEF;"> getDataType</span><span style="color:#ABB2BF;">();</span></span>
<span class="line"><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#7F848E;font-style:italic;"> // Get column category</span></span>
<span class="line"><span style="color:#C678DD;"> public</span><span style="color:#E5C07B;"> Tablet</span><span style="color:#ABB2BF;">.</span><span style="color:#E5C07B;">ColumnCategory</span><span style="color:#61AFEF;"> getColumnCategory</span><span style="color:#ABB2BF;">();</span></span>
<span class="line"><span style="color:#ABB2BF;">}</span></span>
<span class="line"></span>
<span class="line"><span style="color:#C678DD;">class</span><span style="color:#E5C07B;"> ColumnSchemaBuilder</span><span style="color:#ABB2BF;"> {</span></span>
<span class="line"><span style="color:#7F848E;font-style:italic;"> // Build ColumnSchema object</span></span>
<span class="line"><span style="color:#C678DD;"> public</span><span style="color:#E5C07B;"> ColumnSchema</span><span style="color:#61AFEF;"> build</span><span style="color:#ABB2BF;">();</span></span>
<span class="line"><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#7F848E;font-style:italic;"> // Column Name</span></span>
<span class="line"><span style="color:#C678DD;"> public</span><span style="color:#E5C07B;"> ColumnSchemaBuilder</span><span style="color:#61AFEF;"> name</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;font-style:italic;"> columnName</span><span style="color:#ABB2BF;">);</span></span>
<span class="line"><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#7F848E;font-style:italic;"> // The data type of the column</span></span>
<span class="line"><span style="color:#C678DD;"> public</span><span style="color:#E5C07B;"> ColumnSchemaBuilder</span><span style="color:#61AFEF;"> dataType</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">TSDataType</span><span style="color:#E06C75;font-style:italic;"> columnType</span><span style="color:#ABB2BF;">);</span></span>
<span class="line"><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#7F848E;font-style:italic;"> // Column category</span></span>
<span class="line"><span style="color:#C678DD;"> public</span><span style="color:#E5C07B;"> ColumnSchemaBuilder</span><span style="color:#61AFEF;"> category</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">ColumnCategory</span><span style="color:#E06C75;font-style:italic;"> columnCategory</span><span style="color:#ABB2BF;">);</span></span>
<span class="line"><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#7F848E;font-style:italic;"> // Supported types</span></span>
<span class="line"><span style="color:#C678DD;"> enum</span><span style="color:#E5C07B;"> TSDataType</span><span style="color:#E06C75;"> { </span></span>
<span class="line"><span style="color:#D19A66;"> BOOLEAN</span><span style="color:#ABB2BF;">,</span><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#D19A66;"> INT32</span><span style="color:#ABB2BF;">,</span></span>
<span class="line"><span style="color:#D19A66;"> INT64</span><span style="color:#ABB2BF;">,</span><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#D19A66;"> FLOAT</span><span style="color:#ABB2BF;">,</span><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#D19A66;"> DOUBLE</span><span style="color:#ABB2BF;">,</span><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#D19A66;"> TIMESTAMP</span><span style="color:#ABB2BF;">,</span><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#D19A66;"> TEXT</span><span style="color:#ABB2BF;">,</span><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#D19A66;"> DATE</span><span style="color:#ABB2BF;">,</span><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#D19A66;"> BLOB</span><span style="color:#ABB2BF;">,</span><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#D19A66;"> STRING</span><span style="color:#ABB2BF;">;</span><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#E06C75;"> }</span></span>
<span class="line"><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#7F848E;font-style:italic;"> // Supported column categories</span></span>
<span class="line"><span style="color:#C678DD;"> enum</span><span style="color:#E5C07B;"> ColumnCategory</span><span style="color:#E06C75;"> { </span></span>
<span class="line"><span style="color:#D19A66;"> TAG</span><span style="color:#ABB2BF;">,</span><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#D19A66;"> FIELD</span><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#E06C75;"> }</span></span>
<span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h3 id="tablet" tabindex="-1"><a class="header-anchor" href="#tablet"><span>Tablet</span></a></h3><p>Write column memory structure</p><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" data-title="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">class</span><span style="color:#E5C07B;"> Tablet</span><span style="color:#ABB2BF;"> {</span></span>
<span class="line"><span style="color:#7F848E;font-style:italic;"> // Constructor function</span></span>
<span class="line"><span style="color:#C678DD;"> public</span><span style="color:#61AFEF;"> Tablet</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">List</span><span style="color:#ABB2BF;">&lt;</span><span style="color:#E5C07B;">String</span><span style="color:#ABB2BF;">&gt; </span><span style="color:#E06C75;font-style:italic;">columnNameList</span><span style="color:#ABB2BF;">, </span><span style="color:#E5C07B;">List</span><span style="color:#ABB2BF;">&lt;</span><span style="color:#E5C07B;">TSDataType</span><span style="color:#ABB2BF;">&gt; </span><span style="color:#E06C75;font-style:italic;">dataTypeList</span><span style="color:#ABB2BF;">);</span></span>
<span class="line"><span style="color:#C678DD;"> public</span><span style="color:#61AFEF;"> Tablet</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">List</span><span style="color:#ABB2BF;">&lt;</span><span style="color:#E5C07B;">String</span><span style="color:#ABB2BF;">&gt; </span><span style="color:#E06C75;font-style:italic;">columnNameList</span><span style="color:#ABB2BF;">, </span><span style="color:#E5C07B;">List</span><span style="color:#ABB2BF;">&lt;</span><span style="color:#E5C07B;">TSDataType</span><span style="color:#ABB2BF;">&gt; </span><span style="color:#E06C75;font-style:italic;">dataTypeList</span><span style="color:#ABB2BF;">, </span><span style="color:#C678DD;">int</span><span style="color:#E06C75;font-style:italic;"> maxRowNum</span><span style="color:#ABB2BF;">);</span></span>
<span class="line"><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#7F848E;font-style:italic;"> // Interface for adding timestamps</span></span>
<span class="line"><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> addTimestamp</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">int</span><span style="color:#E06C75;font-style:italic;"> rowIndex</span><span style="color:#ABB2BF;">, </span><span style="color:#C678DD;">long</span><span style="color:#E06C75;font-style:italic;"> timestamp</span><span style="color:#ABB2BF;">);</span></span>
<span class="line"><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#7F848E;font-style:italic;"> // Interface for adding values</span></span>
<span class="line"><span style="color:#7F848E;font-style:italic;"> // Add values based on column names</span></span>
<span class="line"><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> addValue</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">int</span><span style="color:#E06C75;font-style:italic;"> rowIndex</span><span style="color:#ABB2BF;">, </span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;font-style:italic;"> columnName</span><span style="color:#ABB2BF;">, </span><span style="color:#C678DD;">int</span><span style="color:#E06C75;font-style:italic;"> val</span><span style="color:#ABB2BF;">);</span></span>
<span class="line"><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> addValue</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">int</span><span style="color:#E06C75;font-style:italic;"> rowIndex</span><span style="color:#ABB2BF;">, </span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;font-style:italic;"> columnName</span><span style="color:#ABB2BF;">, </span><span style="color:#C678DD;">long</span><span style="color:#E06C75;font-style:italic;"> val</span><span style="color:#ABB2BF;">);</span><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> addValue</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">int</span><span style="color:#E06C75;font-style:italic;"> rowIndex</span><span style="color:#ABB2BF;">, </span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;font-style:italic;"> columnName</span><span style="color:#ABB2BF;">, </span><span style="color:#C678DD;">float</span><span style="color:#E06C75;font-style:italic;"> val</span><span style="color:#ABB2BF;">);</span><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> addValue</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">int</span><span style="color:#E06C75;font-style:italic;"> rowIndex</span><span style="color:#ABB2BF;">, </span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;font-style:italic;"> columnName</span><span style="color:#ABB2BF;">, </span><span style="color:#C678DD;">double</span><span style="color:#E06C75;font-style:italic;"> val</span><span style="color:#ABB2BF;">);</span><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> addValue</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">int</span><span style="color:#E06C75;font-style:italic;"> rowIndex</span><span style="color:#ABB2BF;">, </span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;font-style:italic;"> columnName</span><span style="color:#ABB2BF;">, </span><span style="color:#C678DD;">boolean</span><span style="color:#E06C75;font-style:italic;"> val</span><span style="color:#ABB2BF;">);</span><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> addValue</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">int</span><span style="color:#E06C75;font-style:italic;"> rowIndex</span><span style="color:#ABB2BF;">, </span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;font-style:italic;"> columnName</span><span style="color:#ABB2BF;">, </span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;font-style:italic;"> val</span><span style="color:#ABB2BF;">);</span></span>
<span class="line"><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> addValue</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">int</span><span style="color:#E06C75;font-style:italic;"> rowIndex</span><span style="color:#ABB2BF;">, </span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;font-style:italic;"> columnName</span><span style="color:#ABB2BF;">, </span><span style="color:#C678DD;">byte</span><span style="color:#ABB2BF;">[] </span><span style="color:#E06C75;font-style:italic;">val</span><span style="color:#ABB2BF;">);</span><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> addValue</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">int</span><span style="color:#E06C75;font-style:italic;"> rowIndex</span><span style="color:#ABB2BF;">, </span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;font-style:italic;"> columnName</span><span style="color:#ABB2BF;">, </span><span style="color:#E5C07B;">LocalDate</span><span style="color:#E06C75;font-style:italic;"> val</span><span style="color:#ABB2BF;">);</span><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#7F848E;font-style:italic;"> // Add values based on index position</span></span>
<span class="line"><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> addValue</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">int</span><span style="color:#E06C75;font-style:italic;"> rowIndex</span><span style="color:#ABB2BF;">, </span><span style="color:#C678DD;">int</span><span style="color:#E06C75;font-style:italic;"> columnIndex</span><span style="color:#ABB2BF;">, </span><span style="color:#C678DD;">int</span><span style="color:#E06C75;font-style:italic;"> val</span><span style="color:#ABB2BF;">);</span></span>
<span class="line"><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> addValue</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">int</span><span style="color:#E06C75;font-style:italic;"> rowIndex</span><span style="color:#ABB2BF;">, </span><span style="color:#C678DD;">int</span><span style="color:#E06C75;font-style:italic;"> columnIndex</span><span style="color:#ABB2BF;">, </span><span style="color:#C678DD;">long</span><span style="color:#E06C75;font-style:italic;"> val</span><span style="color:#ABB2BF;">);</span><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> addValue</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">int</span><span style="color:#E06C75;font-style:italic;"> rowIndex</span><span style="color:#ABB2BF;">, </span><span style="color:#C678DD;">int</span><span style="color:#E06C75;font-style:italic;"> columnIndex</span><span style="color:#ABB2BF;">, </span><span style="color:#C678DD;">float</span><span style="color:#E06C75;font-style:italic;"> val</span><span style="color:#ABB2BF;">);</span><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> addValue</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">int</span><span style="color:#E06C75;font-style:italic;"> rowIndex</span><span style="color:#ABB2BF;">, </span><span style="color:#C678DD;">int</span><span style="color:#E06C75;font-style:italic;"> columnIndex</span><span style="color:#ABB2BF;">, </span><span style="color:#C678DD;">double</span><span style="color:#E06C75;font-style:italic;"> val</span><span style="color:#ABB2BF;">);</span><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> addValue</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">int</span><span style="color:#E06C75;font-style:italic;"> rowIndex</span><span style="color:#ABB2BF;">, </span><span style="color:#C678DD;">int</span><span style="color:#E06C75;font-style:italic;"> columnIndex</span><span style="color:#ABB2BF;">, </span><span style="color:#C678DD;">boolean</span><span style="color:#E06C75;font-style:italic;"> val</span><span style="color:#ABB2BF;">);</span><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> addValue</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">int</span><span style="color:#E06C75;font-style:italic;"> rowIndex</span><span style="color:#ABB2BF;">, </span><span style="color:#C678DD;">int</span><span style="color:#E06C75;font-style:italic;"> columnIndex</span><span style="color:#ABB2BF;">, </span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;font-style:italic;"> val</span><span style="color:#ABB2BF;">);</span></span>
<span class="line"><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> addValue</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">int</span><span style="color:#E06C75;font-style:italic;"> rowIndex</span><span style="color:#ABB2BF;">, </span><span style="color:#C678DD;">int</span><span style="color:#E06C75;font-style:italic;"> columnIndex</span><span style="color:#ABB2BF;">, </span><span style="color:#C678DD;">byte</span><span style="color:#ABB2BF;">[] </span><span style="color:#E06C75;font-style:italic;">val</span><span style="color:#ABB2BF;">);</span><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> addValue</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">int</span><span style="color:#E06C75;font-style:italic;"> rowIndex</span><span style="color:#ABB2BF;">, </span><span style="color:#C678DD;">int</span><span style="color:#E06C75;font-style:italic;"> columnIndex</span><span style="color:#ABB2BF;">, </span><span style="color:#E5C07B;">LocalDate</span><span style="color:#E06C75;font-style:italic;"> val</span><span style="color:#ABB2BF;">);</span></span>
<span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="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="read-interface" tabindex="-1"><a class="header-anchor" href="#read-interface"><span>Read Interface</span></a></h2><h3 id="itsfilereader" tabindex="-1"><a class="header-anchor" href="#itsfilereader"><span>ITsFileReader</span></a></h3><p>Used to query data in tsfile</p><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" data-title="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">interface</span><span style="color:#E5C07B;"> ITsFileReader</span><span style="color:#C678DD;"> extends</span><span style="color:#E5C07B;"> AutoCloseable</span><span style="color:#ABB2BF;"> {</span></span>
<span class="line"><span style="color:#7F848E;font-style:italic;"> // Used to execute queries and return results</span></span>
<span class="line"><span style="color:#E5C07B;"> ResultSet</span><span style="color:#61AFEF;"> query</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;font-style:italic;"> tableName</span><span style="color:#ABB2BF;">, </span><span style="color:#E5C07B;">List</span><span style="color:#ABB2BF;">&lt;</span><span style="color:#E5C07B;">String</span><span style="color:#ABB2BF;">&gt; </span><span style="color:#E06C75;font-style:italic;">columnNames</span><span style="color:#ABB2BF;">, </span><span style="color:#C678DD;">long</span><span style="color:#E06C75;font-style:italic;"> startTime</span><span style="color:#ABB2BF;">, </span><span style="color:#C678DD;">long</span><span style="color:#E06C75;font-style:italic;"> endTime</span><span style="color:#ABB2BF;">);</span></span>
<span class="line"><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#7F848E;font-style:italic;"> // Return the schema of the table named tableName in tsfile</span></span>
<span class="line"><span style="color:#E5C07B;"> Optional</span><span style="color:#ABB2BF;">&lt;</span><span style="color:#E5C07B;">TableSchema</span><span style="color:#ABB2BF;">&gt;</span><span style="color:#61AFEF;"> getTableSchemas</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;font-style:italic;"> tableName</span><span style="color:#ABB2BF;">);</span></span>
<span class="line"><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#7F848E;font-style:italic;"> // Retrieve schema information for all tables in the tsfile</span></span>
<span class="line"><span style="color:#E5C07B;"> List</span><span style="color:#ABB2BF;">&lt;</span><span style="color:#E5C07B;">TableSchema</span><span style="color:#ABB2BF;">&gt;</span><span style="color:#61AFEF;"> getAllTableSchema</span><span style="color:#ABB2BF;">();</span></span>
<span class="line"><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#7F848E;font-style:italic;"> // Close query</span></span>
<span class="line"><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> close</span><span style="color:#ABB2BF;">();</span></span>
<span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h3 id="tsfilereaderbuilder" tabindex="-1"><a class="header-anchor" href="#tsfilereaderbuilder"><span>TsFileReaderBuilder</span></a></h3><p>Used to construct ITsFileReader</p><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" data-title="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">class</span><span style="color:#E5C07B;"> TsFileReaderBuilder</span><span style="color:#ABB2BF;"> {</span></span>
<span class="line"><span style="color:#7F848E;font-style:italic;"> // Build ITsFileReader object</span></span>
<span class="line"><span style="color:#C678DD;"> public</span><span style="color:#E5C07B;"> ITsFileReader</span><span style="color:#61AFEF;"> build</span><span style="color:#ABB2BF;">();</span></span>
<span class="line"><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#7F848E;font-style:italic;"> // target file</span></span>
<span class="line"><span style="color:#C678DD;"> public</span><span style="color:#E5C07B;"> TsFileReaderBuilder</span><span style="color:#61AFEF;"> file</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">File</span><span style="color:#E06C75;font-style:italic;"> file</span><span style="color:#ABB2BF;">);</span></span>
<span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h3 id="resultset" tabindex="-1"><a class="header-anchor" href="#resultset"><span>ResultSet</span></a></h3><p>The result set of the query</p><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" data-title="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">interface</span><span style="color:#E5C07B;"> ResultSet</span><span style="color:#C678DD;"> extends</span><span style="color:#E5C07B;"> AutoCloseable</span><span style="color:#ABB2BF;"> {</span><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#7F848E;font-style:italic;"> // Move the cursor to the next row and return whether there is still data</span></span>
<span class="line"><span style="color:#C678DD;"> boolean</span><span style="color:#61AFEF;"> next</span><span style="color:#ABB2BF;">();</span><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#7F848E;font-style:italic;"> // Get the value of the current row and a certain column</span></span>
<span class="line"><span style="color:#C678DD;"> int</span><span style="color:#61AFEF;"> getInt</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;font-style:italic;"> columnName</span><span style="color:#ABB2BF;">);</span><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#C678DD;"> int</span><span style="color:#61AFEF;"> getInt</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">int</span><span style="color:#E06C75;font-style:italic;"> columnIndex</span><span style="color:#ABB2BF;">);</span><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#C678DD;"> long</span><span style="color:#61AFEF;"> getLong</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;font-style:italic;"> columnName</span><span style="color:#ABB2BF;">);</span><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#C678DD;"> long</span><span style="color:#61AFEF;"> getLong</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">int</span><span style="color:#E06C75;font-style:italic;"> columnIndex</span><span style="color:#ABB2BF;">);</span></span>
<span class="line"><span style="color:#C678DD;"> float</span><span style="color:#61AFEF;"> getFloat</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;font-style:italic;"> columnName</span><span style="color:#ABB2BF;">);</span></span>
<span class="line"><span style="color:#C678DD;"> float</span><span style="color:#61AFEF;"> getFloat</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">int</span><span style="color:#E06C75;font-style:italic;"> columnIndex</span><span style="color:#ABB2BF;">);</span><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#C678DD;"> double</span><span style="color:#61AFEF;"> getDouble</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;font-style:italic;"> columnName</span><span style="color:#ABB2BF;">);</span></span>
<span class="line"><span style="color:#C678DD;"> double</span><span style="color:#61AFEF;"> getDouble</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">int</span><span style="color:#E06C75;font-style:italic;"> columnIndex</span><span style="color:#ABB2BF;">);</span><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#C678DD;"> boolean</span><span style="color:#61AFEF;"> getBoolean</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;font-style:italic;"> columnName</span><span style="color:#ABB2BF;">);</span></span>
<span class="line"><span style="color:#C678DD;"> boolean</span><span style="color:#61AFEF;"> getBoolean</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">int</span><span style="color:#E06C75;font-style:italic;"> columnIndex</span><span style="color:#ABB2BF;">);</span></span>
<span class="line"><span style="color:#E5C07B;"> String</span><span style="color:#61AFEF;"> getString</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;font-style:italic;"> columnName</span><span style="color:#ABB2BF;">);</span></span>
<span class="line"><span style="color:#E5C07B;"> String</span><span style="color:#61AFEF;"> getString</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">int</span><span style="color:#E06C75;font-style:italic;"> columnIndex</span><span style="color:#ABB2BF;">);</span></span>
<span class="line"><span style="color:#E5C07B;"> LocalDate</span><span style="color:#61AFEF;"> getDate</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;font-style:italic;"> columnName</span><span style="color:#ABB2BF;">);</span></span>
<span class="line"><span style="color:#E5C07B;"> LocalDate</span><span style="color:#61AFEF;"> getDate</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">int</span><span style="color:#E06C75;font-style:italic;"> columnIndex</span><span style="color:#ABB2BF;">);</span><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#C678DD;"> byte</span><span style="color:#61AFEF;">[] getBinary</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;font-style:italic;"> columnName</span><span style="color:#ABB2BF;">);</span></span>
<span class="line"><span style="color:#C678DD;"> byte</span><span style="color:#61AFEF;">[] getBinary</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">int</span><span style="color:#E06C75;font-style:italic;"> columnIndex</span><span style="color:#ABB2BF;">);</span></span>
<span class="line"><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#7F848E;font-style:italic;"> // Determine whether a column is NULL in the current row</span></span>
<span class="line"><span style="color:#C678DD;"> boolean</span><span style="color:#61AFEF;"> isNull</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;font-style:italic;"> columnName</span><span style="color:#ABB2BF;">);</span><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#C678DD;"> boolean</span><span style="color:#61AFEF;"> isNull</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">int</span><span style="color:#E06C75;font-style:italic;"> columnIndex</span><span style="color:#ABB2BF;">);</span><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#7F848E;font-style:italic;"> // Close the current result set</span></span>
<span class="line"><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> close</span><span style="color:#ABB2BF;">();</span></span>
<span class="line"><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#7F848E;font-style:italic;"> // Obtain the header of the result set</span></span>
<span class="line"><span style="color:#E5C07B;"> ResultSetMetadata</span><span style="color:#61AFEF;"> getMetadata</span><span style="color:#ABB2BF;">();</span></span>
<span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="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="resultsetmetadata" tabindex="-1"><a class="header-anchor" href="#resultsetmetadata"><span>ResultSetMetadata</span></a></h3><p>Used to obtain metadata for the result set</p><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" data-title="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">interface</span><span style="color:#E5C07B;"> ResultSetMetadata</span><span style="color:#ABB2BF;"> {</span><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#7F848E;font-style:italic;"> // Obtain the column name of the Nth column in the result set</span></span>
<span class="line"><span style="color:#E5C07B;"> String</span><span style="color:#61AFEF;"> getColumnName</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">int</span><span style="color:#E06C75;font-style:italic;"> columnIndex</span><span style="color:#ABB2BF;">);</span></span>
<span class="line"><span style="color:#E06C75;"> </span></span>
<span class="line"><span style="color:#7F848E;font-style:italic;"> // Obtain the data type of the Nth column in the result set</span></span>
<span class="line"><span style="color:#E5C07B;"> TSDataType</span><span style="color:#61AFEF;"> getColumnType</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">int</span><span style="color:#E06C75;font-style:italic;"> columnIndex</span><span style="color:#ABB2BF;">);</span></span>
<span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div>`,27)]))}const r=n(o,[["render",p]]),y=JSON.parse('{"path":"/UserGuide/develop/QuickStart/InterfaceDefinition/InterfaceDefinition-Java.html","title":"Interface Definitions - Java","lang":"en-US","frontmatter":{"description":"Interface Definitions - Java Write Interface ITsFileWriter Used to write data to tsfile TsFileWriterBuilder Used to construct ITsFileWriter TableSchema Describe the data structu...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://tsfile.apache.org/zh/UserGuide/develop/QuickStart/InterfaceDefinition/InterfaceDefinition-Java.html"}],["meta",{"property":"og:url","content":"https://tsfile.apache.org/UserGuide/develop/QuickStart/InterfaceDefinition/InterfaceDefinition-Java.html"}],["meta",{"property":"og:site_name","content":"Apache TsFile"}],["meta",{"property":"og:title","content":"Interface Definitions - Java"}],["meta",{"property":"og:description","content":"Interface Definitions - Java Write Interface ITsFileWriter Used to write data to tsfile TsFileWriterBuilder Used to construct ITsFileWriter TableSchema Describe the data structu..."}],["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-07-21T08:27:12.000Z"}],["meta",{"property":"article:modified_time","content":"2025-07-21T08:27:12.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Interface Definitions - Java\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2025-07-21T08:27:12.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"Write Interface","slug":"write-interface","link":"#write-interface","children":[{"level":3,"title":"ITsFileWriter","slug":"itsfilewriter","link":"#itsfilewriter","children":[]},{"level":3,"title":"TsFileWriterBuilder","slug":"tsfilewriterbuilder","link":"#tsfilewriterbuilder","children":[]},{"level":3,"title":"TableSchema","slug":"tableschema","link":"#tableschema","children":[]},{"level":3,"title":"Tablet","slug":"tablet","link":"#tablet","children":[]}]},{"level":2,"title":"Read Interface","slug":"read-interface","link":"#read-interface","children":[{"level":3,"title":"ITsFileReader","slug":"itsfilereader","link":"#itsfilereader","children":[]},{"level":3,"title":"TsFileReaderBuilder","slug":"tsfilereaderbuilder","link":"#tsfilereaderbuilder","children":[]},{"level":3,"title":"ResultSet","slug":"resultset","link":"#resultset","children":[]},{"level":3,"title":"ResultSetMetadata","slug":"resultsetmetadata","link":"#resultsetmetadata","children":[]}]}],"git":{"createdTime":1753086432000,"updatedTime":1753086432000,"contributors":[{"name":"Colin Lee","username":"Colin Lee","email":"105656576+ColinLeeo@users.noreply.github.com","commits":1,"url":"https://github.com/Colin Lee"}]},"readingTime":{"minutes":2.59,"words":776},"filePathRelative":"UserGuide/develop/QuickStart/InterfaceDefinition/InterfaceDefinition-Java.md","localizedDate":"July 21, 2025","autoDesc":true}');export{r as comp,y as data};