entidb_sync_engine 2.0.0-alpha.3

Sync state machine and engine for EntiDB
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

# entidb_sync_engine


Sync state machine and engine for EntiDB.

## Overview


This crate implements the synchronization state machine for EntiDB's offline-first
architecture. It manages the pull-then-push protocol and handles conflict detection.

## Features


- **State machine**: Robust sync lifecycle (idle → connecting → pulling → pushing → synced)
- **Pull-then-push**: Always pull remote changes before pushing local changes
- **Cursor tracking**: Maintains server and local cursors for incremental sync
- **Conflict detection**: Identifies concurrent modifications for resolution

## Sync Flow


```
┌─────────┐     ┌───────────┐     ┌─────────┐     ┌────────┐
│  Idle   │────▶│ Connecting│────▶│ Pulling │────▶│ Pushing│
└─────────┘     └───────────┘     └─────────┘     └────────┘
     ▲                                                  │
     └──────────────────────────────────────────────────┘
                           (synced)
```

## Usage


```rust
use entidb_sync_engine::SyncEngine;

let engine = SyncEngine::new(database, config);
engine.sync().await?;
```

## License


Licensed under either of Apache License, Version 2.0 or MIT license at your option.