CODEWITHSUNDEEP
ruby-on-railsactiverecordeager-loading
wbharding
wbharding

Reputation: 4573

How to Determine if Rails Association is Eager Loaded?

Does anyone know a way to determine if a Rails association has been eager loaded?

My situation: I have a result set where sometimes one of the associations is eager loaded, and sometimes it isn't. If it isn't eager-loaded, then I want to look up associations using ActiveRecord's find. If it is eager loaded, I want to use detect.

For example, say that I have a "has_many" array of shipping_info objects in my item model. Then:

If item is eager loaded, most efficient load is: 

item.shipping_infos.detect { |si| si.region == "United States" }

If item isn't eager loaded, most efficient load is:

item.shipping_infos.where(region: "United States").first

But unless I know whether it is eager loaded, I don't know which code to call to get the record efficiently. If I use the first method when it wasn't eager loaded, then I have to look up more DB records than necessary. And if I use the second method when it was eager loaded, then my eager loaded objects are ignored.

Upvotes: 80

Views: 32495

Answers (7)

dabobert
dabobert

Reputation: 929

I'd suggest using item.association_cache.keys that will provide a list of the eager loaded associations. So you item.association_cache.keys.include?(:name_of_association)

Upvotes: 27

gamov
gamov

Reputation: 3859

Use .association(name).loaded? on a record.

For Rails < 3.1 use loaded_foo?.

(It is deprecated since Rails 3.1. See: https://github.com/rails/rails/issues/472.)

Upvotes: 89

phil pirozhkov
phil pirozhkov

Reputation: 4900

association_cached? might be a good fit:

item.association_cached?(:shipping_infos)

Upvotes: 14

Bryan Stearns
Bryan Stearns

Reputation: 1337

item.shipping_infos.loaded? will tell you.

I gotta say, though: this path leads to madness... before writing code that tests loaded? to decide between #detect and #find, make sure this instance really matters, relative to everything else that's going on.

If this isn't the slowest thing your app does, adding extra code paths adds unnecessary complexity. Just because you might waste a little database effort doesn't mean you need to fix it - it probably doesn't matter in any measurable way.

Upvotes: 75

Bitterzoet
Bitterzoet

Reputation: 2792

Have a look at the Bullet gem.. This will tell you when you should and should not use eager loading.

Upvotes: 1

Lev Lukomskyi
Lev Lukomskyi

Reputation: 6667

Solution to this problem should be foo.association(:bla).loaded?, BUT it works incorrectly - it checks and marks association as dirty:

class Foo; has_one :bla, :autosave => true end
foo.association(:bla).loaded? #=> false
foo.save # saves foo and fires select * from bla

So I've added following extension to ActiveRecord:

module ActiveRecord
  class Base
    def association_loaded?(name)
      association_instance_get(name).present?
    end
  end
end

and now:

class Foo; has_one :bla, :autosave => true end
foo.association_loaded?(:bla) #=> false
foo.save # saves foo

Upvotes: 3

Jim Stewart
Jim Stewart

Reputation: 17323

You can detect whether or not a single association has been loaded with loaded_foo?. For example, if shipping_info was a belongs_to association, then item.loaded_shipping_info? will return true when it's been eager-loaded. Oddly, it appears to return nil (rather than false) when it hasn't been loaded (in Rails 2.3.10 anyway).

Upvotes: 3

Related Questions