Go のクエリビルダー goqu 入門

36514 ワード

テキストリンク

はじめに

この記事では Go のクエリビルダーである goqu の基本的な使い方を紹介したいと思います。

この記事が他の人の参考になったら幸いです。
また、この記事の内容に間違った記載がありましたら、指摘してもらえるとありがたいです。

goqu とは

goqu は表現力豊かな SQL ビルダーです。また、SQL を実行することもできます。複数の SQL 方言に対応しており、複数のレコードをスキャンして構造体やプリミティブ値にマッピングする機能もあります。

しかし、goqu は ORM として使用されることを意図したものではないので、アソシエーションやフックの機能はありません。そのような機能が欲しい場合は GORM や Hood を使用することが推奨されています。

このように goqu は単純な機能に集中した SQL ビルダーです。そのため私のように SQL を文字列として直接書くのは面倒臭いが、GORM などは機能が複雑で難しいと感じた人にピッタリな SQL ビルダーだと思います。

ここからは goqu を使って基本的な CRUD の SQL を生成する方法について紹介します。記載するコードは Dialect を使用して MySQL 用の SQL を生成します。直接構造体をスキャンしたり、SQL を実行したい場合は公式ドキュメントの Database を参照して下さい。

共通 DSL

goqu はそれぞれ InsertDataset、SelectDataset など各データセット構造体から .ToSQL メソッドで SQL を生成するところはどんな SQL を生成する場合でも共通です。
プリペアドステートメントを利用したい場合は .Prepare メソッドを利用します。

func main() {
	dialect := goqu.Dialect("mysql")
	sql1, args1, err := dialect.From("users").Select("first_name").Where(goqu.C("id").Eq(1)).ToSQL()
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(sql1, args1)
	// SELECT `first_name` FROM `users` WHERE (`id` = 1) []

	sql2, args2, err := dialect.From("users").Select("first_name").Where(goqu.C("id").Eq(1)).Prepared(true).ToSQL()
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(sql2, args2)
	// SELECT `first_name` FROM `users` WHERE (`id` = ?) [1]
}

ToSQL メソッドの戻り値の sql は string 型の文字列であり、args は interface{} 型のスライスです。

INSERT 句を生成する

goqu で INSERT 句を生成する方法は複数あります。そのうちよく使用するものをここでは取り上げます。
他の方法は Inserting を参照して下さい。

`.Cols`、`.Vals` で INSERT 句を生成する

.Cols、.Vals メソッドを使用して INSERT 句を生成する方法です。
この方法はレコードの値を並べられるので、複数のレコードを挿入する際に便利です。

.Insert メソッドの引数にはテーブル名を渡します。

func main() {
	dialect := goqu.Dialect("mysql")
	sql, _, err := dialect.Insert("users").Cols("first_name", "last_name", "age").Vals(
		goqu.Vals{"Yamada", "Taro", 20},
		goqu.Vals{"Yamada", "Hanako", 30},
	).ToSQL()
	fmt.Println(sql)
	// INSERT INTO `users` (`first_name`, `last_name`, `age`) VALUES ('Yamada', 'Taro', 20), ('Yamada', 'Hanako', 30)
}

`goqu.Record` で INSERT 句を生成する

goqu.Record を使用して INSERT 句を生成する方法です。
この方法はカラムと対応する値を分かりやすく書けます。

func main() {
	dialect := goqu.Dialect("mysql")
	sql, _, err := dialect.Insert("users").Rows(
		goqu.Record{"first_name": "Yamada", "last_name": "Taro", "age": 20},
		goqu.Record{"first_name": "Yamada", "last_name": "Hanako", "age": 30},
	).ToSQL()
	fmt.Println(sql)
	// INSERT INTO `users` (`age`, `first_name`, `last_name`) VALUES (20, 'Yamada', 'Taro'), (30, 'Yamada', 'Hanako')
}

構造体で INSERT 句を生成する

構造体と db タグを使用して INSERT 句を生成する方法です。
この方法は DB のテーブルに対応する構造体を使用する場合にとても便利です。

構造体はフィールドをエクスポートし、db タグで対応するテーブルのカラム名を指定します。
db タグの値を - にするとフィールドがエクスポートされていても goqu から無視されます。
goqu タグはその他のオプションを利用する場合に使用します。
skipinsert は挿入時にそのフィールドを無視し、defaultifempty はそのフィールドの値がゼロ値であった場合に DEFAULT を使用します。

type User struct {
	ID        int    `db:"id"  goqu:"skipinsert"`
	FirstName string `db:"first_name" goqu:"defaultifempty"`
	LastName  string `db:"last_name"`
	Age       int    `db:"age"`
	Address   string `db:"-"`
}

func main() {
	user1 := User{
		FirstName: "Yamada",
		LastName:  "Taro",
		Age:       20,
		Address:   "Japan",
	}
	dialect := goqu.Dialect("mysql")
	sql, _, err := dialect.Insert("users").Rows(
		user1,
		User{
			LastName: "Hanako",
			Age:      30,
			Address:  "Japan",
		},
	).ToSQL()
	fmt.Println(sql)
	// INSERT INTO `users` (`age`, `first_name`, `last_name`) VALUES (20, 'Yamada', 'Taro'), (30, DEFAULT, 'Hanako')
}

SELECT 句を生成する

goqu で SELECT 句を生成するには .From、.Select メソッドを使用します。
上記のメソッドに加えて .Where、Limit、Offset メソッドを使用することで目的に叶う SQL を生成します。
また、複雑な SELECT 句も goqu は生成できますが、ここでは紹介しきれないので詳しくは Selecting を参照して下さい。列を構造体にマッピングする ScanStruct なども先のドキュメントに記載されています。

基本的な SELECT 句は以下のようになります。
.From メソッドの引数にはテーブル名を渡します。
構造体のポインタを渡すことで構造体のフィールドを全て指定できます。
ただし、db タグの値が - の場合は無視され、フィールドはアルファベット順に並ぶことに注意して下さい。

type User struct {
	ID        int    `db:"id"  goqu:"skipinsert"`
	FirstName string `db:"first_name" goqu:"defaultifempty"`
	LastName  string `db:"last_name"`
	Age       int    `db:"age"`
	Address   string `db:"-"`
}

func main() {
	dialect := goqu.Dialect("mysql")
	sql1, _, err := dialect.From("users").Select("first_name", "last_name", "age").Where(goqu.C("age").Eq(20)).ToSQL()
	fmt.Println(sql1)
	// -> SELECT `first_name`, `last_name`, `age` FROM `users` WHERE (`age` = 20)

	sql2, _, err := dialect.From("users").Select(&User{}).Where(
		goqu.C("first_name").Eq("Taro"),
		goqu.C("age").Gt(20),
		goqu.C("created_at").IsNotNull(),
	).ToSQL()
	fmt.Println(sql2)
	// SELECT `age`, `first_name`, `id`, `last_name` FROM `users` WHERE ((`first_name` = 'Taro') AND (`age` > 20) AND (`created_at` IS NOT NULL))
}

また、.Where メソッドを重ねることもできます。

func main() {
	dialect := goqu.Dialect("mysql")
	sql, _, err := dialect.From("users").Select("first_name", "last_name", "age").
		Where(goqu.C("age").Eq(20)).
		Where(goqu.C("age").IsNull()).
		ToSQL()
	fmt.Println(sql)
	// SELECT `first_name`, `last_name`, `age` FROM `users` WHERE ((`age` = 20) AND (`age` IS NULL))
}

Update 句を生成する

goqu で Update 句を生成するには .Update、.Set メソッドを使用します。
セットする値の指定には主に goqu.Record か構造体を使用します。

.Update メソッドの引数にテーブル名を渡します。
Insert 句を生成する場合と同様に構造体のフィールドに db、goqu タグを使用できます。
goqu タグの skipupdate は Update 句の生成時にそのフィールド値を無視します。

type User struct {
	ID        int    `db:"id"  goqu:"skipinsert,skipupdate"`
	FirstName string `db:"first_name" goqu:"defaultifempty"`
	LastName  string `db:"last_name"`
	Age       int    `db:"age"`
	Address   string `db:"-"`
}

func main() {
	dialect := goqu.Dialect("mysql")
	sql1, _, err := dialect.Update("users").Set(
		goqu.Record{"first_name": "Jiro", "last_name": "Sato"},
	).ToSQL()
	fmt.Println(sql1)
	// UPDATE `users` SET `first_name`='Jiro',`last_name`='Sato'

	user := User{
		ID:       100,
		LastName: "Jiro",
		Age:      21,
	}
	sql2, _, err := dialect.Update("users").Set(user).Where(goqu.C("id").Eq(1)).ToSQL()
	fmt.Println(sql2)
	// UPDATE `users` SET `age`=21,`first_name`=DEFAULT,`last_name`='Jiro' WHERE (`id` = 1)
}

また、goqu.Record は map[string]interface{} 型のエイリアスであるので以下のように扱えます。

func main() {
	dialect := goqu.Dialect("mysql")
	record := goqu.Record{}
	record["id"] = 100
	record["first_name"] = "Jiro"
	sql, _, err := dialect.Update("users").Set(record).ToSQL()
	fmt.Println(sql)
	// UPDATE `users` SET `first_name`='Jiro',`id`=100
}

DELETE 句を生成する

goqu で DELETE 句を生成するには .Delete メソッドを使用します。
より詳しくは Deleting を参照して下さい。

func main() {
	dialect := goqu.Dialect("mysql")
	sql1, _, _ := dialect.Delete("users").ToSQL()
	fmt.Println(sql1)
	// DELETE `users` FROM `users`

	sql2, _, _ := dialect.Delete("users").Where(goqu.C("id").Eq(1)).ToSQL()
	fmt.Println(sql2)
	// DELETE `users` FROM `users` WHERE (`id` = 1)
}

参考

Author And Source

この問題について(Go のクエリビルダー goqu 入門), 我々は、より多くの情報をここで見つけました https://zenn.dev/minguu42/articles/20220413-goqu-tutorial

著者帰属：元の著者の情報は、元のURLに含まれています。著作権は原作者に属する。

Collection and Share based on the CC protocol

NestJS カスタムロガーサンプル

MudBlazorを使ってBlazor ServerのCRUDアプリのサンプルを作ってみた