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
540
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.7k
Other Decks in Programming
See All in Programming
Jakarta EE meets AI
ivargrimstad
0
720
データベースのオペレーターであるCloudNativePGがStatefulSetを使わない理由に迫る
nnaka2992
0
250
『テスト書いた方が開発が早いじゃん』を解き明かす #phpcon_nagoya
o0h
PRO
9
2.6k
Jasprが凄い話
hyshu
0
190
はじめての Go * WASM * OCR
sgash708
1
120
Generating OpenAPI schema from serializers throughout the Rails stack - Kyobashi.rb #5
envek
1
440
バッチを作らなきゃとなったときに考えること
irof
2
560
AWS Step Functions は CDK で書こう!
konokenj
5
920
もう僕は OpenAPI を書きたくない
sgash708
6
1.9k
5分で理解する SOLID 原則 #phpcon_nagoya
shogogg
1
420
読まないコードリーディング術
hisaju
1
140
推しメソッドsource_locationのしくみを探る - はじめてRubyのコードを読んでみた
nobu09
2
360
Featured
See All Featured
No one is an island. Learnings from fostering a developers community.
thoeni
21
3.2k
Evolution of real-time – Irina Nazarova, EuRuKo, 2024
irinanazarova
6
580
Being A Developer After 40
akosma
89
590k
I Don’t Have Time: Getting Over the Fear to Launch Your Podcast
jcasabona
32
2.2k
Creating an realtime collaboration tool: Agile Flush - .NET Oxford
marcduiker
28
1.9k
BBQ
matthewcrist
87
9.5k
Done Done
chrislema
182
16k
Agile that works and the tools we love
rasmusluckow
328
21k
Typedesign – Prime Four
hannesfritz
41
2.5k
Docker and Python
trallard
44
3.3k
The Myth of the Modular Monolith - Day 2 Keynote - Rails World 2024
eileencodes
21
2.5k
Mobile First: as difficult as doing things right
swwweet
223
9.5k
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/
ありがとうございました