Ruby on Railsのschema.rbの深掘り【株式会社ライトコード】

なぜこの記事を書くのか

最近、Github ActionsでRailsアプリケーションの自動テストを設定する中で、schema.rbがCI環境やテスト環境で重要な役割を果たすことを体感しました。

その際、schema.rbが正しく管理されていないことが原因で、スキーマの不一致によるエラーや不便な点がありました。
これを機にschema.rbの役割や管理方法をしっかりと理解しておこうと思い、ブログ執筆に至りました。

schema.rbの基本

schema.rbとは？

Railsアプリケーションのデータベース構造を記録するファイルです。
データベースのスキーマの情報がこのファイルに反映されます。

schema.rbに書かれる情報

Rails 7.1.3.4

ActiveRecord::Schema[7.1].define(version: 2024_10_10_071952) do create_table "sample_users", id: :integer, charset: "utf8", force: :cascade do |t| 

 t.datetime "created_at", precision: nil, null: false 

 t.datetime "updated_at", precision: nil, null: false 

 t.string "name" t.string "birthday" t.text "hobby" 

 t.index ["name"], name: "index_sample_user_on_name", unique: true

end

テーブルの定義がズラッと並びます。
内容としては、ActiveRecordのcreate_tableメソッドでテーブルを生成する記述がされています。

version: 2024_10_10_071952はmigrationのバージョンで、DBのschema_migrationsテーブルの最新のものが反映されます。

schema_migrationsテーブルには、Rails アプリケーションでマイグレーションを実行する度にバージョンがインサートされていきます。
Railsはこのテーブルを介して、マイグレーションがどこまで実行されたかを管理しています。

rails db:schema:dumpによるschema.rbの生成・更新について

Railsでschema.rbを生成・更新するのはrails db:schema:dumpコマンドです。
rails db:migrateで、マイグレーションを実行する際は、このrails db:schema:dumpコマンドがDBスキーマ更新後に実行され、db/schema.rbファイルにスキーマが出力されます。

なお、データベース上にすでにテーブルが存在し、schema_migrationsテーブルがあれば、マイグレーションファイルがなくてもrails db:schema:dumpコマンドを実行すればdb/schema.rbに出力されます。

つまり、rails db:schema:dumpは、マイグレーションファイルを見るのではなく、実際のデータベースのスキーマを見ています。

schema.rbの役割

schema.rbの役割はなんでしょうか？
Railsでmigrationファイルを触ったことのある人であれば、例に挙げたschema.rbのsample_usersテーブル生成の記述は、migrationファイルの記述ととてもよく似ていることに気がつくと思います。

schema.rbの役割を理解するには、このmigrationファイルとの役割の違いを理解することが大切です。

両者の違いは以下になります。

migrationファイルはスキーマの履歴を表現し、開発者が作成・管理
schema.rbは現在のスキーマの状態を表現し、Railsアプリケーションが生成・管理

migrationファイルはスキーマの履歴を表現し、開発者が作成・管理

migrationファイルは、必要なテーブルやカラムの追加、ユニークキーやインデックスの追加を行う際に使用します。
migrationファイルの記述後、rails db:migrateコマンドを実行しデータベースにスキーマを反映します。
これらのmigrationファイルをGitリポジトリ上で管理しておくことで、スキーマの変更やタイミングを開発者やRailsアプリケーションは知ることができます。

…