Rails 7生成的schema.rb丢失PostgreSQL排除约束问题求解

问题根源 #

Rails默认的schema.rb是通过Active Record的schema dumper生成的，它对PostgreSQL特有的EXCLUDE排除约束支持不完善，会将其误识别为普通的GIST索引，导致执行rails db:schema:load时无法重建约束，仅生成无约束效果的普通索引。

解决方案 #

方案1：改用structure.sql（推荐）

structure.sql直接保存数据库的原生SQL结构，能完整保留PostgreSQL的所有高级特性（包括排除约束、扩展、自定义函数等），是最省心的解决方式。

1. 修改项目配置：
   在config/application.rb中添加/修改以下配置：

   config.active_record.schema_format = :sql
   

2. 生成原生SQL结构文件：

   rails db:structure:dump
   

   执行后会在db/目录下生成structure.sql文件，该文件会准确记录你的排除约束定义。

3. 后续重建数据库时使用：

   rails db:structure:load
   

4. 版本控制调整：

   • 将schema.rb从版本控制中移除（可添加到.gitignore）
   • 将structure.sql加入版本控制

方案2：自定义Schema Dumper（适合不想切换到structure.sql的场景）

通过编写自定义扩展，让Rails的schema dumper能正确识别并生成排除约束的SQL代码。

1. 创建扩展文件：
   在lib/tasks/schema_dumper_extension.rb中写入以下代码：

   require 'active_record/schema_dumper'
   
   ActiveRecord::SchemaDumper.class_eval do
     private
   
     def tables(stream)
       super
       # 遍历所有表，导出EXCLUDE约束
       @connection.tables.each do |table|
         next if ignored_tables.include?(table)
         dump_exclude_constraints(table, stream)
       end
     end
   
     def dump_exclude_constraints(table, stream)
       # 从PostgreSQL系统表中查询当前表的所有EXCLUDE约束
       constraints = @connection.execute(<<~SQL).to_a
         SELECT conname, consrc
         FROM pg_constraint
         JOIN pg_class ON pg_constraint.conrelid = pg_class.oid
         WHERE pg_class.relname = '#{table}' AND contype = 'x'
       SQL
   
       constraints.each do |constraint|
         stream.puts "  execute <<~SQL"
         stream.puts "    ALTER TABLE #{quote_table_name(table)} ADD CONSTRAINT #{quote_column_name(constraint['conname'])} #{constraint['consrc']}"
         stream.puts "  SQL"
         stream.puts
       end
     end
   end
   

2. 加载扩展：
   在Rakefile或者config/initializers/schema_dumper.rb中添加加载代码：

   require_relative '../lib/tasks/schema_dumper_extension'
   

3. 重新生成schema.rb：

   rails db:schema:dump
   

   此时schema.rb中会添加execute语句，正确生成排除约束。

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