Skip to main content

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 instance pass the url parameter:

db = RushDB(
api_key="RUSHDB_API_KEY",
url="https://your-rushdb-instance.com",
)

API Reference

ClassDescription
RushDBMain client — entry point for all operations
RecordTyped record class with instance methods (attach, detach, update, delete)
Relationship PatternsReview and apply AI-suggested relationships
SearchQueryQuery builder types and interfaces
SearchResultPaginated result wrapper returned by find and ai.search
TransactionACID transaction handle