tauri-impl-database

tauri-impl-database

Decision Tree: Which Storage Approach

Need persistent data in Tauri 2?
|
+-- Simple key-value pairs (settings, preferences, cache)?
|   --> tauri-plugin-store (Section 1)
|
+-- Relational data with SQL queries?
|   |
|   +-- Frontend-driven queries (JS/TS calls SQL directly)?
|   |   --> tauri-plugin-sql (Section 2)
|   |
|   +-- Backend-driven queries (Rust owns the data layer)?
|       --> Custom DB via Rust commands (Section 3)
|
+-- Encrypted storage for secrets?
    --> tauri-plugin-stronghold (out of scope, see plugin docs)

---

Section 1: tauri-plugin-store (Key-Value Storage)

When to Use

Use tauri-plugin-store for user preferences, application settings, small cache data, and any scenario where you need persistent key-value pairs without relational queries.

Setup

Rust side (src-tauri/Cargo.toml):

[dependencies]
tauri-plugin-store = "2"

Register the plugin (src-tauri/src/lib.rs):

tauri::Builder::default()
    .plugin(tauri_plugin_store::Builder::default().build())
    .run(tauri::generate_context!())
    .expect("error while running tauri application");

Frontend side (package.json):

{
  "dependencies": {
    "@tauri-apps/plugin-store": "^2"
  }
}

Permissions (src-tauri/capabilities/default.json):

{
  "permissions": ["store:default"]
}

Eager Loading Pattern

ALWAYS use eager loading when you need the store immediately at component mount or app startup.

import { load } from '@tauri-apps/plugin-store';

// Eager: loads from disk immediately, awaits until ready
const store = await load('settings.json', { autoSave: true });

// CRUD operations
await store.set('theme', 'dark');
await store.set('user', { name: 'Alice', prefs: { lang: 'en' } });

const theme = await store.get<string>('theme');
// Returns undefined if key does not exist -- ALWAYS handle this
const hasKey = await store.has('theme');

// Enumeration
const allKeys = await store.keys();
const allValues = await store.values();
const allEntries = await store.entries();
const count = await store.length();

// Deletion
await store.delete('theme');
await store.clear();

// Manual persistence (only needed when autoSave is false)
await store.save();

// Reload from disk (discard in-memory changes)
await store.reload();

// Reset to default values
await store.reset();