Railsアプリケーションにおける外部キー制約エラーの解決法 #Rails

エラーの概要

Railsアプリケーション開発中、以下のような外部キー制約違反のエラーに直面しました。

ActiveRecord::InvalidForeignKey (PG::ForeignKeyViolation: ERROR:  update or delete on table "company_business_days" violates foreign key constraint "fk_rails_... on table "company_business_hours")

このエラーは、Companyモデルを削除しようとした際に発生しました。

エラーの解消方法

問題の解決には、データベースの外部キー制約にon_delete: :cascadeオプションを追加する必要があります。これにより、親モデルの削除時に関連する子モデルが自動的に削除されます。

前提条件のセクションを、提供されたモデルの定義に基づいて再構成します。ここで目指すのは、記事の読者が問題の文脈をより明確に理解できるように、モデル間の関係性とそれらがどのように連携しているかを詳細に説明することです。

📌 重要な参考資料 📌

▶️ 以下の記事も参考にしてください。 ◀️
Railsで動的に営業時間入力フォームを表示させる方法（ストロングパラメータに注意！）

前提条件

Company、CompanyBusinessDay、およびCompanyBusinessHourの3つのモデル間の関係性は以下の通りです。

Companyモデルは、CompanyBusinessDayとhas_many関係にあります。これにより、一つの会社が複数の営業日（CompanyBusinessDay）を持つことができます。また、dependent: :destroyオプションが設定されており、会社が削除されると、それに紐づく営業日も同時に削除されます。
Companyモデルは、CompanyBusinessDayを介してBusinessDayと多対多の関係を持ちます。これにより、会社は複数のビジネスデイ（営業日）を介して複数の営業時間（CompanyBusinessHour）を持つことができます。
CompanyBusinessDayモデルは、CompanyとBusinessDayに属しており、さらにCompanyBusinessHourとhas_many関係にあります。これにより、一つの営業日が複数の営業時間を持つことができます。また、dependent: :destroyオプションがこちらにも設定されており、営業日が削除されると、それに紐づく営業時間も同時に削除されます。
Companyモデルは、accepts_nested_attributes_for :company_business_days, allow_destroy: trueを使用して、ネストされた属性の削除を許可し、フォームから直接関連するCompanyBusinessDaysとその下にあるCompanyBusinessHoursを作成または更新できるようにしています。
CompanyBusinessDayモデルは、accepts_nested_attributes_for :company_business_hours, allow_destroy: trueを使用して、同様にネストされた属性の削除を許可し、関連するCompanyBusinessHoursの作成や更新を容易にしています。

詳細

問題の発生

アプリケーションでは、Company、CompanyBusinessDay、CompanyBusinessHourの3つのモデルが関連付けられており、dependent: :destroyオプションを用いていました。しかし、Companyを削除しようとすると上記の外部キー制約違反エラーが発生していました。

原因分析

エラーの原因は、データベースレベルでCompanyBusinessDayまたはCompanyBusinessHourへの外部キー制約がon_delete: :cascadeオプションを持たなかったことにありました。そのため、親モデルの削除が子モデルの自動削除をトリガーしていませんでした。

解決策の実装

解決策として、新しいマイグレーションを作成し、外部キー制約にon_delete: :cascadeオプションを追加しました。具体的には以下のステップを実行しました。

新しいマイグレーションファイルの生成:

rails generate migration AddOnDeleteCascadeToCompanyBusinessHours

生成されたマイグレーションファイルを以下のように編集:

class AddOnDeleteCascadeToCompanyBusinessHours < ActiveRecord::Migration[7.0]
  def change
    remove_foreign_key :company_business_hours, :company_business_days
    add_foreign_key :company_business_hours, :company_business_days, on_delete: :cascade
  end
end

マイグレーションの適用:

rails db:migrate

結果

この変更により、Companyモデルの削除時にCompanyBusinessDayおよびCompanyBusinessHourが正しく削除されるようになり、外部キー制約違反のエラーが解消されました。

注意点

この変更を適用する前には、必ずデータベースのバックアップを取ることをお勧めします。また、開発環境でのテストを十分に行い、本番環境への適用前に予期せず動作することがないようにしてください。