Add config to disable schema dump after migration #13948

emilsoman · 2014-02-05T07:36:46Z

Add a config on active_record named dump_schema_after_migration
Schema dump doesn't happen if the config is set to false
Set default value of the config to true
Set config in generated production and test environment files to false
Update configuration guide
Update CHANGELOG

senny · 2014-02-05T07:57:39Z

Relevant discussion on the mailing list: https://groups.google.com/forum/#!topic/rubyonrails-core/h4cQXmKuB7M

senny · 2014-02-05T09:19:07Z

activerecord/CHANGELOG.md

@@ -1,3 +1,12 @@
+*   Add flag to disable schema dump after migration


missing . at the end.

senny · 2014-02-05T09:25:06Z

@emilsoman this is looking good. I added a few minor comments about formatting and style.

/cc @fxn

carlosantoniodasilva · 2014-02-05T09:57:15Z

railties/lib/rails/generators/rails/app/templates/config/environments/production.rb.tt

@@ -81,4 +81,9 @@ Rails.application.configure do

  # Use default logging formatter so that PID and timestamp are not suppressed.
  config.log_formatter = ::Logger::Formatter.new
+
+  <%- unless options.skip_active_record? -%>


You should move the blank line to inside the unless clause, so that it doesn't end up with extra blank line when skipping AR.

emilsoman · 2014-02-05T10:43:17Z

@senny , @carlosantoniodasilva Thanks for the feedback ! Fixed formatting and style issues. Anything else ?

fxn · 2014-02-05T10:45:39Z

Hey, gonna have a look today.

senny · 2014-02-05T10:45:43Z

@emilsoman you will need to squash all your commits into a single one but let's wait for feedback from @fxn first.

fxn · 2014-02-05T19:25:19Z

Looks good. Just a couple of details.

I believe the flag should not appear in test.rb. I explained the rationale in the mailing list but the summary is that since you are not supposed to run migrations in the test environment, it looks strange that the config file says anything about them. The comment is enlightening, see "Do not dump schema after migrations", "in the test environment? which migrations? I am not supposed to run migrations in the test environment!", the user may wonder.

Since migrations do not run, the implicit true value is fine, it won't hurt.

Then some details regarding the values of the flag. We try to avoid using singletons in docs and tests. As far as the user is concerned this is a flag. We could assign anything to it that is true, and the user can set it to nil if he so wishes, we only use the flag for its boolean interpretation. I am going to do some inline comments to be more specific.

fxn · 2014-02-05T19:26:56Z

activerecord/CHANGELOG.md

@@ -1,3 +1,12 @@
+*   Add flag to disable schema dump after migration.
+
+    Add a config on active_record named `dump_schema_after_migration`


config parameter

I know what you mean by active_record, but by itself doesn't have a lot of meaning. Better to just say "Active Record", those config parameters configure the ORM, "Active Record" is going to be good.

emilsoman · 2014-02-06T05:52:44Z

@fxn , Thanks for the amazing feedback ! I've removed the config from config/environments/test.rb because what you said makes perfect sense. I've fixed the grammatical issues that you pointed out. I am not sure about a couple of things for which I've left inline comments. Please take a look whenever you can. Thank you :)

senny · 2014-02-06T08:14:47Z

@emilsoman sorry for pointing you in the wrong direction with true and false 😓

fxn · 2014-02-06T08:55:41Z

Exactly :), the idea is that we want to communicate that the default config is such that the schema is not dumped in production. The exact value needed to enable or disable the flag doesn't matter, any value works (interpreted as a flag).

fxn · 2014-02-06T08:57:58Z

activerecord/CHANGELOG.md

@@ -1,3 +1,11 @@
+*   Add flag to disable schema dump after migration.
+
+    Add a config parameter on ActiveRecord named `dump_schema_after_migration`


Please note that "Active Record" has a space in its name, Active Record is an ORM, and ActiveRecord is a Ruby module that generally has little to have documented.

fxn · 2014-02-06T08:58:45Z

activerecord/lib/active_record/core.rb

+      ##
+      # :singleton-method:
+      # Specify whether schema dump should happen at the end of the
+      # db:migrate rake task. This is true by default, which is useful for


for the development environment

fxn · 2014-02-06T09:01:50Z

I made some editorial comments. Almost there!

emilsoman · 2014-02-06T09:33:13Z

@fxn Fixed. Can I squash the commits ?

fxn · 2014-02-06T09:38:45Z

railties/test/application/configuration_test.rb

@@ -781,5 +781,22 @@ def index
      assert_not Rails.configuration.respond_to?(:method_missing)
      assert Rails.configuration.respond_to?(:method_missing, true)
    end
+
+    test "config.active_record.dump_schema_after_migration is falsy on production" do


we try to avoid "truthy" and "falsy", "false" is enough

fxn · 2014-02-06T09:41:56Z

Awesome @emilsoman, added a few minor remarks and I think it is good to go. If you revise those and squash we'll apply.

* Add a config on Active Record named `dump_schema_after_migration` * Schema dump doesn't happen if the config is set to false * Set default value of the config to true * Set config in generated production environment file to false * Update configuration guide * Update CHANGELOG

emilsoman · 2014-02-06T12:15:01Z

@fxn , done :)

fxn · 2014-02-06T13:14:22Z

Fantastic! Thanks a lot for working on this 😄 ❤️

emilsoman · 2014-02-06T13:30:14Z

Thanks for guiding this into good shape. You guys were super helpful. Thank you !

fxn · 2014-02-06T14:20:54Z

Merged here.

gkop · 2018-04-06T02:10:20Z

Scott I agree it's generally harmless. It bit us though when we switched from schema to structure, as we rightfully didn't supply pg_dump in our production environments. So grateful for Emil's contribution :)

https://groups.google.com/forum/#!topic/rubyonrails-core/h4cQXmKuB7M rails/rails#13948

* Updated sample database.yml file. * Added sidekiq config file. * Removed rails_12factor gem. Added required config changes for heroku logging. * Removed tagged_logging initializer file. The tagged logging configs are handled separately for each env. * Do not dump schema after migrations. https://groups.google.com/forum/#!topic/rubyonrails-core/h4cQXmKuB7M rails/rails#13948 * Enabled force_ssl config. * Added comments about config/initializers/assets.rb. * reverting some of the changes Co-authored-by: Raj Singh <raj.singh@vineti.com>

senny added the activerecord label Feb 5, 2014

senny reviewed Feb 5, 2014
View reviewed changes

activerecord/CHANGELOG.md

@@ -1,3 +1,12 @@

* Add flag to disable schema dump after migration

Copy link

Member

senny Feb 5, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

missing . at the end.

senny closed this Feb 5, 2014

senny reopened this Feb 5, 2014

carlosantoniodasilva reviewed Feb 5, 2014
View reviewed changes

fxn reviewed Feb 5, 2014
View reviewed changes

fxn reviewed Feb 6, 2014
View reviewed changes

fxn merged commit 8806768 into rails:master Feb 6, 2014

ashiksp added a commit to bigbinary/wheel that referenced this pull request Mar 13, 2020

Do not dump schema after migrations.

9def0a8

https://groups.google.com/forum/#!topic/rubyonrails-core/h4cQXmKuB7M rails/rails#13948

ashiksp added a commit to bigbinary/wheel that referenced this pull request Mar 13, 2020

Do not dump schema after migrations.

b2b57a2

https://groups.google.com/forum/#!topic/rubyonrails-core/h4cQXmKuB7M rails/rails#13948

ashiksp mentioned this pull request Mar 14, 2020

Environment config updates bigbinary/wheel#291

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add config to disable schema dump after migration #13948

Add config to disable schema dump after migration #13948

		@@ -1,3 +1,12 @@
		* Add flag to disable schema dump after migration

		@@ -1,3 +1,12 @@
		* Add flag to disable schema dump after migration.

		Add a config on active_record named `dump_schema_after_migration`

		@@ -1,3 +1,11 @@
		* Add flag to disable schema dump after migration.

		Add a config parameter on ActiveRecord named `dump_schema_after_migration`

Add config to disable schema dump after migration #13948

Add config to disable schema dump after migration #13948

Conversation

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment