SQL

GitHub npm crates.io

API Reference

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.

Install

This plugin requires a Rust version of at least 1.75

Firstly, you have to install Core plugin by adding the following to your Cargo.toml file:

crates.io

src-tauri/Cargo.toml

[dependencies.tauri-plugin-sql]
features = ["sqlite"] # or "postgres", or "mysql"
version = "2.0.0-beta"

Git

src-tauri/Cargo.toml

[dependencies.tauri-plugin-sql]
features = ["sqlite"] # or "postgres", or "mysql"
git = "https://github.com/tauri-apps/plugins-workspace"
branch = "v2"

Then, you have to add JavaScript Guest bindings using your preferred JavaScript package manager.

npm.io

npm

npm add @tauri-apps/plugin-sql

yarn

yarn add @tauri-apps/plugin-sql

pnpm

pnpm add @tauri-apps/plugin-sql

bun

bun add @tauri-apps/plugin-sql

Git

npm

npm add https://github.com/tauri-apps/tauri-plugin-sql#v2

yarn

yarn add https://github.com/tauri-apps/tauri-plugin-sql#v2

pnpm

pnpm add https://github.com/tauri-apps/tauri-plugin-sql#v2

bun

bun add https://github.com/tauri-apps/tauri-plugin-sql#v2

Usage

First you need to register the core plugin with Tauri:

src-tauri/src/main.rs

fn main() {
    tauri::Builder::default()
        .plugin(tauri_plugin_sql::Builder::default().build())
        .run(tauri::generate_context!())
        .expect("error while running tauri application");
}

Afterwards all the plugin’s APIs are available through the JavaScript guest bindings:

SQLite

The path is relative to tauri::api::path::BaseDirectory::App

import Database from '@tauri-apps/plugin-sql';
const db = await Database.load('sqlite:test.db');
await db.execute('INSERT INTO ...');

MySQL

import Database from '@tauri-apps/plugin-sql';
const db = await Database.load('mysql://user:pass@host/database');
await db.execute('INSERT INTO ...');

PostgreSQL

import Database from "@tauri-apps/plugin-sql";
const db = await Database.load("postgres://postgres:password@localhost/test");
await db.execute("INSERT INTO ...");

Syntax

We use sqlx as the underlying library and adopt their query syntax.

SQLite

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],
);

MySQL

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],
);

PostgreSQL

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

This plugin supports database migrations, allowing you to manage database schema evolution over time.

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,
};

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 adding migrations:

src-tauri/src/main.rs

use tauri_plugin_sql::{Builder, Migration, MigrationKind};

fn main() {
    let migrations = vec![
        // Define your migrations here
        Migration {
            version: 1,
            description: "create_initial_tables",
            sql: "CREATE TABLE users (id INTEGER PRIMARY KEY, name TEXT);",
            kind: MigrationKind::Up,
        }
    ];

    tauri::Builder::default()
        .plugin(
            tauri_plugin_sql::Builder::default()
                .add_migrations("sqlite:mydatabase.db", migrations)
                .build(),
        )
        ...
}

Applying Migrations

Migrations are applied automatically when the plugin is initialized. The plugin runs these migrations against the database specified by the connection string. Ensure that the migrations are defined in the correct order and are idempotent (safe to run multiple times).

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

By default all plugin commands are blocked and cannot be accessed. You must define a list of permissions in your capabilities configuration.

See Permissions Overview for more information.

src-tauri/capabilities/main.json

{
  "$schema": "../gen/schemas/desktop-schema.json",
  "identifier": "main-capability",
  "description": "Capability for the main window",
  "windows": ["main"],
  "permissions": ["sql:allow-load", "sql:allow-execute"]
}

Permission	Description
sql:allow-close	Enables the close command without any pre-configured scope.
sql:deny-close	Denies the close command without any pre-configured scope.
sql:allow-execute	Enables the execute command without any pre-configured scope.
sql:deny-execute	Denies the execute command without any pre-configured scope.
sql:allow-load	Enables the load command without any pre-configured scope.
sql:deny-load	Denies the load command without any pre-configured scope.
sql:allow-select	Enables the select command without any pre-configured scope.
sql:deny-select	Denies the select command without any pre-configured scope.