Stores
Typed data access patterns within databases providing structured interaction with Entry RawData.
Core Concepts
SubTree Trait: Interface for typed store implementations accessed through Operation handles.
Reserved Names: Store names with underscore prefix (e.g., _settings) reserved for internal use.
Typed APIs: Handle serialization/deserialization and provide structured access to raw entry data.
Current Implementations
Table
Record-oriented store for managing collections with unique identifiers.
Features:
- Stores user-defined types (T: Serialize + Deserialize)
- Automatic UUID generation for records
- CRUD operations: insert, get, set, search
- Type-safe access via Operation::get_subtree
Use Cases: User lists, task management, any collection requiring persistent IDs.
DocStore
Document-oriented store wrapping crdt::Doc for nested structures and path-based access.
Features:
- Path-based operations for nested data (set_path, get_path, etc.)
- Simple key-value operations (get, set, delete)
- Support for nested map structures via Value enum
- Tombstone support for distributed deletion propagation
- Last-write-wins merge strategy
Use Cases: Configuration data, metadata, structured documents, sync state.
YDoc (Y-CRDT Integration)
Real-time collaborative editing with sophisticated conflict resolution.
Features (requires "y-crdt" feature):
- Y-CRDT algorithms for collaboration
- Differential saving for storage efficiency
- Full Y-CRDT API access
- Caching for performance optimization
Architecture:
- YrsBinary wrapper implements CRDT traits
- Differential updates vs full snapshots
- Binary update merging preserves Y-CRDT algorithms
Operations:
- Document access with safe closures
- External update application
- Incremental change tracking
Use Cases: Collaborative documents, real-time editing, complex conflict resolution.
Custom SubTree Implementation
Requirements:
- Struct implementing SubTree trait
- Handle creation linked to Transaction
- Custom API methods using Transaction interaction:
- get_local_data for staged state
- get_full_state for merged historical state
- update_subtree for staging changes
Integration
Operation Context: All stores accessed through atomic operations
CRDT Support: Stores can implement CRDT trait for conflict resolution
Serialization: Data stored as RawData strings in Entry structure