sqlite_graphrag/commands/
rename.rs

1//! Handler for the `rename` 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, versions};
10use serde::Serialize;
11
12#[derive(clap::Args)]
13#[command(after_long_help = "EXAMPLES:\n  \
14    # Rename using two positional arguments (NAME NEW)\n  \
15    sqlite-graphrag rename onboarding welcome-guide\n\n  \
16    # Rename using the positional NAME + --new-name flag\n  \
17    sqlite-graphrag rename onboarding --new-name welcome-guide\n\n  \
18    # Rename using the named flag form\n  \
19    sqlite-graphrag rename --name onboarding --new-name welcome-guide\n\n  \
20    # Rename within a specific namespace\n  \
21    sqlite-graphrag rename onboarding welcome-guide --namespace my-project")]
22pub struct RenameArgs {
23    /// Current memory name as a positional argument. Alternative to `--name` / `--old`.
24    #[arg(
25        value_name = "NAME",
26        conflicts_with = "name",
27        help = "Current memory name to rename; alternative to --name/--old"
28    )]
29    pub name_positional: Option<String>,
30    /// Current memory name. Also accepts the aliases `--old` and `--from` (since v1.0.35).
31    #[arg(long, alias = "old", alias = "from")]
32    pub name: Option<String>,
33    /// New memory name as a positional argument. Alternative to `--new-name`.
34    #[arg(
35        value_name = "NEW",
36        conflicts_with = "new_name",
37        help = "New memory name; alternative to --new-name/--new/--to"
38    )]
39    pub new_name_positional: Option<String>,
40    /// New memory name. Also accepts the aliases `--new` and `--to` (since v1.0.35).
41    #[arg(long, alias = "new", alias = "to")]
42    pub new_name: Option<String>,
43    #[arg(
44        long,
45        help = "Namespace (env: SQLITE_GRAPHRAG_NAMESPACE, default: global)"
46    )]
47    pub namespace: Option<String>,
48    /// Optimistic locking: reject if the current updated_at does not match (exit 3).
49    #[arg(
50        long,
51        value_name = "EPOCH_OR_RFC3339",
52        value_parser = crate::parsers::parse_expected_updated_at,
53        long_help = "Optimistic lock: reject if updated_at does not match. \
54Accepts Unix epoch (e.g. 1700000000) or RFC 3339 (e.g. 2026-04-19T12:00:00Z)."
55    )]
56    pub expected_updated_at: Option<i64>,
57    /// Optional session ID used to trace the origin of the change.
58    #[arg(long, value_name = "UUID")]
59    pub session_id: Option<String>,
60    /// Output format.
61    #[arg(long, value_enum, default_value_t = JsonOutputFormat::Json)]
62    pub format: JsonOutputFormat,
63    #[arg(long, hide = true, help = "No-op; JSON is always emitted on stdout")]
64    pub json: bool,
65    #[arg(long, env = "SQLITE_GRAPHRAG_DB_PATH")]
66    pub db: Option<String>,
67}
68
69#[derive(Serialize)]
70struct RenameResponse {
71    memory_id: i64,
72    name: String,
73    action: &'static str,
74    version: i64,
75    /// Total execution time in milliseconds from handler start to serialisation.
76    elapsed_ms: u64,
77}
78
79pub fn run(args: RenameArgs) -> Result<(), AppError> {
80    let inicio = std::time::Instant::now();
81    let _ = args.format;
82    use crate::constants::*;
83
84    // Resolve current name from positional or --name/--old flag.
85    let name = args.name_positional.or(args.name).ok_or_else(|| {
86        AppError::Validation("name required: pass as positional argument or via --name".to_string())
87    })?;
88    let namespace = crate::namespace::resolve_namespace(args.namespace.as_deref())?;
89
90    let raw_new_name = args.new_name.or(args.new_name_positional).ok_or_else(|| {
91        AppError::Validation(
92            "new name required: pass as positional <NEW> or via --new-name/--new/--to".to_string(),
93        )
94    })?;
95
96    // v1.0.20: trim_matches('-') also removes trailing/leading hyphens.
97    let normalized_new_name = {
98        let lower = raw_new_name.to_lowercase().replace(['_', ' '], "-");
99        let trimmed = lower.trim_matches('-').to_string();
100        if trimmed != raw_new_name {
101            tracing::warn!(
102                original = %raw_new_name,
103                normalized = %trimmed,
104                "new_name auto-normalized to kebab-case"
105            );
106        }
107        trimmed
108    };
109
110    if normalized_new_name == name {
111        return Err(AppError::Validation(
112            "source and target names are identical".to_string(),
113        ));
114    }
115
116    if normalized_new_name.starts_with("__") {
117        return Err(AppError::Validation(
118            crate::i18n::validation::reserved_name(),
119        ));
120    }
121
122    if normalized_new_name.is_empty() || normalized_new_name.len() > MAX_MEMORY_NAME_LEN {
123        return Err(AppError::Validation(
124            crate::i18n::validation::new_name_length(MAX_MEMORY_NAME_LEN),
125        ));
126    }
127
128    {
129        let slug_re = regex::Regex::new(crate::constants::NAME_SLUG_REGEX)
130            .map_err(|e| AppError::Internal(anyhow::anyhow!("regex: {e}")))?;
131        if !slug_re.is_match(&normalized_new_name) {
132            return Err(AppError::Validation(
133                crate::i18n::validation::new_name_kebab(&normalized_new_name),
134            ));
135        }
136    }
137
138    let paths = AppPaths::resolve(args.db.as_deref())?;
139    crate::storage::connection::ensure_db_ready(&paths)?;
140    let mut conn = open_rw(&paths.db)?;
141
142    let (memory_id, current_updated_at, _) = memories::find_by_name(&conn, &namespace, &name)?
143        .ok_or_else(|| AppError::NotFound(errors_msg::memory_not_found(&name, &namespace)))?;
144
145    if let Some(expected) = args.expected_updated_at {
146        if expected != current_updated_at {
147            return Err(AppError::Conflict(errors_msg::optimistic_lock_conflict(
148                expected,
149                current_updated_at,
150            )));
151        }
152    }
153
154    let row = memories::read_by_name(&conn, &namespace, &name)?
155        .ok_or_else(|| AppError::Internal(anyhow::anyhow!("memory not found before rename")))?;
156
157    let memory_type = row.memory_type.clone();
158    let description = row.description.clone();
159    let body = row.body.clone();
160    let metadata = row.metadata.clone();
161
162    let tx = conn.transaction_with_behavior(rusqlite::TransactionBehavior::Immediate)?;
163
164    let affected = if let Some(ts) = args.expected_updated_at {
165        tx.execute(
166            "UPDATE memories SET name=?2 WHERE id=?1 AND updated_at=?3 AND deleted_at IS NULL",
167            rusqlite::params![memory_id, normalized_new_name, ts],
168        )?
169    } else {
170        tx.execute(
171            "UPDATE memories SET name=?2 WHERE id=?1 AND deleted_at IS NULL",
172            rusqlite::params![memory_id, normalized_new_name],
173        )?
174    };
175
176    if affected == 0 {
177        return Err(AppError::Conflict(
178            "optimistic lock conflict: memory was modified by another process".to_string(),
179        ));
180    }
181
182    let next_v = versions::next_version(&tx, memory_id)?;
183
184    versions::insert_version(
185        &tx,
186        memory_id,
187        next_v,
188        &normalized_new_name,
189        &memory_type,
190        &description,
191        &body,
192        &metadata,
193        None,
194        "rename",
195    )?;
196
197    memories::sync_fts_after_update(
198        &tx,
199        memory_id,
200        &name,
201        &description,
202        &body,
203        &normalized_new_name,
204        &description,
205        &body,
206    )?;
207
208    tx.commit()?;
209
210    conn.execute_batch("PRAGMA wal_checkpoint(TRUNCATE);")?;
211
212    output::emit_json(&RenameResponse {
213        memory_id,
214        name: normalized_new_name,
215        action: "renamed",
216        version: next_v,
217        elapsed_ms: inicio.elapsed().as_millis() as u64,
218    })?;
219
220    Ok(())
221}
222
223#[cfg(test)]
224mod tests {
225    use crate::storage::memories::{insert, NewMemory};
226    use tempfile::TempDir;
227
228    fn setup_db() -> (TempDir, rusqlite::Connection) {
229        crate::storage::connection::register_vec_extension();
230        let dir = TempDir::new().unwrap();
231        let db_path = dir.path().join("test.db");
232        let mut conn = rusqlite::Connection::open(&db_path).unwrap();
233        crate::migrations::runner().run(&mut conn).unwrap();
234        (dir, conn)
235    }
236
237    fn new_memory(name: &str) -> NewMemory {
238        NewMemory {
239            namespace: "global".to_string(),
240            name: name.to_string(),
241            memory_type: "user".to_string(),
242            description: "desc".to_string(),
243            body: "corpo".to_string(),
244            body_hash: format!("hash-{name}"),
245            session_id: None,
246            source: "agent".to_string(),
247            metadata: serde_json::json!({}),
248        }
249    }
250
251    #[test]
252    fn rejects_new_name_with_double_underscore_prefix() {
253        use crate::errors::AppError;
254        let (_dir, conn) = setup_db();
255        insert(&conn, &new_memory("mem-teste")).unwrap();
256        drop(conn);
257
258        let err = AppError::Validation(
259            "names and namespaces starting with __ are reserved for internal use".to_string(),
260        );
261        assert!(err.to_string().contains("__"));
262        assert_eq!(err.exit_code(), 1);
263    }
264
265    #[test]
266    fn rejects_rename_to_same_name() {
267        use crate::errors::AppError;
268        let err = AppError::Validation("source and target names are identical".to_string());
269        assert_eq!(err.exit_code(), 1);
270        assert!(err.to_string().contains("identical"));
271    }
272
273    #[test]
274    fn optimistic_lock_conflict_returns_exit_3() {
275        use crate::errors::AppError;
276        let err = AppError::Conflict(
277            "optimistic lock conflict: expected updated_at=100, but current is 200".to_string(),
278        );
279        assert_eq!(err.exit_code(), 3);
280    }
281}
sqlite_graphrag/commands/rename.rs

sqlite_graphrag/commands/
rename.rs
