nodedb 0.3.0

Local-first, real-time, edge-to-cloud hybrid database for multi-modal workloads
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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164

// SPDX-License-Identifier: BUSL-1.1

use std::path::PathBuf;

use serde::{Deserialize, Serialize};

/// Snapshot storage configuration for warm-tier snapshot archives.
///
/// Example TOML:
/// ```toml
/// [snapshot_storage]
/// bucket = "my-nodedb-snapshots"
/// region = "us-east-1"
/// ```
///
/// When `endpoint` is empty, snapshots are stored on the local filesystem
/// under `local_dir` (default: `{data_dir}/snapshots`).
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SnapshotStorageSettings {
    /// S3-compatible endpoint URL. Empty = local filesystem (default).
    #[serde(default)]
    pub endpoint: String,
    /// Bucket name.
    #[serde(default = "default_snapshot_bucket")]
    pub bucket: String,
    /// Prefix path within the bucket.
    #[serde(default = "default_snapshot_prefix")]
    pub prefix: String,
    /// Access key (empty = IAM role / instance credentials).
    #[serde(default)]
    pub access_key: String,
    /// Secret key.
    #[serde(default)]
    pub secret_key: String,
    /// Region (required for AWS S3; ignored by most S3-compatible stores).
    #[serde(default = "default_snapshot_region")]
    pub region: String,
    /// Local directory for snapshot storage (used when endpoint is empty).
    #[serde(default)]
    pub local_dir: Option<PathBuf>,
}

fn default_snapshot_bucket() -> String {
    "nodedb-snapshots".into()
}

fn default_snapshot_prefix() -> String {
    "snapshots/".into()
}

fn default_snapshot_region() -> String {
    "us-east-1".into()
}

impl SnapshotStorageSettings {
    /// Convert to the `SnapshotStorageConfig` used by the storage layer.
    pub fn to_snapshot_storage_config(
        &self,
    ) -> crate::storage::snapshot_writer::SnapshotStorageConfig {
        crate::storage::snapshot_writer::SnapshotStorageConfig {
            endpoint: self.endpoint.clone(),
            bucket: self.bucket.clone(),
            prefix: self.prefix.clone(),
            access_key: self.access_key.clone(),
            secret_key: self.secret_key.clone(),
            region: self.region.clone(),
            local_dir: self.local_dir.clone(),
        }
    }

    /// Default storage-layer config (local filesystem) used when the
    /// `[snapshot_storage]` section is omitted from the server config.
    pub fn default_storage_config() -> crate::storage::snapshot_writer::SnapshotStorageConfig {
        crate::storage::snapshot_writer::SnapshotStorageConfig {
            endpoint: String::new(),
            bucket: default_snapshot_bucket(),
            prefix: default_snapshot_prefix(),
            access_key: String::new(),
            secret_key: String::new(),
            region: default_snapshot_region(),
            local_dir: None,
        }
    }
}

/// Quarantine storage configuration for corrupt-segment archives.
///
/// Example TOML:
/// ```toml
/// [quarantine_storage]
/// bucket = "my-nodedb-quarantine"
/// region = "us-east-1"
/// ```
///
/// When `endpoint` is empty, quarantined files are archived on the local
/// filesystem under `local_dir` (default: `{data_dir}/quarantine`).
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct QuarantineStorageSettings {
    /// S3-compatible endpoint URL. Empty = local filesystem (default).
    #[serde(default)]
    pub endpoint: String,
    /// Bucket name.
    #[serde(default = "default_quarantine_bucket")]
    pub bucket: String,
    /// Prefix path within the bucket.
    #[serde(default = "default_quarantine_prefix")]
    pub prefix: String,
    /// Access key (empty = IAM role / instance credentials).
    #[serde(default)]
    pub access_key: String,
    /// Secret key.
    #[serde(default)]
    pub secret_key: String,
    /// Region (required for AWS S3; ignored by most S3-compatible stores).
    #[serde(default = "default_quarantine_region")]
    pub region: String,
    /// Local directory for quarantine storage (used when endpoint is empty).
    #[serde(default)]
    pub local_dir: Option<PathBuf>,
}

fn default_quarantine_bucket() -> String {
    "nodedb-quarantine".into()
}

fn default_quarantine_prefix() -> String {
    "quarantine/".into()
}

fn default_quarantine_region() -> String {
    "us-east-1".into()
}

impl QuarantineStorageSettings {
    /// Convert to the `QuarantineStorageConfig` used by the storage layer.
    pub fn to_quarantine_storage_config(
        &self,
    ) -> crate::storage::quarantine::registry::QuarantineStorageConfig {
        crate::storage::quarantine::registry::QuarantineStorageConfig {
            endpoint: self.endpoint.clone(),
            bucket: self.bucket.clone(),
            prefix: self.prefix.clone(),
            access_key: self.access_key.clone(),
            secret_key: self.secret_key.clone(),
            region: self.region.clone(),
            local_dir: self.local_dir.clone(),
        }
    }

    /// Default storage-layer config (local filesystem) used when the
    /// `[quarantine_storage]` section is omitted from the server config.
    pub fn default_storage_config() -> crate::storage::quarantine::registry::QuarantineStorageConfig
    {
        crate::storage::quarantine::registry::QuarantineStorageConfig {
            endpoint: String::new(),
            bucket: default_quarantine_bucket(),
            prefix: default_quarantine_prefix(),
            access_key: String::new(),
            secret_key: String::new(),
            region: default_quarantine_region(),
            local_dir: None,
        }
    }
}