Skip to content

NebulaGraph Jupyter

for NebulaGraph Docker Image Docker Extension GitHub release (latest by date) pypi-version

Google Colab

Experience it directly on Google Colab: Open In Colab


jupyter_nebulagraph, formerly ipython-ngql, is a Python package that simplifies the process of connecting to NebulaGraph from Jupyter Notebooks or iPython environments. It enhances the user experience by streamlining the creation, debugging, and sharing of Jupyter Notebooks. With jupyter_nebulagraph, users can effortlessly connect to NebulaGraph, load data, execute queries, visualize results, and fine-tune query outputs, thereby boosting collaborative efforts and productivity.

Get Started

For a more comprehensive guide on how to get started with jupyter_nebulagraph, please refer to the Get Started Guide. This guide provides step-by-step instructions on installation, connecting to NebulaGraph, making queries, and visualizing query results, making it easier for new users to get up and running.


Feature Cheat Sheet Example Command Documentation
Connect %ngql --address --port 9669 --user user --password password Connect %ngql
Load Data from CSV %ng_load --source actor.csv --tag player --vid 0 --props 1:name,2:age --space basketballplayer Load Data %ng_load
Query Execution %ngql MATCH p=(v:player{name:"Tim Duncan"})-->(v2:player) RETURN p; Query Execution %ngql or %%ngql(multi-line)
Result Visualization %ng_draw Draw Graph %ng_draw
Draw Schema %ng_draw_schema Draw Schema %ng_draw_schema
Tweak Query Result df = _ to get last query result as pd.dataframe or ResultSet Tweak Result Configure ngql_result_style

Acknowledgments ♥️