(window.webpackJsonp=window.webpackJsonp||[]).push([[419],{814:function(e,s,t){"use strict";t.r(s);var a=t(29),n=Object(a.a)({},(function(){var e=this,s=e._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[s("h1",{attrs:{id:"programming-session"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#programming-session"}},[e._v("#")]),e._v(" Programming - Session")]),e._v(" "),s("h2",{attrs:{id:"usage"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#usage"}},[e._v("#")]),e._v(" Usage")]),e._v(" "),s("h3",{attrs:{id:"dependencies"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#dependencies"}},[e._v("#")]),e._v(" Dependencies")]),e._v(" "),s("ul",[s("li",[e._v("JDK >= 1.8")]),e._v(" "),s("li",[e._v("Maven >= 3.1")])]),e._v(" "),s("h3",{attrs:{id:"how-to-package-only-client-module"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#how-to-package-only-client-module"}},[e._v("#")]),e._v(" How to package only client module")]),e._v(" "),s("p",[e._v("In root directory:")]),e._v(" "),s("blockquote",[s("p",[e._v("mvn clean package -pl client -am -Dmaven.test.skip=true")])]),e._v(" "),s("h3",{attrs:{id:"how-to-install-in-local-maven-repository"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#how-to-install-in-local-maven-repository"}},[e._v("#")]),e._v(" How to install in local maven repository")]),e._v(" "),s("p",[e._v("In root directory:")]),e._v(" "),s("blockquote",[s("p",[e._v("mvn clean install -pl client -am -Dmaven.test.skip=true")])]),e._v(" "),s("h3",{attrs:{id:"using-iotdb-session-with-maven"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#using-iotdb-session-with-maven"}},[e._v("#")]),e._v(" Using IoTDB Session with Maven")]),e._v(" "),s("div",{staticClass:"language-java line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-java"}},[s("code",[s("span",{pre:!0,attrs:{class:"token generics"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("<")]),e._v("dependencies"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(">")])]),e._v("\n    "),s("span",{pre:!0,attrs:{class:"token generics"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("<")]),e._v("dependency"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(">")])]),e._v("\n      "),s("span",{pre:!0,attrs:{class:"token generics"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("<")]),e._v("groupId"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(">")])]),e._v("org"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("apache"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("iotdb"),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v("/")]),e._v("groupId"),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v("\n      "),s("span",{pre:!0,attrs:{class:"token generics"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("<")]),e._v("artifactId"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(">")])]),e._v("iotdb"),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v("-")]),e._v("session"),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v("/")]),e._v("artifactId"),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v("\n      "),s("span",{pre:!0,attrs:{class:"token generics"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("<")]),e._v("version"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(">")])]),s("span",{pre:!0,attrs:{class:"token number"}},[e._v("0.9")]),s("span",{pre:!0,attrs:{class:"token number"}},[e._v(".3")]),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v("/")]),e._v("version"),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v("\n    "),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v("/")]),e._v("dependency"),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v("\n"),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v("/")]),e._v("dependencies"),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v("\n")])]),e._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[e._v("1")]),s("br"),s("span",{staticClass:"line-number"},[e._v("2")]),s("br"),s("span",{staticClass:"line-number"},[e._v("3")]),s("br"),s("span",{staticClass:"line-number"},[e._v("4")]),s("br"),s("span",{staticClass:"line-number"},[e._v("5")]),s("br"),s("span",{staticClass:"line-number"},[e._v("6")]),s("br"),s("span",{staticClass:"line-number"},[e._v("7")]),s("br")])]),s("h3",{attrs:{id:"examples-with-session-interfaces"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#examples-with-session-interfaces"}},[e._v("#")]),e._v(" Examples with Session interfaces")]),e._v(" "),s("p",[e._v("Here we show the commonly used interfaces and their parameters in the Session:")]),e._v(" "),s("h4",{attrs:{id:"run-the-session"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#run-the-session"}},[e._v("#")]),e._v(" Run the Session")]),e._v(" "),s("ul",[s("li",[s("p",[e._v("Initialize a Session")]),e._v(" "),s("p",[e._v("Session(String host, int port)")]),e._v(" "),s("p",[e._v("Session(String host, String port, String username, String password)")]),e._v(" "),s("p",[e._v("Session(String host, int port, String username, String password)")])]),e._v(" "),s("li",[s("p",[e._v("Open a Session")]),e._v(" "),s("p",[e._v("​\tSession.open()")])]),e._v(" "),s("li",[s("p",[e._v("Close a Session")]),e._v(" "),s("p",[e._v("​\tSession.close()")])])]),e._v(" "),s("h4",{attrs:{id:"operate-the-session"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#operate-the-session"}},[e._v("#")]),e._v(" Operate the Session")]),e._v(" "),s("ul",[s("li",[s("p",[e._v("Set storage group")]),e._v(" "),s("p",[e._v("​\tTSStatus setStorageGroup(String storageGroupId)")])]),e._v(" "),s("li",[s("p",[e._v("Delete one or several storage groups")]),e._v(" "),s("p",[e._v("​\tTSStatus deleteStorageGroup(String storageGroup)")]),e._v(" "),s("div",{staticClass:"language- line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-text"}},[s("code",[e._v("TSStatus deleteStorageGroups(List<String> storageGroups)\n")])]),e._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[e._v("1")]),s("br")])])]),e._v(" "),s("li",[s("p",[e._v("Create one timeseries under a existing storage group")]),e._v(" "),s("p",[e._v("​\tTSStatus createTimeseries(String path, TSDataType dataType, TSEncoding encoding, CompressionType compressor)")])]),e._v(" "),s("li",[s("p",[e._v("Delete one or several timeseries")]),e._v(" "),s("p",[e._v("​\tTSStatus deleteTimeseries(String path)")]),e._v(" "),s("div",{staticClass:"language- line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-text"}},[s("code",[e._v("TSStatus deleteTimeseries(List<String> paths)\n")])]),e._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[e._v("1")]),s("br")])])]),e._v(" "),s("li",[s("p",[e._v("Delete one or several timeseries before a certain timestamp")]),e._v(" "),s("p",[e._v("​\tTSStatus deleteData(String path, long time)")]),e._v(" "),s("div",{staticClass:"language- line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-text"}},[s("code",[e._v("TSStatus deleteData(List<String> paths, long time)\n")])]),e._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[e._v("1")]),s("br")])])]),e._v(" "),s("li",[s("p",[e._v("Insert data into existing timeseries")]),e._v(" "),s("div",{staticClass:"language- line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-text"}},[s("code",[e._v("TSStatus insert(String deviceId, long time, List<String> measurements, List<String> values)\n")])]),e._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[e._v("1")]),s("br")])])]),e._v(" "),s("li",[s("p",[e._v("Batch insertion into timeseries")]),e._v(" "),s("p",[e._v("​\tTSExecuteBatchStatementResp insertBatch(RowBatch rowBatch)")])])]),e._v(" "),s("h4",{attrs:{id:"sample-code"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#sample-code"}},[e._v("#")]),e._v(" Sample code")]),e._v(" "),s("p",[e._v("To get more information of the following interfaces, please view session/src/main/java/org/apache/iotdb/session/Session.java")]),e._v(" "),s("p",[e._v("The sample code of using these interfaces is in example/session/src/main/java/org/apache/iotdb/SessionExample.java，which provides an example of how to open an IoTDB session, execute a batch insertion.")]),e._v(" "),s("h1",{attrs:{id:"session-pool-for-native-api"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#session-pool-for-native-api"}},[e._v("#")]),e._v(" Session Pool for Native API")]),e._v(" "),s("p",[e._v("We provided a connection pool (`SessionPool) for Native API.\nUsing the interface, you need to define the pool size.")]),e._v(" "),s("p",[e._v("If you can not get a session connection in 60 secondes, there is a warning log but the program will hang.")]),e._v(" "),s("p",[e._v("If a session has finished an operation, it will be put back to the pool automatically.\nIf a session connection is broken, the session will be removed automatically and the pool will try\nto create a new session and redo the operation.")]),e._v(" "),s("p",[e._v("For query operations:")]),e._v(" "),s("ol",[s("li",[e._v("When using SessionPool to query data, the result set is "),s("code",[e._v("SessionDataSetWrapper")]),e._v(";")]),e._v(" "),s("li",[e._v("Given a "),s("code",[e._v("SessionDataSetWrapper")]),e._v(", if you have not scanned all the data in it and stop to use it,\nyou have to call "),s("code",[e._v("SessionPool.closeResultSet(wrapper)")]),e._v(" manually;")]),e._v(" "),s("li",[e._v("When you call "),s("code",[e._v("hasNext()")]),e._v(" and "),s("code",[e._v("next()")]),e._v(" of a "),s("code",[e._v("SessionDataSetWrapper")]),e._v(" and there is an exception, then\nyou have to call "),s("code",[e._v("SessionPool.closeResultSet(wrapper)")]),e._v(" manually;")])]),e._v(" "),s("p",[e._v("Examples: "),s("code",[e._v("session/src/test/java/org/apache/iotdb/session/pool/SessionPoolTest.java")])])])}),[],!1,null,null,null);s.default=n.exports}}]);