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

//! SurrealDB connection and write settings (plain fields, no CLI parsing).

use crate::ZeroTemporalPolicy;

/// Plain-field SurrealDB connection and write options (no clap).
///
/// Use this from embedders and [`SinkConnect`](super::SinkConnect) helpers.
/// The stock CLI continues to parse argv into clap-derived structs and maps
/// them into this type (or sink-crate connect helpers) at the boundary.
#[derive(Debug, Clone)]
pub struct SurrealConfig {
    /// SurrealDB endpoint URL (`http://…` or `ws://…`).
    pub endpoint: String,
    /// Username for SurrealDB sign-in.
    pub username: String,
    /// Password for SurrealDB sign-in.
    pub password: String,
    /// Target namespace.
    pub namespace: String,
    /// Target database.
    pub database: String,
    /// How zero temporal values are written.
    pub zero_temporal: ZeroTemporalPolicy,
    /// Batch size hint for full-sync writers (sources that honor it).
    pub batch_size: usize,
    /// When true, sources should not write to the sink.
    pub dry_run: bool,
}

impl Default for SurrealConfig {
    fn default() -> Self {
        Self {
            endpoint: "http://localhost:8000".to_string(),
            username: "root".to_string(),
            password: "root".to_string(),
            namespace: "test".to_string(),
            database: "test".to_string(),
            zero_temporal: ZeroTemporalPolicy::default(),
            batch_size: 1000,
            dry_run: false,
        }
    }
}

impl SurrealConfig {
    /// Create a config with endpoint / credentials / ns / db.
    pub fn new(
        endpoint: impl Into<String>,
        username: impl Into<String>,
        password: impl Into<String>,
        namespace: impl Into<String>,
        database: impl Into<String>,
    ) -> Self {
        Self {
            endpoint: endpoint.into(),
            username: username.into(),
            password: password.into(),
            namespace: namespace.into(),
            database: database.into(),
            ..Self::default()
        }
    }
}