Struct Builder 

pub struct Builder { /* private fields */ }

Tauri SQL plugin builder.

Implementations

impl Builder

pub fn new() -> Self

Creates a new builder with no migrations registered.

Prints a message to stderr when none of the sqlite, mysql and postgres Cargo features is enabled, since no database can be connected to in that case.

pub fn add_migrations(self, db_url: &str, migrations: Vec<Migration>) -> Self

Add migrations to a database.

pub fn build<R: Runtime>(self) -> TauriPlugin<R, Option<PluginConfig>>

Builds the SQL plugin.

On setup the plugin connects to every database listed in the preload array of its configuration, running the migrations registered for them, and it closes all connection pools when the application exits.

Examples

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

fn sql_plugin<R: tauri::Runtime>(
) -> tauri::plugin::TauriPlugin<R, Option<tauri_plugin_sql::PluginConfig>> {
    Builder::new()
        .add_migrations(
            "sqlite:mydatabase.db",
            vec![Migration {
                version: 1,
                description: "create todos table",
                sql: "CREATE TABLE todos (id INTEGER PRIMARY KEY, title TEXT);",
                kind: MigrationKind::Up,
            }],
        )
        .build()
}

Trait Implementations

impl Default for Builder

fn default() -> Self

Returns the “default value” for a type.