Expand description
Real-Time Database Adapter
Trait and types for pluggable real-time database backends that store JSON documents
using hierarchical path-based access (e.g., posts/abc123/comments/xyz789).
Read operations (query, get, subscribe) work directly on the adapter. Write operations (create, update, delete) require a transaction for atomicity.
Each adapter implementation provides its own constructor handling backend-specific initialization (database path, connection settings, etc.).
Structs§
- Aggregate
Options - Aggregation options: group by a field and compute statistics.
- DbStats
- Database statistics.
- Lock
Info - Information about an active lock on a document path.
- Query
Filter - Query filter for selecting documents.
- Query
Options - Options for querying documents (filter, sort, limit, offset).
- Sort
Field - Sort order for a field.
- Subscription
Options - Options for subscribing to real-time changes.
Enums§
- Aggregate
Op - An aggregation operation to compute per group.
- Change
Event - Real-time change event emitted when a document is created, updated, or deleted.
- Lock
Mode - Lock mode for document locking.
Traits§
- Rtdb
Adapter - Real-Time Database Adapter trait.
- Transaction
- Transaction for atomic write operations.
Functions§
- value_
to_ group_ string - Convert a JSON value to a string key for aggregate group indexing.