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.
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:
Then, you have to add JavaScript Guest bindings using your preferred JavaScript package manager.
Usage
First you need to register the core plugin with Tauri:
Afterwards 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
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.
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. |
© 2024 Tauri Contributors. CC-BY / MIT