sqlc と併用するクエリビルダとログ出力ライブラリ

https://github.com/tecowl/querybm と https://github.com/akm/sql-slog の紹介です

Transcript

1. sqlc と併用する クエリビルダ と ログ出力ライブラリ akm
2. 自己紹介 • 秋間武志 ◦ github: akm ◦ twitter: @akimatter • 株式会社グルーヴノーツ 社員 • 株式会社テクノ産業 副社長 今日お話するライブラリはテクノ産業のプロジェクトの中で開発あるいは利用されている ものです。
3. sqlc スキーマ定義とコメント付きクエリから Go のコードを生成するツールです 例 https://github.com/sqlc-dev/sqlc/tree/main/examples/authors/mysql
4. query.sql
5. models.go
6. query.sql.go
7. sqlc の良いところ • SQL をそのまま動かす安心感 • 型安全 ◦ sqlc.embed マクロ • 生成される実行時のコードは reflect 不使用
8. sqlc の困った点 クエリが静的に定義されているため動的な条件に基づいてクエリを生成することができ ません
9. クエリビルダの候補 • goqu reflect を使っている • gocqlx reflect を使っている • jet reflect を使っている • query DB 接続部分も実装している • godb reflect を使っている • sqlz コンストラクタに Driver が必要 • loukoum PostgreSQL 専用 • sqlf reflect を使っている。マッピングの仕方がちょっと惜しい
10. querybm 動的に SELECT 文を生成しモデルにマッピングするための Go のライブラリです https://github.com/tecowl/querybm/ • reflect 不使用 • 依存ゼロ
11. 最もシンプルなケース
12. querybm.Query の使い方
13. 検索フォームのユースケース • 検索条件が入力された場合には WHERE 句を追加 • 検索条件によっては INNER JOIN も追加 • 取得するフィールドのために INNER JOIN が必要になることも • ページネーションのために COUNT を実行 ◦ フィールドは不要
14. INNER JOIN を使うケース
15. querybm の現状 • カバレッジ 100% ◦ 本体のカバレッジと mysql で動作確認したテストコードでのカバレッジと go tool covdata merge で マージすることで依存ゼロとカバレッジ 100% を両立 • 101 enabled linters • シンプルに書けるようにまだまだ開発中
16. sqlc のちょっと困った点 ログの出力は実装されていません。 開発者はログ出力を別途実装する必要があります。
17. sql-slog database/sql のログを log/slog を使って出力するためのライブラリです。 https://github.com/akm/sql-slog • sql.DB の使い方は（ほぼ）これまで通り • ログアダプタ不要。log/slog を使うだけ • 依存ゼロ • ログレベルの設定を詳細に変更可能 ◦ TRACE, VERBOSE も指定可能 • 実行時間の出力
18. log/slog とは • Go 1.21 で導入されたログ出力のためのパッケージ • 構造化ロギングをサポート • ログレベルの定義済み • JSON と テキストをサポート
19. sql-slog の使い方 https://pkg.go.dev/github.com/akm/sql-slog#hdr-How_ mysql, postgres, sqlite3 の例
20. sql-slog のログ出力の例
21. sql-slog で頑張ったところ • カバレッジ 100% ◦ 本体のカバレッジと mysql で動作確認したテストコードでのカバレッジと go tool covdata merge で マージすることで依存ゼロとカバレッジ 100% を両立 • 99 enabled linters • 汎用的にしようとするとdatabase/sql/driver のインターフェースの実装がややこしく なるけど頑張った
22. まとめ • querybm を使うって動的なクエリを生成できます • sql-slog でログ出力できます • どちらも依存ゼロで軽量です • なにか気づいたことがあればぜひ教えて下さい ◦ Issue, Slack なんでも大丈夫です ◦ 良かったら Star お願いします！