Was ist goose und warum braucht man es?

Die Bibliothek goose (Go Object-Oriented SQL Environment) ist ein leistungsstarkes Tool für das Management von Datenbankmigrationen im Go-Ökosystem. Im Gegensatz zu integrierten Lösungen bietet goose einen deklarativen Ansatz zur Versionierung des Datenbankschemas, der es Entwicklern ermöglicht, Änderungen in SQL oder Go-Code zu beschreiben. Die Hauptaufgabe von goose ist es, das Anwenden und Zurücksetzen von Änderungen an der Datenbankstruktur zu automatisieren – ein entscheidender Vorteil für Teamarbeit und CI/CD-Pipelines.

Warum ist goose nützlich? Erstens löst es das Problem der Synchronisation des Datenbankschemas zwischen Entwicklern: Jedes Teammitglied kann die neuesten Migrationen mit einem einzigen Befehl anwenden. Zweitens unterstützt goose die Versionierung – jede Migration hat eine eindeutige Nummer, sodass genau nachvollzogen werden kann, welche Änderungen bereits angewendet wurden. Drittens arbeitet die Bibliothek mit verschiedenen DBMS (PostgreSQL, MySQL, SQLite, ClickHouse und andere) über eine einheitliche Schnittstelle, was den Wechsel zwischen Umgebungen vereinfacht.

Der entscheidende Vorteil von goose gegenüber Alternativen (z. B. golang-migrate/migrate) ist die Unterstützung von Migrationen in Go, nicht nur in SQL. Sie können komplexe Migrationen mit Geschäftslogik schreiben, Transaktionen verwenden und auf externe APIs zugreifen. Darüber hinaus bietet goose eine integrierte Unterstützung für Embed (Einbetten von Migrationen in die Binärdatei), was ideal für Produktionsumgebungen ist.

Installation

Die Installation von goose erfolgt über den standardmäßigen Go-Paketmanager. Stellen Sie zunächst sicher, dass Go Version 1.18 oder höher installiert ist.

go install github.com/pressly/goose/v3/cmd/goose@latest

Überprüfen Sie nach der Installation die Version:

goose --version

Um goose als Bibliothek in Ihrem Projekt zu verwenden, fügen Sie die Abhängigkeit hinzu:

go get github.com/pressly/goose/v3

Außerdem benötigen Sie einen Treiber für Ihr DBMS. Zum Beispiel für PostgreSQL:

go get github.com/lib/pq

Für MySQL:

go get github.com/go-sql-driver/mysql

Für SQLite:

go get github.com/mattn/go-sqlite3

Schnellstart – Ein minimales Arbeitsbeispiel

Erstellen wir ein einfaches Projekt, um die grundlegenden Funktionen von goose zu demonstrieren.

1. Erstellen Sie ein Projektverzeichnis und initialisieren Sie das Modul:

mkdir goose-demo && cd goose-demo
go mod init goose-demo

2. Erstellen Sie ein Verzeichnis für die Migrationen:

mkdir migrations

3. Erstellen Sie die erste Migration in SQL. Datei migrations/001_create_users.sql:

-- +goose Up
CREATE TABLE users (
    id SERIAL PRIMARY KEY,
    name VARCHAR(255) NOT NULL,
    email VARCHAR(255) UNIQUE NOT NULL,
    created_at TIMESTAMP DEFAULT NOW()
);

-- +goose Down
DROP TABLE users;

4. Erstellen Sie die Datei main.go für den programmatischen Start der Migrationen:

package main

import (
    "database/sql"
    "embed"
    "log"

    "github.com/pressly/goose/v3"
    _ "github.com/lib/pq"
)

//go:embed migrations/*.sql
var migrations embed.FS

func main() {
    // Verbindung zur Datenbank herstellen
    db, err := sql.Open("postgres", "host=localhost port=5432 user=postgres password=postgres dbname=testdb sslmode=disable")
    if err != nil {
        log.Fatal(err)
    }
    defer db.Close()

    // Migrationsquelle aus embed.FS setzen
    goose.SetBaseFS(migrations)

    // Migrationen bis zur neuesten Version ausführen
    if err := goose.Up(db, "migrations"); err != nil {
        log.Fa