mirror of
https://github.com/snapotter-hq/SnapOtter.git
synced 2026-08-03 07:46:42 +02:00
All 181 docs markdown files translated into 20 languages (apps/docs/<locale>/**). Companion to the i18n code PR; admin-merged because the file count exceeds GitHub's per-PR CI trigger limit. Validated by pnpm i18n:check (all surfaces, 0 stale/missing) and a clean all-locale docs build.
186 lines
7.2 KiB
Markdown
186 lines
7.2 KiB
Markdown
---
|
|
description: "Schema del database PostgreSQL, tabelle, migrazioni e procedure di backup per SnapOtter."
|
|
i18n_source_hash: b37398ae91a3
|
|
i18n_provenance: human
|
|
i18n_output_hash: 6498644e25e3
|
|
---
|
|
|
|
# Database {#database}
|
|
|
|
SnapOtter usa PostgreSQL 17 con [Drizzle ORM](https://orm.drizzle.team/) (pg-core / node-postgres) per la persistenza dei dati. Lo schema è definito in `apps/api/src/db/schema.ts`.
|
|
|
|
La connessione è configurata tramite la variabile d'ambiente `DATABASE_URL` (predefinita `postgres://snapotter:snapotter@postgres:5432/snapotter`). In Docker Compose, il container Postgres memorizza i suoi dati nel volume denominato `SnapOtter-pgdata`.
|
|
|
|
## Tabelle {#tables}
|
|
|
|
### users {#users}
|
|
|
|
Memorizza gli account utente. Creata automaticamente al primo avvio da `DEFAULT_USERNAME` e `DEFAULT_PASSWORD`.
|
|
|
|
| Colonna | Tipo | Note |
|
|
|---|---|---|
|
|
| `id` | uuid | Chiave primaria |
|
|
| `username` | varchar | Univoco, obbligatorio |
|
|
| `passwordHash` | varchar | Hash scrypt |
|
|
| `role` | varchar | `admin`, `editor` o `user` |
|
|
| `mustChangePassword` | boolean | Flag di reimpostazione forzata della password |
|
|
| `createdAt` | timestamp | Data di creazione |
|
|
| `updatedAt` | timestamp | Data dell'ultimo aggiornamento |
|
|
|
|
### sessions {#sessions}
|
|
|
|
Sessioni di login attive. Ogni riga associa un token di sessione a un utente.
|
|
|
|
| Colonna | Tipo | Note |
|
|
|---|---|---|
|
|
| `id` | varchar | Chiave primaria (token di sessione) |
|
|
| `userId` | uuid | Chiave esterna verso `users.id` |
|
|
| `expiresAt` | timestamp | Data di scadenza |
|
|
| `createdAt` | timestamp | Data di creazione |
|
|
|
|
### teams {#teams}
|
|
|
|
Gruppi per organizzare gli utenti. Gli amministratori possono assegnare gli utenti ai team.
|
|
|
|
| Colonna | Tipo | Descrizione |
|
|
|--------|------|-------------|
|
|
| `id` | uuid | Chiave primaria |
|
|
| `name` | varchar (univoco, max 50 caratteri) | Nome del team |
|
|
| `createdAt` | timestamp | Data di creazione |
|
|
|
|
### api_keys {#api-keys}
|
|
|
|
Chiavi API per l'accesso programmatico. La chiave grezza viene mostrata una sola volta alla creazione; viene memorizzato solo l'hash.
|
|
|
|
| Colonna | Tipo | Note |
|
|
|---|---|---|
|
|
| `id` | uuid | Chiave primaria |
|
|
| `userId` | uuid | Chiave esterna verso `users.id` |
|
|
| `keyHash` | varchar | Hash scrypt della chiave |
|
|
| `name` | varchar | Etichetta fornita dall'utente |
|
|
| `createdAt` | timestamp | Data di creazione |
|
|
| `lastUsedAt` | timestamp | Aggiornata a ogni richiesta autenticata |
|
|
|
|
Le chiavi hanno il prefisso `si_` seguito da 96 caratteri esadecimali (48 byte casuali).
|
|
|
|
### pipelines {#pipelines}
|
|
|
|
Catene di strumenti salvate che gli utenti creano nell'interfaccia.
|
|
|
|
| Colonna | Tipo | Note |
|
|
|---|---|---|
|
|
| `id` | uuid | Chiave primaria |
|
|
| `name` | varchar | Nome della pipeline |
|
|
| `description` | varchar | Descrizione facoltativa |
|
|
| `steps` | jsonb | Array di oggetti `{ toolId, settings }` |
|
|
| `createdAt` | timestamp | Data di creazione |
|
|
|
|
### user_files {#user-files}
|
|
|
|
Libreria di file persistente con tracciamento della catena delle versioni. Ogni passaggio di elaborazione che salva un risultato crea una nuova riga collegata al suo genitore tramite `parentId`, formando un albero delle versioni.
|
|
|
|
| Colonna | Tipo | Descrizione |
|
|
|--------|------|-------------|
|
|
| `id` | uuid | Chiave primaria |
|
|
| `userId` | uuid | FK verso users (CASCADE DELETE) |
|
|
| `originalName` | varchar | Nome del file di caricamento originale |
|
|
| `storedName` | varchar | Nome del file su disco |
|
|
| `mimeType` | varchar | Tipo MIME |
|
|
| `size` | integer | Dimensione del file in byte |
|
|
| `width` | integer | Larghezza dell'immagine in px |
|
|
| `height` | integer | Altezza dell'immagine in px |
|
|
| `version` | integer | Numero di versione (1 = originale) |
|
|
| `parentId` | uuid o null | FK verso user_files (versione genitore) |
|
|
| `toolChain` | jsonb | ID degli strumenti applicati in ordine per produrre questa versione |
|
|
| `createdAt` | timestamp | Data di creazione |
|
|
|
|
### jobs {#jobs}
|
|
|
|
Traccia i job di elaborazione per la segnalazione dell'avanzamento e la pulizia.
|
|
|
|
| Colonna | Tipo | Note |
|
|
|---|---|---|
|
|
| `id` | uuid | Chiave primaria |
|
|
| `type` | varchar | Identificatore dello strumento o della pipeline |
|
|
| `status` | varchar | `queued`, `processing`, `completed` o `failed` |
|
|
| `progress` | real | Frazione 0.0-1.0 |
|
|
| `inputFiles` | jsonb | Array dei percorsi dei file di input |
|
|
| `outputPath` | varchar | Percorso del file risultato |
|
|
| `settings` | jsonb | Impostazioni dello strumento utilizzate |
|
|
| `error` | varchar | Messaggio di errore in caso di fallimento |
|
|
| `createdAt` | timestamp | Data di creazione |
|
|
| `completedAt` | timestamp | Data di completamento |
|
|
|
|
### settings {#settings}
|
|
|
|
Archivio chiave-valore per le impostazioni a livello di server che gli amministratori possono modificare dall'interfaccia.
|
|
|
|
| Colonna | Tipo | Note |
|
|
|---|---|---|
|
|
| `key` | varchar | Chiave primaria |
|
|
| `value` | varchar | Valore dell'impostazione |
|
|
| `updatedAt` | timestamp | Data dell'ultimo aggiornamento |
|
|
|
|
### roles {#roles}
|
|
|
|
Ruoli personalizzati con permessi granulari.
|
|
|
|
| Colonna | Tipo | Note |
|
|
|---|---|---|
|
|
| `id` | uuid | Chiave primaria |
|
|
| `name` | varchar | Nome univoco del ruolo |
|
|
| `description` | varchar | Descrizione facoltativa |
|
|
| `permissions` | jsonb | Array di stringhe di permesso |
|
|
| `createdAt` | timestamp | Data di creazione |
|
|
|
|
### audit_log {#audit-log}
|
|
|
|
Registro delle azioni rilevanti per la sicurezza.
|
|
|
|
| Colonna | Tipo | Note |
|
|
|---|---|---|
|
|
| `id` | uuid | Chiave primaria |
|
|
| `userId` | uuid | FK verso users |
|
|
| `action` | varchar | Tipo di azione |
|
|
| `details` | jsonb | Dati specifici dell'azione |
|
|
| `createdAt` | timestamp | Data dell'azione |
|
|
|
|
## Migrazioni {#migrations}
|
|
|
|
Drizzle gestisce le migrazioni dello schema. I file di migrazione risiedono in `apps/api/drizzle/`. Durante lo sviluppo:
|
|
|
|
```bash
|
|
cd apps/api
|
|
npx drizzle-kit generate # generate a migration from schema changes
|
|
npx drizzle-kit migrate # apply pending migrations
|
|
```
|
|
|
|
In produzione, le migrazioni in sospeso vengono applicate automaticamente all'avvio.
|
|
|
|
## Backup e ripristino {#backup-and-restore}
|
|
|
|
Il database relazionale risiede nel volume `SnapOtter-pgdata` del container Postgres, non nel volume `/data` dell'app.
|
|
|
|
**Opzione 1: pg_dump (consigliata)**
|
|
|
|
```bash
|
|
# Dump the database while the stack is running
|
|
docker exec SnapOtter-postgres pg_dump -U snapotter snapotter > backup.sql
|
|
|
|
# Restore into a fresh database
|
|
cat backup.sql | docker exec -i SnapOtter-postgres psql -U snapotter snapotter
|
|
```
|
|
|
|
**Opzione 2: Snapshot del volume**
|
|
|
|
```bash
|
|
# Stop the stack, then snapshot the pgdata volume
|
|
docker compose down
|
|
docker run --rm -v SnapOtter-pgdata:/data -v $(pwd)/backup:/backup \
|
|
alpine tar czf /backup/snapotter-pgdata.tar.gz -C /data .
|
|
```
|
|
|
|
### Migrazione dalla 1.x (SQLite) {#migrating-from-1-x-sqlite}
|
|
|
|
L'aggiornamento da SnapOtter 1.x ha una guida dedicata: vedi [Aggiornamento dalla 1.x alla 2.0](./upgrading). In breve, riutilizza il tuo volume `/data` esistente e la 2.0 rileva e importa automaticamente `/data/snapotter.db` al primo avvio (oppure imposta `SQLITE_MIGRATE_PATH` per puntarvi esplicitamente). Esegui prima il backup dell'intero volume `/data`, non solo di `snapotter.db`: la 1.x usa la modalità WAL di SQLite, quindi un container arrestato lascia spesso la maggior parte dei suoi dati in `snapotter.db-wal` accanto a un `snapotter.db` quasi vuoto.
|