gormでデータベースに接続

ORMライブラリgormを使ってデータベースを操作します。

事前準備

データベースはMySQLを使うこととします。ライブラリをインストールします:

go get -u gorm.io/gorm
go get -u gorm.io/driver/mysql

実装例

CRUD操作の実装例を記載します。

データベース構築

下記docker-composeで構築されたデータベースを操作します:

docker-compose.yaml

services:
  eadb:
    image: mariadb:latest
    container_name: eadb
    ports:
      - 3306:3306
    volumes:
      - ./volumes/initdb.d:/docker-entrypoint-initdb.d
    environment:
      - MYSQL_ROOT_PASSWORD=password

volumes/initdb.d/create-database.sql

CREATE DATABASE eadb;
USE eadb;

CREATE TABLE users (
    id INT PRIMARY KEY AUTO_INCREMENT
    , name VARCHAR(8)
    , age INT
);

INSERT INTO users (
    name
    , age
) VALUES (
    'nob'
    , 13
);

アプリ実装

package main

import (
    "context"
    "fmt"

    "gorm.io/driver/mysql"
    "gorm.io/gorm"
)

func main() {

    db, err := connectDB()
    if err != nil {
        panic(err)
    }

    ctx := context.Background()

    // Select cf. https://gorm.io/docs/query.html
    users, err := gorm.G[Users](db).Where("name = ?", "nob").First(ctx)
    if err != nil {
        panic(err)
    }
    fmt.Println(users)

    // Update cf. https://gorm.io/docs/update.html
    if _, err = gorm.G[Users](db).Where(
        "name = ?",
        users.Name,
    ).Updates(
        ctx,
        Users{Age: 706},
    ); err != nil {
        panic(err)
    }

    // Insert cf. https://gorm.io/docs/create.html
    if err = gorm.G[Users](db).Create(ctx, &Users{Name: "nob2", Age: 13}); err != nil {
        panic(err)
    }

    // Select all cf. https://gorm.io/docs/query.html#Selecting-Specific-Fields
    var usersList []Users
    result := db.Find(&usersList)
    if result.Error != nil {
        panic(result.Error)
    }
    fmt.Println(usersList)

    // Delete cf. https://gorm.io/docs/delete.html
    if _, err = gorm.G[Users](db).Where("name = ?", "nob2").Delete(ctx); err != nil {
        panic(err)
    }
}

// データベースに接続します。
func connectDB() (*gorm.DB, error) {

    // データベース接続
    const (
        user     string = "root"
        password string = "password"
        domain   string = "localhost:3306"
        dbName   string = "eadb"
    )
    dsn := fmt.Sprintf("%s:%s@tcp(%s)/%s", user, password, domain, dbName)
    db, err := gorm.Open(mysql.Open(dsn), &gorm.Config{})
    if err != nil {
        panic(err)
    }

    return db, err
}

// usersテーブル向けのエンティティ構造体です。
type Users struct {
    Id   int    `gorm:"primaryKey"` // 管理ID
    Name string // ユーザ名
    Age  int    // 年齢
}

テスト

ライブラリをインストールします:

go get -u gorm.io/driver/sqlite

テスト向けデータベースへの接続設定を下記で作成します:

package test

import (
    "os"
    "testing"

    "gorm.io/driver/sqlite"
    "gorm.io/gorm"
)

// テスト用データベースに接続します。
func ConnectTestDB(t *testing.T, table string) *gorm.DB {

    dbfile := "gorm.db"

    // 各テストケースでテーブルを共有するように設定
    db, err := gorm.Open(sqlite.Open(dbfile), &gorm.Config{})
    if err != nil {
        t.Fatalf("failed to open in-memory db: %v", err)
    }

    // schema.sqlを読み込み・実行
    schema, err := os.ReadFile("test/data/" + table + "/schema.sql")
    if err != nil {
        t.Fatalf("failed to read schema: %v", err)
    }
    db.Exec(string(schema))

    // data.sqlを読み込み・実行
    data, err := os.ReadFile("test/data/" + table + "/data.sql")
    if err != nil {
        t.Fatalf("failed to read data: %v", err)
    }
    db.Exec(string(data))

    // テスト終了時にデータベース削除
    t.Cleanup(func() {
        os.Remove(dbfile)
        os.Remove(dbfile + "-journal")
    })

    return db
}

テスト関数については、標準ライブラリ利用時の*sql.DBを*gorm.DBに差し替えることで作成可能です。