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
This plugin requires a Rust version of at least 1.77.2
Platform | Level | Notes |
---|---|---|
windows | ||
linux | ||
macos | ||
android | ||
ios | |
Setup
Install the SQL plugin to get started.
Use your project’s package manager to add the dependency:
-
Run the following command in the
src-tauri
folder to add the plugin to the project’s dependencies inCargo.toml
: -
Modify
lib.rs
to initialize the plugin: -
Install the JavaScript Guest bindings using your preferred JavaScript package manager:
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:
Usage
All the plugin’s APIs are available through the JavaScript guest bindings:
The path is relative to tauri::api::path::BaseDirectory::AppConfig
.
Syntax
We use sqlx as the underlying library and adopt their query syntax.
Use the ”$#” syntax when substituting query data
Use ”?” when substituting query data
Use the ”$#” syntax when substituting query data
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:
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:
Applying Migrations
To apply the migrations when the plugin is initialized, add the connection string to the tauri.conf.json
file:
Alternatively, the client side load()
also runs the migrations for a given connection string:
Ensure that the migrations are defined in the correct order and are 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 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.
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.
allow-close
allow-load
allow-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. |
© 2024 Tauri Contributors. CC-BY / MIT