べき等データベースマイグレーションツールmigu

1. べき等データベーススキーマ
マイグレーションツール
migu
mercari.go #15
2020-02-05

2. 自己紹介
● @naoina (Naoya Inada)
● Backend engineer at Merpay
https://github.com/naoina
https://twitter.com/naoina

3. データベーススキーマのマイグレーションどうやってますか？
● bitbucket.org/liamstask/goose / pressly/goose
● golang-migrate/migrate
● rubenv/sql-migrate
● 手作業による温かみのあるALTER TABLE

4. よくあるマイグレーションツール

5. よくあるマイグレーションツール
マイグレーション用ファイルを作成

6. よくあるマイグレーションツール
マイグレーション用の SQLを書く

7. よくあるマイグレーションツール
適用する

8. 何が問題か？
● 最新に追いつくまでに時間がかかる
○ 最初からひとつひとつマイグレーションしていくため
○ 最新のスキーマをダンプしたものを初期化に使ったりして時間を節約する
○ 途中までマイグレーションしていたら？
● 人力でマイグレーション用SQLを書く必要がある
○ バージョン管理があるだけの温かみのある手動 ALTER TABLE
○ 柔軟性はある
○ UP/DOWNを間違いなく書けますか？
● データベースのテーブルでバージョン管理
○ マイグレーションをどこまで行ったかを管理用テーブルで把握する
○ 実際のテーブルスキーマとバージョン情報の間で不整合が生まれてしまったら？
■ 開発時など頻繁にスキーマを変更するときにめっちゃ面倒・・・

9. 実際のテーブルと手元の環境のスキーマの差分をとって
マイグレーション用のSQLを生成すればいいのでは？？？

10. naoina/migu

11. Miguとは
● https://github.com/naoina/migu
● べき等データベーススキーママイグレーションツール
○ 何度実行しても結果は同じ
● Go製
○ コマンドまたはライブラリとして使える
○ mercari.goなので
● MySQL / MariaDB / Cloud Spanner対応
○ Merpayで使われているデータベースは Cloud Spanner
○ PostgreSQLなどで使いたい人がいればぜひ Pull-Requestをください
● GoのstructからDDLを生成する
○ モデルからスキーマを生成できる
■ スキーマからモデルの生成は cloudspannerecosystem/yo や daichirata/hammer がある
○ 逆も可

12. Miguをつかったマイグレーション（CLI）

13. Miguをつかったマイグレーション（CLI）
アノテーションをつける

14. Miguをつかったマイグレーション（CLI）
カラムの設定をstruct tagで指定
(ここでは主キーを指定 )

15. Miguをつかったマイグレーション（CLI）
ディレクトリも指定可

16. Miguをつかったマイグレーション（CLI）
変更がないので2度目は何も起こらない

17. Miguをつかったマイグレーション（CLI）
型をintからuintに変更

18. Miguをつかったマイグレーション（CLI）
型をintからuintに変更したことで
UNSIGNEDに

19. Miguをつかったマイグレーション（ライブラリ）
GoDoc: https://pkg.go.dev/github.com/naoina/migu

20. Miguをつかったマイグレーション（ライブラリ）
GoDoc: https://pkg.go.dev/github.com/naoina/migu

21. Miguをつかったマイグレーション
● 最新に追いつくまでに時間がかからない
○ 現在の手元のスキーマとデータベースとの差分からマイグレーション用 SQLを生成するので1回の
マイグレーションで済む
● 人力でマイグレーション用SQLを書く必要がない
○ ツールで自動生成
● データベースのテーブルでバージョン管理しなくていい
○ スキーマがどんな状態であっても差分からマイグレーション用 SQLを生成するのでバージョン管理
不要
○ 不整合も起きない

22. まとめ
● べき等（宣言的？）マイグレーションツールというものがある
● そろそろマイグレーションも次のパラダイムに移ってもいいのではないか？
● べき等はいいぞ
● https://github.com/naoina/migu