AgensGraph Python Driver

October 22, 2025 ยท View on GitHub

AgensGraph Python Driver allows Python programs to connect to an AgensGraph database. Since it is Psycopg2 type extension module for AgensGraph, it supports additional data types such as Vertex, Edge, and Path to represent graph data.

Features

  • Cypher query support for Psycopg2 PostgreSQL Python driver (enables cypher queries directly)
  • Deserialize AgensGraph results (AGType) to Vertex, Edge, Path

Install for PYPI

pip install agensgraph-python

Build From Source

git clone https://github.com/skaiworldwide-oss/agensgraph-python
cd agensgraph-python
python setup.py install

Example

import psycopg2
import agensgraph

conn = psycopg2.connect("dbname=test host=127.0.0.1 user=agens")
cur = conn.cursor()
cur.execute("DROP GRAPH IF EXISTS t CASCADE")
cur.execute("CREATE GRAPH t")
cur.execute("SET graph_path = t")

cur.execute("CREATE (:v {name: 'AgensGraph'})")
conn.commit()

cur.execute("MATCH (n) RETURN n")
v = cur.fetchone()[0]
print(v.props['name'])

Test

You may run the following command to test AgensGraph Python Driver.

python setup.py test

Before running the command, set the following environment variables to specify which database you will use for the test.

Variable NameMeaning
AGENSGRAPH_TESTDBdatabase name to connect to
AGENSGRAPH_TESTDB_HOSTdatabase server host
AGENSGRAPH_TESTDB_PORTdatabase server port
AGENSGRAPH_TESTDB_USERdatabase user name
AGENSGRAPH_TESTDB_PASSWORDuser password