Merge pull request #1609 from tursodatabase/sqld-dump-preserve-rowids

add preserve_rowids query parameter to align with native SQLite shell feature

Author: sivukhin

libsql-server/src/connection/dump/exporter.rs

@@ -20,6 +20,7 @@ impl<W: Write> DumpState<W> {
         &mut self,
         txn: &rusqlite::Connection,
         stmt: &str,
+        preserve_rowids: bool,
     ) -> anyhow::Result<()> {
         let mut stmt = txn.prepare(stmt)?;
         let mut rows = stmt.query(())?;
@@ -67,7 +68,8 @@ impl<W: Write> DumpState<W> {
 
             if ty == b"table" {
                 let table_str = std::str::from_utf8(table)?;
-                let (row_id_col, colss) = self.list_table_columns(txn, table_str)?;
+                let (row_id_col, colss) =
+                    self.list_table_columns(txn, table_str, preserve_rowids)?;
                 let mut insert = String::new();
                 write!(&mut insert, "INSERT INTO {}", Quoted(table_str))?;
 
@@ -146,11 +148,12 @@ impl<W: Write> DumpState<W> {
         &self,
         txn: &rusqlite::Connection,
         table: &str,
+        preserve_rowids: bool,
     ) -> anyhow::Result<(Option<String>, Vec<String>)> {
         let mut cols = Vec::new();
         let mut num_primary_keys = 0;
         let mut is_integer_primary_key = false;
-        let mut preserve_row_id = false;
+        let mut preserve_rowids = preserve_rowids;
         let mut row_id_col = None;
 
         txn.pragma(None, "table_info", table, |row| {
@@ -186,14 +189,14 @@ impl<W: Write> DumpState<W> {
                 [table],
                 |_| {
                     // re-set preserve_row_id if there is a row
-                    preserve_row_id = true;
+                    preserve_rowids = true;
                     Ok(())
                 },
             )
             .optional()?;
         }
 
-        if preserve_row_id {
+        if preserve_rowids {
             const ROW_ID_NAMES: [&str; 3] = ["rowid", "_row_id_", "oid"];
 
             for row_id_name in ROW_ID_NAMES {
@@ -430,7 +433,11 @@ fn find_unused_str(haystack: &str, needle1: &str, needle2: &str) -> String {
     }
 }
 
-pub fn export_dump(db: &mut rusqlite::Connection, writer: impl Write) -> anyhow::Result<()> {
+pub fn export_dump(
+    db: &mut rusqlite::Connection,
+    writer: impl Write,
+    preserve_rowids: bool,
+) -> anyhow::Result<()> {
     let mut txn = db.transaction()?;
     txn.execute("PRAGMA writable_schema=ON", ())?;
     let savepoint = txn.savepoint_with_name("dump")?;
@@ -451,7 +458,7 @@ pub fn export_dump(db: &mut rusqlite::Connection, writer: impl Write) -> anyhow:
 WHERE type=='table' 
 AND sql NOT NULL 
 ORDER BY tbl_name='sqlite_sequence', rowid";
-    state.run_schema_dump_query(&savepoint, q)?;
+    state.run_schema_dump_query(&savepoint, q, preserve_rowids)?;
 
     let q = "SELECT sql FROM sqlite_schema AS o 
 WHERE sql NOT NULL 
@@ -508,7 +515,24 @@ mod test {
         conn.execute(r#"create table test ("limit")"#, ()).unwrap();
 
         let mut out = Vec::new();
-        export_dump(&mut conn, &mut out).unwrap();
+        export_dump(&mut conn, &mut out, false).unwrap();
+
+        insta::assert_snapshot!(std::str::from_utf8(&out).unwrap());
+    }
+
+    #[test]
+    fn table_preserve_rowids() {
+        let tmp = tempdir().unwrap();
+        let mut conn = Connection::open(tmp.path().join("data")).unwrap();
+        conn.execute(r#"create table test ( id TEXT PRIMARY KEY )"#, ())
+            .unwrap();
+        conn.execute(r#"insert into test values ( 'a' ), ( 'b' ), ( 'c' )"#, ())
+            .unwrap();
+        conn.execute(r#"delete from test where id = 'a'"#, ())
+            .unwrap();
+
+        let mut out = Vec::new();
+        export_dump(&mut conn, &mut out, true).unwrap();
 
         insta::assert_snapshot!(std::str::from_utf8(&out).unwrap());
     }

libsql-server/src/connection/dump/snapshots/libsql_server__connection__dump__exporter__test__table_preserve_rowids.snap

@@ -0,0 +1,10 @@
+---
+source: libsql-server/src/connection/dump/exporter.rs
+expression: "std::str::from_utf8(&out).unwrap()"
+---
+PRAGMA foreign_keys=OFF;
+BEGIN TRANSACTION;
+CREATE TABLE IF NOT EXISTS test ( id TEXT PRIMARY KEY );
+INSERT INTO test(rowid,id) VALUES(2,'b');
+INSERT INTO test(rowid,id) VALUES(3,'c');
+COMMIT;

libsql-server/src/http/user/dump.rs

@@ -2,10 +2,11 @@ use std::future::Future;
 use std::pin::Pin;
 use std::task;
 
-use axum::extract::State as AxumState;
+use axum::extract::{Query, State as AxumState};
 use futures::StreamExt;
 use hyper::HeaderMap;
 use pin_project_lite::pin_project;
+use serde::Deserialize;
 
 use crate::auth::Authenticated;
 use crate::connection::dump::exporter::export_dump;
@@ -72,10 +73,16 @@ where
     }
 }
 
+#[derive(Deserialize)]
+pub struct DumpQuery {
+    preserve_row_ids: Option<bool>,
+}
+
 pub(super) async fn handle_dump(
     auth: Authenticated,
     AxumState(state): AxumState<AppState>,
     headers: HeaderMap,
+    query: Query<DumpQuery>,
 ) -> crate::Result<axum::body::StreamBody<impl futures::Stream<Item = Result<bytes::Bytes, Error>>>>
 {
     let namespace = namespace_from_headers(
@@ -102,7 +109,9 @@ pub(super) async fn handle_dump(
 
     let join_handle = BLOCKING_RT.spawn_blocking(move || {
         let writer = tokio_util::io::SyncIoBridge::new(writer);
-        conn.with_raw(|conn| export_dump(conn, writer).map_err(Into::into))
+        conn.with_raw(|conn| {
+            export_dump(conn, writer, query.preserve_row_ids.unwrap_or(false)).map_err(Into::into)
+        })
     });
 
     let stream = tokio_util::io::ReaderStream::new(reader);