Cara menggunakan migrasi dengan Golang

Aplikasi contoh mudah yang menunjukkan cara menggunakan golang-migrate

Mengapa anda perlu menggunakan migrasi?

Ramai orang bertanya soalan ini dan saya telah cuba membuat senarai ini untuk menyerlahkan kelebihan utama tentang penggunaan migrasi:

Kawalan Versi: Salah satu yang utama dan paling penting ialah dapat memiliki versi pengubahsuaian berbeza skema pangkalan data. Tanpa migrasi, perubahan skema ini akan menjadi tidak koheren dan mustahil untuk dijejaki, yang akan menyebabkan masalah versi dan kemungkinan ralat.

Kembali: Sistem tarik balik sentiasa diperlukan sekiranya berlaku sebarang kegagalan. Sistem migrasi sentiasa mempunyai dua kaedah untuk menggunakan perubahan dalam pangkalan data dan menurunkan bertanggungjawab untuk mengembalikan perubahan dengan cepat dan konsisten :-)

Automasi dan Penyepaduan CI/CD: Migrasi boleh diautomasikan, membolehkan mereka menjadi sebahagian daripada saluran paip CI/CD. Ini membantu dalam melaksanakan perubahan dengan lancar dan konsisten tanpa campur tangan manual.

Kita boleh temui banyak lagi kelebihan tetapi saya rasa perkara ini mewakili ringkasan yang baik tentang kelebihan utama.

Bagaimana untuk melaksanakan migrasi di Golang?

Go tidak menyokong migrasi secara asli untuk propuso itu, kita boleh menggunakan pakej golang-migrate yang popular juga jika anda menggunakan ORM seperti GORM anda boleh menggunakannya untuk itu.

Kedua-dua pakej sangat popular tetapi dalam contoh ini saya akan menggunakan golang-migrate kerana saya tidak berminat untuk melaksanakan ORM.

Tunjukkan kod itu!

Mari kita lihat langkah demi langkah cara melaksanakan aplikasi mudah untuk melihat cara ia digunakan.

Untuk mengikuti artikel ini, anda memerlukan: Pergi dan Docker dengan Docker Compose

Infrastruktur

Buat fail docker-compose.yml dalam direktori akar anda di mana kami akan menentukan DB kegemaran anda, dalam kes saya gunakan MariaDB tetapi jangan ragu untuk menggunakan yang lain.

services:
  mariadb:
    image: mariadb:11.5.2
    container_name: mariadb_example_go_migration
    ports:
      - "3306:3306"
    environment:
      - MYSQL_DATABASE=app
      - MYSQL_ROOT_PASSWORD=root
      - TZ=Europe/Berlin
    volumes:
      - mariadbdata:/var/lib/mysql

volumes:
  mariadbdata:
    driver: local

docker compose up -d 

Jika anda lebih suka, anda boleh menggunakan Docker secara langsung dan bukannya docker-compose:

docker volume create -d local mariadbdata
docker run --name mariadb_example_go_migration -p 3306:3306 -e MYSQL_DATABASE=app -e MYSQL_ROOT_PASSWORD=root -e TZ=Europe/Berlin -v mariadbdata:/var/lib/mysql mariadb:11.5.2

Nilai persekitaran

Buat atau kemas kini fail .env dalam direktori akar anda di mana anda perlu menentukan pembolehubah untuk menyambungkan pangkalan data kami.

DATABASE_DSN=root:root@tcp(localhost:3306)/app

Buat aplikasi golang mudah

Buat aplikasi golang mudah untuk memastikan sambungan DB berjaya dan senaraikan semua jadual dan struktur dalam pangkalan data dengan strukturnya. cmd/main.go

package main

import (
 "database/sql"
 "fmt"
 "log"
 "os"
 "text/tabwriter"

 _ "github.com/go-sql-driver/mysql"
 "github.com/joho/godotenv"
)

func main() {
 // Load .env variables
 err := godotenv.Load()
 if err != nil {
  log.Fatal("Error loading .env file")
 }

 // Open connection with MySQL DB
 db, err := sql.Open("mysql", os.Getenv("DATABASE_DSN"))
 if err != nil {
  log.Fatalf("Error opening database: %v\n", err)
 }
 defer db.Close()

 // Ensure that the connection works
 err = db.Ping()
 if err != nil {
  log.Fatalf("Error connecting database: %v\n", err)
 }

 fmt.Println("Connected to database")

 // Execute the SHOW TABLES query to list all tables in the database
 tables, err := db.Query("SHOW TABLES")
 if err != nil {
  log.Fatalf("Failed to execute SHOW TABLES query: %v\n", err)
 }
 defer tables.Close()

 fmt.Println("Database structure:")

 for tables.Next() {
  var tableName string
  if err := tables.Scan(&tableName); err != nil {
   log.Fatalf("Failed to scan table name: %v\n", err)
  }

  w := tabwriter.NewWriter(os.Stdout, 0, 0, 2, ' ', tabwriter.Debug)

  fmt.Printf("\n[Table: %s]\n\n", tableName)
  fmt.Fprintf(w, "%s\t%s\t%s\t%s\t%s\t%s\t\n", "Field", "Type", "Null", "Key", "Default", "Extra")

  // Get the structure of the current table
  structureQuery := fmt.Sprintf("DESCRIBE %s", tableName)
  columns, err := db.Query(structureQuery)
  if err != nil {
   log.Fatalf("Failed to describe table %s: %v\n", tableName, err)
  }
  defer columns.Close()

  for columns.Next() {
   var field, colType, null, key, defaultVal, extra sql.NullString
   err := columns.Scan(&field, &colType, &null, &key, &defaultVal, &extra)
   if err != nil {
    log.Fatalf("Failed to scan column: %v\n", err)
   }

   fmt.Fprintf(w, "%s\t%s\t%s\t%s\t%s\t%s\t\n",
    field.String, colType.String, null.String, key.String, defaultVal.String, extra.String)
  }

  w.Flush()
 }
}

Dan apabila kita menjalankannya, kita mempunyai output yang serupa:

Berhijrah CLI

Untuk menjalankan golang-migrate CLI pada asasnya anda mempunyai dua kaedah memasang CLI secara setempat atau menjalankan imej Docker rasmi: migrate/migrate.

Secara peribadi saya lebih suka varian de docker tetapi dalam tutorial ini menggambarkan kedua-dua varian.

Bagaimana untuk menjana migrasi

Langkah pertama ialah mencipta migrasi kosong dengan arahan seterusnya.

services:
  mariadb:
    image: mariadb:11.5.2
    container_name: mariadb_example_go_migration
    ports:
      - "3306:3306"
    environment:
      - MYSQL_DATABASE=app
      - MYSQL_ROOT_PASSWORD=root
      - TZ=Europe/Berlin
    volumes:
      - mariadbdata:/var/lib/mysql

volumes:
  mariadbdata:
    driver: local

docker compose up -d 

docker volume create -d local mariadbdata
docker run --name mariadb_example_go_migration -p 3306:3306 -e MYSQL_DATABASE=app -e MYSQL_ROOT_PASSWORD=root -e TZ=Europe/Berlin -v mariadbdata:/var/lib/mysql mariadb:11.5.2

• ext: Sambungan fail yang akan dijana.
• dir: Direktori tempat penghijrahan kami akan dibuat.
• seq: Nama jujukan migrasi.

Arahan ini akan menghasilkan dua fail kosong pada pangkalan data/migrasi/ folder: 000001createuserstable.up.sql dan 000001createuserstable.down.sql

Pada fail 000001createuserstable.up.sql tentukan SQL untuk membuat pengguna jadual:

DATABASE_DSN=root:root@tcp(localhost:3306)/app

Pada fail 000001createuserstable.down.sql tentukan SQL untuk mengembalikan semua perubahan yang dibuat oleh atas, dalam kes ini kita perlu memadamkan jadual pengguna:

package main

import (
 "database/sql"
 "fmt"
 "log"
 "os"
 "text/tabwriter"

 _ "github.com/go-sql-driver/mysql"
 "github.com/joho/godotenv"
)

func main() {
 // Load .env variables
 err := godotenv.Load()
 if err != nil {
  log.Fatal("Error loading .env file")
 }

 // Open connection with MySQL DB
 db, err := sql.Open("mysql", os.Getenv("DATABASE_DSN"))
 if err != nil {
  log.Fatalf("Error opening database: %v\n", err)
 }
 defer db.Close()

 // Ensure that the connection works
 err = db.Ping()
 if err != nil {
  log.Fatalf("Error connecting database: %v\n", err)
 }

 fmt.Println("Connected to database")

 // Execute the SHOW TABLES query to list all tables in the database
 tables, err := db.Query("SHOW TABLES")
 if err != nil {
  log.Fatalf("Failed to execute SHOW TABLES query: %v\n", err)
 }
 defer tables.Close()

 fmt.Println("Database structure:")

 for tables.Next() {
  var tableName string
  if err := tables.Scan(&tableName); err != nil {
   log.Fatalf("Failed to scan table name: %v\n", err)
  }

  w := tabwriter.NewWriter(os.Stdout, 0, 0, 2, ' ', tabwriter.Debug)

  fmt.Printf("\n[Table: %s]\n\n", tableName)
  fmt.Fprintf(w, "%s\t%s\t%s\t%s\t%s\t%s\t\n", "Field", "Type", "Null", "Key", "Default", "Extra")

  // Get the structure of the current table
  structureQuery := fmt.Sprintf("DESCRIBE %s", tableName)
  columns, err := db.Query(structureQuery)
  if err != nil {
   log.Fatalf("Failed to describe table %s: %v\n", tableName, err)
  }
  defer columns.Close()

  for columns.Next() {
   var field, colType, null, key, defaultVal, extra sql.NullString
   err := columns.Scan(&field, &colType, &null, &key, &defaultVal, &extra)
   if err != nil {
    log.Fatalf("Failed to scan column: %v\n", err)
   }

   fmt.Fprintf(w, "%s\t%s\t%s\t%s\t%s\t%s\t\n",
    field.String, colType.String, null.String, key.String, defaultVal.String, extra.String)
  }

  w.Flush()
 }
}

Cara memohon migrasi

Perintah berikut menggunakan semua migrasi yang belum selesai. Anda juga boleh menentukan bilangan migrasi untuk digunakan dengan menambah nombor selepas naik.

#CLI variant
migrate create -ext sql -dir ./database/migrations -seq create_users_table

#Docker CLI variant
docker run --rm -v $(pwd)/database/migrations:/migrations migrate/migrate \
    create -ext sql -dir /migrations -seq create_users_table

• laluan: Laluan ke direktori migrasi.
• pangkalan data: Tentukan sambungan DSN pangkalan data anda.

NOTA : Apabila menjalankan penghijrahan buat kali pertama jadual "schema_migrations" akan dibuat di mana penghijrahan mengetahui nombor versi yang digunakan.

Dan jalankan aplikasi Golang kami untuk memaparkan keputusan:

Menambah penghijrahan baharu

Tambah telefon lajur baharu pada jadual pengguna

CREATE TABLE `users` (
    `id` VARCHAR(36) NOT NULL PRIMARY KEY,
    `name` VARCHAR(255) NOT NULL,
    `email` VARCHAR(255) NOT NULL UNIQUE,
    `password` VARCHAR(255) NOT NULL
);

DROP TABLE IF EXISTS `users`;

#CLI variant
migrate -path=./database/migrations -database "mysql://root:root@tcp(localhost:3306)/app" up

#Docker CLI variant
docker run --rm -v $(pwd)/database/migrations:/migrations --network host migrate/migrate \
    -path=/migrations -database "mysql://root:root@tcp(localhost:3306)/app" up

Dan apabila anda menjalankannya dari aplikasi Golang kami, anda boleh melihat medan baharu:

Bagaimana untuk mengembalikan penghijrahan

Dengan arahan berikut, kami boleh melancarkan semula yang digunakan dengan mudah. penghijrahan. Dalam contoh berikut, kita dapat melihat cara kita membalikkan penghijrahan terakhir yang digunakan:

#CLI variant
migrate create -ext sql -dir ./database/migrations -seq add_column_phone

#Docker CLI variant
docker run --rm -v $(pwd)/database/migrations:/migrations migrate/migrate \
    create -ext sql -dir /migrations -seq add_column_phone

-- 000002_add_column_phone.up.sql
ALTER TABLE `users` ADD `phone` VARCHAR(255) NULL;

AMARAN : Jika anda tidak mentakrifkan bilangan migrasi, GOLONG SEMULA akan digunakan pada SEMUA MIGRASI!

Dan kemudian kita boleh menunjukkan bahawa penghijrahan terakhir telah dibalikkan dan medan telefon telah dialih keluar :-)

Cara Menyelesaikan Ralat Migrasi

Jika penghijrahan mengandungi ralat dan dilaksanakan, penghijrahan itu tidak boleh digunakan dan sistem penghijrahan akan menghalang sebarang penghijrahan selanjutnya pada pangkalan data sehingga penghijrahan ini dibetulkan.

Dan apabila cuba memohon kami akan mendapat mesej seperti ini:

services:
  mariadb:
    image: mariadb:11.5.2
    container_name: mariadb_example_go_migration
    ports:
      - "3306:3306"
    environment:
      - MYSQL_DATABASE=app
      - MYSQL_ROOT_PASSWORD=root
      - TZ=Europe/Berlin
    volumes:
      - mariadbdata:/var/lib/mysql

volumes:
  mariadbdata:
    driver: local

docker compose up -d 

Jangan panik, tidak sukar untuk kembali kepada sistem yang konsisten.

Mula-mula kita perlu menyelesaikan migrasi yang rosak, dalam kes ini versi 2.

Setelah migrasi diselesaikan, kami perlu memaksa sistem ke versi sah terakhir, dalam kes ini versi 1.

docker volume create -d local mariadbdata
docker run --name mariadb_example_go_migration -p 3306:3306 -e MYSQL_DATABASE=app -e MYSQL_ROOT_PASSWORD=root -e TZ=Europe/Berlin -v mariadbdata:/var/lib/mysql mariadb:11.5.2

DATABASE_DSN=root:root@tcp(localhost:3306)/app

Dan kini anda boleh memohon semula migrasi tanpa sebarang masalah ;-)

Makefile

Untuk meningkatkan produktiviti kami dan memudahkan penggunaan arahan ini, kami boleh menggunakan Makefile. Di bawah anda boleh melihat dua varian: klien asli dan buruh pelabuhan.

Varian CLI

package main

import (
 "database/sql"
 "fmt"
 "log"
 "os"
 "text/tabwriter"

 _ "github.com/go-sql-driver/mysql"
 "github.com/joho/godotenv"
)

func main() {
 // Load .env variables
 err := godotenv.Load()
 if err != nil {
  log.Fatal("Error loading .env file")
 }

 // Open connection with MySQL DB
 db, err := sql.Open("mysql", os.Getenv("DATABASE_DSN"))
 if err != nil {
  log.Fatalf("Error opening database: %v\n", err)
 }
 defer db.Close()

 // Ensure that the connection works
 err = db.Ping()
 if err != nil {
  log.Fatalf("Error connecting database: %v\n", err)
 }

 fmt.Println("Connected to database")

 // Execute the SHOW TABLES query to list all tables in the database
 tables, err := db.Query("SHOW TABLES")
 if err != nil {
  log.Fatalf("Failed to execute SHOW TABLES query: %v\n", err)
 }
 defer tables.Close()

 fmt.Println("Database structure:")

 for tables.Next() {
  var tableName string
  if err := tables.Scan(&tableName); err != nil {
   log.Fatalf("Failed to scan table name: %v\n", err)
  }

  w := tabwriter.NewWriter(os.Stdout, 0, 0, 2, ' ', tabwriter.Debug)

  fmt.Printf("\n[Table: %s]\n\n", tableName)
  fmt.Fprintf(w, "%s\t%s\t%s\t%s\t%s\t%s\t\n", "Field", "Type", "Null", "Key", "Default", "Extra")

  // Get the structure of the current table
  structureQuery := fmt.Sprintf("DESCRIBE %s", tableName)
  columns, err := db.Query(structureQuery)
  if err != nil {
   log.Fatalf("Failed to describe table %s: %v\n", tableName, err)
  }
  defer columns.Close()

  for columns.Next() {
   var field, colType, null, key, defaultVal, extra sql.NullString
   err := columns.Scan(&field, &colType, &null, &key, &defaultVal, &extra)
   if err != nil {
    log.Fatalf("Failed to scan column: %v\n", err)
   }

   fmt.Fprintf(w, "%s\t%s\t%s\t%s\t%s\t%s\t\n",
    field.String, colType.String, null.String, key.String, defaultVal.String, extra.String)
  }

  w.Flush()
 }
}

Varian CLI Docker

#CLI variant
migrate create -ext sql -dir ./database/migrations -seq create_users_table

Repositori

Kod untuk tutorial ini boleh didapati di umum: GitHub - albertcolom/example-go-migration

---

Asal diterbitkan di: albertcolom.com

Atas ialah kandungan terperinci Cara menggunakan migrasi dengan Golang. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!