sqlite_graphrag/commands/
rename_entity.rs

1//! Handler for the `rename-entity` CLI subcommand.
2//!
3//! Renames an entity preserving all relationships and memory bindings.
4//! Only the `name` column in `entities` and the corresponding `vec_entities`
5//! row need updating because relationships use integer FK `entity_id`.
6
7use crate::entity_type::EntityType;
8use crate::errors::AppError;
9use crate::i18n::errors_msg;
10use crate::output::{self, OutputFormat};
11use crate::paths::AppPaths;
12use crate::storage::connection::open_rw;
13use crate::storage::entities;
14use rusqlite::params;
15use serde::Serialize;
16
17#[derive(clap::Args)]
18#[command(after_long_help = "EXAMPLES:\n  \
19    # Rename an entity\n  \
20    sqlite-graphrag rename-entity --name old-name --new-name new-name\n\n  \
21    # Rename with namespace\n  \
22    sqlite-graphrag rename-entity --name auth --new-name authentication --namespace my-project")]
23pub struct RenameEntityArgs {
24    /// Current entity name to rename.
25    #[arg(long, value_name = "NAME")]
26    pub name: String,
27    /// New name for the entity.
28    #[arg(long, value_name = "NEW_NAME")]
29    pub new_name: String,
30    #[arg(long)]
31    pub namespace: Option<String>,
32    #[arg(long, value_enum, default_value = "json")]
33    pub format: OutputFormat,
34    #[arg(long, hide = true, help = "No-op; JSON is always emitted on stdout")]
35    pub json: bool,
36    #[arg(long, env = "SQLITE_GRAPHRAG_DB_PATH")]
37    pub db: Option<String>,
38}
39
40#[derive(Serialize)]
41struct RenameEntityResponse {
42    action: String,
43    old_name: String,
44    new_name: String,
45    entity_id: i64,
46    namespace: String,
47    elapsed_ms: u64,
48}
49
50pub fn run(args: RenameEntityArgs) -> Result<(), AppError> {
51    let start = std::time::Instant::now();
52    let namespace = crate::namespace::resolve_namespace(args.namespace.as_deref())?;
53    let paths = AppPaths::resolve(args.db.as_deref())?;
54
55    crate::storage::connection::ensure_db_ready(&paths)?;
56
57    let mut conn = open_rw(&paths.db)?;
58
59    // Verify source entity exists and fetch its id and type.
60    // Normalize the lookup name to match the normalized stored names.
61    let lookup_name = crate::parsers::normalize_entity_name(&args.name);
62    let row: Option<(i64, EntityType)> = {
63        let mut stmt = conn
64            .prepare_cached("SELECT id, type FROM entities WHERE namespace = ?1 AND name = ?2")?;
65        match stmt.query_row(params![namespace, lookup_name], |r| {
66            Ok((r.get::<_, i64>(0)?, r.get::<_, EntityType>(1)?))
67        }) {
68            Ok(row) => Some(row),
69            Err(rusqlite::Error::QueryReturnedNoRows) => None,
70            Err(e) => return Err(AppError::Database(e)),
71        }
72    };
73    let (entity_id, entity_type) = row
74        .ok_or_else(|| AppError::NotFound(errors_msg::entity_not_found(&args.name, &namespace)))?;
75
76    // Validate the raw new name first (catches short ALL_CAPS NER noise),
77    // then normalize it for storage to preserve the normalized-name invariant.
78    entities::validate_entity_name(&args.new_name)?;
79    let new_name = crate::parsers::normalize_entity_name(&args.new_name);
80
81    if lookup_name == new_name {
82        return Err(AppError::Validation(
83            "source and target entity names are identical".to_string(),
84        ));
85    }
86
87    // Ensure new name is not already taken in this namespace.
88    if entities::find_entity_id(&conn, &namespace, &new_name)?.is_some() {
89        return Err(AppError::Validation(format!(
90            "entity with name '{new_name}' already exists in namespace '{namespace}'"
91        )));
92    }
93
94    // Embed the normalized new name for vec_entities replacement.
95    let embedding = crate::daemon::embed_passage_or_local(&paths.models, &new_name)?;
96
97    let tx = conn.transaction_with_behavior(rusqlite::TransactionBehavior::Immediate)?;
98    tx.execute(
99        "UPDATE entities SET name = ?1, updated_at = unixepoch() WHERE id = ?2",
100        params![new_name, entity_id],
101    )?;
102    // vec0 does not support UPDATE — delete then insert.
103    tx.execute(
104        "DELETE FROM vec_entities WHERE entity_id = ?1",
105        params![entity_id],
106    )?;
107    let embedding_bytes = crate::embedder::f32_to_bytes(&embedding);
108    tx.execute(
109        "INSERT INTO vec_entities(entity_id, namespace, type, embedding, name)
110         VALUES (?1, ?2, ?3, ?4, ?5)",
111        params![
112            entity_id,
113            namespace,
114            entity_type,
115            &embedding_bytes,
116            new_name
117        ],
118    )?;
119    tx.commit()?;
120
121    conn.execute_batch("PRAGMA wal_checkpoint(TRUNCATE);")?;
122
123    let response = RenameEntityResponse {
124        action: "renamed".to_string(),
125        old_name: args.name,
126        new_name,
127        entity_id,
128        namespace: namespace.clone(),
129        elapsed_ms: start.elapsed().as_millis() as u64,
130    };
131
132    match args.format {
133        OutputFormat::Json => output::emit_json(&response)?,
134        OutputFormat::Text | OutputFormat::Markdown => {
135            output::emit_text(&format!(
136                "renamed entity: '{}' → '{}' [{}]",
137                response.old_name, response.new_name, response.namespace
138            ));
139        }
140    }
141
142    Ok(())
143}
144
145#[cfg(test)]
146mod tests {
147    use super::*;
148
149    #[test]
150    fn rename_entity_response_serializes_all_fields() {
151        let resp = RenameEntityResponse {
152            action: "renamed".to_string(),
153            old_name: "auth".to_string(),
154            new_name: "authentication".to_string(),
155            entity_id: 42,
156            namespace: "global".to_string(),
157            elapsed_ms: 7,
158        };
159        let json = serde_json::to_value(&resp).expect("serialization failed");
160        assert_eq!(json["action"], "renamed");
161        assert_eq!(json["old_name"], "auth");
162        assert_eq!(json["new_name"], "authentication");
163        assert_eq!(json["entity_id"], 42);
164        assert_eq!(json["namespace"], "global");
165        assert!(json["elapsed_ms"].is_number());
166    }
167
168    #[test]
169    fn rename_entity_response_action_is_renamed() {
170        let resp = RenameEntityResponse {
171            action: "renamed".to_string(),
172            old_name: "x".to_string(),
173            new_name: "y".to_string(),
174            entity_id: 1,
175            namespace: "ns".to_string(),
176            elapsed_ms: 1,
177        };
178        assert_eq!(resp.action, "renamed");
179    }
180
181    #[test]
182    fn rename_entity_response_entity_id_preserved() {
183        let resp = RenameEntityResponse {
184            action: "renamed".to_string(),
185            old_name: "old".to_string(),
186            new_name: "new".to_string(),
187            entity_id: 999,
188            namespace: "test-ns".to_string(),
189            elapsed_ms: 5,
190        };
191        let json = serde_json::to_value(&resp).expect("serialization failed");
192        assert_eq!(json["entity_id"], 999);
193    }
194
195    #[test]
196    fn rejects_rename_entity_to_same_name() {
197        use crate::errors::AppError;
198        let err = AppError::Validation("source and target entity names are identical".to_string());
199        assert_eq!(err.exit_code(), 1);
200        assert!(err.to_string().contains("identical"));
201    }
202
203    #[test]
204    fn rename_entity_response_namespace_reflected() {
205        let resp = RenameEntityResponse {
206            action: "renamed".to_string(),
207            old_name: "a".to_string(),
208            new_name: "b".to_string(),
209            entity_id: 10,
210            namespace: "my-project".to_string(),
211            elapsed_ms: 2,
212        };
213        let json = serde_json::to_value(&resp).expect("serialization failed");
214        assert_eq!(json["namespace"], "my-project");
215    }
216}
sqlite_graphrag/commands/rename_entity.rs

sqlite_graphrag/commands/
rename_entity.rs
