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
360
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
3.2k
Other Decks in Programming
See All in Programming
ONE WEDGE_Company_Information
1wedge
0
180
品質が高いコードって何?Rev2.1
ickx
1
490
Creating Retro-Style Photos Using Swift
ski
1
360
DDDはなぜ難しいのか / 良いコードの定義と設計能力の壁
pospome
24
7.6k
15分間でふんわり理解するDocker @ Matsuriba MAX
ukwhatn
PRO
1
340
ISUCONってなんだか難しそう……!!でも、初めてのISUCONにPHPで挑戦してきました!
kotomin_m
1
300
チームでモデリングを育てるうえで 考えたこと・気づいたこと / Cultivating Modeling in Teams: Thoughts and Insights
mackey0225
5
2.4k
GitHub Copilot Tips and Tricks
yuichielectric
26
7.5k
PHPerKaigi 2024〜10年以上動いているレガシーなバッチシステムを Kubernetes(Amazon EKS) に移行する取り組み〜
tshinowpub
1
220
ファイル先頭の use の意味、説明できますか? 〜PHP の namespace と autoloading の関係を正しく理解しよう〜 / namespace and autoloading in php
okashoi
2
470
品質とスピードを両立: TypeScriptの柔軟な型システムをバックエンドで活用する
kosui
5
1.1k
Deep Dive 大規模システムアーキテクチャ/開発組織エンジニアリング / Deep Dive Large-Scale System Architecture, Development Organization Engineering
nrslib
15
2.9k
Featured
See All Featured
Become a Pro
speakerdeck
PRO
8
4.4k
GraphQLとの向き合い方2022年版
quramy
28
12k
Ruby is Unlike a Banana
tanoku
95
10k
In The Pink: A Labor of Love
frogandcode
137
21k
Music & Morning Musume
bryan
39
5.5k
CoffeeScript is Beautiful & I Never Want to Write Plain JavaScript Again
sstephenson
153
14k
[Rails World 2023 - Day 1 Closing Keynote] - The Magic of Rails
eileencodes
1
1.2k
Visualization
eitanlees
135
14k
Adopting Sorbet at Scale
ufuk
66
8.5k
Reflections from 52 weeks, 52 projects
jeffersonlam
343
19k
Producing Creativity
orderedlist
PRO
335
39k
Creating an realtime collaboration tool: Agile Flush - .NET Oxford
marcduiker
11
1.4k
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/
ありがとうございました