Programming - Native API

Programming - Native API

Dependencies

JDK >= 1.8
Maven >= 3.1

How to install in local maven repository

In root directory:

mvn clean install -pl session -am -DskipTests

Using IoTDB Native API with Maven

<dependencies>
    <dependency>
      <groupId>org.apache.iotdb</groupId>
      <artifactId>iotdb-session</artifactId>
      <version>0.10.0</version>
    </dependency>
</dependencies>

Native APIs

Here we show the commonly used interfaces and their parameters in the Native API:

Initialize a Session

Session(String host, int port)
Session(String host, String port, String username, String password)
Session(String host, int port, String username, String password)

Open a Session
```
Session.open()
```
Close a Session
```
Session.close()
```

Set storage group

void setStorageGroup(String storageGroupId)

Delete one or several storage groups

void deleteStorageGroup(String storageGroup)
void deleteStorageGroups(List<String> storageGroups)

Create one or multiple timeseries

void createTimeseries(String path, TSDataType dataType,
        TSEncoding encoding, CompressionType compressor, Map<String, String> props,
        Map<String, String> tags, Map<String, String> attributes, String measurementAlias)
void createMultiTimeseries(List<String> paths, List<TSDataType> dataTypes,
        List<TSEncoding> encodings, List<CompressionType> compressors,
        List<Map<String, String>> propsList, List<Map<String, String>> tagsList,
        List<Map<String, String>> attributesList, List<String> measurementAliasList)

Delete one or several timeseries

void deleteTimeseries(String path)
void deleteTimeseries(List<String> paths)

Delete data before or equal to a timestamp of one or several timeseries

void deleteData(String path, long time)
void deleteData(List<String> paths, long time)

Insert a Record，which contains multiple measurement value of a device at a timestamp. Without type info the server has to do type inference, which may cost some time
```
void insertRecord(String deviceId, long time, List<String> measurements, List<String> values)
```
Insert a Tablet，which is multiple rows of a device, each row has the same measurements
```
void insertTablet(Tablet tablet)
```

Insert multiple Tablets

void insertTablets(Map<String, Tablet> tablet)

Insert multiple Records. Without type info the server has to do type inference, which may cost some time

void insertRecords(List<String> deviceIds, List<Long> times, 
                     List<List<String>> measurementsList, List<List<String>> valuesList)

Insert a Record，which contains multiple measurement value of a device at a timestamp. With type info the server has no need to do type inference, which leads a better performance
```
void insertRecord(String deviceId, long time, List<String> measurements,
     List<TSDataType> types, List<Object> values)
```

Insert multiple Records. With type info the server has no need to do type inference, which leads a better performance

void insertRecords(List<String> deviceIds, List<Long> times,
      List<List<String>> measurementsList, List<List<TSDataType>> typesList,
      List<List<Object>> valuesList)

Native APIs for profiling network cost

Test the network and client cost of insertRecords. This method NOT insert data into database and server just return after accept the request, this method should be used to test other time cost in client

void testInsertRecords(List<String> deviceIds, List<Long> times,
                List<List<String>> measurementsList, List<List<String>> valuesList)

void testInsertRecords(List<String> deviceIds, List<Long> times,
      List<List<String>> measurementsList, List<List<TSDataType>> typesList,
      List<List<Object>> valuesList)

Test the network and client cost of insertRecord. This method NOT insert data into database and server just return after accept the request, this method should be used to test other time cost in client

void testInsertRecord(String deviceId, long time, List<String> measurements, List<String> values)

void testInsertRecord(String deviceId, long time, List<String> measurements,
      List<TSDataType> types, List<Object> values)

Test the network and client cost of insertTablet. This method NOT insert data into database and server just return after accept the request, this method should be used to test other time cost in client
```
void testInsertTablet(Tablet tablet)
```

Sample code

To get more information of the following interfaces, please view session/src/main/java/org/apache/iotdb/session/Session.java

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.

Session Pool for Native API

We provided a connection pool (`SessionPool) for Native API. Using the interface, you need to define the pool size.

If you can not get a session connection in 60 secondes, there is a warning log but the program will hang.

If a session has finished an operation, it will be put back to the pool automatically. If a session connection is broken, the session will be removed automatically and the pool will try to create a new session and redo the operation.

For query operations:

When using SessionPool to query data, the result set is SessionDataSetWrapper;
Given a SessionDataSetWrapper, if you have not scanned all the data in it and stop to use it, you have to call SessionPool.closeResultSet(wrapper) manually;
When you call hasNext() and next() of a SessionDataSetWrapper and there is an exception, then you have to call SessionPool.closeResultSet(wrapper) manually;
You can call getColumnNames() of SessionDataSetWrapper to get the column names of query result;

Examples: session/src/test/java/org/apache/iotdb/session/pool/SessionPoolTest.java

Or example/session/src/main/java/org/apache/iotdb/SessionPoolExample.java