Skip to main content

Module rtdb_adapter

Module rtdb_adapter 

Source
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§

AggregateOptions
Aggregation options: group by a field and compute statistics.
DbStats
Database statistics.
LockInfo
Information about an active lock on a document path.
QueryFilter
Query filter for selecting documents.
QueryOptions
Options for querying documents (filter, sort, limit, offset).
SortField
Sort order for a field.
SubscriptionOptions
Options for subscribing to real-time changes.

Enums§

AggregateOp
An aggregation operation to compute per group.
ChangeEvent
Real-time change event emitted when a document is created, updated, or deleted.
LockMode
Lock mode for document locking.

Traits§

RtdbAdapter
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.