This page was machine-translated. Spotted a mistake?Help improve it.
Skip to content

Databas

SnapOtter använder PostgreSQL 17 med Drizzle ORM (pg-core / node-postgres) för datapersistens. Schemat definieras i apps/api/src/db/schema.ts.

Anslutningen konfigureras via miljövariabeln DATABASE_URL (standard postgres://snapotter:snapotter@postgres:5432/snapotter). I Docker Compose lagrar Postgres-containern sina data i den namngivna volymen SnapOtter-pgdata.

Tabeller

users

Lagrar användarkonton. Skapas automatiskt vid första körningen från DEFAULT_USERNAME och DEFAULT_PASSWORD.

KolumnTypAnmärkningar
iduuidPrimärnyckel
usernamevarcharUnik, obligatorisk
passwordHashvarcharscrypt-hash
rolevarcharadmin, editor eller user
mustChangePasswordbooleanFlagga för framtvingad lösenordsåterställning
createdAttimestampSkapandetidpunkt
updatedAttimestampSenaste uppdateringstidpunkt

sessions

Aktiva inloggningssessioner. Varje rad knyter en sessionstoken till en användare.

KolumnTypAnmärkningar
idvarcharPrimärnyckel (sessionstoken)
userIduuidFrämmande nyckel till users.id
expiresAttimestampUtgångstidpunkt
createdAttimestampSkapandetidpunkt

teams

Grupper för att organisera användare. Administratörer kan tilldela användare till team.

KolumnTypBeskrivning
iduuidPrimärnyckel
namevarchar (unik, max 50 tecken)Teamnamn
createdAttimestampSkapandetidpunkt

api_keys

API-nycklar för programmatisk åtkomst. Den råa nyckeln visas en gång vid skapandet; endast hashen lagras.

KolumnTypAnmärkningar
iduuidPrimärnyckel
userIduuidFrämmande nyckel till users.id
keyHashvarcharscrypt-hash av nyckeln
namevarcharAnvändarangiven etikett
createdAttimestampSkapandetidpunkt
lastUsedAttimestampUppdateras vid varje autentiserad begäran

Nycklar prefixas med si_ följt av 96 hex-tecken (48 slumpmässiga byte).

pipelines

Sparade verktygskedjor som användare skapar i användargränssnittet.

KolumnTypAnmärkningar
iduuidPrimärnyckel
namevarcharPipeline-namn
descriptionvarcharValfri beskrivning
stepsjsonbArray av { toolId, settings }-objekt
createdAttimestampSkapandetidpunkt

user_files

Beständigt filbibliotek med spårning av versionskedjor. Varje bearbetningssteg som sparar ett resultat skapar en ny rad länkad till sin förälder via parentId, vilket bildar ett versionsträd.

KolumnTypBeskrivning
iduuidPrimärnyckel
userIduuidFK till users (CASCADE DELETE)
originalNamevarcharUrsprungligt uppladdningsfilnamn
storedNamevarcharFilnamn på disk
mimeTypevarcharMIME-typ
sizeintegerFilstorlek i byte
widthintegerBildbredd i px
heightintegerBildhöjd i px
versionintegerVersionsnummer (1 = original)
parentIduuid eller nullFK till user_files (förälderversion)
toolChainjsonbVerktygs-ID:n tillämpade i ordning för att producera den här versionen
createdAttimestampSkapandetidpunkt

jobs

Spårar bearbetningsjobb för framstegsrapportering och rensning.

KolumnTypAnmärkningar
iduuidPrimärnyckel
typevarcharIdentifierare för verktyg eller pipeline
statusvarcharqueued, processing, completed eller failed
progressreal0.0-1.0 andel
inputFilesjsonbArray av sökvägar till indatafiler
outputPathvarcharSökväg till resultatfilen
settingsjsonbAnvända verktygsinställningar
errorvarcharFelmeddelande om det misslyckades
createdAttimestampSkapandetidpunkt
completedAttimestampSlutförandetidpunkt

settings

Nyckel-värde-lager för serveromfattande inställningar som administratörer kan ändra från användargränssnittet.

KolumnTypAnmärkningar
keyvarcharPrimärnyckel
valuevarcharInställningsvärde
updatedAttimestampSenaste uppdateringstidpunkt

roles

Anpassade roller med granulära behörigheter.

KolumnTypAnmärkningar
iduuidPrimärnyckel
namevarcharUnikt rollnamn
descriptionvarcharValfri beskrivning
permissionsjsonbArray av behörighetssträngar
createdAttimestampSkapandetidpunkt

audit_log

Logg över säkerhetsrelevanta åtgärder.

KolumnTypAnmärkningar
iduuidPrimärnyckel
userIduuidFK till users
actionvarcharÅtgärdstyp
detailsjsonbÅtgärdsspecifika data
createdAttimestampÅtgärdstidpunkt

Migrationer

Drizzle sköter schemamigrationer. Migrationsfiler ligger i apps/api/drizzle/. Under utveckling:

bash
cd apps/api
npx drizzle-kit generate   # generate a migration from schema changes
npx drizzle-kit migrate    # apply pending migrations

I produktion tillämpas väntande migrationer automatiskt vid uppstart.

Säkerhetskopiering och återställning

Den relationella databasen ligger i Postgres-containerns SnapOtter-pgdata-volym, inte i appens /data-volym.

Alternativ 1: pg_dump (rekommenderas)

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

Alternativ 2: Volymsnapshot

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 .

Migrera från 1.x (SQLite)

Uppgradering från SnapOtter 1.x har sin egen guide: se Uppgradera från 1.x till 2.0. Kort sagt, återanvänd din befintliga /data-volym så upptäcker och importerar 2.0 automatiskt /data/snapotter.db vid första uppstarten (eller ställ in SQLITE_MIGRATE_PATH för att peka på den explicit). Säkerhetskopiera hela /data-volymen först, inte bara snapotter.db: 1.x använder SQLite WAL-läge, så en stoppad container lämnar ofta det mesta av sina data i snapotter.db-wal bredvid en nästan tom snapotter.db.