go-mssqldbでsqlxを使う

SQLx は、Goの database/sql を拡張し、構造体スキャン、名前付きパラメータバインディング、クエリヘルパーを備えた軽量ライブラリです。 database/sqlを含むどのgo-mssqldbドライバーでも動作します。

ORMとは異なり、SQLxはSQLを生成したりスキーマを管理したりしません。 クエリを書くと、SQLxが結果セットとGo構造体のマッピングを担当します。 このバランスが、フルORMの抽象化を避けつつ、生の定型 database/sql を抑えたいときに適しています。

この記事の例は AdventureWorks2025 のサンプルデータベースと比較しています。

sqlxをインストールする

Goモジュールを作成または開いてから sqlx と go-mssqldbを加えます。

mkdir go-sqlx-sqlserver
cd go-sqlx-sqlserver
go mod init example.com/go-sqlx-sqlserver
go get github.com/jmoiron/sqlx
go get github.com/microsoft/go-mssqldb

SQL Serverに接続する

sqlx.Open を使用して、sqlserver ドライバー名で接続を開きます:

package main

import (
    "fmt"
    "log"

    "github.com/jmoiron/sqlx"
    _ "github.com/microsoft/go-mssqldb"
)

func main() {
    // Replace <server>, <user>, and <password> with your own values.
    // In production, load credentials from environment variables or a secret store.
    dsn := "sqlserver://<user>:<password>@<server>.database.windows.net:1433?database=AdventureWorks2025&encrypt=true&TrustServerCertificate=false"
    db, err := sqlx.Open("sqlserver", dsn)
    if err != nil {
        log.Fatal(err)
    }
    defer db.Close()

    if err := db.Ping(); err != nil {
        log.Fatal(err)
    }
    fmt.Println("Connected to SQL Server with sqlx")
}

sqlx.Openは標準*sqlx.DBをラップする*sql.DBを返します。 すべての database/sql メソッドは今でも動作し、この記事で説明しているSQLx拡張も使えます。

SelectとGetによる構造体スキャン

SQLXが生 database/sql に比べて持つ主な利点は自動構造スキャニングです。 dbタグ付きで列を構造体フィールドにマッピングします:

type Product struct {
    ProductID int32   `db:"ProductID"`
    Name      string  `db:"Name"`
    ListPrice float64 `db:"ListPrice"`
}

複数行を選択する

Select すべての結果行をスライス・オブ・ストラクチャーにスキャンします:

var products []Product
err := db.Select(&products,
    "SELECT TOP 5 ProductID, Name, ListPrice FROM Production.Product WHERE ListPrice > @p1 ORDER BY ListPrice DESC",
    sql.Named("p1", 1000))
if err != nil {
    log.Fatal(err)
}
for _, p := range products {
    fmt.Printf("%-35s $%.2f\n", p.Name, p.ListPrice)
}

Select クエリを実行し、すべての行を構造体にスキャンし、行のイテレータを閉じます。 Query / for rows.Next() / rows.Scan()パターンに代わるものです。

1段にしてください

Get 最初の行を単一の構造体にスキャンします:

var product Product
err := db.Get(&product,
    "SELECT ProductID, Name, ListPrice FROM Production.Product WHERE ProductID = @p1",
    sql.Named("p1", 680))
if err != nil {
    log.Fatal(err)
}
fmt.Printf("%s: $%.2f\n", product.Name, product.ListPrice)

Get クエリが行を返さない場合、 sql.ErrNoRows を返します。 複数の行が一致する場合は、最初の行のみをスキャンします。

名前付きパラメーター

SQLXはマップや構造体をパラメータソースとして使う、 :name スタイルの命名パラメータをサポートしています。 ただし、go-mssqldbは@nameパラメータをネイティブに使っているため、SQL Serverには前述の例のように標準のsql.Namedプレースホルダー付き@p1を用いてください。

もしSQLxの :name 構文を好むなら、 sqlx.Named を使ってリバインドしてください:

query, args, err := sqlx.Named(
    "SELECT ProductID, Name, ListPrice FROM Production.Product WHERE ProductID = :id",
    map[string]interface{}{"id": 680})
if err != nil {
    log.Fatal(err)
}
// Rebind to positional placeholders for go-mssqldb
query = db.Rebind(query)

var product Product
err = db.Get(&product, query, args...)
if err != nil {
    log.Fatal(err)
}
fmt.Printf("%s: $%.2f\n", product.Name, product.ListPrice)

Note

sqlx.Named :nameプレースホルダーを位置?パラメータに変換します。 Rebind その後、 ? をターゲットドライバーのフォーマットに変換します。 ドライバー間で名前付きパラメータを移植したい場合、この2ステップ方式を活用してください。

IN条項の拡張

可変個の値を含むWHERE column IN (...)句を構築するのは、生SQLでは面倒です。 sqlx.Inを使ってスライスを個別のプレースホルダーに展開します:

ids := []int32{680, 706, 707}
query, args, err := sqlx.In(
    "SELECT ProductID, Name, ListPrice FROM Production.Product WHERE ProductID IN (?)", ids)
if err != nil {
    log.Fatal(err)
}
query = db.Rebind(query)

var products []Product
err = db.Select(&products, query, args...)
if err != nil {
    log.Fatal(err)
}
for _, p := range products {
    fmt.Printf("%d: %s ($%.2f)\n", p.ProductID, p.Name, p.ListPrice)
}

sqlx.In 単一 ? を ?, ?, ? に展開し、スライスをARGSリストにフラット化します。 Rebind その後、ドライバーのプレースホルダー形式に変換されます。

書き込みを実行する

Exec、INSERT、UPDATE文にはDELETEを使いましょう。 これらの例は重要なテーブルを改変しない Production.ScrapReason を対象としています。

注意事項

SQLXはエラーを返す代わりにパニック状態に陥る MustExecも提供しています。 本番サービスでの MustExec は避けてください。回復しないパニックがプロセスを終了させてしまうからです。 この節の例では、明示的なエラーチェックを伴う Exec を用いています。

行を挿入してください

Exec を INSERT 文と名前付きパラメータで使います:

result, err := db.Exec(
    "INSERT INTO Production.ScrapReason (Name, ModifiedDate) VALUES (@p1, @p2)",
    sql.Named("p1", "sqlx test scrap"), sql.Named("p2", time.Now()))
if err != nil {
    log.Fatal(err)
}
affected, _ := result.RowsAffected()
fmt.Printf("Inserted %d row(s)\n", affected)

// Clean up
db.Exec("DELETE FROM Production.ScrapReason WHERE Name = @p1",
    sql.Named("p1", "sqlx test scrap"))

sqlxを用いたトランザクション

トランザクション内でのラップ操作は以下の Beginx を用います:

tx, err := db.Beginx()
if err != nil {
    log.Fatal(err)
}
defer tx.Rollback() // no-op after Commit, but essential if an error occurs

if _, err := tx.Exec(
    "INSERT INTO Production.ScrapReason (Name, ModifiedDate) VALUES (@p1, @p2)",
    sql.Named("p1", "sqlx tx scrap 1"), sql.Named("p2", time.Now())); err != nil {
    log.Fatal(err)
}
if _, err := tx.Exec(
    "INSERT INTO Production.ScrapReason (Name, ModifiedDate) VALUES (@p1, @p2)",
    sql.Named("p1", "sqlx tx scrap 2"), sql.Named("p2", time.Now())); err != nil {
    log.Fatal(err)
}

if err := tx.Commit(); err != nil {
    log.Fatal(err)
}
fmt.Println("Transaction committed")

// Clean up
db.Exec("DELETE FROM Production.ScrapReason WHERE Name IN (@p1, @p2)",
    sql.Named("p1", "sqlx tx scrap 1"), sql.Named("p2", "sqlx tx scrap 2"))

defer tx.Rollback()コールは、いずれかの操作が失敗した場合にトランザクションがクリーンアップされることを保証します。 Commit が成功した後は、Rollback は安全な no-op です。 txオブジェクトはトランザクションにスコープを持つすべてのSQLxヘルパー(Select、Get、Exec)を提供します。

結合を伴う構造体スキャン

SQLXは、結合クエリからカラムをフラット構造体や組み込み構造体にスキャンすることができます。

type ProductWithCategory struct {
    ProductID    int32   `db:"ProductID"`
    ProductName  string  `db:"ProductName"`
    CategoryName string  `db:"CategoryName"`
    ListPrice    float64 `db:"ListPrice"`
}

var results []ProductWithCategory
err := db.Select(&results, `
    SELECT TOP 5
        p.ProductID,
        p.Name AS ProductName,
        pc.Name AS CategoryName,
        p.ListPrice
    FROM Production.Product p
    JOIN Production.ProductSubcategory ps ON p.ProductSubcategoryID = ps.ProductSubcategoryID
    JOIN Production.ProductCategory pc ON ps.ProductCategoryID = pc.ProductCategoryID
    WHERE p.ListPrice > @p1
    ORDER BY p.ListPrice DESC`,
    sql.Named("p1", 1000))
if err != nil {
    log.Fatal(err)
}
for _, r := range results {
    fmt.Printf("%-35s %-15s $%.2f\n", r.ProductName, r.CategoryName, r.ListPrice)
}

いつSQLX、GORM、またはデータベース/SQLを選ぶべきか

選択。。。 最適なタイミングで
database/sql ドライバー以外の依存関係は一切持たせないか、すべてのクエリを完全にコントロールする必要があります。
SQLx ORMの抽象化レイヤーを使わずに、structスキャンやクエリヘルパーが欲しいです。
GORM スキーマ管理、アソシエーション、フック、そして完全なORM機能セットが必要です。