SQL
Plugin providing an interface for the frontend to communicate with SQL databases through sqlx. It supports the SQLite, MySQL and PostgreSQL drivers, enabled by a Cargo feature.
Supported Platforms
Section titled “Supported Platforms”This plugin requires a Rust version of at least 1.77.2
| Platform | Level | Notes |
|---|---|---|
| windows | ||
| linux | ||
| macos | ||
| android | ||
| ios |
Install the SQL plugin to get started.
Use your project’s package manager to add the dependency:
npm run tauri add sqlyarn run tauri add sqlpnpm tauri add sqldeno task tauri add sqlbun tauri add sqlcargo tauri add sqlRun the following command in the
src-taurifolder to add the plugin to the project’s dependencies inCargo.toml:cargo add tauri-plugin-sql@2src-tauri/Cargo.toml tauri-plugin-opener = "2"serde = { version = "1", features = ["derive"] }serde_json = "1"tauri-plugin-sql = "2"# Read the optimization guideline for more details: https://tauri.app/concept/size/#cargo-configurationModify
lib.rsto initialize the plugin. The example app keeps its builder chain in aconfigurefunction thatruncalls, so the plugin registers there. If yourrunholds the chain, add the same line there:src-tauri/src/lib.rs pub fn configure<R: tauri::Runtime>(builder: tauri::Builder<R>) -> tauri::Builder<R> {builder.plugin(tauri_plugin_opener::init()).plugin(tauri_plugin_sql::Builder::default().build()).invoke_handler(tauri::generate_handler![greet])}Install the JavaScript Guest bindings using your preferred JavaScript package manager:
npm install @tauri-apps/plugin-sqlyarn add @tauri-apps/plugin-sqlpnpm add @tauri-apps/plugin-sqldeno add npm:@tauri-apps/plugin-sqlbun add @tauri-apps/plugin-sql
After installing the plugin, you must select the supported database engine.
The available engines are Sqlite, MySQL and PostgreSQL.
Run the following command in the src-tauri folder to enable your preferred engine:
The plugin only compiles a database driver when its Cargo feature is enabled:
cargo add tauri-plugin-sql@2 --features sqlitetauri-plugin-opener = "2"serde = { version = "1", features = ["derive"] }serde_json = "1"tauri-plugin-sql = "2"tauri-plugin-sql = { version = "2", features = ["sqlite"] }
# Read the optimization guideline for more details: https://tauri.app/concept/size/#cargo-configurationcargo add tauri-plugin-sql --features mysqlcargo add tauri-plugin-sql --features postgresAll the plugin’s APIs are available through the JavaScript guest bindings:
The path is relative to
tauri::api::path::BaseDirectory::AppConfig.
When using "withGlobalTauri": true, you may use const Database = window.__TAURI__.sql; instead of the import:
import { invoke } from "@tauri-apps/api/core";import Database from "@tauri-apps/plugin-sql";
let greetInputEl: HTMLInputElement | null;let greetMsgEl: HTMLElement | null; }}
window.addEventListener("DOMContentLoaded", () => {window.addEventListener("DOMContentLoaded", async () => { greetInputEl = document.querySelector("#greet-input"); greetMsgEl = document.querySelector("#greet-msg"); document.querySelector("#greet-form")?.addEventListener("submit", (e) => { e.preventDefault(); greet(); });
// The path is resolved relative to the app's config directory. const db = await Database.load("sqlite:test.db");
// Use the "$#" syntax when substituting query data. await db.execute( "INSERT into todos (id, title, status) VALUES ($1, $2, $3)", [1, "Try the sql plugin", "open"], );});import Database from '@tauri-apps/plugin-sql';// when using `"withGlobalTauri": true`, you may use// const Database = window.__TAURI__.sql;
const db = await Database.load('mysql://user:password@host/test');await db.execute('INSERT INTO ...');import Database from '@tauri-apps/plugin-sql';// when using `"withGlobalTauri": true`, you may use// const Database = window.__TAURI__.sql;
const db = await Database.load('postgres://user:password@host/test');await db.execute('INSERT INTO ...');Syntax
Section titled “Syntax”We use sqlx as the underlying library and adopt their query syntax.
Use the “$#” syntax when substituting query data
const result = await db.execute( 'INSERT into todos (id, title, status) VALUES ($1, $2, $3)', [todos.id, todos.title, todos.status]);
const result = await db.execute( 'UPDATE todos SET title = $1, status = $2 WHERE id = $3', [todos.title, todos.status, todos.id]);Use “?” when substituting query data
const result = await db.execute( 'INSERT into todos (id, title, status) VALUES (?, ?, ?)', [todos.id, todos.title, todos.status]);
const result = await db.execute( 'UPDATE todos SET title = ?, status = ? WHERE id = ?', [todos.title, todos.status, todos.id]);Use the “$#” syntax when substituting query data
const result = await db.execute( 'INSERT into todos (id, title, status) VALUES ($1, $2, $3)', [todos.id, todos.title, todos.status]);
const result = await db.execute( 'UPDATE todos SET title = $1, status = $2 WHERE id = $3', [todos.title, todos.status, todos.id]);Migrations
Section titled “Migrations”This plugin supports database migrations, allowing you to manage database schema evolution over time.
Defining Migrations
Section titled “Defining Migrations”Migrations are defined in Rust using the Migration struct. Each migration should include a unique version number, a description, the SQL to be executed, and the type of migration (Up or Down).
Example of a migration:
use tauri_plugin_sql::{Migration, MigrationKind};
let migration = Migration { version: 1, description: "create_initial_tables", sql: "CREATE TABLE users (id INTEGER PRIMARY KEY, name TEXT);", kind: MigrationKind::Up,};Or if you want to use SQL from a file, you can include it by using include_str!:
use tauri_plugin_sql::{Migration, MigrationKind};
let migration = Migration { version: 1, description: "create_initial_tables", sql: include_str!("../drizzle/0000_graceful_boomer.sql"), kind: MigrationKind::Up,};Adding Migrations to the Plugin Builder
Section titled “Adding Migrations to the Plugin Builder”Migrations are registered with the Builder struct provided by the plugin. Use the add_migrations method to add your migrations to the plugin for a specific database connection.
Example of defining a migration and adding it for the sqlite:test.db
connection:
use tauri_plugin_sql::{Migration, MigrationKind};
// Learn more about Tauri commands at https://tauri.app/develop/calling-rust/#[tauri::command]fn greet(name: &str) -> String {}
pub fn configure<R: tauri::Runtime>(builder: tauri::Builder<R>) -> tauri::Builder<R> { let migrations = vec![ // Define your migrations here Migration { version: 1, description: "create_initial_tables", sql: "CREATE TABLE todos (id INTEGER PRIMARY KEY, title TEXT, status TEXT);", kind: MigrationKind::Up, }, ];
builder .plugin(tauri_plugin_opener::init()) .plugin(tauri_plugin_sql::Builder::default().build()) .plugin( tauri_plugin_sql::Builder::default() .add_migrations("sqlite:test.db", migrations) .build(), ) .invoke_handler(tauri::generate_handler![greet])}Applying Migrations
Section titled “Applying Migrations”To apply the migrations when the plugin is initialized, add the connection
string to the tauri.conf.json file:
"icons/icon.icns", "icons/icon.ico" ] }, "plugins": { "sql": { "preload": [ "sqlite:test.db" ] } }}Alternatively, the client side load() also runs the migrations for a given connection string:
import Database from '@tauri-apps/plugin-sql';const db = await Database.load('sqlite:test.db');Ensure that the migrations are defined in the correct order and are safe to run multiple times.
Migration Management
Section titled “Migration Management”- Version Control: Each migration must have a unique version number. This is crucial for ensuring the migrations are applied in the correct order.
- Idempotency: Write migrations in a way that they can be safely re-run without causing errors or unintended consequences.
- Testing: Thoroughly test migrations to ensure they work as expected and do not compromise the integrity of your database.
Permissions
Section titled “Permissions”By default all potentially dangerous plugin commands and scopes are blocked and cannot be accessed. You must modify the permissions in your capabilities configuration to enable these.
See the Capabilities Overview for more information and the step by step guide to use plugin permissions.
Until the capability grants the sql permissions, loading the database from the
webview is denied by the ACL; with them granted, load() succeeds — and
applies the migrations:
"windows": ["main"], "permissions": [ "core:default", "opener:default" "opener:default", "sql:default", "sql:allow-execute" ]}Default Permission
Default Permissions
This permission set configures what kind of database operations are available from the sql plugin.
Granted Permissions
All reading related operations are enabled. Also allows to load or close a connection.
This default permission set includes the following:
allow-closeallow-loadallow-select
Permission Table
| Identifier | Description |
|---|---|
|
|
Enables the close command without any pre-configured scope. |
|
|
Denies the close command without any pre-configured scope. |
|
|
Enables the execute command without any pre-configured scope. |
|
|
Denies the execute command without any pre-configured scope. |
|
|
Enables the load command without any pre-configured scope. |
|
|
Denies the load command without any pre-configured scope. |
|
|
Enables the select command without any pre-configured scope. |
|
|
Denies the select command without any pre-configured scope. |
© 2026 Tauri Contributors. CC-BY / MIT