ActiveRecord の移行によって db/structural.sql に大きな変更が加えられるのを防ぐ

概要

以下の ActiveRecord 移行をテスト (運用環境ではない) データベースで実行すると、db/structural.sql に大きな変更が表示されます。これは再現可能です。変更点は次のとおりです。

これらは、運用データベースサーバー上の postgresql バージョンと、テストデータベースで移行が実行されるマシン上の postgresql のバージョン間の不一致に関連している可能性がありますか?

これらの無関係な変更により、git diff 出力の有用性が大幅に低下します。 GitHub の差分結果についても同様です。

以下の小さな最小限の例では、ほんの数個のテーブルが再配置されています。しかし、実際の（より大規模な）移行では、数十のテーブル、ビュー、マットビューの順序が変更されます。これは大きな変更です。

class FixFooBarBaz < ActiveRecord::Migration[5.2]

  def up
    sql = <<~SQL
                  DROP VIEW master_foo;
                  DROP VIEW IF EXISTS bar1;
                  CREATE OR REPLACE VIEW bar1 AS
                  SELECT * FROM baz1
                  UNION ALL
                  SELECT * FROM baz2;
                  CREATE OR REPLACE VIEW master_foo AS
                  SELECT
                      *,
                      'bar1' AS bar_type
                  FROM
                      bar1
                  UNION ALL
                  ...
    SQL

    execute sql
  end

  def down
    sql = <<~SQL
                  DROP VIEW IF EXISTS master_foo;
                  DROP VIEW IF EXISTS bar1;
                  ...
    SQL

    execute sql
  end
end

使用されるハードウェア/ソフトウェア:

マイグレーションが実行されるマシン:

MacBookPro, Apple M1 Max, macOS Sonoma 14.2.1
ruby 2.7.3p183 (2021-04-05 revision 6847ee089d) [arm64-darwin21]
15.3 psql (PostgreSQL) 15.3 (Homebrew)

本番データベースサーバー:

psql (14.9 (Homebrew), server 13.3 (Ubuntu 13.3-1.pgdg20.04+1))

解決策

はい、これは、異なるマシン間で使用しているデータベースエンジンのバージョンや構成 (インストールされているプラグインなど) が原因で発生する可能性があります。例: リポジトリをクローンし、structural.sql を使用してデータベースを最初から再作成した後、このファイルに予期しない変更がいくつか表示されます: https://github.com/coopdevs/timeoverflow/pull/713/files。

その他に考えられる原因は次のとおりです。可読性、一貫性、またはその他の理由により、Rails (アクティブレコード) の内部変更が行われています。例: https://github.com/rails/rails/issues/44571。

Structure.sql ファイル内のテーブルまたはビューの順序の違い (schema.rb アプローチにも同じことが当てはまります) は、通常、Rails アプリケーションの機能には影響しないことに注意してください。ただし、他の種類の変更を見つけた場合は、注意深く確認してください (たとえば、MySQL では、照合順序や文字セットに変更が見られましたが、これによりアプリで実際に奇妙な問題が発生する可能性があります)。

「順序」に関しては、移行で :before および :after オプションを使用することで強制できます。例：

create_table :my_table, before: :my_other_table

これらのオプションは列にも機能します。

add_column :my_table, :my_new_attribute, :integer, after: :my_other_column