Skip to content

User Guide

Getting Started
Tutorial: Building a Blog Application
Connection Management
Connections, Pooling, and Observability
Document Models
Field Types
Querying
Relationships
Schema Management
Signals
Materialized Views
LIVE Queries (Subscriptions)
Performance Optimization

API Reference

Connection API Reference
Document API Reference
Field Types API Reference
Query Building and Execution
Exceptions
Schema API Reference
Signals API Reference
Materialized Views API Reference
Aggregation Pipeline
Utilities API Reference

Examples

basic usage
async operations
relationships
advanced queries
schema migrations

Development

Contributing
Changelog
License

Docs
basic usage

Edit on GitHub View source

basic usage¶

See example_scripts/basic_usage_example.py for a complete working example.

This section is under development.

← Utilities API Reference async operations →

Features
About Wagtail
Services
Blog
Packages
Developers

© Copyright 2025, SurrealEngine Contributors