Welcome to Runic¶
Graph schema migrations and ORM for Cypher-based graph databases.
runic ships two tools:
runic.orm — a lightweight, graph-optimized ORM that maps Python classes to graph nodes and edges. Supports FalkorDB, ArcadeDB, Neo4j, Memgraph, Apache AGE (PostgreSQL), and any Bolt-compatible database via a pluggable driver layer.
runic.migrate — an Alembic-style migration engine that tracks index and constraint changes as versioned, replayable scripts.
from runic.orm import Field, Node, Repository, Session, create_driver
class Person(Node, labels=["Person"]):
id: str = Field()
name: str = Field()
email: str = Field(index=True, unique=True)
with Session(driver) as session:
session.add(Person(id="alice", name="Alice", email="alice@example.com"))
session.commit()
repo = Repository(session, Person)
print(repo.count()) # 1
ORM
Define your first node, open a session, and persist it in under a minute.
Node, Edge, Field, object states, dirty tracking, identity map.
Lazy/eager loading, polymorphic hierarchies, edge properties.
add · delete · get · flush · commit · rollback · expire.
Fluent filter, traversal, aggregation, fulltext and vector KNN API.
FalkorDB, ArcadeDB, and generic Bolt — feature matrix and limitations.
Full autodoc reference for every public class and function.
Migration
Install runic, run runic init, write your first migration, and
apply it — all in one page.
Every command, option, and flag documented with examples.
Full list of op.* calls available inside migration scripts.
IndexManager and SchemaManager — declare, validate, and sync indexes.
runic.migrate — programmatic migration engine API.