Skip to main content

Getting started with GQLAlchemy

GQLAlchemy

GQLAlchemy is an open-source Python library and an Object Graph Mapper (OGM) - a link between graph database objects and Python objects. GQLAlchemy supports Memgraph and Neo4j.

An Object Graph Mapper or OGM provides a developer-friendly workflow for writing object-oriented notation to communicate to a graph database. Instead of writing Cypher queries, you can write object-oriented code, which the OGM will automatically translate into Cypher queries.

Quick start​

1. Install GQLAlchemy​

Either install GQLAlchemy through pip or build it from source. If you are using Conda for Python environment management, you can install GQLAlchemy through pip.

caution

GQLAlchemy can't be installed with Python 3.11 (#203) and on Windows with Python > 3.9 (#179). If this is currently a blocker for you, please let us know by commenting on opened issues.

2. Learn how to use GQLAlchemy​

With the help of the How-to guides you can learn how to use GQLAlchemy's features, such as object graph mapper and query builder.

3. Check the reference guide​

Don't forget to check the Reference guide if you want to find out which methods GQLAlchemy has and how to use it. If the reference guide is not clear enough, head over to the GQLAlchemy repository and inspect the source code. While you're there, feel free to give us a star or contribute to this open-source Python library.