Skip to content

NebulaGraph Python

NebulaGraph Python is a Python client for connecting to and managing the NebulaGraph database.

Prerequisites

You have installed Python 3.6 or later versions.

Compatibility with NebulaGraph

NebulaGraph version NebulaGraph Python version
3.3.0 3.3.0
3.1.0 ~ 3.2.x 3.1.0
3.0.0 ~ 3.0.2 3.0.0
2.6.x 2.6.0
2.0.x 2.0.0
2.0.0-rc1 2.0.0rc1

Install NebulaGraph Python

Install NebulaGraph Python with pip

$ pip install nebula3-python==<version>

Install NebulaGraph Python from the source code

  1. Clone the NebulaGraph Python source code to the host.

    • (Recommended) To install a specific version of NebulaGraph Python, use the Git option --branch to specify the branch. For example, to install v3.3.0, run the following command:

      $ git clone --branch release-3.3 https://github.com/vesoft-inc/nebula-python.git
      
    • To install the daily development version, run the following command to download the source code from the master branch:

      $ git clone https://github.com/vesoft-inc/nebula-python.git
      
  2. Change the working directory to nebula-python.

    $ cd nebula-python
    
  3. Run the following command to install NebulaGraph Python.

    $ pip install .
    

Core of the example code

NebulaGraph Python clients provides Connection Pool and Session Pool methods to connect to NebulaGraph. Using the Connection Pool method requires users to manage sessions by themselves.

  • Connection Pool

    For details about all the code, see Example.


Last update: December 6, 2022