Databasemigreringer og skemahåndtering

Hvad sker der, når din applikation ændrer sig? Nye funktioner har ofte brug for nye steder at gemme data eller ændringer i eksisterende datastrukturer. Det er her, håndtering af dit databaseskema bliver relevant.

Et databaseskema fungerer som en plan for din database. Det definerer de tabeller, kolonner, relationer og begrænsninger, der strukturerer dine data.

Efterhånden som din applikation udvikler sig, skal skemaet også gøre det. Manuelle ændringer kan være risikable og inkonsistente på tværs af miljøer.

Databasemigreringer er versionsstyring for dit databaseskema. Tænk på dem som kode-commits, men for din databasestruktur.

Hver migrering er et sæt instruktioner (normalt SQL), der beskriver, hvordan databasen ændres fra én version til den næste. De får typisk et tidsstempel og anvendes i rækkefølge.

• `up`-script: Anvender en ændring (f.eks. tilføjer en tabel).
• `down`-script: Ruller en ændring tilbage (f.eks. sletter en tabel).

Brug af databasemigreringer giver udviklingsteams flere vigtige fordele:

• Konsistens: Sikrer, at alle udviklere og udrulningsmiljøer har det samme databaseskema.
• Samarbejde: Gør det nemt for flere udviklere at bidrage med skemaændringer uden konflikter.
• Mulighed for tilbagerulning: Gør det nemt at vende tilbage til en tidligere skematilstand, hvis noget går galt.
• Automatisering: Integreres problemfrit i din CI/CD-pipeline til automatiserede udrulninger.

I Clojure-økosystemet er et populært og robust bibliotek til håndtering af databasemigreringer Migratus.

Migratus er fleksibelt og understøtter SQL samt migreringer baseret på Clojure. Det holder styr på anvendte migreringer i din database og sikrer, at de kun køres én gang og i den korrekte rækkefølge.

Det er designet til at være enkelt at konfigurere og bruge og passer godt til Clojures funktionelle tilgang.

For at bruge Migratus skal du først tilføje det som en afhængighed og konfigurere det. Her er en typisk opsætning med deps.edn og et konfigurationskort:

Tilføj først afhængigheden til din deps.edn:

{:deps {org.clojure/clojure {:mvn/version "1.11.1"}
        migratus/migratus {:mvn/version "1.0.10"}
        org.postgresql/postgresql {:mvn/version "42.6.0"}}}

Opret derefter en fil med navnet migratus-config.edn (eller et tilsvarende navn) for at definere din databaseforbindelse:

{:store :database
 :migration-dir "resources/migrations"
 :db {:classname   "org.postgresql.Driver"
      :subprotocol "postgresql"
      :subname     "//localhost:5432/myapp_db"
      :user        "dbuser"
      :password    "dbpass"}}

Migreringer er normalt SQL-filer, der placeres i en bestemt mappe (for eksempel resources/migrations, som konfigureret tidligere). Hver migrering består af et "up"- og et "down"-script.

Migratus forventer filer med navne som YYYYMMDDHHMMSS-migration-name.up.sql og YYYYMMDDHHMMSS-migration-name.down.sql.

Tidsstemplet sikrer en entydig rækkefølge. Du kan generere disse med et kommandolinjeværktøj, typisk migratus create <name>.

Filen .up.sql indeholder SQL-kommandoer, der anvender skemaændringen. Dette eksempel opretter en ny tabel med navnet users.

-- resources/migrations/20231027100000-create-users-table.up.sql

CREATE TABLE users (
  id SERIAL PRIMARY KEY,
  username VARCHAR(255) NOT NULL UNIQUE,
  email VARCHAR(255) NOT NULL,
  created_at TIMESTAMP WITHOUT TIME ZONE DEFAULT CURRENT_TIMESTAMP
);

Dette script definerer den oprindelige struktur for vores brugere.

Filen .down.sql indeholder SQL-kommandoer, der ruller skemaændringen fra den tilsvarende .up.sql-fil tilbage. Dette eksempel sletter tabellen users.

-- resources/migrations/20231027100000-create-users-table.down.sql

DROP TABLE IF EXISTS users;

Det er afgørende, at `down`-scriptet præcist ophæver ændringerne fra `up`-scriptet, så du kan foretage sikre tilbagerulninger.

Når dine migreringsfiler er klar, og `migratus` er konfigureret, kan du anvende dine migreringer.

Typisk bruger du et kommandolinjeværktøj som Leiningen eller clj med et alias, der er konfigureret til `migratus`.

Sådan anvender du alle ventende migreringer:

lein migratus migrate

eller, hvis du bruger clj med et migratus-alias:

clj -M:migratus migrate

Migratus kører alle `up`-scripts, der endnu ikke er anvendt, i rækkefølge.

Nogle gange har du brug for at ophæve en migrering, måske på grund af en fejl eller ændrede krav. Migratus gør det nemt.

Sådan ruller du den senest anvendte migrering tilbage:

lein migratus rollback

Denne kommando kører `down`-scriptet for den senest anvendte migrering. Du kan kalde den flere gange for at rulle længere tilbage.

Sørg altid for, at dine `down`-scripts er sikre og idempotente!

Vi har undersøgt databasemigreringers afgørende rolle i håndteringen af skemaændringer i Clojure-projekter. Du har lært:

• Hvad databaseskemaer og migreringer er.
• Fordelene ved versionsstyrede skemaændringer.
• Hvordan du bruger `Migratus` til at definere og anvende migreringer med SQL-scripts af typen `up` og `down`.
• Kommandoer til at anvende og rulle migreringer tilbage.

Med migreringer kan dit databaseskema udvikle sig sammen med din programkode på en kontrolleret og pålidelig måde!