mirror of
https://github.com/tauri-apps/plugins-workspace.git
synced 2026-04-21 11:26:15 +02:00
docs(sql): add preload config example for migrations (#1557)
* docs(sql): add `preload` config example for migrations * improve idempotency explanation
This commit is contained in:
committed by
GitHub
parent
1adf7e3872
commit
490d4208d7
+20
-1
@@ -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
|
||||
|
||||
|
||||
Reference in New Issue
Block a user