GQLAlchemy

<p> <a href="https://github.com/memgraph/gqlalchemy/actions"><img src="https://github.com/memgraph/gqlalchemy/workflows/Build%20and%20Test/badge.svg" /></a> <a href="https://github.com/memgraph/gqlalchemy/blob/main/LICENSE"><img src="https://img.shields.io/github/license/memgraph/gqlalchemy" /></a> <a href="https://pypi.org/project/gqlalchemy"><img src="https://img.shields.io/pypi/v/gqlalchemy" /></a> <a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a> <a href="https://memgraph.com/docs/gqlalchemy" alt="Documentation"><img src="https://img.shields.io/badge/documentation-GQLAlchemy-orange" /></a> <a href="https://github.com/memgraph/gqlalchemy/stargazers" alt="Stargazers"><img src="https://img.shields.io/github/stars/memgraph/gqlalchemy?style=social" /></a> </p>

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

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

Installation

Prerequisites

• Python 3.10+

• pymgclient:

  • Install pymgclient build prerequisites
  • Install pymgclient via pip:

  bashCopy
  pip install --user pymgclient

[!NOTE]
GQLAlchemy is tested on Python 3.10 through 3.14 in CI. Some optional extras
(for example TensorFlow/TF-GNN stacks) are available only for a subset of Python
versions due to upstream wheel availability.

Install GQLAlchemy

After you’ve installed the prerequisites, run the following command to install
GQLAlchemy:

bashCopy
pip install gqlalchemy

With the above command, you get the default GQLAlchemy installation which
doesn’t include import/export support for certain formats (see below). To get
additional import/export capabilities, use one of the following install options:

bashCopy
pip install gqlalchemy[arrow] # Support for the CSV, Parquet, ORC and IPC/Feather/Arrow formats
pip install gqlalchemy[dgl] # DGL support (also includes torch)
pip install gqlalchemy[docker] # Docker support

pip install gqlalchemy[all] # All of the above

If you intend to use GQLAlchemy with PyTorch Geometric support, that library must be installed manually:

bashCopy
pip install gqlalchemy[torch_pyg] # prerequisite
pip install torch-scatter torch-sparse torch-cluster torch-spline-conv torch-geometric -f https://data.pyg.org/whl/torch-1.13.0+cpu.html"

If you are using the zsh terminal, surround gqlalchemy[$extras] with quotes:

bashCopy
pip install 'gqlalchemy[arrow]'

If you are using Conda for Python environment management, you can install GQLAlchemy through pip.

Build & Test

The project uses uv to manage dependencies and build the library. Clone or download the GQLAlchemy source code locally and run the following command to build it from source with uv:

bashCopy
uv sync --all-extras

The uv sync --all-extras command installs GQLAlchemy with all extras
(optional dependencies). Alternatively, you can use the --extra option to define
what extras to install:

bashCopy
uv sync # No extras

uv sync --extra arrow # Support for the CSV, Parquet, ORC and IPC/Feather/Arrow formats
uv sync --extra dgl # Installs torch (DGL must be installed separately, see below)
uv sync --extra docker # Docker support
uv sync --extra tfgnn # TFGNN support

The dgl and torch_pyg extras install PyTorch only. DGL and PyTorch Geometric wheels
must be installed separately due to their custom package indexes:

bashCopy
# DGL
uv sync --extra dgl
uv pip install dgl -f https://data.dgl.ai/wheels/torch-2.4/repo.html

# PyTorch Geometric
uv sync --extra torch_pyg
uv pip install torch-scatter torch-sparse torch-cluster torch-spline-conv torch-geometric -f https://data.pyg.org/whl/torch-2.4.0+cpu.html

To run the tests, make sure you have an active Memgraph instance, and execute one of the following commands:

bashCopy
uv run pytest . -k "not slow" # If all extras installed

uv run pytest . -k "not slow and not extras" # Otherwise

If you’ve installed only certain extras, it’s also possible to run their associated tests:

bashCopy
uv run pytest . -k "arrow"
uv run pytest . -k "dgl"
uv run pytest . -k "docker"
uv run pytest . -k "tfgnn"

Development (how to build)

bashCopy
uv run flake8 .
uv run black .
uv run pytest . -k "not slow and not extras"

Documentation

The GQLAlchemy documentation is available on GitHub.

The reference guide can be generated from the code by executing:

pip3 install pydoc-markdown
pydoc-markdown

Other parts of the documentation are written and located at docs directory. To test the documentation locally execute:

pip3 install mkdocs
pip3 install mkdocs-material
pip3 install pymdown-extensions
mkdocs serve

License

Copyright (c) 2016-2023 Memgraph Ltd.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use
this file except in compliance with the License. You may obtain a copy of the
License at

 http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
CONDITIONS OF ANY KIND, either express or implied. See the License for the
specific language governing permissions and limitations under the License.