如何让Rails运行db:migrate时同时更新structure.sql和schema.rb

核心问题背景 #

• 项目使用Postgres独有特性（如全文索引依赖的array_to_string自定义函数）时，若设置config.active_record.schema_format = :sql，Rails会仅生成structure.sql，停止更新可读性更强的schema.rb
• 手动切换配置重复执行迁移的操作效率极低，需要自动化实现双文件同步更新

具体实现方案 #

Rails原生未提供同时导出两种格式schema的配置项，通过Rake任务增强即可实现无感知自动同步，全程不需要手动切换配置：

1. 保留项目默认的schema格式配置为:ruby，即正常走schema.rb生成逻辑，不需要全局修改为:sql格式
2. 在项目中新增自定义Rake任务，挂载到数据库迁移相关任务的执行链路后，在schema.rb正常导出完成后，临时切换配置导出structure.sql，执行完成后自动还原原有配置，不影响其他业务流程。
   在lib/tasks/db/dual_schema_dump.rake中写入以下代码即可：

   # 给db:migrate挂载后续执行逻辑
   Rake::Task["db:migrate"].enhance do
     original_schema_format = ActiveRecord::Base.schema_format
     begin
       ActiveRecord::Base.schema_format = :sql
       Rake::Task["db:schema:dump"].invoke
     ensure
       ActiveRecord::Base.schema_format = original_schema_format
     end
   end
   
   # 兼容回滚、重做迁移等会触发schema更新的场景
   %w[db:rollback db:migrate:redo db:migrate:up db:migrate:down].each do |task_name|
     next unless Rake::Task.task_defined?(task_name)
     Rake::Task[task_name].enhance do
       Rake::Task["db:migrate"].execute
     end
   end
   

3. 配套注意事项
   • 不要同时配置两个schema文件作为数据库初始化的加载源，日常开发、测试环境继续用schema.rb做快速库初始化即可，structure.sql仅作为特殊PG特性的备份留存，避免db:schema:load时出现重复建表、重复创建函数的报错
   • 如果仅需要留存少量自定义函数、特殊索引的定义，也可以选择不生成全量structure.sql，将这类特殊SQL逻辑单独维护在迁移文件中，配置ActiveRecord的schema dumper跳过这类手动维护的对象，进一步降低维护成本

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