はじめに

database/sql パッケージは、SQL (または SQLライクな) データベースに対する汎用的なインターフェースを提供します。詳細については、公式ドキュメントを参照してください。

このページでは、使用パターンの例を示します。

データベースドライバー

database/sql パッケージは、データベースドライバーと組み合わせて使用する必要があります。ドライバーのリストについては、https://go.dokyumento.jp/s/sqldrivers を参照してください。

以下のドキュメントでは、ドライバーがインポートされていることを前提としています。

データベースへの接続

Open はデータベースハンドルを作成するために使用されます。

db, err := sql.Open(driver, dataSourceName)

ここで driver はデータベースドライバーを指定し、dataSourceName はデータベース名や認証情報などのデータベース固有の接続情報を指定します。

Open はデータベース接続を直接開かないことに注意してください。これはクエリが実行されるまで延期されます。クエリを実行する前に接続が可能であることを確認するには、PingContext メソッドを使用します。

if err := db.PingContext(ctx); err != nil {
  log.Fatal(err)
}

使用後、データベースは Close を使用して閉じられます。

クエリの実行

行が返されないクエリには ExecContext が使用されます。

result, err := db.ExecContext(ctx,
    "INSERT INTO users (name, age) VALUES ($1, $2)",
    "gopher",
    27,
)

ここで result には、最後に挿入されたIDと影響を受けた行数が含まれます。これらの値の利用可能性は、データベースドライバーに依存します。

取得には QueryContext が使用されます。

rows, err := db.QueryContext(ctx, "SELECT name FROM users WHERE age = $1", age)
if err != nil {
    log.Fatal(err)
}
defer rows.Close()
for rows.Next() {
    var name string
    if err := rows.Scan(&name); err != nil {
        log.Fatal(err)
    }
    fmt.Printf("%s is %d\n", name, age)
}
if err := rows.Err(); err != nil {
    log.Fatal(err)
}

単一の行のみが期待される場合は QueryRowContext が使用されます。

var age int64
err := db.QueryRowContext(ctx, "SELECT age FROM users WHERE name = $1", name).Scan(&age)

プリペアドステートメントは PrepareContext で作成できます。

age := 27
stmt, err := db.PrepareContext(ctx, "SELECT name FROM users WHERE age = $1")
if err != nil {
    log.Fatal(err)
}
rows, err := stmt.Query(age)
// process rows

ステートメントに対して ExecContext、QueryContext、QueryRowContext を呼び出すことができます。使用後、ステートメントは Close で閉じる必要があります。

トランザクション

トランザクションは BeginTx で開始されます。

tx, err := db.BeginTx(ctx, nil)
if err != nil {
    log.Fatal(err)
}

既に説明した ExecContext、QueryContext、QueryRowContext、PrepareContext メソッドはトランザクション内で使用できます。

トランザクションは Commit または Rollback の呼び出しで終了する必要があります。

NULLの扱い

データベースの列がNULL可能である場合、NULL値をサポートする型をScanに渡す必要があります。

例えば、namesテーブルのname列がNULL可能である場合

var name sql.NullString
err := db.QueryRowContext(ctx, "SELECT name FROM names WHERE id = $1", id).Scan(&name)
...
if name.Valid {
    // use name.String
} else {
    // value is NULL
}

database/sql で実装されているのは、NullByte、NullBool、NullFloat64、NullInt64、NullInt32、NullInt16、NullTime のみです。データベース固有のNULL型の実装はデータベースドライバーに任されています。NULL をサポートするユーザー型は、database/sql/driver.Valuer および database/sql.Scanner インターフェースを実装することで作成できます。

ポインタ型を渡すこともできます。余分なメモリ割り当てが必要になるため、パフォーマンスの問題に注意してください。

var name *string
err := db.QueryRowContext(ctx, "SELECT name FROM names WHERE id = $1", id).Scan(&name)

テーブルの取得

SQLクエリから構造体配列を取得したい場合。

func getTable[T any](rows *sql.Rows) (out []T) {
    var table []T
    for rows.Next() {
        var data T
        s := reflect.ValueOf(&data).Elem()
        numCols := s.NumField()
        columns := make([]interface{}, numCols)

        for i := 0; i < numCols; i++ {
            field := s.Field(i)
            columns[i] = field.Addr().Interface()
        }

        if err := rows.Scan(columns...); err != nil {
            fmt.Println("Case Read Error ", err)
        }

        table = append(table, data)
    }
    return table
}

データベースからのNULL値の処理を忘れないでください。

type User struct {
  UUID  sql.NullString
  Name  sql.NullString
}

rows, err := db.Query("SELECT * FROM Users")
cases := getTable[User](rows)