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    let row: Option<(i64, EntityType)> = {
61        let mut stmt = conn
62            .prepare_cached("SELECT id, type FROM entities WHERE namespace = ?1 AND name = ?2")?;
63        match stmt.query_row(params![namespace, args.name], |r| {
64            Ok((r.get::<_, i64>(0)?, r.get::<_, EntityType>(1)?))
65        }) {
66            Ok(row) => Some(row),
67            Err(rusqlite::Error::QueryReturnedNoRows) => None,
68            Err(e) => return Err(AppError::Database(e)),
69        }
70    };
71    let (entity_id, entity_type) = row
72        .ok_or_else(|| AppError::NotFound(errors_msg::entity_not_found(&args.name, &namespace)))?;
73
74    // Ensure new name is not already taken in this namespace.
75    if entities::find_entity_id(&conn, &namespace, &args.new_name)?.is_some() {
76        return Err(AppError::Validation(format!(
77            "entity with name '{}' already exists in namespace '{}'",
78            args.new_name, namespace
79        )));
80    }
81
82    // Embed new name for vec_entities replacement.
83    let embedding = crate::daemon::embed_passage_or_local(&paths.models, &args.new_name)?;
84
85    let tx = conn.transaction_with_behavior(rusqlite::TransactionBehavior::Immediate)?;
86    tx.execute(
87        "UPDATE entities SET name = ?1, updated_at = unixepoch() WHERE id = ?2",
88        params![args.new_name, entity_id],
89    )?;
90    // vec0 does not support UPDATE — delete then insert.
91    tx.execute(
92        "DELETE FROM vec_entities WHERE entity_id = ?1",
93        params![entity_id],
94    )?;
95    let embedding_bytes = crate::embedder::f32_to_bytes(&embedding);
96    tx.execute(
97        "INSERT INTO vec_entities(entity_id, namespace, type, embedding, name)
98         VALUES (?1, ?2, ?3, ?4, ?5)",
99        params![
100            entity_id,
101            namespace,
102            entity_type,
103            &embedding_bytes,
104            args.new_name
105        ],
106    )?;
107    tx.commit()?;
108
109    conn.execute_batch("PRAGMA wal_checkpoint(TRUNCATE);")?;
110
111    let response = RenameEntityResponse {
112        action: "renamed".to_string(),
113        old_name: args.name,
114        new_name: args.new_name,
115        entity_id,
116        namespace: namespace.clone(),
117        elapsed_ms: start.elapsed().as_millis() as u64,
118    };
119
120    match args.format {
121        OutputFormat::Json => output::emit_json(&response)?,
122        OutputFormat::Text | OutputFormat::Markdown => {
123            output::emit_text(&format!(
124                "renamed entity: '{}' → '{}' [{}]",
125                response.old_name, response.new_name, response.namespace
126            ));
127        }
128    }
129
130    Ok(())
131}
132
133#[cfg(test)]
134mod tests {
135    use super::*;
136
137    #[test]
138    fn rename_entity_response_serializes_all_fields() {
139        let resp = RenameEntityResponse {
140            action: "renamed".to_string(),
141            old_name: "auth".to_string(),
142            new_name: "authentication".to_string(),
143            entity_id: 42,
144            namespace: "global".to_string(),
145            elapsed_ms: 7,
146        };
147        let json = serde_json::to_value(&resp).expect("serialization failed");
148        assert_eq!(json["action"], "renamed");
149        assert_eq!(json["old_name"], "auth");
150        assert_eq!(json["new_name"], "authentication");
151        assert_eq!(json["entity_id"], 42);
152        assert_eq!(json["namespace"], "global");
153        assert!(json["elapsed_ms"].is_number());
154    }
155
156    #[test]
157    fn rename_entity_response_action_is_renamed() {
158        let resp = RenameEntityResponse {
159            action: "renamed".to_string(),
160            old_name: "x".to_string(),
161            new_name: "y".to_string(),
162            entity_id: 1,
163            namespace: "ns".to_string(),
164            elapsed_ms: 1,
165        };
166        assert_eq!(resp.action, "renamed");
167    }
168
169    #[test]
170    fn rename_entity_response_entity_id_preserved() {
171        let resp = RenameEntityResponse {
172            action: "renamed".to_string(),
173            old_name: "old".to_string(),
174            new_name: "new".to_string(),
175            entity_id: 999,
176            namespace: "test-ns".to_string(),
177            elapsed_ms: 5,
178        };
179        let json = serde_json::to_value(&resp).expect("serialization failed");
180        assert_eq!(json["entity_id"], 999);
181    }
182
183    #[test]
184    fn rename_entity_response_namespace_reflected() {
185        let resp = RenameEntityResponse {
186            action: "renamed".to_string(),
187            old_name: "a".to_string(),
188            new_name: "b".to_string(),
189            entity_id: 10,
190            namespace: "my-project".to_string(),
191            elapsed_ms: 2,
192        };
193        let json = serde_json::to_value(&resp).expect("serialization failed");
194        assert_eq!(json["namespace"], "my-project");
195    }
196}
sqlite_graphrag/commands/rename_entity.rs

sqlite_graphrag/commands/
rename_entity.rs
