sqlite_graphrag/commands/
forget.rs

1//! Handler for the `forget` CLI subcommand.
2
3use crate::errors::AppError;
4use crate::i18n::errors_msg;
5use crate::output;
6use crate::paths::AppPaths;
7use crate::storage::connection::open_rw;
8use crate::storage::memories;
9use rusqlite::{params, OptionalExtension};
10use serde::Serialize;
11
12#[derive(clap::Args)]
13#[command(after_long_help = "EXAMPLES:\n  \
14    # Soft-delete a memory by name (positional form)\n  \
15    sqlite-graphrag forget onboarding\n\n  \
16    # Soft-delete using the named flag form\n  \
17    sqlite-graphrag forget --name onboarding\n\n  \
18    # Soft-delete from a specific namespace\n  \
19    sqlite-graphrag forget onboarding --namespace my-project")]
20pub struct ForgetArgs {
21    /// Memory name as a positional argument. Alternative to `--name`.
22    #[arg(
23        value_name = "NAME",
24        conflicts_with = "name",
25        help = "Memory name to soft-delete; alternative to --name"
26    )]
27    pub name_positional: Option<String>,
28    /// Memory name to soft-delete. The row is preserved with `deleted_at` set, recoverable via `restore`.
29    /// Use `purge` to permanently remove soft-deleted memories.
30    #[arg(long)]
31    pub name: Option<String>,
32    #[arg(
33        long,
34        help = "Namespace (env: SQLITE_GRAPHRAG_NAMESPACE, default: global)"
35    )]
36    pub namespace: Option<String>,
37    #[arg(long, hide = true, help = "No-op; JSON is always emitted on stdout")]
38    pub json: bool,
39    #[arg(long, env = "SQLITE_GRAPHRAG_DB_PATH")]
40    pub db: Option<String>,
41}
42
43#[derive(Serialize)]
44struct ForgetResponse {
45    /// Outcome of the forget operation: `soft_deleted`, `already_deleted`, or `not_found`.
46    action: String,
47    /// True only when this invocation actively transitioned the memory from live to soft-deleted.
48    forgotten: bool,
49    name: String,
50    namespace: String,
51    /// Unix epoch seconds when the memory was soft-deleted; `None` when `action="not_found"`.
52    #[serde(skip_serializing_if = "Option::is_none")]
53    deleted_at: Option<i64>,
54    /// RFC 3339 UTC timestamp parallel to `deleted_at` for ISO 8601 parsers.
55    #[serde(skip_serializing_if = "Option::is_none")]
56    deleted_at_iso: Option<String>,
57    /// Total execution time in milliseconds from handler start to serialisation.
58    elapsed_ms: u64,
59}
60
61pub fn run(args: ForgetArgs) -> Result<(), AppError> {
62    let start = std::time::Instant::now();
63    // Resolve name from positional or --name flag; both are optional, at least one is required.
64    let name = args.name_positional.or(args.name).ok_or_else(|| {
65        AppError::Validation("name required: pass as positional argument or via --name".to_string())
66    })?;
67    let namespace = crate::namespace::resolve_namespace(args.namespace.as_deref())?;
68    let paths = AppPaths::resolve(args.db.as_deref())?;
69    crate::storage::connection::ensure_db_ready(&paths)?;
70
71    let conn = open_rw(&paths.db)?;
72
73    // Probe state without filtering on `deleted_at` so we can distinguish
74    // `not_found` (no row) from `already_deleted` (row with deleted_at set)
75    // from the live case (deleted_at IS NULL) handled by `soft_delete`.
76    let probe: Option<(i64, Option<i64>)> = conn
77        .query_row(
78            "SELECT id, deleted_at FROM memories WHERE namespace = ?1 AND name = ?2",
79            params![namespace, name],
80            |r| Ok((r.get::<_, i64>(0)?, r.get::<_, Option<i64>>(1)?)),
81        )
82        .optional()?;
83
84    let (action, forgotten, deleted_at, memory_id) = match probe {
85        None => ("not_found", false, None, None),
86        Some((id, Some(existing))) => ("already_deleted", false, Some(existing), Some(id)),
87        Some((id, None)) => {
88            let ok = memories::soft_delete(&conn, &namespace, &name)?;
89            if !ok {
90                // Race: row was concurrently soft-deleted between probe and update.
91                // Re-read to get the current `deleted_at`.
92                let current: Option<i64> = conn
93                    .query_row(
94                        "SELECT deleted_at FROM memories WHERE id = ?1",
95                        params![id],
96                        |r| r.get::<_, Option<i64>>(0),
97                    )
98                    .optional()?
99                    .flatten();
100                ("already_deleted", false, current, Some(id))
101            } else {
102                let ts: Option<i64> = conn
103                    .query_row(
104                        "SELECT deleted_at FROM memories WHERE id = ?1",
105                        params![id],
106                        |r| r.get::<_, Option<i64>>(0),
107                    )
108                    .optional()?
109                    .flatten();
110                ("soft_deleted", true, ts, Some(id))
111            }
112        }
113    };
114
115    if forgotten {
116        if let Some(id) = memory_id {
117            // FTS5 external-content: manual `DELETE FROM fts_memories WHERE rowid=?`
118            // corrupts the index. The correct cleanup happens via the `trg_fts_ad` trigger
119            // when `purge` physically removes the row from `memories`. Between soft-delete
120            // and purge, FTS queries filter `m.deleted_at IS NULL` in the JOIN.
121            if let Err(e) = memories::delete_vec(&conn, id) {
122                tracing::warn!(memory_id = id, error = %e, "vec cleanup failed — orphan vector left");
123            }
124        }
125    }
126
127    conn.execute_batch("PRAGMA wal_checkpoint(TRUNCATE);")?;
128
129    if action == "not_found" {
130        return Err(AppError::NotFound(errors_msg::memory_not_found(
131            &name, &namespace,
132        )));
133    }
134
135    let deleted_at_iso = deleted_at.map(crate::tz::epoch_to_iso);
136    let response = ForgetResponse {
137        action: action.to_string(),
138        forgotten,
139        name: name.clone(),
140        namespace: namespace.clone(),
141        deleted_at,
142        deleted_at_iso,
143        elapsed_ms: start.elapsed().as_millis() as u64,
144    };
145    output::emit_json(&response)?;
146
147    Ok(())
148}
149
150#[cfg(test)]
151mod tests {
152    use super::*;
153
154    #[test]
155    fn forget_response_serializes_basic_fields() {
156        let resp = ForgetResponse {
157            action: "soft_deleted".to_string(),
158            forgotten: true,
159            name: "my-memory".to_string(),
160            namespace: "global".to_string(),
161            deleted_at: Some(1_700_000_000),
162            deleted_at_iso: Some("2023-11-14T22:13:20+00:00".to_string()),
163            elapsed_ms: 5,
164        };
165        let json = serde_json::to_value(&resp).expect("serialization failed");
166        assert_eq!(json["action"], "soft_deleted");
167        assert_eq!(json["forgotten"], true);
168        assert_eq!(json["name"], "my-memory");
169        assert_eq!(json["namespace"], "global");
170        assert_eq!(json["deleted_at"], 1_700_000_000i64);
171        assert!(json["deleted_at_iso"].is_string());
172        assert!(json["elapsed_ms"].is_number());
173    }
174
175    #[test]
176    fn forget_response_action_soft_deleted_implies_forgotten_true() {
177        let resp = ForgetResponse {
178            action: "soft_deleted".to_string(),
179            forgotten: true,
180            name: "test".to_string(),
181            namespace: "ns".to_string(),
182            deleted_at: Some(42),
183            deleted_at_iso: Some(crate::tz::epoch_to_iso(42)),
184            elapsed_ms: 1,
185        };
186        assert_eq!(resp.action, "soft_deleted");
187        assert!(resp.forgotten);
188        assert_eq!(resp.deleted_at, Some(42));
189        assert!(resp.deleted_at_iso.is_some());
190    }
191
192    #[test]
193    fn forget_response_already_deleted_preserves_timestamp() {
194        let resp = ForgetResponse {
195            action: "already_deleted".to_string(),
196            forgotten: false,
197            name: "abc".to_string(),
198            namespace: "my-project".to_string(),
199            deleted_at: Some(1_650_000_000),
200            deleted_at_iso: Some(crate::tz::epoch_to_iso(1_650_000_000)),
201            elapsed_ms: 2,
202        };
203        let json = serde_json::to_value(&resp).expect("serialization failed");
204        assert_eq!(json["action"], "already_deleted");
205        assert_eq!(json["forgotten"], false);
206        assert_eq!(json["deleted_at"], 1_650_000_000i64);
207        assert!(json["deleted_at_iso"].is_string());
208    }
209
210    #[test]
211    fn forget_response_not_found_omits_deleted_at_fields() {
212        let resp = ForgetResponse {
213            action: "not_found".to_string(),
214            forgotten: false,
215            name: "phantom".to_string(),
216            namespace: "global".to_string(),
217            deleted_at: None,
218            deleted_at_iso: None,
219            elapsed_ms: 0,
220        };
221        let json = serde_json::to_value(&resp).expect("serialization failed");
222        assert_eq!(json["action"], "not_found");
223        assert_eq!(json["forgotten"], false);
224        // skip_serializing_if = "Option::is_none" means both fields are absent
225        assert!(json.get("deleted_at").is_none());
226        assert!(json.get("deleted_at_iso").is_none());
227        assert_eq!(json["elapsed_ms"], 0u64);
228    }
229}
sqlite_graphrag/commands/forget.rs

sqlite_graphrag/commands/
forget.rs
