sqlite_graphrag/commands/
restore.rs

1//! Handler for the `restore` CLI subcommand.
2
3use crate::errors::AppError;
4use crate::i18n::errors_msg;
5use crate::output;
6use crate::output::JsonOutputFormat;
7use crate::paths::AppPaths;
8use crate::storage::connection::open_rw;
9use crate::storage::memories;
10use crate::storage::versions;
11use rusqlite::params;
12use rusqlite::OptionalExtension;
13use serde::Serialize;
14
15#[derive(clap::Args)]
16#[command(after_long_help = "EXAMPLES:\n  \
17    # Restore the latest non-`restore` version of a memory\n  \
18    sqlite-graphrag restore --name onboarding\n\n  \
19    # Restore a specific version\n  \
20    sqlite-graphrag restore --name onboarding --version 3\n\n  \
21    # Restore within a specific namespace\n  \
22    sqlite-graphrag restore --name onboarding --namespace my-project")]
23pub struct RestoreArgs {
24    /// Memory name as a positional argument. Alternative to `--name`.
25    #[arg(
26        value_name = "NAME",
27        conflicts_with = "name",
28        help = "Memory name to restore; alternative to --name"
29    )]
30    pub name_positional: Option<String>,
31    /// Memory name to restore (must exist, including soft-deleted/forgotten).
32    #[arg(long)]
33    pub name: Option<String>,
34    /// Version to restore. When omitted, defaults to the latest non-`restore` version
35    /// from `memory_versions`. This makes the forget+restore workflow work without
36    /// requiring the user to discover the version first.
37    #[arg(long)]
38    pub version: Option<i64>,
39    #[arg(
40        long,
41        help = "Namespace (env: SQLITE_GRAPHRAG_NAMESPACE, default: global)"
42    )]
43    pub namespace: Option<String>,
44    /// Optimistic locking: reject if the current updated_at does not match (exit 3).
45    #[arg(
46        long,
47        value_name = "EPOCH_OR_RFC3339",
48        value_parser = crate::parsers::parse_expected_updated_at,
49        long_help = "Optimistic lock: reject if updated_at does not match. \
50Accepts Unix epoch (e.g. 1700000000) or RFC 3339 (e.g. 2026-04-19T12:00:00Z)."
51    )]
52    pub expected_updated_at: Option<i64>,
53    /// Output format.
54    #[arg(long, value_enum, default_value_t = JsonOutputFormat::Json)]
55    pub format: JsonOutputFormat,
56    #[arg(long, hide = true, help = "No-op; JSON is always emitted on stdout")]
57    pub json: bool,
58    #[arg(long, env = "SQLITE_GRAPHRAG_DB_PATH")]
59    pub db: Option<String>,
60}
61
62#[derive(Serialize)]
63struct RestoreResponse {
64    /// Always `"restored"` — signals the completed action to shell callers and LLM agents.
65    action: String,
66    memory_id: i64,
67    name: String,
68    version: i64,
69    restored_from: i64,
70    /// Total execution time in milliseconds from handler start to serialisation.
71    elapsed_ms: u64,
72}
73
74pub fn run(args: RestoreArgs) -> Result<(), AppError> {
75    let start = std::time::Instant::now();
76    let _ = args.format;
77    let name = args
78        .name_positional
79        .as_deref()
80        .or(args.name.as_deref())
81        .ok_or_else(|| {
82            AppError::Validation(
83                "name required: pass as positional argument or via --name".to_string(),
84            )
85        })?
86        .to_string();
87    let namespace = crate::namespace::resolve_namespace(args.namespace.as_deref())?;
88    let paths = AppPaths::resolve(args.db.as_deref())?;
89    let mut conn = open_rw(&paths.db)?;
90
91    // PRD line 1118: query WITHOUT a deleted_at filter — restore must work on soft-deleted memories
92    let result: Option<(i64, i64)> = conn
93        .query_row(
94            "SELECT id, updated_at FROM memories WHERE namespace = ?1 AND name = ?2",
95            params![namespace, name],
96            |r| Ok((r.get(0)?, r.get(1)?)),
97        )
98        .optional()?;
99    let (memory_id, current_updated_at) = result
100        .ok_or_else(|| AppError::NotFound(errors_msg::memory_not_found(&name, &namespace)))?;
101
102    if let Some(expected) = args.expected_updated_at {
103        if expected != current_updated_at {
104            return Err(AppError::Conflict(errors_msg::optimistic_lock_conflict(
105                expected,
106                current_updated_at,
107            )));
108        }
109    }
110
111    // v1.0.22 P0: resolve optional `--version`. When absent, uses the highest version
112    // whose `change_reason` is not 'restore' (recovers the real state, not meta-restore).
113    // Lets the forget+restore workflow function without manually reading memory_versions.
114    let target_version: i64 = match args.version {
115        Some(v) => v,
116        None => {
117            let last: Option<i64> = conn
118                .query_row(
119                    "SELECT MAX(version) FROM memory_versions
120                     WHERE memory_id = ?1 AND change_reason != 'restore'",
121                    params![memory_id],
122                    |r| r.get(0),
123                )
124                .optional()?
125                .flatten();
126            let v = last.ok_or_else(|| {
127                AppError::NotFound(errors_msg::memory_not_found(&name, &namespace))
128            })?;
129            tracing::info!(
130                "restore --version omitted; using latest non-restore version: {}",
131                v
132            );
133            v
134        }
135    };
136
137    let version_row: (String, String, String, String, String) = {
138        let mut stmt = conn.prepare(
139            "SELECT name, type, description, body, metadata
140             FROM memory_versions
141             WHERE memory_id = ?1 AND version = ?2",
142        )?;
143
144        stmt.query_row(params![memory_id, target_version], |r| {
145            Ok((r.get(0)?, r.get(1)?, r.get(2)?, r.get(3)?, r.get(4)?))
146        })
147        .map_err(|_| AppError::NotFound(errors_msg::version_not_found(target_version, &name)))?
148    };
149
150    let (_old_name, old_type, old_description, old_body, old_metadata) = version_row;
151
152    // Read current FTS-indexed values before the UPDATE so sync_fts_after_update
153    // can issue the correct DELETE command for the external-content FTS5 table.
154    let (cur_name, cur_desc, cur_body): (String, String, String) = conn.query_row(
155        "SELECT name, description, body FROM memories WHERE id = ?1",
156        params![memory_id],
157        |r| Ok((r.get(0)?, r.get(1)?, r.get(2)?)),
158    )?;
159
160    // v1.0.21 P1-D: re-embed restored body to keep `vec_memories` synchronized
161    // with `memories`. Without this, semantic queries used the post-forget version
162    // vector, causing inconsistent recall (vec_memories=2 vs memories=3 after forget+restore).
163    output::emit_progress_i18n(
164        "Re-computing embedding for restored memory...",
165        crate::i18n::validation::runtime_pt::restore_recomputing_embedding(),
166    );
167    let embedding = crate::daemon::embed_passage_or_local(&paths.models, &old_body)?;
168    let snippet: String = old_body.chars().take(300).collect();
169
170    let tx = conn.transaction_with_behavior(rusqlite::TransactionBehavior::Immediate)?;
171
172    // deleted_at = NULL reactivates soft-deleted memories; no deleted_at filter in the WHERE
173    let affected = if let Some(ts) = args.expected_updated_at {
174        tx.execute(
175            "UPDATE memories SET type=?2, description=?3, body=?4, body_hash=?5, deleted_at=NULL
176             WHERE id=?1 AND updated_at=?6",
177            rusqlite::params![
178                memory_id,
179                old_type,
180                old_description,
181                old_body,
182                blake3::hash(old_body.as_bytes()).to_hex().to_string(),
183                ts
184            ],
185        )?
186    } else {
187        tx.execute(
188            "UPDATE memories SET type=?2, description=?3, body=?4, body_hash=?5, deleted_at=NULL
189             WHERE id=?1",
190            rusqlite::params![
191                memory_id,
192                old_type,
193                old_description,
194                old_body,
195                blake3::hash(old_body.as_bytes()).to_hex().to_string()
196            ],
197        )?
198    };
199
200    if affected == 0 {
201        return Err(AppError::Conflict(errors_msg::concurrent_process_conflict()));
202    }
203
204    let next_v = versions::next_version(&tx, memory_id)?;
205
206    versions::insert_version(
207        &tx,
208        memory_id,
209        next_v,
210        &cur_name,
211        &old_type,
212        &old_description,
213        &old_body,
214        &old_metadata,
215        None,
216        "restore",
217    )?;
218
219    memories::upsert_vec(
220        &tx, memory_id, &namespace, &old_type, &embedding, &cur_name, &snippet,
221    )?;
222
223    memories::sync_fts_after_update(
224        &tx,
225        memory_id,
226        &cur_name,
227        &cur_desc,
228        &cur_body,
229        &cur_name,
230        &old_description,
231        &old_body,
232    )?;
233
234    tx.commit()?;
235
236    conn.execute_batch("PRAGMA wal_checkpoint(TRUNCATE);")?;
237
238    output::emit_json(&RestoreResponse {
239        action: "restored".to_string(),
240        memory_id,
241        name: cur_name.clone(),
242        version: next_v,
243        restored_from: target_version,
244        elapsed_ms: start.elapsed().as_millis() as u64,
245    })?;
246
247    Ok(())
248}
249
250#[cfg(test)]
251mod tests {
252    use crate::errors::AppError;
253
254    #[test]
255    fn optimistic_lock_conflict_returns_exit_3() {
256        let err = AppError::Conflict(
257            "optimistic lock conflict: expected updated_at=50, but current is 99".to_string(),
258        );
259        assert_eq!(err.exit_code(), 3);
260        assert!(err.to_string().contains("conflict"));
261    }
262
263    #[test]
264    fn restore_response_includes_action_field() {
265        let resp = super::RestoreResponse {
266            action: "restored".to_string(),
267            memory_id: 1,
268            name: "test-mem".to_string(),
269            version: 3,
270            restored_from: 2,
271            elapsed_ms: 42,
272        };
273        let json = serde_json::to_value(&resp).expect("serialization failed");
274        assert_eq!(json["action"], "restored");
275        assert_eq!(json["memory_id"], 1);
276        assert_eq!(json["version"], 3);
277        assert_eq!(json["restored_from"], 2);
278    }
279}
sqlite_graphrag/commands/restore.rs

sqlite_graphrag/commands/
restore.rs
