surreal-sync-core 0.6.0

Core types, SurrealSink, transform/sink-connect traits, and checkpoint API for surreal-sync
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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

//! Sync configuration for checkpoint operations.

/// Checkpoint storage backend
#[derive(Debug, Clone)]
pub enum CheckpointStorage {
    /// No checkpoint storage
    Disabled,
    /// Filesystem storage at specified directory
    Filesystem { dir: String },
    /// SurrealDB storage in specified table
    SurrealDB {
        table_name: String,
        namespace: String,
        database: String,
    },
}

/// Configuration for sync operations.
///
/// Controls checkpoint emission and storage behavior.
#[derive(Debug, Clone)]
pub struct SyncConfig {
    /// Whether to run in incremental mode.
    ///
    /// When `true`, the sync operation will:
    /// - Read from a starting checkpoint
    /// - Process only changes since that checkpoint
    pub incremental: bool,

    /// Whether to emit checkpoints during sync.
    ///
    /// When `true`, checkpoints are written according to `checkpoint_storage`.
    pub emit_checkpoints: bool,

    /// Checkpoint storage backend configuration
    pub checkpoint_storage: CheckpointStorage,
}

impl Default for SyncConfig {
    fn default() -> Self {
        Self {
            incremental: false,
            emit_checkpoints: true,
            checkpoint_storage: CheckpointStorage::Filesystem {
                dir: ".surreal-sync-checkpoints".to_string(),
            },
        }
    }
}

impl SyncConfig {
    /// Create a new sync config with default values.
    pub fn new() -> Self {
        Self::default()
    }

    /// Create a config for full sync with filesystem checkpoint emission.
    pub fn full_sync_with_checkpoints(checkpoint_dir: String) -> Self {
        Self {
            incremental: false,
            emit_checkpoints: true,
            checkpoint_storage: CheckpointStorage::Filesystem {
                dir: checkpoint_dir,
            },
        }
    }

    /// Create a config for full sync with SurrealDB checkpoint emission.
    pub fn full_sync_with_surrealdb_checkpoints(
        table_name: String,
        namespace: String,
        database: String,
    ) -> Self {
        Self {
            incremental: false,
            emit_checkpoints: true,
            checkpoint_storage: CheckpointStorage::SurrealDB {
                table_name,
                namespace,
                database,
            },
        }
    }

    /// Create a config for incremental sync.
    pub fn incremental() -> Self {
        Self {
            incremental: true,
            emit_checkpoints: false,
            checkpoint_storage: CheckpointStorage::Disabled,
        }
    }

    /// Check if checkpoint emission is enabled and configured.
    pub fn should_emit_checkpoints(&self) -> bool {
        self.emit_checkpoints && !matches!(self.checkpoint_storage, CheckpointStorage::Disabled)
    }
}