Sha256: 3cd209bb5af2cfb02208ef5a529e95aca34d0b88afe461367ee2ee793980e926

Contents?: true

Size: 1.56 KB

Versions: 33

Compression:

Stored size: 1.56 KB

Contents

module ActiveRecord
  class Relation
    module RecordFetchWarning
      # When this module is prepended to ActiveRecord::Relation and
      # `config.active_record.warn_on_records_fetched_greater_than` is
      # set to an integer, if the number of records a query returns is
      # greater than the value of `warn_on_records_fetched_greater_than`,
      # a warning is logged. This allows for the detection of queries that
      # return a large number of records, which could cause memory bloat.
      #
      # In most cases, fetching large number of records can be performed
      # efficiently using the ActiveRecord::Batches methods.
      # See active_record/lib/relation/batches.rb for more information.
      def exec_queries
        QueryRegistry.reset

        super.tap do
          if logger && warn_on_records_fetched_greater_than
            if @records.length > warn_on_records_fetched_greater_than
              logger.warn "Query fetched #{@records.size} #{@klass} records: #{QueryRegistry.queries.join(";")}"
            end
          end
        end
      end

      # :stopdoc:
      ActiveSupport::Notifications.subscribe("sql.active_record") do |*, payload|
        QueryRegistry.queries << payload[:sql]
      end
      # :startdoc:

      class QueryRegistry # :nodoc:
        extend ActiveSupport::PerThreadRegistry

        attr_reader :queries

        def initialize
          @queries = []
        end

        def reset
          @queries.clear
        end
      end
    end
  end
end

ActiveRecord::Relation.prepend ActiveRecord::Relation::RecordFetchWarning

Version data entries

33 entries across 33 versions & 4 rubygems

Version Path
activerecord-5.0.7.2 lib/active_record/relation/record_fetch_warning.rb
activerecord-5.0.7.1 lib/active_record/relation/record_fetch_warning.rb
activerecord-5.0.7 lib/active_record/relation/record_fetch_warning.rb
activerecord-5.0.6 lib/active_record/relation/record_fetch_warning.rb
activerecord-5.0.6.rc1 lib/active_record/relation/record_fetch_warning.rb
activerecord-5.0.5 lib/active_record/relation/record_fetch_warning.rb
activerecord-5.0.5.rc2 lib/active_record/relation/record_fetch_warning.rb
activerecord-5.0.5.rc1 lib/active_record/relation/record_fetch_warning.rb
activerecord-5.0.4 lib/active_record/relation/record_fetch_warning.rb
activerecord-5.0.4.rc1 lib/active_record/relation/record_fetch_warning.rb
activerecord-5.0.3 lib/active_record/relation/record_fetch_warning.rb
enju_leaf-1.2.1 vendor/bundle/ruby/2.3/gems/activerecord-5.0.2/lib/active_record/relation/record_fetch_warning.rb
activerecord-5.0.2 lib/active_record/relation/record_fetch_warning.rb
activerecord-5.0.2.rc1 lib/active_record/relation/record_fetch_warning.rb
autocompl-0.2.2 test/dummy/vendor/bundle/ruby/2.3.0/gems/activerecord-5.0.1/lib/active_record/relation/record_fetch_warning.rb
autocompl-0.2.1 test/dummy/vendor/bundle/ruby/2.3.0/gems/activerecord-5.0.1/lib/active_record/relation/record_fetch_warning.rb
autocompl-0.2.0 test/dummy/vendor/bundle/ruby/2.3.0/gems/activerecord-5.0.1/lib/active_record/relation/record_fetch_warning.rb
autocompl-0.1.2 test/dummy/vendor/bundle/ruby/2.3.0/gems/activerecord-5.0.1/lib/active_record/relation/record_fetch_warning.rb
autocompl-0.1.1 test/dummy/vendor/bundle/ruby/2.3.0/gems/activerecord-5.0.1/lib/active_record/relation/record_fetch_warning.rb
autocompl-0.1.0 test/dummy/vendor/bundle/ruby/2.3.0/gems/activerecord-5.0.1/lib/active_record/relation/record_fetch_warning.rb