docs(sql): add `preload` config example for migrations (#1557)

* docs(sql): add `preload` config example for migrations

* improve idempotency explanation
pull/1572/head
Gabriel Silva (Gabe) 11 months ago committed by GitHub
parent 1adf7e3872
commit 490d4208d7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

@ -158,7 +158,26 @@ fn main() {
### 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).
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:
```ts
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.
### Migration Management

Loading…
Cancel
Save