Python SDK

The official Python SDK for RushDB. Compatible with Python 3.8+.

Installation

pip install rushdb

Quick Start

from rushdb import RushDB

db = RushDB("RUSHDB_API_KEY")

# Store a record
db.records.create(
    label="User",
    data={"name": "Alice", "role": "engineer"},
)

# Query records
result = db.records.find({
    "labels": ["User"],
    "where": {"role": "engineer"},
    "limit": 10,
})

To connect to a self-hosted engine, use direct mode with the engine's URL and token:

db = RushDB("ENGINE_TOKEN", direct=True, engine_url="http://127.0.0.1:3000")

See SDKs for what direct mode offers.

API Reference

Class	Description
RushDB	Main client — entry point for all operations
Record	Typed record class with instance methods (attach, detach, update, delete)
Relationship Patterns	Review and apply AI-suggested relationships
SearchQuery	Query builder types and interfaces
SearchResult	Paginated result wrapper returned by find, records.vector_search, and ai.search
Transaction	ACID transaction handle