Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
Information Schemaから自動生成する型付きORM spannent
Search
Khmer495
June 02, 2023
Programming
0
520
Information Schemaから自動生成する型付きORM spannent
https://gocon.jp/2023/sessions/LT4/
Khmer495
June 02, 2023
Tweet
Share
More Decks by Khmer495
See All by Khmer495
Google Cloud Spannerにおけるページネーションとインデックスの考え方
khmer495
0
4.4k
Other Decks in Programming
See All in Programming
ブラウザ単体でmp4書き出すまで - muddy-web - 2024-12
yue4u
2
440
17年周年のWebアプリケーションにTanStack Queryを導入する / Implementing TanStack Query in a 17th Anniversary Web Application
saitolume
0
240
競技プログラミングで 基礎体力を身につけよう / You can get basic skills through competitive programming
mdstoy
0
170
StarlingMonkeyを触ってみた話 - 2024冬
syumai
3
260
MCP with Cloudflare Workers
yusukebe
2
200
htmxって知っていますか?次世代のHTML
hiro_ghap1
0
270
Haze - Real time background blurring
chrisbanes
1
500
KubeCon + CloudNativeCon NA 2024 Overviewat Kubernetes Meetup Tokyo #68 / amsy810_k8sjp68
masayaaoyama
0
230
Zoneless Testing
rainerhahnekamp
0
120
これでLambdaが不要に?!Step FunctionsのJSONata対応について
iwatatomoya
2
3.4k
Refactor your code - refactor yourself
xosofox
1
230
バグを見つけた?それAppleに直してもらおう!
uetyo
0
150
Featured
See All Featured
Product Roadmaps are Hard
iamctodd
PRO
49
11k
Documentation Writing (for coders)
carmenintech
66
4.5k
[RailsConf 2023 Opening Keynote] The Magic of Rails
eileencodes
28
9.1k
Understanding Cognitive Biases in Performance Measurement
bluesmoon
26
1.5k
Improving Core Web Vitals using Speculation Rules API
sergeychernyshev
0
88
Rails Girls Zürich Keynote
gr2m
94
13k
個人開発の失敗を避けるイケてる考え方 / tips for indie hackers
panda_program
95
17k
ピンチをチャンスに:未来をつくるプロダクトロードマップ #pmconf2020
aki_iinuma
111
49k
Why Our Code Smells
bkeepers
PRO
335
57k
The Language of Interfaces
destraynor
154
24k
4 Signs Your Business is Dying
shpigford
181
21k
We Have a Design System, Now What?
morganepeng
51
7.3k
Transcript
Information Schemaから 自動生成する型付きORM spannent 久米 祐貴 / くめーる Twitter:@kume_ru Github:@Khmer495
自己紹介 久米 祐貴(くめ ゆうき) / くめーる 株式会社サイバーエージェント 2021年度 新卒入社
AI事業本部 小売DX領域 ~2022/4 広告配信基盤の運用保守 2022/5~ 小売企業のアプリの開発・運用保守 Goの経験:3年(実務は1年) @Khmer495 @kume_ru
早速作ったものの紹介 自動生成したSpannerの ORMの使い方
Insert • Userテーブルに対するInsert用の メソッドを生成 • メソッドチェーンで記述可 • 型付き(DBとGoの型を対応) DB Go
STRING, NOT NULL string INT64, NULLABLE *int64
Update • Userテーブルに対するUpdate用の メソッドを生成 ◦ 引数にPrimary Key • メソッドチェーンで記述可 •
型付き(DBとGoの型を対応) DB Go STRING, NOT NULL string INT64, NULLABLE *int64
Select • Userテーブルに対するSelect用の メソッドを生成 ◦ 引数にPrimary Key • 可変長引数でカラムを指定 •
テーブル単位のstruct DB Go STRING, NOT NULL string INT64, NULLABLE spanner.NullInt64
作った背景 • DBにGoogle Cloud Spannerを使用 ◦ interfaceはGoogle 標準 SQL ▪
なお2022/06にPostgreSQLも対応している • 開発当時(2022/05)GoドライバはGAしていない ◦ 2022/09にGA • 対応するORMも少ない ◦ メルカリ社製のyo(https://github.com/cloudspannerecosystem/yo) ◦ ORMではないが公式のSDK • 求めているORMはなかった
作った背景 • DBにGoogle Cloud Spannerを使用 ◦ interfaceはGoogle 標準 SQL ▪
なお2022/06にPostgreSQLも対応している • 開発当時(2022/05)GoドライバはGAしていない ◦ 2022/09にGA • 対応するORMも少ない ◦ メルカリ社製のyo(https://github.com/cloudspannerecosystem/yo) ◦ ORMではないが公式のSDK • 求めているORMはなかった なければ作る
実現したいこと • CRUDのCUDに関してGoで完結すること ◦ 完結する= ▪ DBの定義を見なくても良い=テーブル、カラム、 nullable、型などがGoで分かる ▪ SQLを書かなくて良い
◦ 完結しないのであれば公式の SDKで良い ◦ Rは複雑になりがちでクエリビルダを自作するのは大変、生の SQLを書くことが多い ▪ 最終的にはテーブル単位の( Joinなしの)Rのみ作った • 上記を実現するためにスキーマ駆動であること ◦ スキーマ駆動=DBのスキーマからGoのコードを生成、またはその逆と ◦ 一番理想に近いORMがent(https://entgo.io/) ▪ ただしentはSpannerに未対応
実装方針 • 基本方針はentを参考にした • ただしentはGoでスキーマを定義しDBにマイグレーションをかける ◦ Go => DB
◦ マイグレーション自作はあまりやりたくない • よってInformation SchemaからGoのコードを生成する ◦ DB => Go ◦ yoがそのパターンなので参考にした
Information Schemaとは データベースメタデータが載っているテーブル群 • テーブルの ◦ 名前 ◦ カラム一覧 •
カラムの ◦ 名前 ◦ 型 ◦ インデックス ◦ nullable 等 RDBだけでなくデータウェアハウス (BigQueryやSnowflakeなど)にも 存在することがある Information Schemaがなくても相当する メタデータは基本的に取得できるはずなので 応用可能
テンプレを作る 1. 生成物を手で書いてみる 2. 変数にしたい場所を明確にし、テンプレートにする 3. 変数をInformation Schemaから取得するコードを書く
必要があれば加工する 自動生成したコードの使い方 自動生成したコード テンプレ
テンプレを作る 1. 生成物を手で書いてみる 2. 変数にしたい場所を明確にし、テンプレートにする 3. 変数をInformation Schemaから取得するコードを書く
必要があれば加工する 自動生成したコード テンプレ
テンプレを作る 1. 生成物を手で書いてみる 2. 変数にしたい場所を明確にし、テンプレートにする 3. 変数をInformation Schemaから取得するコードを書く
必要があれば加工する テンプレに必要なデータの型 Information Schemaから作った値
応用例 • Information SchemaからSnowflakeのテーブル定義書を作成 > データベースのテーブル定義の仕様書を自動生成しよう https://developers.cyberagent.co.jp/blog/archives/35959/
ありがとうございました