| import{_ as o,c as p,b as l,d as a,e as n,a as t,w as r,r as c,o as i}from"./app-pmkzp6TS.js";const d={};function y(B,s){const e=c("RouteLink");return i(),p("div",null,[s[4]||(s[4]=l(`<h1 id="应用编程接口" tabindex="-1"><a class="header-anchor" href="#应用编程接口"><span>应用编程接口</span></a></h1><h2 id="java-原生接口" tabindex="-1"><a class="header-anchor" href="#java-原生接口"><span>Java 原生接口</span></a></h2><h3 id="安装" tabindex="-1"><a class="header-anchor" href="#安装"><span>安装</span></a></h3><h3 id="依赖" tabindex="-1"><a class="header-anchor" href="#依赖"><span>依赖</span></a></h3><ul><li>JDK >= 1.8</li><li>Maven >= 3.6</li></ul><h3 id="在-maven-中使用原生接口" tabindex="-1"><a class="header-anchor" href="#在-maven-中使用原生接口"><span>在 MAVEN 中使用原生接口</span></a></h3><div class="language-xml line-numbers-mode" data-highlighter="shiki" data-ext="xml" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-xml"><span class="line"><span style="color:#ABB2BF;"><</span><span style="color:#E06C75;">dependencies</span><span style="color:#ABB2BF;">></span></span> |
| <span class="line"><span style="color:#ABB2BF;"> <</span><span style="color:#E06C75;">dependency</span><span style="color:#ABB2BF;">></span></span> |
| <span class="line"><span style="color:#ABB2BF;"> <</span><span style="color:#E06C75;">groupId</span><span style="color:#ABB2BF;">>org.apache.iotdb</</span><span style="color:#E06C75;">groupId</span><span style="color:#ABB2BF;">></span></span> |
| <span class="line"><span style="color:#ABB2BF;"> <</span><span style="color:#E06C75;">artifactId</span><span style="color:#ABB2BF;">>iotdb-session</</span><span style="color:#E06C75;">artifactId</span><span style="color:#ABB2BF;">></span></span> |
| <span class="line"><span style="color:#ABB2BF;"> <</span><span style="color:#E06C75;">version</span><span style="color:#ABB2BF;">>0.13.0-SNAPSHOT</</span><span style="color:#E06C75;">version</span><span style="color:#ABB2BF;">></span></span> |
| <span class="line"><span style="color:#ABB2BF;"> </</span><span style="color:#E06C75;">dependency</span><span style="color:#ABB2BF;">></span></span> |
| <span class="line"><span style="color:#ABB2BF;"></</span><span style="color:#E06C75;">dependencies</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></div><h3 id="语法说明" tabindex="-1"><a class="header-anchor" href="#语法说明"><span>语法说明</span></a></h3>`,8)),a("ul",null,[a("li",null,[s[1]||(s[1]=n("对于 IoTDB-SQL 接口：传入的 SQL 参数需要符合 ",-1)),t(e,{to:"/zh/UserGuide/V0.13.x/Reference/Syntax-Conventions.html"},{default:r(()=>[...s[0]||(s[0]=[n("语法规范",-1)])]),_:1}),s[2]||(s[2]=n(" ，并且针对 JAVA 字符串进行反转义，如双引号前需要加反斜杠。（即：经 JAVA 转义之后与命令行执行的 SQL 语句一致。）",-1))]),s[3]||(s[3]=a("li",null,[n("对于其他接口： "),a("ul",null,[a("li",null,[n("经参数传入的路径或路径前缀中的节点： "),a("ul",null,[a("li",null,"在 SQL 语句中需要使用反引号（`）进行转义的，此处均不需要进行转义。"),a("li",null,"使用单引号或双引号括起的节点，仍需要使用单引号或双引号括起，并且要针对 JAVA 字符串进行反转义。"),a("li",null,[n("对于 "),a("code",null,"checkTimeseriesExists"),n(" 接口，由于内部调用了 IoTDB-SQL 接口，因此需要和 SQL 语法规范保持一致，并且针对 JAVA 字符串进行反转义。")])])]),a("li",null,"经参数传入的标识符（如模板名）：在 SQL 语句中需要使用反引号（`）进行转义的，此处均不需要进行转义。")])],-1))]),s[5]||(s[5]=l(`<h3 id="基本接口说明" tabindex="-1"><a class="header-anchor" href="#基本接口说明"><span>基本接口说明</span></a></h3><p>下面将给出 Session 对应的接口的简要介绍和对应参数：</p><h4 id="初始化" tabindex="-1"><a class="header-anchor" href="#初始化"><span>初始化</span></a></h4><ul><li>初始化 Session</li></ul><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-java"><span class="line"><span style="color:#7F848E;font-style:italic;">// 全部使用默认配置</span></span> |
| <span class="line"><span style="color:#E06C75;">session </span><span style="color:#56B6C2;">=</span><span style="color:#C678DD;"> new</span><span style="color:#E06C75;"> Session</span><span style="color:#ABB2BF;">.</span><span style="color:#E5C07B;">Builder</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">build</span><span style="color:#ABB2BF;">();</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">// 指定一个可连接节点</span></span> |
| <span class="line"><span style="color:#E06C75;">session </span><span style="color:#56B6C2;">=</span><span style="color:#E06C75;"> </span></span> |
| <span class="line"><span style="color:#C678DD;"> new</span><span style="color:#E06C75;"> Session</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">Builder</span><span style="color:#ABB2BF;">()</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> .</span><span style="color:#61AFEF;">host</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">String</span><span style="color:#ABB2BF;"> host)</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> .</span><span style="color:#61AFEF;">port</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">int</span><span style="color:#ABB2BF;"> port)</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> .</span><span style="color:#61AFEF;">build</span><span style="color:#ABB2BF;">();</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">// 指定多个可连接节点</span></span> |
| <span class="line"><span style="color:#E06C75;">session </span><span style="color:#56B6C2;">=</span><span style="color:#E06C75;"> </span></span> |
| <span class="line"><span style="color:#C678DD;"> new</span><span style="color:#E06C75;"> Session</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">Builder</span><span style="color:#ABB2BF;">()</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> .</span><span style="color:#61AFEF;">nodeUrls</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#ABB2BF;">String</span><span style="color:#56B6C2;">></span><span style="color:#ABB2BF;"> nodeUrls)</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> .</span><span style="color:#61AFEF;">build</span><span style="color:#ABB2BF;">();</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">// 其他配置项</span></span> |
| <span class="line"><span style="color:#E06C75;">session </span><span style="color:#56B6C2;">=</span><span style="color:#E06C75;"> </span></span> |
| <span class="line"><span style="color:#C678DD;"> new</span><span style="color:#E06C75;"> Session</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">Builder</span><span style="color:#ABB2BF;">()</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> .</span><span style="color:#61AFEF;">fetchSize</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">int</span><span style="color:#ABB2BF;"> fetchSize)</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> .</span><span style="color:#61AFEF;">username</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">String</span><span style="color:#ABB2BF;"> username)</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> .</span><span style="color:#61AFEF;">password</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">String</span><span style="color:#ABB2BF;"> password)</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> .</span><span style="color:#61AFEF;">thriftDefaultBufferSize</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">int</span><span style="color:#ABB2BF;"> thriftDefaultBufferSize)</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> .</span><span style="color:#61AFEF;">thriftMaxFrameSize</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">int</span><span style="color:#ABB2BF;"> thriftMaxFrameSize)</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> .</span><span style="color:#61AFEF;">enableCacheLeader</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">boolean</span><span style="color:#ABB2BF;"> enableCacheLeader)</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> .</span><span style="color:#61AFEF;">version</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">Version</span><span style="color:#ABB2BF;"> version)</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> .</span><span style="color:#61AFEF;">build</span><span style="color:#ABB2BF;">();</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div 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><p>其中，version 表示客户端使用的 SQL 语义版本，用于升级 0.13 时兼容 0.12 的 SQL 语义，可能取值有：<code>V_0_12</code>、<code>V_0_13</code>。</p><ul><li>开启 Session</li></ul><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-java"><span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> open</span><span style="color:#E06C75;">()</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>开启 Session，并决定是否开启 RPC 压缩</li></ul><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-java"><span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> open</span><span style="color:#E06C75;">(</span><span style="color:#C678DD;">boolean</span><span style="color:#E06C75;"> enableRPCCompression)</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>注意: 客户端的 RPC 压缩开启状态需和服务端一致</p><ul><li>关闭 Session</li></ul><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-java"><span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> close</span><span style="color:#E06C75;">()</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><h4 id="数据定义接口-ddl" tabindex="-1"><a class="header-anchor" href="#数据定义接口-ddl"><span>数据定义接口 DDL</span></a></h4><h5 id="存储组管理" tabindex="-1"><a class="header-anchor" href="#存储组管理"><span>存储组管理</span></a></h5><ul><li>设置存储组</li></ul><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-java"><span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> setStorageGroup</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> storageGroupId)</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>删除单个或多个存储组</li></ul><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-java"><span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> deleteStorageGroup</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> storageGroup)</span></span> |
| <span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> deleteStorageGroups</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> storageGroups)</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></div><h5 id="时间序列管理" tabindex="-1"><a class="header-anchor" href="#时间序列管理"><span>时间序列管理</span></a></h5><ul><li>创建单个或多个时间序列</li></ul><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-java"><span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> createTimeseries</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> path</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> TSDataType</span><span style="color:#E06C75;"> dataType</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> TSEncoding</span><span style="color:#E06C75;"> encoding</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> CompressionType</span><span style="color:#E06C75;"> compressor</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> Map</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#ABB2BF;">,</span><span style="color:#E06C75;"> String</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> props</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> Map</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#ABB2BF;">,</span><span style="color:#E06C75;"> String</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> tags</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> Map</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#ABB2BF;">,</span><span style="color:#E06C75;"> String</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> attributes</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> String</span><span style="color:#E06C75;"> measurementAlias)</span></span> |
| <span class="line"><span style="color:#E06C75;"> </span></span> |
| <span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> createMultiTimeseries</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> paths</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">TSDataType</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> dataTypes</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">TSEncoding</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> encodings</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">CompressionType</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> compressors</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E5C07B;">Map</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#ABB2BF;">,</span><span style="color:#E06C75;"> String</span><span style="color:#56B6C2;">>></span><span style="color:#E06C75;"> propsList</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E5C07B;">Map</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#ABB2BF;">,</span><span style="color:#E06C75;"> String</span><span style="color:#56B6C2;">>></span><span style="color:#E06C75;"> tagsList</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E5C07B;">Map</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#ABB2BF;">,</span><span style="color:#E06C75;"> String</span><span style="color:#56B6C2;">>></span><span style="color:#E06C75;"> attributesList</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> measurementAliasList)</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><ul><li>创建对齐时间序列</li></ul><div class="language- line-numbers-mode" data-highlighter="shiki" data-ext="" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-"><span class="line"><span>void createAlignedTimeseries(String prefixPath, List<String> measurements,</span></span> |
| <span class="line"><span> List<TSDataType> dataTypes, List<TSEncoding> encodings,</span></span> |
| <span class="line"><span> CompressionType compressor, List<String> measurementAliasList);</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></div><p>注意：目前<strong>暂不支持</strong>使用传感器别名。</p><ul><li>删除一个或多个时间序列</li></ul><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-java"><span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> deleteTimeseries</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> path)</span></span> |
| <span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> deleteTimeseries</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> paths)</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></div><ul><li>检测时间序列是否存在</li></ul><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-java"><span class="line"><span style="color:#C678DD;">boolean</span><span style="color:#61AFEF;"> checkTimeseriesExists</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> path)</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><h5 id="元数据模版" tabindex="-1"><a class="header-anchor" href="#元数据模版"><span>元数据模版</span></a></h5><ul><li>创建元数据模板，可以通过先后创建<code>Template</code>、<code>MeasurementNode</code>的对象，描述模板内物理量结构与类型、编码方式、压缩方式等信息，并通过以下接口创建模板</li></ul><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-java"><span class="line"><span style="color:#C678DD;">public</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> createSchemaTemplate</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">Template</span><span style="color:#E06C75;"> template)</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#E5C07B;">Class</span><span style="color:#E06C75;"> Template {</span></span> |
| <span class="line"><span style="color:#C678DD;"> private</span><span style="color:#E5C07B;"> String</span><span style="color:#E06C75;"> name</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;"> private</span><span style="color:#C678DD;"> boolean</span><span style="color:#E06C75;"> directShareTime</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#E5C07B;"> Map</span><span style="color:#ABB2BF;"><</span><span style="color:#E5C07B;">String</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> Node</span><span style="color:#ABB2BF;">></span><span style="color:#E06C75;"> children</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;"> public</span><span style="color:#61AFEF;"> Template</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> name</span><span style="color:#ABB2BF;">,</span><span style="color:#C678DD;"> boolean</span><span style="color:#E06C75;"> isShareTime)</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#E06C75;"> </span></span> |
| <span class="line"><span style="color:#C678DD;"> public</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> addToTemplate</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">Node</span><span style="color:#E06C75;"> node)</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;"> public</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> deleteFromTemplate</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> name)</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;"> public</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> setShareTime</span><span style="color:#E06C75;">(</span><span style="color:#C678DD;">boolean</span><span style="color:#E06C75;"> shareTime)</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#E06C75;">}</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#E5C07B;">Abstract</span><span style="color:#E5C07B;"> Class</span><span style="color:#E06C75;"> Node {</span></span> |
| <span class="line"><span style="color:#C678DD;"> private</span><span style="color:#E5C07B;"> String</span><span style="color:#E06C75;"> name</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;"> public</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> addChild</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">Node</span><span style="color:#E06C75;"> node)</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;"> public</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> deleteChild</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">Node</span><span style="color:#E06C75;"> node)</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#E06C75;">}</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#E5C07B;">Class</span><span style="color:#E5C07B;"> MeasurementNode</span><span style="color:#E06C75;"> extends Node {</span></span> |
| <span class="line"><span style="color:#E5C07B;"> TSDataType</span><span style="color:#E06C75;"> dataType</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#E5C07B;"> TSEncoding</span><span style="color:#E06C75;"> encoding</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#E5C07B;"> CompressionType</span><span style="color:#E06C75;"> compressor</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;"> public</span><span style="color:#61AFEF;"> MeasurementNode</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> name</span><span style="color:#ABB2BF;">,</span><span style="color:#E06C75;"> </span></span> |
| <span class="line"><span style="color:#E5C07B;"> TSDataType</span><span style="color:#E06C75;"> dataType</span><span style="color:#ABB2BF;">,</span><span style="color:#E06C75;"> </span></span> |
| <span class="line"><span style="color:#E5C07B;"> TSEncoding</span><span style="color:#E06C75;"> encoding</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> CompressionType</span><span style="color:#E06C75;"> compressor)</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#E06C75;">}</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><p>通过上述类的实例描述模板时，<code>Template</code>内应当仅能包含单层的<code>MeasurementNode</code>，具体可以参见如下示例：</p><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-java"><span class="line"><span style="color:#E5C07B;">MeasurementNode</span><span style="color:#E06C75;"> nodeX </span><span style="color:#56B6C2;">=</span><span style="color:#C678DD;"> new</span><span style="color:#61AFEF;"> MeasurementNode</span><span style="color:#E06C75;">(</span><span style="color:#98C379;">"x"</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> TSDataType</span><span style="color:#ABB2BF;">.</span><span style="color:#E5C07B;">FLOAT</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> TSEncoding</span><span style="color:#ABB2BF;">.</span><span style="color:#E5C07B;">RLE</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> CompressionType</span><span style="color:#ABB2BF;">.</span><span style="color:#E5C07B;">SNAPPY</span><span style="color:#E06C75;">)</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#E5C07B;">MeasurementNode</span><span style="color:#E06C75;"> nodeY </span><span style="color:#56B6C2;">=</span><span style="color:#C678DD;"> new</span><span style="color:#61AFEF;"> MeasurementNode</span><span style="color:#E06C75;">(</span><span style="color:#98C379;">"y"</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> TSDataType</span><span style="color:#ABB2BF;">.</span><span style="color:#E5C07B;">FLOAT</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> TSEncoding</span><span style="color:#ABB2BF;">.</span><span style="color:#E5C07B;">RLE</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> CompressionType</span><span style="color:#ABB2BF;">.</span><span style="color:#E5C07B;">SNAPPY</span><span style="color:#E06C75;">)</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#E5C07B;">MeasurementNode</span><span style="color:#E06C75;"> nodeSpeed </span><span style="color:#56B6C2;">=</span><span style="color:#C678DD;"> new</span><span style="color:#61AFEF;"> MeasurementNode</span><span style="color:#E06C75;">(</span><span style="color:#98C379;">"speed"</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> TSDataType</span><span style="color:#ABB2BF;">.</span><span style="color:#E5C07B;">DOUBLE</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> TSEncoding</span><span style="color:#ABB2BF;">.</span><span style="color:#E5C07B;">GORILLA</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> CompressionType</span><span style="color:#ABB2BF;">.</span><span style="color:#E5C07B;">SNAPPY</span><span style="color:#E06C75;">)</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">// This is the template we suggest to implement</span></span> |
| <span class="line"><span style="color:#E5C07B;">Template</span><span style="color:#E06C75;"> flatTemplate </span><span style="color:#56B6C2;">=</span><span style="color:#C678DD;"> new</span><span style="color:#61AFEF;"> Template</span><span style="color:#E06C75;">(</span><span style="color:#98C379;">"flatTemplate"</span><span style="color:#E06C75;">)</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#E5C07B;">template</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">addToTemplate</span><span style="color:#ABB2BF;">(nodeX);</span></span> |
| <span class="line"><span style="color:#E5C07B;">template</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">addToTemplate</span><span style="color:#ABB2BF;">(nodeY);</span></span> |
| <span class="line"><span style="color:#E5C07B;">template</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">addToTemplate</span><span style="color:#ABB2BF;">(nodeSpeed);</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#61AFEF;">createSchemaTemplate</span><span style="color:#E06C75;">(flatTemplate)</span><span style="color:#ABB2BF;">;</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>在创建概念元数据模板以后，还可以通过以下接口增加或删除模板内的物理量。请注意，已经挂载的模板不能删除内部的物理量。</li></ul><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-java"><span class="line"><span style="color:#7F848E;font-style:italic;">// 为指定模板新增一组对齐的物理量，若其父节点在模板中已经存在，且不要求对齐，则报错</span></span> |
| <span class="line"><span style="color:#C678DD;">public</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> addAlignedMeasurementsInTemplate</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> templateName</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> String</span><span style="color:#E06C75;">[] measurementsPath</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> TSDataType</span><span style="color:#E06C75;">[] dataTypes</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> TSEncoding</span><span style="color:#E06C75;">[] encodings</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> CompressionType</span><span style="color:#E06C75;">[] compressors)</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">// 为指定模板新增一个对齐物理量, 若其父节点在模板中已经存在，且不要求对齐，则报错</span></span> |
| <span class="line"><span style="color:#C678DD;">public</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> addAlignedMeasurementInTemplate</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> templateName</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> String</span><span style="color:#E06C75;"> measurementPath</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> TSDataType</span><span style="color:#E06C75;"> dataType</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> TSEncoding</span><span style="color:#E06C75;"> encoding</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> CompressionType</span><span style="color:#E06C75;"> compressor)</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">// 为指定模板新增一个不对齐物理量, 若其父节在模板中已经存在，且要求对齐，则报错</span></span> |
| <span class="line"><span style="color:#C678DD;">public</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> addUnalignedMeasurementInTemplate</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> templateName</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> String</span><span style="color:#E06C75;"> measurementPath</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> TSDataType</span><span style="color:#E06C75;"> dataType</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> TSEncoding</span><span style="color:#E06C75;"> encoding</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> CompressionType</span><span style="color:#E06C75;"> compressor)</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;">// 为指定模板新增一组不对齐的物理量, 若其父节在模板中已经存在，且要求对齐，则报错</span></span> |
| <span class="line"><span style="color:#C678DD;">public</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> addUnalignedMeasurementsIntemplate</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> templateName</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> String</span><span style="color:#E06C75;">[] measurementPaths</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> TSDataType</span><span style="color:#E06C75;">[] dataTypes</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> TSEncoding</span><span style="color:#E06C75;">[] encodings</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> CompressionType</span><span style="color:#E06C75;">[] compressors)</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">// 从指定模板中删除一个节点</span></span> |
| <span class="line"><span style="color:#C678DD;">public</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> deleteNodeInTemplate</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> templateName</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> String</span><span style="color:#E06C75;"> path)</span><span style="color:#ABB2BF;">;</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div 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><ul><li>对于已经创建的元数据模板，还可以通过以下接口查询模板信息：</li></ul><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-java"><span class="line"><span style="color:#7F848E;font-style:italic;">// 查询返回目前模板中所有物理量的数量</span></span> |
| <span class="line"><span style="color:#C678DD;">public</span><span style="color:#C678DD;"> int</span><span style="color:#61AFEF;"> countMeasurementsInTemplate</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> templateName)</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">// 检查模板内指定路径是否为物理量</span></span> |
| <span class="line"><span style="color:#C678DD;">public</span><span style="color:#C678DD;"> boolean</span><span style="color:#61AFEF;"> isMeasurementInTemplate</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> templateName</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> String</span><span style="color:#E06C75;"> path)</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">// 检查在指定模板内是否存在某路径</span></span> |
| <span class="line"><span style="color:#C678DD;">public</span><span style="color:#C678DD;"> boolean</span><span style="color:#61AFEF;"> isPathExistInTemplate</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> templateName</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> String</span><span style="color:#E06C75;"> path)</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">// 返回指定模板内所有物理量的路径</span></span> |
| <span class="line"><span style="color:#C678DD;">public</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">></span><span style="color:#61AFEF;"> showMeasurementsInTemplate</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> templateName)</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">// 返回指定模板内某前缀路径下的所有物理量的路径</span></span> |
| <span class="line"><span style="color:#C678DD;">public</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">></span><span style="color:#61AFEF;"> showMeasurementsInTemplate</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> templateName</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> String</span><span style="color:#E06C75;"> pattern)</span><span style="color:#ABB2BF;">;</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>将名为<code>templateName</code>的元数据模板挂载到'prefixPath'路径下，在执行这一步之前，你需要创建名为<code>templateName</code>的元数据模板</li><li><strong>请注意，我们强烈建议您将模板设置在存储组或存储组下层的节点中，以更好地适配未来版本更新及各模块的协作</strong></li></ul><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-java"><span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> setSchemaTemplate</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> templateName</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> String</span><span style="color:#E06C75;"> prefixPath)</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>将模板挂载到 MTree 上之后，你可以随时查询所有模板的名称、某模板被设置到 MTree 的所有路径、所有正在使用某模板的所有路径，即如下接口：</li></ul><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-java"><span class="line"><span style="color:#7F848E;font-style:italic;">/** </span><span style="color:#C678DD;font-style:italic;">@return</span><span style="color:#7F848E;font-style:italic;"> All template names. */</span></span> |
| <span class="line"><span style="color:#C678DD;">public</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">></span><span style="color:#61AFEF;"> showAllTemplates</span><span style="color:#E06C75;">()</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">/** </span><span style="color:#C678DD;font-style:italic;">@return</span><span style="color:#7F848E;font-style:italic;"> All paths have been set to designated template. */</span></span> |
| <span class="line"><span style="color:#C678DD;">public</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">></span><span style="color:#61AFEF;"> showPathsTemplateSetOn</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> templateName)</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">/** </span><span style="color:#C678DD;font-style:italic;">@return</span><span style="color:#7F848E;font-style:italic;"> All paths are using designated template. */</span></span> |
| <span class="line"><span style="color:#C678DD;">public</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">></span><span style="color:#61AFEF;"> showPathsTemplateUsingOn</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> templateName)</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><ul><li>如果你需要删除某一个模板，请确保在进行删除之前，MTree 上已经没有节点被挂载了模板，对于已经被挂载模板的节点，可以用如下接口卸载模板；</li></ul><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-java"><span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> unsetSchemaTemplate</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> prefixPath</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> String</span><span style="color:#E06C75;"> templateName)</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;">public</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> dropSchemaTemplate</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> templateName)</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></div><ul><li>请注意，如果一个子树中有多个孩子节点需要使用模板，可以在其共同父母节点上使用 <code>setSchemaTemplate</code> 。而只有在已有数据点插入模板对应的物理量，或使用以下接口激活模板，模板才会被设置为激活状态，进而被 <code>show timeseries</code> 等查询访问到。</li></ul><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-java"><span class="line"><span style="color:#C678DD;">public</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> createTimeseriesOfTemplateOnPath</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> path)</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></div><ul><li>卸载'prefixPath'路径下的名为<code>templateName</code>的元数据模板。你需要保证给定的路径<code>prefixPath</code>下需要有名为<code>templateName</code>的元数据模板。</li><li>如果在挂载模板后，曾经在<code>prefixPath</code>路径及其后代节点使用模板插入数据后，或者使用了激活模板命令，那么在卸载模板之前，还要对所有已激活模板的节点使用以下接口解除模板：</li></ul><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-java"><span class="line"><span style="color:#C678DD;">public</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> deactivateTemplateOn</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> templateName</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> String</span><span style="color:#E06C75;"> prefixPath)</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></div><ul><li>以上解除模板接口中，参数<code>prefixPath</code>如果含有通配符（<code>*</code>或<code>**</code>）则按 PathPattern 匹配目标路径，否则仅表达其字面量对应的路径。</li><li>解除模板接口会删除对应节点按照模板中的序列写入的数据。</li></ul><h4 id="数据操作接口-dml" tabindex="-1"><a class="header-anchor" href="#数据操作接口-dml"><span>数据操作接口 DML</span></a></h4><h5 id="数据写入" tabindex="-1"><a class="header-anchor" href="#数据写入"><span>数据写入</span></a></h5><p>推荐使用 insertTablet 帮助提高写入效率</p><ul><li>插入一个 Tablet，Tablet 是一个设备若干行数据块，每一行的列都相同 <ul><li><strong>写入效率高</strong></li><li><strong>支持批量写入</strong></li><li><strong>支持写入空值</strong>：空值处可以填入任意值，然后通过 BitMap 标记空值</li></ul></li></ul><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-java"><span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> insertTablet</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">Tablet</span><span style="color:#E06C75;"> tablet)</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#C678DD;">public</span><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;"> /** deviceId of this tablet */</span></span> |
| <span class="line"><span style="color:#C678DD;"> public</span><span style="color:#E5C07B;"> String</span><span style="color:#E06C75;"> prefixPath</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> /** the list of measurement schemas for creating the tablet */</span></span> |
| <span class="line"><span style="color:#C678DD;"> private</span><span style="color:#E5C07B;"> List</span><span style="color:#ABB2BF;"><</span><span style="color:#E5C07B;">MeasurementSchema</span><span style="color:#ABB2BF;">></span><span style="color:#E06C75;"> schemas</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> /** timestamps in this tablet */</span></span> |
| <span class="line"><span style="color:#C678DD;"> public</span><span style="color:#C678DD;"> long</span><span style="color:#E06C75;">[] timestamps</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> /** each object is a primitive type array, which represents values of one measurement */</span></span> |
| <span class="line"><span style="color:#C678DD;"> public</span><span style="color:#E5C07B;"> Object</span><span style="color:#E06C75;">[] values</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> /** each bitmap represents the existence of each value in the current column. */</span></span> |
| <span class="line"><span style="color:#C678DD;"> public</span><span style="color:#E5C07B;"> BitMap</span><span style="color:#E06C75;">[] bitMaps</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> /** the number of rows to include in this tablet */</span></span> |
| <span class="line"><span style="color:#C678DD;"> public</span><span style="color:#C678DD;"> int</span><span style="color:#E06C75;"> rowSize</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> /** the maximum number of rows for this tablet */</span></span> |
| <span class="line"><span style="color:#C678DD;"> private</span><span style="color:#C678DD;"> int</span><span style="color:#E06C75;"> maxRowNumber</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> /** whether this tablet store data of aligned timeseries or not */</span></span> |
| <span class="line"><span style="color:#C678DD;"> private</span><span style="color:#C678DD;"> boolean</span><span style="color:#E06C75;"> isAligned</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></div><ul><li>插入多个 Tablet</li></ul><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-java"><span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> insertTablets</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">Map</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#ABB2BF;">,</span><span style="color:#E06C75;"> Tablet</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> tablets)</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li><p>插入一个 Record，一个 Record 是一个设备一个时间戳下多个测点的数据。这里的 value 是 Object 类型，相当于提供了一个公用接口，后面可以通过 TSDataType 将 value 强转为原类型</p><p>其中，Object 类型与 TSDataType 类型的对应关系如下表所示：</p><table><thead><tr><th>TSDataType</th><th>Object</th></tr></thead><tbody><tr><td>BOOLEAN</td><td>Boolean</td></tr><tr><td>INT32</td><td>Integer</td></tr><tr><td>INT64</td><td>Long</td></tr><tr><td>FLOAT</td><td>Float</td></tr><tr><td>DOUBLE</td><td>Double</td></tr><tr><td>TEXT</td><td>String, Binary</td></tr></tbody></table></li></ul><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-java"><span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> insertRecord</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> prefixPath</span><span style="color:#ABB2BF;">,</span><span style="color:#C678DD;"> long</span><span style="color:#E06C75;"> time</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> measurements</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">TSDataType</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> types</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">Object</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> values)</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></div><ul><li>插入多个 Record</li></ul><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-java"><span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> insertRecords</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> deviceIds</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">Long</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> times</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">>></span><span style="color:#E06C75;"> measurementsList</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">TSDataType</span><span style="color:#56B6C2;">>></span><span style="color:#E06C75;"> typesList</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">Object</span><span style="color:#56B6C2;">>></span><span style="color:#E06C75;"> valuesList)</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></div><ul><li>插入同属于一个 device 的多个 Record</li></ul><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-java"><span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> insertRecordsOfOneDevice</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> deviceId</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">Long</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> times</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">>></span><span style="color:#E06C75;"> measurementsList</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">TSDataType</span><span style="color:#56B6C2;">>></span><span style="color:#E06C75;"> typesList</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">Object</span><span style="color:#56B6C2;">>></span><span style="color:#E06C75;"> valuesList)</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></div><h5 id="带有类型推断的写入" tabindex="-1"><a class="header-anchor" href="#带有类型推断的写入"><span>带有类型推断的写入</span></a></h5><p>当数据均是 String 类型时，我们可以使用如下接口，根据 value 的值进行类型推断。例如：value 为 "true" ，就可以自动推断为布尔类型。value 为 "3.2" ，就可以自动推断为数值类型。服务器需要做类型推断，可能会有额外耗时，速度较无需类型推断的写入慢</p><ul><li>插入一个 Record，一个 Record 是一个设备一个时间戳下多个测点的数据</li></ul><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-java"><span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> insertRecord</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> prefixPath</span><span style="color:#ABB2BF;">,</span><span style="color:#C678DD;"> long</span><span style="color:#E06C75;"> time</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> measurements</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> values)</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>插入多个 Record</li></ul><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-java"><span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> insertRecords</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> deviceIds</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">Long</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> times</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">>></span><span style="color:#E06C75;"> measurementsList</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">>></span><span style="color:#E06C75;"> valuesList)</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></div><ul><li>插入同属于一个 device 的多个 Record</li></ul><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-java"><span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> insertStringRecordsOfOneDevice</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> deviceId</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">Long</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> times</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">>></span><span style="color:#E06C75;"> measurementsList</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">>></span><span style="color:#E06C75;"> valuesList)</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></div><h5 id="对齐时间序列的写入" tabindex="-1"><a class="header-anchor" href="#对齐时间序列的写入"><span>对齐时间序列的写入</span></a></h5><p>对齐时间序列的写入使用 insertAlignedXXX 接口，其余与上述接口类似：</p><ul><li>insertAlignedRecord</li><li>insertAlignedRecords</li><li>insertAlignedRecordsOfOneDevice</li><li>insertAlignedStringRecordsOfOneDevice</li><li>insertAlignedTablet</li><li>insertAlignedTablets</li></ul><h5 id="数据删除" tabindex="-1"><a class="header-anchor" href="#数据删除"><span>数据删除</span></a></h5><ul><li>删除一个或多个时间序列在某个时间点前或这个时间点的数据</li></ul><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-java"><span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> deleteData</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> path</span><span style="color:#ABB2BF;">,</span><span style="color:#C678DD;"> long</span><span style="color:#E06C75;"> endTime)</span></span> |
| <span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> deleteData</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> paths</span><span style="color:#ABB2BF;">,</span><span style="color:#C678DD;"> long</span><span style="color:#E06C75;"> endTime)</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></div><h5 id="数据查询" tabindex="-1"><a class="header-anchor" href="#数据查询"><span>数据查询</span></a></h5><ul><li>原始数据查询。时间间隔包含开始时间，不包含结束时间</li></ul><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-java"><span class="line"><span style="color:#E5C07B;">SessionDataSet</span><span style="color:#61AFEF;"> executeRawDataQuery</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> paths</span><span style="color:#ABB2BF;">,</span><span style="color:#C678DD;"> long</span><span style="color:#E06C75;"> startTime</span><span style="color:#ABB2BF;">,</span><span style="color:#C678DD;"> long</span><span style="color:#E06C75;"> endTime)</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>查询最后一条时间戳大于等于某个时间点的数据</li></ul><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-java"><span class="line"><span style="color:#E5C07B;">SessionDataSet</span><span style="color:#61AFEF;"> executeLastDataQuery</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> paths</span><span style="color:#ABB2BF;">,</span><span style="color:#C678DD;"> long</span><span style="color:#E06C75;"> LastTime)</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><h4 id="iotdb-sql-接口" tabindex="-1"><a class="header-anchor" href="#iotdb-sql-接口"><span>IoTDB-SQL 接口</span></a></h4><ul><li>执行查询语句</li></ul><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-java"><span class="line"><span style="color:#E5C07B;">SessionDataSet</span><span style="color:#61AFEF;"> executeQueryStatement</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> sql)</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>执行非查询语句</li></ul><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-java"><span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> executeNonQueryStatement</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> sql)</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><h4 id="写入测试接口-用于分析网络带宽" tabindex="-1"><a class="header-anchor" href="#写入测试接口-用于分析网络带宽"><span>写入测试接口 (用于分析网络带宽)</span></a></h4><p>不实际写入数据，只将数据传输到 server 即返回</p><ul><li>测试 insertRecord</li></ul><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-java"><span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> testInsertRecord</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> deviceId</span><span style="color:#ABB2BF;">,</span><span style="color:#C678DD;"> long</span><span style="color:#E06C75;"> time</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> measurements</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> values)</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> testInsertRecord</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">String</span><span style="color:#E06C75;"> deviceId</span><span style="color:#ABB2BF;">,</span><span style="color:#C678DD;"> long</span><span style="color:#E06C75;"> time</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> measurements</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">TSDataType</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> types</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">Object</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> values)</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></div><ul><li>测试 testInsertRecords</li></ul><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-java"><span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> testInsertRecords</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> deviceIds</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">Long</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> times</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">>></span><span style="color:#E06C75;"> measurementsList</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">>></span><span style="color:#E06C75;"> valuesList)</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> testInsertRecords</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> deviceIds</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">Long</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> times</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#56B6C2;">>></span><span style="color:#E06C75;"> measurementsList</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">TSDataType</span><span style="color:#56B6C2;">>></span><span style="color:#E06C75;"> typesList</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E5C07B;"> List</span><span style="color:#56B6C2;"><</span><span style="color:#E5C07B;">List</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">Object</span><span style="color:#56B6C2;">>></span><span style="color:#E06C75;"> valuesList)</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></div><ul><li>测试 insertTablet</li></ul><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-java"><span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> testInsertTablet</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">Tablet</span><span style="color:#E06C75;"> tablet)</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>测试 insertTablets</li></ul><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-java"><span class="line"><span style="color:#C678DD;">void</span><span style="color:#61AFEF;"> testInsertTablets</span><span style="color:#E06C75;">(</span><span style="color:#E5C07B;">Map</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">String</span><span style="color:#ABB2BF;">,</span><span style="color:#E06C75;"> Tablet</span><span style="color:#56B6C2;">></span><span style="color:#E06C75;"> tablets)</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><h5 id="示例代码" tabindex="-1"><a class="header-anchor" href="#示例代码"><span>示例代码</span></a></h5><p>浏览上述接口的详细信息，请参阅代码 <code>session/src/main/java/org/apache/iotdb/session/Session.java</code></p><p>使用上述接口的示例代码在 <code>example/session/src/main/java/org/apache/iotdb/SessionExample.java</code></p><p>使用对齐时间序列和元数据模板的示例可以参见 <code>example/session/src/main/java/org/apache/iotdb/AlignedTimeseriesSessionExample.java</code></p><h6 id="针对原生接口的连接池" tabindex="-1"><a class="header-anchor" href="#针对原生接口的连接池"><span>针对原生接口的连接池</span></a></h6><p>我们提供了一个针对原生接口的连接池 (<code>SessionPool</code>)，使用该接口时，你只需要指定连接池的大小，就可以在使用时从池中获取连接。<br> 如果超过 60s 都没得到一个连接的话，那么会打印一条警告日志，但是程序仍将继续等待。</p><p>当一个连接被用完后，他会自动返回池中等待下次被使用；<br> 当一个连接损坏后，他会从池中被删除，并重建一个连接重新执行用户的操作；<br> 你还可以像创建 Session 那样在创建 SessionPool 时指定多个可连接节点的 url，以保证分布式集群中客户端的高可用性。</p><p>对于查询操作：</p><ol><li>使用 SessionPool 进行查询时，得到的结果集是<code>SessionDataSet</code>的封装类<code>SessionDataSetWrapper</code>;</li><li>若对于一个查询的结果集，用户并没有遍历完且不再想继续遍历时，需要手动调用释放连接的操作<code>closeResultSet</code>;</li><li>若对一个查询的结果集遍历时出现异常，也需要手动调用释放连接的操作<code>closeResultSet</code>.</li><li>可以调用 <code>SessionDataSetWrapper</code> 的 <code>getColumnNames()</code> 方法得到结果集列名</li></ol><p>使用示例可以参见 <code>session/src/test/java/org/apache/iotdb/session/pool/SessionPoolTest.java</code></p><p>或 <code>example/session/src/main/java/org/apache/iotdb/SessionPoolExample.java</code></p><h6 id="集群信息相关的接口-仅在集群模式下可用" tabindex="-1"><a class="header-anchor" href="#集群信息相关的接口-仅在集群模式下可用"><span>集群信息相关的接口 （仅在集群模式下可用）</span></a></h6><p>集群信息相关的接口允许用户获取如数据分区情况、节点是否当机等信息。<br> 要使用该 API，需要增加依赖：</p><div class="language-xml line-numbers-mode" data-highlighter="shiki" data-ext="xml" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-xml"><span class="line"><span style="color:#ABB2BF;"><</span><span style="color:#E06C75;">dependencies</span><span style="color:#ABB2BF;">></span></span> |
| <span class="line"><span style="color:#ABB2BF;"> <</span><span style="color:#E06C75;">dependency</span><span style="color:#ABB2BF;">></span></span> |
| <span class="line"><span style="color:#ABB2BF;"> <</span><span style="color:#E06C75;">groupId</span><span style="color:#ABB2BF;">>org.apache.iotdb</</span><span style="color:#E06C75;">groupId</span><span style="color:#ABB2BF;">></span></span> |
| <span class="line"><span style="color:#ABB2BF;"> <</span><span style="color:#E06C75;">artifactId</span><span style="color:#ABB2BF;">>iotdb-thrift-cluster</</span><span style="color:#E06C75;">artifactId</span><span style="color:#ABB2BF;">></span></span> |
| <span class="line"><span style="color:#ABB2BF;"> <</span><span style="color:#E06C75;">version</span><span style="color:#ABB2BF;">>0.13.0-SNAPSHOT</</span><span style="color:#E06C75;">version</span><span style="color:#ABB2BF;">></span></span> |
| <span class="line"><span style="color:#ABB2BF;"> </</span><span style="color:#E06C75;">dependency</span><span style="color:#ABB2BF;">></span></span> |
| <span class="line"><span style="color:#ABB2BF;"></</span><span style="color:#E06C75;">dependencies</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></div><p>建立连接与关闭连接的示例：</p><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-java"><span class="line"><span style="color:#C678DD;">import</span><span style="color:#E5C07B;"> org.apache.thrift.protocol.TBinaryProtocol</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;">import</span><span style="color:#E5C07B;"> org.apache.thrift.transport.TSocket</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;">import</span><span style="color:#E5C07B;"> org.apache.thrift.transport.TTransport</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;">import</span><span style="color:#E5C07B;"> org.apache.thrift.transport.TTransportException</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;">import</span><span style="color:#E5C07B;"> org.apache.iotdb.rpc.RpcTransportFactory</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#C678DD;">public</span><span style="color:#C678DD;"> class</span><span style="color:#E5C07B;"> CluserInfoClient</span><span style="color:#ABB2BF;"> {</span></span> |
| <span class="line"><span style="color:#E5C07B;"> TTransport</span><span style="color:#E06C75;"> transport</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#E5C07B;"> ClusterInfoService</span><span style="color:#ABB2BF;">.</span><span style="color:#E5C07B;">Client</span><span style="color:#E06C75;"> client</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"><span style="color:#C678DD;"> public</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> connect</span><span style="color:#ABB2BF;">()</span><span style="color:#ABB2BF;"> {</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> transport </span><span style="color:#56B6C2;">=</span></span> |
| <span class="line"><span style="color:#E5C07B;"> RpcTransportFactory</span><span style="color:#ABB2BF;">.</span><span style="color:#E5C07B;">INSTANCE</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">getTransport</span><span style="color:#ABB2BF;">(</span></span> |
| <span class="line"><span style="color:#C678DD;"> new</span><span style="color:#61AFEF;"> TSocket</span><span style="color:#ABB2BF;">(</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> // the RPC address</span></span> |
| <span class="line"><span style="color:#E5C07B;"> IoTDBDescriptor</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">getInstance</span><span style="color:#ABB2BF;">().</span><span style="color:#61AFEF;">getConfig</span><span style="color:#ABB2BF;">().</span><span style="color:#61AFEF;">getRpcAddress</span><span style="color:#ABB2BF;">(),</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> // the RPC port</span></span> |
| <span class="line"><span style="color:#E5C07B;"> ClusterDescriptor</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">getInstance</span><span style="color:#ABB2BF;">().</span><span style="color:#61AFEF;">getConfig</span><span style="color:#ABB2BF;">().</span><span style="color:#61AFEF;">getClusterRpcPort</span><span style="color:#ABB2BF;">()));</span></span> |
| <span class="line"><span style="color:#C678DD;"> try</span><span style="color:#ABB2BF;"> {</span></span> |
| <span class="line"><span style="color:#E5C07B;"> transport</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">open</span><span style="color:#ABB2BF;">();</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> } </span><span style="color:#C678DD;">catch</span><span style="color:#ABB2BF;"> (</span><span style="color:#E5C07B;">TTransportException</span><span style="color:#E06C75;font-style:italic;"> e</span><span style="color:#ABB2BF;">) {</span></span> |
| <span class="line"><span style="color:#E5C07B;"> Assert</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">fail</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">e</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">getMessage</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;"> //get the client</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> client </span><span style="color:#56B6C2;">=</span><span style="color:#C678DD;"> new</span><span style="color:#ABB2BF;"> ClusterInfoService.</span><span style="color:#61AFEF;">Client</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">new</span><span style="color:#61AFEF;"> TBinaryProtocol</span><span style="color:#ABB2BF;">(transport));</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> }</span></span> |
| <span class="line"><span style="color:#C678DD;"> public</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> close</span><span style="color:#ABB2BF;">()</span><span style="color:#ABB2BF;"> {</span></span> |
| <span class="line"><span style="color:#E5C07B;"> transport</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">close</span><span style="color:#ABB2BF;">();</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> }</span><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></div><p>API 列表：</p><ul><li>获取集群中的各个节点的信息（构成哈希环）</li></ul><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-java"><span class="line"><span style="color:#E06C75;">list</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">Node</span><span style="color:#56B6C2;">></span><span style="color:#61AFEF;"> getRing</span><span style="color:#E06C75;">()</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></div><ul><li>给定一个路径（应包括一个 SG 作为前缀）和起止时间，获取其覆盖的数据分区情况：</li></ul><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-java"><span class="line"><span style="color:#7F848E;font-style:italic;">/**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#E06C75;font-style:italic;"> path</span><span style="color:#7F848E;font-style:italic;"> input path (should contains a Storage group name as its prefix)</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@return</span><span style="color:#7F848E;font-style:italic;"> the data partition info. If the time range only covers one data partition, the the size</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * of the list is one.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> */</span></span> |
| <span class="line"><span style="color:#E06C75;">list</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">DataPartitionEntry</span><span style="color:#56B6C2;">></span><span style="color:#61AFEF;"> getDataPartition</span><span style="color:#E06C75;">(</span><span style="color:#D19A66;">1</span><span style="color:#C678DD;">:</span><span style="color:#E06C75;">string path</span><span style="color:#ABB2BF;">,</span><span style="color:#D19A66;"> 2</span><span style="color:#C678DD;">:long</span><span style="color:#E06C75;"> startTime</span><span style="color:#ABB2BF;">,</span><span style="color:#D19A66;"> 3</span><span style="color:#C678DD;">:long</span><span style="color:#E06C75;"> endTime)</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></div><ul><li>给定一个路径（应包括一个 SG 作为前缀），获取其被分到了哪个节点上：</li></ul><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-java"><span class="line"><span style="color:#7F848E;font-style:italic;">/**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@param</span><span style="color:#E06C75;font-style:italic;"> path</span><span style="color:#7F848E;font-style:italic;"> input path (should contains a Storage group name as its prefix)</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@return</span><span style="color:#7F848E;font-style:italic;"> metadata partition information</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> */</span></span> |
| <span class="line"><span style="color:#E06C75;">list</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">Node</span><span style="color:#56B6C2;">></span><span style="color:#61AFEF;"> getMetaPartition</span><span style="color:#E06C75;">(</span><span style="color:#D19A66;">1</span><span style="color:#C678DD;">:</span><span style="color:#E06C75;">string path)</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></div><ul><li>获取所有节点的死活状态：</li></ul><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-java"><span class="line"><span style="color:#7F848E;font-style:italic;">/**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@return</span><span style="color:#7F848E;font-style:italic;"> key: node, value: live or not</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> */</span></span> |
| <span class="line"><span style="color:#E06C75;">map</span><span style="color:#56B6C2;"><</span><span style="color:#E06C75;">Node</span><span style="color:#ABB2BF;">,</span><span style="color:#E06C75;"> bool</span><span style="color:#56B6C2;">></span><span style="color:#61AFEF;"> getAllNodeStatus</span><span style="color:#E06C75;">()</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></div><ul><li>获取当前连接节点的 Raft 组信息（投票编号等）（一般用户无需使用该接口）:</li></ul><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-java"><span class="line"><span style="color:#7F848E;font-style:italic;">/**</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * </span><span style="color:#C678DD;font-style:italic;">@return</span><span style="color:#7F848E;font-style:italic;"> A multi-line string with each line representing the total time consumption, invocation</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> * number, and average time consumption.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> */</span></span> |
| <span class="line"><span style="color:#E06C75;">string </span><span style="color:#61AFEF;">getInstrumentingInfo</span><span style="color:#E06C75;">()</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></div>`,123))])}const u=o(d,[["render",y]]),C=JSON.parse('{"path":"/zh/UserGuide/V0.13.x/API/Programming-Java-Native-API.html","title":"应用编程接口","lang":"zh-CN","frontmatter":{"description":"应用编程接口 Java 原生接口 安装 依赖 JDK >= 1.8 Maven >= 3.6 在 MAVEN 中使用原生接口 语法说明 对于 IoTDB-SQL 接口：传入的 SQL 参数需要符合 ，并且针对 JAVA 字符串进行反转义，如双引号前需要加反斜杠。（即：经 JAVA 转义之后与命令行执行的 SQL 语句一致。） 对于其他接口： 经参数传入...","head":[["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"应用编程接口\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2024-12-04T09:08:04.000Z\\",\\"author\\":[]}"],["meta",{"property":"og:url","content":"https://iotdb.apache.org/zh/UserGuide/V0.13.x/API/Programming-Java-Native-API.html"}],["meta",{"property":"og:site_name","content":"IoTDB Website"}],["meta",{"property":"og:title","content":"应用编程接口"}],["meta",{"property":"og:description","content":"应用编程接口 Java 原生接口 安装 依赖 JDK >= 1.8 Maven >= 3.6 在 MAVEN 中使用原生接口 语法说明 对于 IoTDB-SQL 接口：传入的 SQL 参数需要符合 ，并且针对 JAVA 字符串进行反转义，如双引号前需要加反斜杠。（即：经 JAVA 转义之后与命令行执行的 SQL 语句一致。） 对于其他接口： 经参数传入..."}],["meta",{"property":"og:type","content":"article"}],["meta",{"property":"og:locale","content":"zh-CN"}],["meta",{"property":"og:locale:alternate","content":"en-US"}],["meta",{"property":"og:updated_time","content":"2024-12-04T09:08:04.000Z"}],["meta",{"property":"article:modified_time","content":"2024-12-04T09:08:04.000Z"}],["link",{"rel":"alternate","hreflang":"en-us","href":"https://iotdb.apache.org/UserGuide/V0.13.x/API/Programming-Java-Native-API.html"}]]},"git":{"createdTime":1688958677000,"updatedTime":1733303284000,"contributors":[{"name":"CritasWang","username":"CritasWang","email":"critas@outlook.com","commits":1,"url":"https://github.com/CritasWang"},{"name":"2b3c511","username":"2b3c511","email":"43237967+2b3c511@users.noreply.github.com","commits":1,"url":"https://github.com/2b3c511"},{"name":"W1y1r","username":"W1y1r","email":"150988475+W1y1r@users.noreply.github.com","commits":1,"url":"https://github.com/W1y1r"}]},"readingTime":{"minutes":12.1,"words":3631},"filePathRelative":"zh/UserGuide/V0.13.x/API/Programming-Java-Native-API.md","autoDesc":true}');export{u as comp,C as data}; |
