SQL - Tauri — ContextQMD

import PluginLinks from '@components/PluginLinks.astro'; import Compatibility from '@components/plugins/Compatibility.astro';

import PluginPermissions from '@components/PluginPermissions.astro'; import { Tabs, TabItem, Steps } from '@astrojs/starlight/components'; import CommandTabs from '@components/CommandTabs.astro';

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

Setup

Install the SQL plugin to get started.

    Use your project's package manager to add the dependency:

    <CommandTabs npm="npm run tauri add sql"
    yarn="yarn run tauri add sql"
    pnpm="pnpm tauri add sql"
    bun="bun tauri add sql"
    deno="deno task tauri add sql"
    cargo="cargo tauri add sql" />

</TabItem>
<TabItem label="Manual">

    <Steps>

    1.  Run the following command in the `src-tauri` folder to add the plugin to the project's dependencies in `Cargo.toml`:

        ```sh frame=none
        cargo add tauri-plugin-sql
        ```

    2.  Modify `lib.rs` to initialize the plugin:

        ```rust title="src-tauri/src/lib.rs" ins={4}
        #[cfg_attr(mobile, tauri::mobile_entry_point)]
		    pub fn run() {
            tauri::Builder::default()
                .plugin(tauri_plugin_sql::Builder::default().build())
                .run(tauri::generate_context!())
                .expect("error while running tauri application");
        }
        ```

    3.	Install the JavaScript Guest bindings using your preferred JavaScript package manager:

        <CommandTabs
            npm="npm install @tauri-apps/plugin-sql"
            yarn="yarn add @tauri-apps/plugin-sql"
            pnpm="pnpm add @tauri-apps/plugin-sql"
            deno="deno add npm:@tauri-apps/plugin-sql"
            bun="bun add @tauri-apps/plugin-sql"
        />

    </Steps>

</TabItem> </Tabs>

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:

```sh frame=none
cargo add tauri-plugin-sql --features sqlite
```

</TabItem> <TabItem label="MySQL">

```sh frame=none
cargo add tauri-plugin-sql --features mysql
```

</TabItem> <TabItem label="PostgreSQL">

```sh frame=none
cargo add tauri-plugin-sql --features postgres
```

</TabItem> </Tabs>

Usage

All the plugin's APIs are available through the JavaScript guest bindings:

The path is relative to tauri::api::path::BaseDirectory::AppConfig.

javascript

import Database from '@tauri-apps/plugin-sql';
// when using `"withGlobalTauri": true`, you may use
// const Database = window.__TAURI__.sql;

const db = await Database.load('sqlite:test.db');
await db.execute('INSERT INTO ...');

</TabItem> <TabItem label="MySQL">

javascript

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 ...');

</TabItem> <TabItem label="PostgreSQL">

javascript

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 ...');

</TabItem> </Tabs>

Syntax

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

<Tabs syncKey='SQLvariant'> <TabItem label="SQLite"> Use the "$#" syntax when substituting query data

javascript

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

</TabItem> <TabItem label="MySQL"> Use "?" when substituting query data

javascript

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

</TabItem> <TabItem label="PostgreSQL"> Use the "$#" syntax when substituting query data

javascript

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

</TabItem> </Tabs>

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:

rust

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!:

rust

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

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:

rust

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

To apply the migrations when the plugin is initialized, add the connection string to the tauri.conf.json file:

json

{
  "plugins": {
    "sql": {
      "preload": ["sqlite:mydatabase.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:mydatabase.db');

Ensure that the migrations are defined in the correct order and are safe to run multiple times.

:::note All migrations are executed within a transaction, ensuring atomicity. If any migration fails, the entire transaction is rolled back, leaving the database in a consistent state. :::

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 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.

json

{
  "permissions": [
    ...,
    "sql:default",
    "sql:allow-execute",
  ]
}