テテミート 2024.11.22

Transcript

1. sqlcとtypedSQLの良さを伝えたい 🌈 〜 自動生成コードの良さ 〜 株式会社ワクト 阿部太一 1
2. sqlc と typedSQLはご存知でしょうか？ 🤔 2
3. 最近流行っている、ORMです！ ORM : Object Relation Mapper (SQLのクエリ結果セットとクラスや構造体のオ ブジェクトとを紐づけてくれるやつ) 3
4. GitHub Satrの推移 📈 TypedSQLは、Prismaの機能の一 つとして出てきた要素なのでス ター ⭐️が多いのは当たり前 一方、sqlcは、メインのサポー トがGoかつ、TypeScriptのサポ ートが今年になってからなので スター ⭐️は少なめ 4
5. 自己紹介 🔥 名前：阿部太一 趣味：日本酒とモンハンと山本 彩のライブに行く 最近、モンハンのコラボ日本酒買っ た 5
6. 目次 📝 対象者 sqlcとは？ typedSQLとは？ sqlc vs TypedSQL 使用可能な言語 使用例 - 基礎編 使用例 - 応用編 所感 まとめ さいごに 6
7. 対象者 🎯 フロントエンドエンジニア バックエンドエンジニア 7
8. sqlc とは ？ 🤔 8
9. sqlc - GitHub sqlc generates type-safe code from SQL. Here's how it works: 1. You write queries in SQL. 2. You run sqlc to generate code with type-safe interfaces to those queries. 3. You write application code that calls the generated code. Check out an interactive example to see it in action, and the introductory blog post for the motivation behind sqlc. 簡単にいうと、 sqlcは、型安全なコードを生成します 🎉 そのために、プログラマーは、 1. SQLを書く 2. sqlcコマンドでコードを生成する 3. アプケーションコードからsqlcで生成されたコードを呼び出す 9
10. TypedSQL とは ? 🤔 10
11. TypedSQL - Prisma Node.jsなどのJavaScript/TypeScriptのORMとして有名なPrismaのひとつのモード 生SQLからORMのコードを生成してくれる 現時点（v5.20）では、Preview ref. TypedSQL - announcement ref. TypedSQL - PR 11
12. sqlc vs TypedSQL 🥇 12
13. point 1. 手軽さ sqlc 設定ファイルのyaml + DDL + SQL で sqlc generate TypedSQL schema.prisma ファイルにTypedSQLを使用する設定を書いて、 sql/ 配下 に .sql にクエリを書く マイグレショーションは、prismaを使用する場合と同じく schema.prisma に定義 を書く Model 定義が独自記法 🎉 Winner 🎉 - sqlc 13
14. point 2. 使用可能な言語 sqlc Go TypeScript TypedSQL JavaScript/TypeScript 🎉 Winner 🎉 - sqlc 14
15. point 3. 複雑なクエリへの対応 sqlc 毎回使用に合致する専用のSQLを記述しないといけない TypedSQL 各種 find メソッドやクエリビルダーなどのORMとしての代替機能がある Winner 🎉 Draw 15
16. 使用例 - 基礎編 16
17. sqlc ❤️ 17
18. Install 18
19. Setting - Go 19
20. Setting - TypeScript wasmを使用して、Goから TypeScript(JavaScript)を生成し ている 20
21. Generate 21
22. 使ってみる 🎉 - Go 生成された構造体のメソッドと して使う https://go.dev/play/p/4xaorp9Can- 22
23. 使ってみる 🎉 - Typescript getAuthor(dbconnection, { id: 1 }) が生成されたメソッド dbコネクションと、生成さ れた型定義で引数を渡す 23
24. TypedSQL ⭐ 24
25. Install 25
26. Setting schema.prisma に設定を書く Model 定義 主キー インデックス 26
27. Generate 27
28. 使ってみる 🎉 やろうと思ったら、生成された 型定義が一瞬、インポートされ なかった prisma.$queryRawTyped(creat eUser("user1", "bio")); の createUser("user1", "bio") が生成されたメソッド 28
29. 使用例 - 応用編 29
30. 試すシナリオ フリマアプリのバックエンドのDBを考える 月間の出品数について集計したい 30
31. 試すSQL SELECT users.id AS user_id, users.name AS user_name, COUNT(items.id) AS item_count FROM items JOIN users ON items.user_id = users.id WHERE items.created_at BETWEEN '開始日' AND '終了日' GROUP BY users.id, users.name ORDER BY item_count DESC; 31
32. sqlc - Go 32
33. sqlc - TypeScript 33
34. TypedSQL 34
35. 所感 SQLからORマッパーのメソッドを生成できるの良い 自動生成サイコー 実際に実行するのはチューニングしたSQLで、アプリ上扱うのはSQLをラップした メソッドっていういいとこどりなORMだなと思いました 生成されるメソッドの命名は大変そう 35
36. まとめ ただ、いちいち簡単なSQLも書かないといけないのはデメリット SQLから生成もできて、標準的なORMとしての機能備わっているPrismaは便利 優劣はつけ難いが、個人的にはsqlcが好き 36
37. 参考 絶対使いたいPrisma新機能ランキング - ムーザルちゃんねる プロダクト開発でsqlcを採用した話 - yuyu_hf 参考リポジトリ orm-sample 37