Programming - Other Languages

Python API

1. Introduction

This is an example of how to connect to IoTDB with python, using the thrift rpc interfaces. Things will be a bit different on Linux or Windows, we will introduce how to operate on the two systems separately.

2. Prerequisites

python3.7 or later is preferred.

You have to install Thrift (0.11.0 or later) to compile our thrift file into python code. Below is the official tutorial of installation:

  1. http://thrift.apache.org/docs/install/

3. How to Get the Python Library

Option 1: pip install

You can find the Apache IoTDB Python Client API package on https://pypi.org/project/apache-iotdb/.

The download command is:

  1. pip install apache-iotdb
Option 2: use the compile script we provided

If you have added Thrift executable into your path, you may just run client-py/compile.sh or client-py\compile.bat, or you will have to modify it to set variable THRIFT_EXE to point to your executable. This will generate thrift sources under folder target, you can add it to your PYTHONPATH so that you would be able to use the library in your code. Notice that the scripts locate the thrift source file by relative path, so if you move the scripts else where, they are no longer valid.

Option 3: basic usage of thrift

Optionally, if you know the basic usage of thrift, you can only download the thrift source file in service-rpc\src\main\thrift\rpc.thrift, and simply use thrift -gen py -out ./target/iotdb rpc.thrift to generate the python library.

4. Use Example

We provided an example of how to use the thrift library to connect to IoTDB in client-py/src /client_example.py, please read it carefully before you write your own code.