Rails 7关联表迁移添加额外引用报错：relation 'creators'不存在

问题详情 #

编写Rails 7关联表迁移代码后，执行db:migrate时触发错误，提示relation "creators" does not exist，但实际并未计划创建creators表。

迁移代码 #

class CreateJoinTableProjectsUsers < ActiveRecord::Migration[7.0]
  def change
    create_join_table :projects, :users do |t|
      # t.index [:project_id, :user_id]
      # t.index [:user_id, :project_id]

      t.references :creator, references: :users, null: false, foreign_key: true
      t.timestamps
    end
  end
end

报错信息 #

== 20230720163543 CreateJoinTableProjectsUsers: migrating =====================
-- create_join_table(:projects, :users)
rake aborted!
StandardError: An error has occurred, this and all later migrations canceled:

PG::UndefinedTable: ERROR:  relation "creators" does not exist
/.../db/migrate/20230720163543_create_join_table_projects_users.rb:3:in `change'

Caused by:
ActiveRecord::StatementInvalid: PG::UndefinedTable: ERROR:  relation "creators" does not exist
/.../db/migrate/20230720163543_create_join_table_projects_users.rb:3:in `change'

Caused by:
PG::UndefinedTable: ERROR:  relation "creators" does not exist
/.../db/migrate/20230720163543_create_join_table_projects_users.rb:3:in `change'
Tasks: TOP => db:migrate
(See full trace by running task with --trace)

问题分析与解决方案 #

错误原因 #

使用t.references :creator时，Rails默认会根据字段名推断外键关联的表为creators，仅通过references: :users无法覆盖这一默认行为，导致数据库尝试查找不存在的creators表。

修正后的迁移代码 #

class CreateJoinTableProjectsUsers < ActiveRecord::Migration[7.0]
  def change
    create_join_table :projects, :users do |t|
      # 必须添加复合索引，提升关联查询性能
      t.index [:project_id, :user_id]
      t.index [:user_id, :project_id]

      # 显式指定外键关联到users表
      t.references :creator, null: false, foreign_key: { to_table: :users }
      # 关联表通常不需要timestamps，若业务无需求可移除
      t.timestamps
    end
  end
end

额外提示 #

• 索引必要性：关联表的双向复合索引是性能优化的关键，不要注释掉。
• timestamps取舍：create_join_table生成的表默认不含时间戳字段，若无需记录关联关系的创建/更新时间，建议删除t.timestamps以减少冗余。

内容的提问来源于stack exchange，提问作者Alexander