Embedding in Python
SurrealDB can be run as an embedded database within your Python application, allowing you to use SurrealDB without running a separate server process. This is ideal for desktop applications, testing, local development, and edge computing scenarios.
Embedded Database Options
SurrealDB supports two types of embedded storage in Python:
In-Memory Database (mem:// or memory) - Fastest performance with data stored in RAM. Perfect for testing, caching, or temporary data. Data is lost when the connection closes.
File-Based Database (file://, rocksdb://, or surrealkv://) - Persistent storage on disk using the SurrealKV storage engine. Data persists across connections and application restarts.
Quick Example
from surrealdb import AsyncSurreal
async with AsyncSurreal("mem://") as db:
await db.use("test", "test")
person = await db.create("person", {"name": "John Doe"})
print(person)
async with AsyncSurreal("rocksdb://mydb") as db:
await db.use("test", "test")
company = await db.create("company", {"name": "TechStart"})
print(company)
For complete documentation, installation instructions, examples, best practices, and troubleshooting, see the embedding in Python guide.
