diff options
author | Rafael Mendonça França <rafaelmfranca@gmail.com> | 2015-03-26 17:21:36 -0300 |
---|---|---|
committer | Rafael Mendonça França <rafaelmfranca@gmail.com> | 2015-03-26 17:21:36 -0300 |
commit | 8b451e3a315666b93da43e7b61503014661f0ac6 (patch) | |
tree | 67c651bc55c083c1bbaaf1e867593fe02e2b6a8c /activerecord/lib/active_record/relation | |
parent | 83429b1ece4b793fba1b6b1bfad1d0de454c3de0 (diff) | |
parent | 4d6fbe2934e94384e722ff6ca16e97c8978d4665 (diff) | |
download | rails-8b451e3a315666b93da43e7b61503014661f0ac6.tar.gz rails-8b451e3a315666b93da43e7b61503014661f0ac6.tar.bz2 rails-8b451e3a315666b93da43e7b61503014661f0ac6.zip |
Merge pull request #18846 from hundredwatt/feat/warn-on-result-set-size
Add `config.active_record.warn_on_result_set_size` option
Diffstat (limited to 'activerecord/lib/active_record/relation')
-rw-r--r-- | activerecord/lib/active_record/relation/record_fetch_warning.rb | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/activerecord/lib/active_record/relation/record_fetch_warning.rb b/activerecord/lib/active_record/relation/record_fetch_warning.rb new file mode 100644 index 0000000000..0d31f73ddd --- /dev/null +++ b/activerecord/lib/active_record/relation/record_fetch_warning.rb @@ -0,0 +1,50 @@ +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 dection 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 + + ActiveSupport::Notifications.subscribe("sql.active_record") do |*args| + payload = args.last + + QueryRegistry.queries << payload[:sql] + end + + class QueryRegistry # :nodoc: + extend ActiveSupport::PerThreadRegistry + + attr_accessor :queries + + def initialize + reset + end + + def reset + @queries = [] + end + end + end + end +end + +ActiveRecord::Relation.prepend ActiveRecord::Relation::RecordFetchWarning |