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
380
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.3k
Other Decks in Programming
See All in Programming
1BRC--Nerd Sniping the Java Community
gunnarmorling
0
300
if constexpr文はテンプレート世界のラムダ式である
faithandbrave
0
160
AWS Application Composerで始める、 サーバーレスなデータ基盤構築 / 20240406-jawsug-hokuriku-shinkansen
kasacchiful
1
250
puregoの活用例
aethiopicuschan
0
220
チーム力を高めるスクラム実践法:カンバン公開と課題攻略について - ニフティのスクラムトーク Vol. 2 - NIFTY Tech Talk #18
niftycorp
PRO
1
110
PostmanでAPIの動作確認が楽になった話
h455h1
0
130
スクラムガイドのスプリントレトロスペクティブを改めて読みかえしてみた / Re-reading the Sprint Retrospective Section in the Scrum Guide
mackey0225
3
330
CA.swift19 恋するAIアプリ開発の裏側
oskmr
0
340
OpenAPIを中心に考えるAPI開発入門 / Introduction to API Development with a Focus on OpenAPI
seike460
PRO
2
120
Java 22 Overview
kishida
1
170
今、知っておきたい! 生成AIエージェントの世界
elith
3
340
Milestoner
bkuhlmann
1
400
Featured
See All Featured
Statistics for Hackers
jakevdp
789
220k
Unsuck your backbone
ammeep
662
57k
CSS Pre-Processors: Stylus, Less & Sass
bermonpainter
352
28k
Intergalactic Javascript Robots from Outer Space
tanoku
266
26k
Web development in the modern age
philhawksworth
202
10k
[RailsConf 2023] Rails as a piece of cake
palkan
22
3.9k
The Illustrated Children's Guide to Kubernetes
chrisshort
29
46k
Practical Orchestrator
shlominoach
181
9.7k
Teambox: Starting and Learning
jrom
128
8.4k
What’s in a name? Adding method to the madness
productmarketing
PRO
15
2.6k
Happy Clients
brianwarren
91
6.4k
Building Better People: How to give real-time feedback that sticks.
wjessup
354
18k
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/
ありがとうございました