Learn
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
| 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 and ai.search |
| Transaction | ACID transaction handle |