Skip to main content

IronGraph for Python

Python access to a GPU-first temporal graph database with built-in streaming and queues.

Use Cypher to query graph structure, search text and vectors, inspect property history, and administer the database. Built-in Kafka-compatible Streams and AMQP-compatible Queues handle event and message workloads. The irongraph package provides native embedded access and remote Query API/Bolt clients for Python. IronGraph is open-source software released under the Apache License 2.0.

Performance at a glance

  • 0.834 µs graph count at 2 million nodes on Metal — sub-microsecond at scale.
  • 12× faster indexed range count on Metal than CPU: 1.61 ms versus 19.38 ms.
  • 7.5× faster k-core analysis on Metal than CPU: 326 ms versus 2,430 ms.

Median results from five runs on an Apple M5 Pro with 2 million nodes and 8 million relationships. See more performance results.

Database capabilities

Capability What you can do
Graph queries and analytics Match relationships and paths with Cypher; run shortest paths, PageRank, connected components, and community detection.
Temporal properties and analysis Retain property history, read values with AT TIME, inspect samples with HISTORY, and aggregate with time windows and maintained rollups.
Text documents and search Store the full text of articles, notes, manuals, and other written content on graph nodes; search that text with text and vector indexes and automatic local embeddings.
Built-in Kafka-compatible Streams Produce and consume events through supported Kafka clients; manage topics, partitions, retention, and consumer-lag monitoring.
Built-in AMQP-compatible Queues Use classic and stream queues, direct/fanout/topic exchanges, bindings, and retention with supported AMQP clients.

Cypher handles graph operations, temporal analysis, search, and stream/queue administration. Message producers and consumers use the supported Kafka or AMQP protocols through the instance's configured listeners. The SDK query interface does not replace those protocol clients.

Explicit projects and the OBSERVED, KNOWLEDGE, and WORKSPACE layers organize data. Indexes and unique constraints, transactions, asynchronous write-ahead logging, recovery, and periodic snapshots are part of the database.

The standalone instance serves its web console at http://127.0.0.1:18484/web/ by default and also supports local MCP access. Start the official standalone distribution before opening that address. Opening an embedded database through Python, Node.js, or Rust does not start a web server or expose the console. For a configured remote instance, use its HTTPS address followed by /web/, with the required browser-managed client certificate.

Temporal reads apply to declared properties within their retention window. Graph topology and ordinary properties are read in their current state.

Install

You need Python 3.9 or later and an official wheel. Native release targets are macOS 15+ ARM64 and Linux with glibc 2.28+ on ARM64 or AMD64. These are package build baselines; check your release's qualification results before deploying. After configuring the official package source supplied with your release:

python -m pip install --only-binary=:all: irongraph

The matching wheel must be published to that source. Installation uses a compiled database binary and does not require a Rust compiler.

Store and read a text document

Use a writable directory exclusively owned by your application process. Default startup downloads and verifies the local embedding model if absent, then loads and warms it. Allow network access and sufficient disk space on first use.

from irongraph import EmbeddedDatabase

with EmbeddedDatabase("./irongraph-data", device="cpu") as database:
    database.query("CREATE PROJECT IF NOT EXISTS notes")
    result = database.query(
        """USE notes
        MERGE (document:Document {id: $id})
        SET document.body = $body
        RETURN document.body AS body""",
        parameters={"id": "welcome", "body": "Graphs connect facts."},
    )
    print(result["rows"][0][0]["value"])

Expected output: Graphs connect facts. The context manager closes the database and the text document persists. Run the example again to update the same text document.

The example selects CPU across native release targets and keeps automatic text embedding enabled. Select device="metal" on a supported Mac to use Metal acceleration.

Next, declare an embedding index on the text document body and use MATCH … SEARCH … RETURN to combine vector retrieval with graph filters. The same query method supports text document updates, indexes, temporal data, graph algorithms, and topic, queue, exchange, and binding administration. Text documents are ordinary graph nodes; their complete text remains on the owning node.

Operate the database

Choose projects explicitly with USE or project_id; there is no implicit default. Each project has OBSERVED, KNOWLEDGE, and WORKSPACE layers for source facts, curated facts, and working data. Transactions, asynchronous write-ahead logging, recovery, and snapshots apply to embedded data as they do in a standalone instance.

One process uses one execution device and one active embedded instance. CPU is the reference backend, Metal is the primary local accelerator, and CUDA requires a CUDA-enabled release. GPU admission rejects project graphs and derived indexes that do not fit in device memory. Keep the database open for the application's lifetime. IronGraph embeds text locally and does not run generative language models.

For remote access, use Client.api_mtls or Client.bolt_mtls with a client certificate, private-key path, and trusted certificate authority. Plain connections are loopback-only; remote access requires mutual TLS and a credential authorized for the project and operations.

License

IronGraph is licensed under the Apache License 2.0. Third-party components and the embedding model retain their own terms.

Metadata

Release files for irongraph 0.1.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distributions (wheels)

Table of built distributions (wheels) for irongraph 0.1.6
File Interpreter ABI Platform
irongraph-0.1.6-cp39-abi3-manylinux_2_28_x86_64.whl CPython 3.9 abi3 Linux glibc 2.28+ x86-64 Details
irongraph-0.1.6-cp39-abi3-manylinux_2_28_aarch64.whl CPython 3.9 abi3 Linux glibc 2.28+ ARM64 Details
irongraph-0.1.6-cp39-abi3-macosx_15_0_arm64.whl CPython 3.9 abi3 macOS 15.0+ ARM64 Details

Total release size: 114.1 MB

Release files / irongraph-0.1.6-cp39-abi3-manylinux_2_28_x86_64.whl

Download URL irongraph-0.1.6-cp39-abi3-manylinux_2_28_x86_64.whl
Size 37.7 MB
Tags CPython 3.9 Linux glibc 2.28+ x86-64 abi3
SHA-256 checksum
How to use checksums
d03b7463a1755271873db641d8ffe22d0ceac8762563b20bbb32e0431c495dae
BLAKE2b-256 checksum
How to use checksums
2c319a9318c94121d07dc2bc7a7647d623a279647a14fe9fba3ccafa62fed139
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.6

Release files / irongraph-0.1.6-cp39-abi3-manylinux_2_28_aarch64.whl

Download URL irongraph-0.1.6-cp39-abi3-manylinux_2_28_aarch64.whl
Size 36.6 MB
Tags CPython 3.9 Linux glibc 2.28+ ARM64 abi3
SHA-256 checksum
How to use checksums
fe068d2c96506acb4e856f156d99bea53dfe91376a6040c31b11c1305f672d74
BLAKE2b-256 checksum
How to use checksums
b2a6a69040122ed66db79a777fe0fbc5e5c3df358ef8203b0a195fba42e5bc77
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.6

Release files / irongraph-0.1.6-cp39-abi3-macosx_15_0_arm64.whl

Download URL irongraph-0.1.6-cp39-abi3-macosx_15_0_arm64.whl
Size 39.9 MB
Tags CPython 3.9 abi3 macOS 15.0+ ARM64
SHA-256 checksum
How to use checksums
edd58d91604451491dc3a40d2c27de465252c1027f4e30663626dac47d3fdb9c
BLAKE2b-256 checksum
How to use checksums
aa0ad23c163e1a47551cc9fc2962eb39291baf8e1dc5206903e899a6a6e4b91f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.6

Release history Release notifications | RSS feed

0.1.8

3 release files

0.1.7

3 release files

This release

0.1.6 This release

3 release files

0.1.5

3 release files

0.1.4

3 release files

0.1.3

3 release files

0.1.2

3 release files

0.1.1

3 release files

0.1.0

3 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page