feat(sql): support for SQLite pragma and encryption pragmas #2553

HuakunShen · 2025-03-20T12:01:28Z

resolve #7

Introduced libsqlite3-sys dependency for SQLite support.
Updated the load method to accept optional pragmas for database connections.
Enhanced the JavaScript API to demonstrate loading databases with encryption keys and custom pragmas.
Added VSCode settings for Rust analyzer to enable SQLite feature, to facilitate development.
Updated Rust code to handle SQLite options and pragmas in the database connection logic.

Now sqlite encryption can be enabled like this.

const db = await Database.load("sqlite:encrypted.db", {
  sqlite: { pragmas: { "key": "encryption_key" } }
});

I already tested on Mac, further testing needed on Windows and Linux.

- Introduced `libsqlite3-sys` dependency for SQLite support. - Updated the `load` method to accept optional pragmas for database connections. - Enhanced the JavaScript API to demonstrate loading databases with encryption keys and custom pragmas. - Added VSCode settings for Rust analyzer to enable SQLite feature, to facilitate development. - Updated Rust code to handle SQLite options and pragmas in the database connection logic.

HuakunShen · 2025-03-20T12:18:53Z

Preload doesn't support pragma yet, because that will introduce breaking APIs here

plugins-workspace/plugins/sql/src/lib.rs

Line 55 in 43f0f95

preload: Vec<String>,

If we have to support pragma in preload, then maybe something like this?

{
  "plugins": {
    "sql": {
      "preload": ["sqlite:mydatabase.db"],
      "sqlite_options": {
        "sqlite:mydatabase.db": {
          "pragmas": {
            "journal_mode": "WAL",
            "foreign_keys": "ON"
          }
        }
      }
    }
  }
}

HuakunShen · 2025-03-21T01:11:38Z

I realized one problem, there are two load commands now, one for sqlite one for others. So the current implementation doesn't support multiple features. Either sqlite only or turn off sqlite feature.
Will need a more robust design.

Problem fixed, the latest version supports connecting to sqlite, mysql and postgres at the same time

…ments on SQLite usage

…nd registration

haexhub · 2025-03-25T22:15:06Z

I'm desperately waiting for this feature

HuakunShen · 2025-03-25T22:54:58Z

I'm desperately waiting for this feature

No one is reviewing this PR.

In the meanwhile, if anyone wants to try this, you can set dependency to my branch in Cargo.toml.
And for JS dependency, you may want to clone my branch and link to it with pnpm/npm/bun link.

roniemartinez · 2025-03-25T23:04:39Z

+1 on this! I am also waiting to move from my custom implementation to fully adapting to this plugin. Thanks for the PR!

HuakunShen · 2025-03-25T23:09:09Z

+1 on this! I am also waiting to move from my custom implementation to fully adapting to this plugin. Thanks for the PR!

I was also using my custom implementation with cipher using rusqlite.
While I made this PR, it will be a lot of work to migrate from my implementation to this.
And I want to at least wait til this PR get merged to migrate.

BTW I also figured out how to use drizzle to work with this sql plugin and also rusqlite.
Working with sqlite in Tauri now feels like in Electron.

c6p

Maybe out of scope of this PR, but with minimal change, it can support loading sqlite extensions.

c6p · 2025-04-24T14:09:58Z

plugins/sql/guest-js/index.ts

+    path: string,
+    options?: {
+      sqlite?: {
+        pragmas?: Record<string, string>


Since you are already adding options. Could you add support for extensions, to fix #1705

extensions?: Record<string, Option<string>> // extension, entry_point

c6p · 2025-04-24T14:12:31Z

plugins/sql/src/wrapper.rs

-                    Sqlite::create_database(conn_url).await?;
+                let mut sqlite_options = SqliteConnectOptions::new()
+                    .filename(filename)
+                    .create_if_missing(true);


Load extensions with entry points.

roniemartinez · 2025-05-02T21:40:57Z

Had the chance to test this PR.... but I added my changes for my use: roniemartinez@7ca825d

fokx · 2025-05-16T11:01:16Z

Hope this PR could be merged soon!

tauri-apps/plugins-workspace#2553

FabianLars · 2025-05-16T13:59:25Z

Sorry i don't have much time for plugins at the moment and this also comes a bit in the middle of a refactor of the sql plugin (which is my bad since that should've been long done).

One thing that sure would help is to do what Huakun also asked for and try this PR yourself before it's merged so we get a bit of feedback on the API and issues.

Preload doesn't support pragma yet, because that will introduce breaking APIs here

We can do it without a breaking change by creating an untagged enum for use in that Vec with string and struct variants.

fokx · 2025-05-17T06:17:05Z

try this PR yourself

I've tried this PR and can confirm pragmas works on Linux.

To build for Android, you need to use bundled-sqlcipher-vendored-openssl feature of libsqlite3-sys instead of bundled-sqlcipher, which cause openssl related build error.

libsqlite3-sys = { version = "0.30", features = ["bundled-sqlcipher-vendored-openssl"] }

It works on Android after makes such modification. Test method: pull the db file from Android device and open it in Sqlite DB Browser.

roniemartinez · 2025-05-17T08:31:38Z

Is it safe to put “PRAGMA key” in the config file? Putting it in the Rust code like what I did in #2553 (comment) looks a lot more safe because I can get the key dynamically from a server.

FabianLars · 2025-05-17T12:11:18Z

Is it safe to put “PRAGMA key” in the config file?

Not reallyyy. But since we consider the js side unsafe as well a config option is not much worse than that. Assuming of course that it's not committed to git but injected at build time (true for config, js, and rust). That's a bit less obvious for the config option so maybe you're right and we shouldn't add it (yet).

FabianLars · 2025-05-17T12:17:17Z

I've tried this PR and can confirm pragmas works on Linux.

Thanks for testing :)

To build for Android, you need to use bundled-sqlcipher-vendored-openssl feature of libsqlite3-sys instead of bundled-sqlcipher, which cause openssl related build error.

That's a bit problematic for those that build their apps on Windows but i guess there's no way around that. But with that both feature flags should be exposed as plugin features and users should enable what they need (making sqlcipher as a whole option again as well).

salemdomain · 2025-06-03T03:12:18Z

I've tried this PR and can confirm pragmas works on Linux.

Thanks for testing :)

To build for Android, you need to use bundled-sqlcipher-vendored-openssl feature of libsqlite3-sys instead of bundled-sqlcipher, which cause openssl related build error.

That's a bit problematic for those that build their apps on Windows but i guess there's no way around that. But with that both feature flags should be exposed as plugin features and users should enable what they need (making sqlcipher as a whole option again as well).

hey everything works fine with npm run tauri dev, but I encounter issues when building a Windows package from macOS using this command npm run tauri build -- --target x86_64-pc-windows-msvc --runner cargo-xwin and here is the error error: failed to run custom build command for 'libsqlite3-sys v0.30.1' and here is my cargo.toml

[dependencies.tauri-plugin-sql]
features = ["bundled-sqlcipher"] # or "postgres", or "mysql"
version = "^2.0.0-beta"
# alternatively with Git
git = "https://github.com/eleroy/plugins-workspace"
branch = "sql/sqlcipher"

HuakunShen requested a review from a team as a code owner March 20, 2025 12:01

HuakunShen mentioned this pull request Mar 20, 2025

[sql] SQLCipher Encryption #7

Open

HuakunShen added 3 commits March 21, 2025 00:18

feat(sql): support multi sql features

65a77b7

docs(sql): enhance examples for database connection with detailed com…

30df392

…ments on SQLite usage

refactor(sql): remove commented-out query function and clean up comma…

49d9a38

…nd registration

c6p suggested changes Apr 24, 2025

View reviewed changes

fokx added a commit to fokx/localshare that referenced this pull request May 16, 2025

enable sqlite using sql plugin PR

c47dc6a

tauri-apps/plugins-workspace#2553

feat(sql): support for SQLite pragma and encryption pragmas #2553

Are you sure you want to change the base?

feat(sql): support for SQLite pragma and encryption pragmas #2553

Uh oh!

Conversation

HuakunShen commented Mar 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

HuakunShen commented Mar 20, 2025

Uh oh!

HuakunShen commented Mar 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

haexhub commented Mar 25, 2025

Uh oh!

HuakunShen commented Mar 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

roniemartinez commented Mar 25, 2025

Uh oh!

HuakunShen commented Mar 25, 2025

Uh oh!

c6p left a comment

Choose a reason for hiding this comment

Uh oh!

c6p Apr 24, 2025

Choose a reason for hiding this comment

Uh oh!

c6p Apr 24, 2025

Choose a reason for hiding this comment

Uh oh!

roniemartinez commented May 2, 2025

Uh oh!

fokx commented May 16, 2025

Uh oh!

FabianLars commented May 16, 2025

Uh oh!

fokx commented May 17, 2025

Uh oh!

roniemartinez commented May 17, 2025

Uh oh!

FabianLars commented May 17, 2025

Uh oh!

FabianLars commented May 17, 2025

Uh oh!

salemdomain commented Jun 3, 2025

Uh oh!

Uh oh!

HuakunShen commented Mar 20, 2025 •

edited

Loading

HuakunShen commented Mar 21, 2025 •

edited

Loading

HuakunShen commented Mar 25, 2025 •

edited

Loading