Extend configuration to support disable_during_db_migrate

README.md

@@ -69,6 +69,8 @@ If you do not want to rewrite default `#to_sql` method you may specify
 You can also disable log formatting by specifying `PpSql.add_rails_logger_formatting=false`
 in initializers.
 
+Formatting the sql messages can add significant overhead to the schema dump portion of the database migration process. This overhead can be avoided by setting `PpSql.disable_for_db_tasks = true`. Alternatively, run time opt out can be done by setting `PPSQL_DISABLE=1`, such as `PPSQL_DISABLE=1 rails db:migrate`. 
+
 ### Add to Application record
 
 I found usefull this trick:

lib/pp_sql.rb

@@ -6,10 +6,17 @@ module PpSql
   # if you do not want to rewrite AR native method #to_sql
   # you may switch this setting to false in initializer
   class << self
-    attr_accessor :rewrite_to_sql_method, :add_rails_logger_formatting
+    attr_accessor :rewrite_to_sql_method, :add_rails_logger_formatting, :disable_for_db_tasks
+
+    def enabled_for?(action)
+      return false if ENV['PPSQL_DISABLED']
+
+      send(action)
+    end
   end
   self.rewrite_to_sql_method = true
   self.add_rails_logger_formatting = true
+  self.disable_for_db_tasks = true
 
   module Formatter
     private
@@ -28,7 +35,7 @@ def _sql_formatter
 
   module ToSqlBeautify
     def to_sql
-      if ::PpSql.rewrite_to_sql_method
+      if ::PpSql.enabled_for?(:rewrite_to_sql_method)
         extend Formatter
         _sql_formatter.format(defined?(super) ? super.dup : dup)
       else
@@ -37,7 +44,7 @@ def to_sql
     end
 
     def pp_sql
-      if ::PpSql.rewrite_to_sql_method
+      if ::PpSql.enabled_for?(:rewrite_to_sql_method)
         puts to_sql
       else
         extend Formatter
@@ -50,7 +57,7 @@ module LogSubscriberPrettyPrint
     include Formatter
 
     def sql(event)
-      return super unless ::PpSql.add_rails_logger_formatting
+      return super unless ::PpSql.enabled_for?(:add_rails_logger_formatting)
 
       e = event.dup
       e.payload[:sql] = _sql_formatter.format(e.payload[:sql].dup)
@@ -66,6 +73,11 @@ class Railtie < Rails::Railtie
           ActiveRecord::LogSubscriber.prepend LogSubscriberPrettyPrint
         end
       end
+
+      rake_tasks do
+        path = File.expand_path(__dir__)
+        Dir.glob("#{path}/pp_sql/tasks/**/*.rake").each { |f| load f }
+      end
     end
   end
 end

lib/pp_sql/tasks/db_hooks.rake

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+namespace :pp_sql do
+  desc 'Hook that is ran before rails `db:*` tasks that can disable pp_sql'
+
+  task :disable_during_db_tasks do
+    if PpSql.disable_for_db_tasks
+      PpSql.add_rails_logger_formatting = false
+      PpSql.rewrite_to_sql_method = false
+    end
+  end
+end
+
+db_tasks = Rake::Task.tasks.select { |task| task.name.starts_with?('db:') }
+db_tasks.each { |task| task.enhance(['pp_sql:disable_during_db_tasks']) }

test/pp_sql_rails_test.rb

@@ -36,6 +36,16 @@ class User < ActiveRecord::Base; end
     assert_equal LOGGER.string.lines.count, 6
   end
 
+  it 'can be disabled with an env var' do
+    old_env = ENV.to_hash
+    ENV.update('PPSQL_DISABLED' => '1')
+    User.create
+    clear_logs!
+    User.first
+    assert_equal 1, LOGGER.string.lines.count
+    ENV.replace old_env
+  end
+
   it 'Rails & ActiveRecord with default output' do
     PpSql.add_rails_logger_formatting = false
     User.create

test/pp_sql_test.rb

@@ -20,6 +20,13 @@ class SubString < String
     assert_equal str.to_sql.lines.count, 1
   end
 
+  it 'can be disabled with env var' do
+    old_env = ENV.to_hash
+    ENV.update('PPSQL_DISABLED' => '1')
+    assert_equal 1, str.to_sql.lines.count
+    ENV.replace old_env
+  end
+
   it 'formats and prints with pp_sql' do
     out, = capture_io do
       str.pp_sql