ActiveRecord::Associations::ClassMethods

Associations are a set of macro-like class methods for tying objects together through foreign keys. They express relationships like "Project has one Project Manager" or "Project belongs to a Portfolio". Each macro adds a number of methods to the class which are specialized according to the collection or association symbol and the options hash. It works much the same way as Ruby’s own attr* methods. Example:

  class Project < ActiveRecord::Base
    belongs_to              :portfolio
    has_one                 :project_manager
    has_many                :milestones
    has_and_belongs_to_many :categories
  end

The project class now has the following methods (and more) to ease the traversal and manipulation of its relationships:

• Project#portfolio, Project#portfolio=(portfolio), Project#portfolio.nil?
• Project#project_manager, Project#project_manager=(project_manager), Project#project_manager.nil?,
• Project#milestones.empty?, Project#milestones.size, Project#milestones, Project#milestones<<(milestone), Project#milestones.delete(milestone), Project#milestones.find(milestone_id), Project#milestones.find(:all, options), Project#milestones.build, Project#milestones.create
• Project#categories.empty?, Project#categories.size, Project#categories, Project#categories<<(category1), Project#categories.delete(category1)

A word of warning

Don’t create associations that have the same name as instance methods of ActiveRecord::Base. Since the association adds a method with that name to its model, it will override the inherited method and break things. For instance, attributes and connection would be bad choices for association names.

Auto-generated methods

Singular associations (one-to-one)

                                    |            |  belongs_to  |
  generated methods                 | belongs_to | :polymorphic | has_one
  ----------------------------------+------------+--------------+---------
  other                             |     X      |      X       |    X
  other=(other)                     |     X      |      X       |    X
  build_other(attributes={})        |     X      |              |    X
  create_other(attributes={})       |     X      |              |    X
  other.create!(attributes={})      |            |              |    X

Collection associations (one-to-many / many-to-many)

                                    |       |          | has_many
  generated methods                 | habtm | has_many | :through
  ----------------------------------+-------+----------+----------
  others                            |   X   |    X     |    X
  others=(other,other,...)          |   X   |    X     |    X
  other_ids                         |   X   |    X     |    X
  other_ids=(id,id,...)             |   X   |    X     |    X
  others<<                          |   X   |    X     |    X
  others.push                       |   X   |    X     |    X
  others.concat                     |   X   |    X     |    X
  others.build(attributes={})       |   X   |    X     |    X
  others.create(attributes={})      |   X   |    X     |    X
  others.create!(attributes={})     |   X   |    X     |    X
  others.size                       |   X   |    X     |    X
  others.length                     |   X   |    X     |    X
  others.count                      |   X   |    X     |    X
  others.sum(args*,&block)          |   X   |    X     |    X
  others.empty?                     |   X   |    X     |    X
  others.clear                      |   X   |    X     |    X
  others.delete(other,other,...)    |   X   |    X     |    X
  others.delete_all                 |   X   |    X     |
  others.destroy_all                |   X   |    X     |    X
  others.find(*args)                |   X   |    X     |    X
  others.find_first                 |   X   |          |
  others.exists?                    |   X   |    X     |    X
  others.uniq                       |   X   |    X     |    X
  others.reset                      |   X   |    X     |    X

Cardinality and associations

Active Record associations can be used to describe one-to-one, one-to-many and many-to-many relationships between models. Each model uses an association to describe its role in the relation. The belongs_to association is always used in the model that has the foreign key.

One-to-one

Use has_one in the base, and belongs_to in the associated model.

  class Employee < ActiveRecord::Base
    has_one :office
  end
  class Office < ActiveRecord::Base
    belongs_to :employee    # foreign key - employee_id
  end

One-to-many

Use has_many in the base, and belongs_to in the associated model.

  class Manager < ActiveRecord::Base
    has_many :employees
  end
  class Employee < ActiveRecord::Base
    belongs_to :manager     # foreign key - manager_id
  end

Many-to-many

There are two ways to build a many-to-many relationship.

The first way uses a has_many association with the :through option and a join model, so there are two stages of associations.

  class Assignment < ActiveRecord::Base
    belongs_to :programmer  # foreign key - programmer_id
    belongs_to :project     # foreign key - project_id
  end
  class Programmer < ActiveRecord::Base
    has_many :assignments
    has_many :projects, :through => :assignments
  end
  class Project < ActiveRecord::Base
    has_many :assignments
    has_many :programmers, :through => :assignments
  end

For the second way, use has_and_belongs_to_many in both models. This requires a join table that has no corresponding model or primary key.

  class Programmer < ActiveRecord::Base
    has_and_belongs_to_many :projects       # foreign keys in the join table
  end
  class Project < ActiveRecord::Base
    has_and_belongs_to_many :programmers    # foreign keys in the join table
  end

Choosing which way to build a many-to-many relationship is not always simple. If you need to work with the relationship model as its own entity, use has_many :through. Use has_and_belongs_to_many when working with legacy schemas or when you never work directly with the relationship itself.

Is it a belongs_to or has_one association?

Both express a 1-1 relationship. The difference is mostly where to place the foreign key, which goes on the table for the class declaring the belongs_to relationship. Example:

  class User < ActiveRecord::Base
    # I reference an account.
    belongs_to :account
  end

  class Account < ActiveRecord::Base
    # One user references me.
    has_one :user
  end

The tables for these classes could look something like:

  CREATE TABLE users (
    id int(11) NOT NULL auto_increment,
    account_id int(11) default NULL,
    name varchar default NULL,
    PRIMARY KEY  (id)
  )

  CREATE TABLE accounts (
    id int(11) NOT NULL auto_increment,
    name varchar default NULL,
    PRIMARY KEY  (id)
  )

Unsaved objects and associations

You can manipulate objects and associations before they are saved to the database, but there is some special behavior you should be aware of, mostly involving the saving of associated objects.

Unless you set the :autosave option on a has_one, belongs_to, has_many, or has_and_belongs_to_many association. Setting it to true will always save the members, whereas setting it to false will never save the members.

One-to-one associations

• Assigning an object to a has_one association automatically saves that object and the object being replaced (if there is one), in order to update their primary keys - except if the parent object is unsaved (new_record? == true).
• If either of these saves fail (due to one of the objects being invalid) the assignment statement returns false and the assignment is cancelled.
• If you wish to assign an object to a has_one association without saving it, use the association.build method (documented below).
• Assigning an object to a belongs_to association does not save the object, since the foreign key field belongs on the parent. It does not save the parent either.

Collections

• Adding an object to a collection (has_many or has_and_belongs_to_many) automatically saves that object, except if the parent object (the owner of the collection) is not yet stored in the database.
• If saving any of the objects being added to a collection (via push or similar) fails, then push returns false.
• You can add an object to a collection without automatically saving it by using the collection.build method (documented below).
• All unsaved (new_record? == true) members of the collection are automatically saved when the parent is saved.

Association callbacks

Similar to the normal callbacks that hook into the lifecycle of an Active Record object, you can also define callbacks that get triggered when you add an object to or remove an object from an association collection. Example:

  class Project
    has_and_belongs_to_many :developers, :after_add => :evaluate_velocity

    def evaluate_velocity(developer)
      ...
    end
  end

It’s possible to stack callbacks by passing them as an array. Example:

  class Project
    has_and_belongs_to_many :developers, :after_add => [:evaluate_velocity, Proc.new { |p, d| p.shipping_date = Time.now}]
  end

Possible callbacks are: before_add, after_add, before_remove and after_remove.

Should any of the before_add callbacks throw an exception, the object does not get added to the collection. Same with the before_remove callbacks; if an exception is thrown the object doesn’t get removed.

Association extensions

The proxy objects that control the access to associations can be extended through anonymous modules. This is especially beneficial for adding new finders, creators, and other factory-type methods that are only used as part of this association. Example:

  class Account < ActiveRecord::Base
    has_many :people do
      def find_or_create_by_name(name)
        first_name, last_name = name.split(" ", 2)
        find_or_create_by_first_name_and_last_name(first_name, last_name)
      end
    end
  end

  person = Account.find(:first).people.find_or_create_by_name("David Heinemeier Hansson")
  person.first_name # => "David"
  person.last_name  # => "Heinemeier Hansson"

If you need to share the same extensions between many associations, you can use a named extension module. Example:

  module FindOrCreateByNameExtension
    def find_or_create_by_name(name)
      first_name, last_name = name.split(" ", 2)
      find_or_create_by_first_name_and_last_name(first_name, last_name)
    end
  end

  class Account < ActiveRecord::Base
    has_many :people, :extend => FindOrCreateByNameExtension
  end

  class Company < ActiveRecord::Base
    has_many :people, :extend => FindOrCreateByNameExtension
  end

If you need to use multiple named extension modules, you can specify an array of modules with the :extend option. In the case of name conflicts between methods in the modules, methods in modules later in the array supercede those earlier in the array. Example:

  class Account < ActiveRecord::Base
    has_many :people, :extend => [FindOrCreateByNameExtension, FindRecentExtension]
  end

Some extensions can only be made to work with knowledge of the association proxy’s internals. Extensions can access relevant state using accessors on the association proxy:

• proxy_owner - Returns the object the association is part of.
• proxy_reflection - Returns the reflection object that describes the association.
• proxy_target - Returns the associated object for belongs_to and has_one, or the collection of associated objects for has_many and has_and_belongs_to_many.

Association Join Models

Has Many associations can be configured with the :through option to use an explicit join model to retrieve the data. This operates similarly to a has_and_belongs_to_many association. The advantage is that you’re able to add validations, callbacks, and extra attributes on the join model. Consider the following schema:

  class Author < ActiveRecord::Base
    has_many :authorships
    has_many :books, :through => :authorships
  end

  class Authorship < ActiveRecord::Base
    belongs_to :author
    belongs_to :book
  end

  @author = Author.find :first
  @author.authorships.collect { |a| a.book } # selects all books that the author's authorships belong to.
  @author.books                              # selects all books by using the Authorship join model

You can also go through a has_many association on the join model:

  class Firm < ActiveRecord::Base
    has_many   :clients
    has_many   :invoices, :through => :clients
  end

  class Client < ActiveRecord::Base
    belongs_to :firm
    has_many   :invoices
  end

  class Invoice < ActiveRecord::Base
    belongs_to :client
  end

  @firm = Firm.find :first
  @firm.clients.collect { |c| c.invoices }.flatten # select all invoices for all clients of the firm
  @firm.invoices                                   # selects all invoices by going through the Client join model.

Similarly you can go through a has_one association on the join model:

  class Group < ActiveRecord::Base
    has_many   :users
    has_many   :avatars, :through => :users
  end

  class User < ActiveRecord::Base
    belongs_to :group
    has_one    :avatar
  end

  class Avatar < ActiveRecord::Base
    belongs_to :user
  end

  @group = Group.first
  @group.users.collect { |u| u.avatar }.flatten # select all avatars for all users in the group
  @group.avatars                                # selects all avatars by going through the User join model.

An important caveat with going through has_one or has_many associations on the join model is that these associations are read-only. For example, the following would not work following the previous example:

  @group.avatars << Avatar.new                # this would work if User belonged_to Avatar rather than the other way around.
  @group.avatars.delete(@group.avatars.last)  # so would this

Polymorphic Associations

Polymorphic associations on models are not restricted on what types of models they can be associated with. Rather, they specify an interface that a has_many association must adhere to.

  class Asset < ActiveRecord::Base
    belongs_to :attachable, :polymorphic => true
  end

  class Post < ActiveRecord::Base
    has_many :assets, :as => :attachable         # The :as option specifies the polymorphic interface to use.
  end

  @asset.attachable = @post

This works by using a type column in addition to a foreign key to specify the associated record. In the Asset example, you’d need an attachable_id integer column and an attachable_type string column.

Using polymorphic associations in combination with single table inheritance (STI) is a little tricky. In order for the associations to work as expected, ensure that you store the base model for the STI models in the type column of the polymorphic association. To continue with the asset example above, suppose there are guest posts and member posts that use the posts table for STI. In this case, there must be a type column in the posts table.

  class Asset < ActiveRecord::Base
    belongs_to :attachable, :polymorphic => true

    def attachable_type=(sType)
       super(sType.to_s.classify.constantize.base_class.to_s)
    end
  end

  class Post < ActiveRecord::Base
    # because we store "Post" in attachable_type now :dependent => :destroy will work
    has_many :assets, :as => :attachable, :dependent => :destroy
  end

  class GuestPost < Post
  end

  class MemberPost < Post
  end

Caching

All of the methods are built on a simple caching principle that will keep the result of the last query around unless specifically instructed not to. The cache is even shared across methods to make it even cheaper to use the macro-added methods without worrying too much about performance at the first go. Example:

  project.milestones             # fetches milestones from the database
  project.milestones.size        # uses the milestone cache
  project.milestones.empty?      # uses the milestone cache
  project.milestones(true).size  # fetches milestones from the database
  project.milestones             # uses the milestone cache

Eager loading of associations

Eager loading is a way to find objects of a certain class and a number of named associations. This is one of the easiest ways of to prevent the dreaded 1+N problem in which fetching 100 posts that each need to display their author triggers 101 database queries. Through the use of eager loading, the 101 queries can be reduced to 2. Example:

  class Post < ActiveRecord::Base
    belongs_to :author
    has_many   :comments
  end

Consider the following loop using the class above:

  for post in Post.all
    puts "Post:            " + post.title
    puts "Written by:      " + post.author.name
    puts "Last comment on: " + post.comments.first.created_on
  end

To iterate over these one hundred posts, we’ll generate 201 database queries. Let’s first just optimize it for retrieving the author:

  for post in Post.find(:all, :include => :author)

This references the name of the belongs_to association that also used the :author symbol. After loading the posts, find will collect the author_id from each one and load all the referenced authors with one query. Doing so will cut down the number of queries from 201 to 102.

We can improve upon the situation further by referencing both associations in the finder with:

  for post in Post.find(:all, :include => [ :author, :comments ])

This will load all comments with a single query. This reduces the total number of queries to 3. More generally the number of queries will be 1 plus the number of associations named (except if some of the associations are polymorphic belongs_to - see below).

To include a deep hierarchy of associations, use a hash:

  for post in Post.find(:all, :include => [ :author, { :comments => { :author => :gravatar } } ])

That’ll grab not only all the comments but all their authors and gravatar pictures. You can mix and match symbols, arrays and hashes in any combination to describe the associations you want to load.

All of this power shouldn’t fool you into thinking that you can pull out huge amounts of data with no performance penalty just because you’ve reduced the number of queries. The database still needs to send all the data to Active Record and it still needs to be processed. So it’s no catch-all for performance problems, but it’s a great way to cut down on the number of queries in a situation as the one described above.

Since only one table is loaded at a time, conditions or orders cannot reference tables other than the main one. If this is the case Active Record falls back to the previously used LEFT OUTER JOIN based strategy. For example

  Post.find(:all, :include => [ :author, :comments ], :conditions => ['comments.approved = ?', true])

will result in a single SQL query with joins along the lines of: LEFT OUTER JOIN comments ON comments.post_id = posts.id and LEFT OUTER JOIN authors ON authors.id = posts.author_id. Note that using conditions like this can have unintended consequences. In the above example posts with no approved comments are not returned at all, because the conditions apply to the SQL statement as a whole and not just to the association. You must disambiguate column references for this fallback to happen, for example :order => "author.name DESC" will work but :order => "name DESC" will not.

If you do want eagerload only some members of an association it is usually more natural to :include an association which has conditions defined on it:

  class Post < ActiveRecord::Base
    has_many :approved_comments, :class_name => 'Comment', :conditions => ['approved = ?', true]
  end

  Post.find(:all, :include => :approved_comments)

will load posts and eager load the approved_comments association, which contains only those comments that have been approved.

If you eager load an association with a specified :limit option, it will be ignored, returning all the associated objects:

  class Picture < ActiveRecord::Base
    has_many :most_recent_comments, :class_name => 'Comment', :order => 'id DESC', :limit => 10
  end

  Picture.find(:first, :include => :most_recent_comments).most_recent_comments # => returns all associated comments.

When eager loaded, conditions are interpolated in the context of the model class, not the model instance. Conditions are lazily interpolated before the actual model exists.

Eager loading is supported with polymorphic associations.

  class Address < ActiveRecord::Base
    belongs_to :addressable, :polymorphic => true
  end

A call that tries to eager load the addressable model

  Address.find(:all, :include => :addressable)

will execute one query to load the addresses and load the addressables with one query per addressable type. For example if all the addressables are either of class Person or Company then a total of 3 queries will be executed. The list of addressable types to load is determined on the back of the addresses loaded. This is not supported if Active Record has to fallback to the previous implementation of eager loading and will raise ActiveRecord::EagerLoadPolymorphicError. The reason is that the parent model’s type is a column value so its corresponding table name cannot be put in the FROM/JOIN clauses of that query.

Table Aliasing

Active Record uses table aliasing in the case that a table is referenced multiple times in a join. If a table is referenced only once, the standard table name is used. The second time, the table is aliased as #{reflection_name}_#{parent_table_name}. Indexes are appended for any more successive uses of the table name.

  Post.find :all, :joins => :comments
  # => SELECT ... FROM posts INNER JOIN comments ON ...
  Post.find :all, :joins => :special_comments # STI
  # => SELECT ... FROM posts INNER JOIN comments ON ... AND comments.type = 'SpecialComment'
  Post.find :all, :joins => [:comments, :special_comments] # special_comments is the reflection name, posts is the parent table name
  # => SELECT ... FROM posts INNER JOIN comments ON ... INNER JOIN comments special_comments_posts

Acts as tree example:

  TreeMixin.find :all, :joins => :children
  # => SELECT ... FROM mixins INNER JOIN mixins childrens_mixins ...
  TreeMixin.find :all, :joins => {:children => :parent}
  # => SELECT ... FROM mixins INNER JOIN mixins childrens_mixins ...
                              INNER JOIN parents_mixins ...
  TreeMixin.find :all, :joins => {:children => {:parent => :children}}
  # => SELECT ... FROM mixins INNER JOIN mixins childrens_mixins ...
                              INNER JOIN parents_mixins ...
                              INNER JOIN mixins childrens_mixins_2

Has and Belongs to Many join tables use the same idea, but add a _join suffix:

  Post.find :all, :joins => :categories
  # => SELECT ... FROM posts INNER JOIN categories_posts ... INNER JOIN categories ...
  Post.find :all, :joins => {:categories => :posts}
  # => SELECT ... FROM posts INNER JOIN categories_posts ... INNER JOIN categories ...
                             INNER JOIN categories_posts posts_categories_join INNER JOIN posts posts_categories
  Post.find :all, :joins => {:categories => {:posts => :categories}}
  # => SELECT ... FROM posts INNER JOIN categories_posts ... INNER JOIN categories ...
                             INNER JOIN categories_posts posts_categories_join INNER JOIN posts posts_categories
                             INNER JOIN categories_posts categories_posts_join INNER JOIN categories categories_posts_2

If you wish to specify your own custom joins using a :joins option, those table names will take precedence over the eager associations:

  Post.find :all, :joins => :comments, :joins => "inner join comments ..."
  # => SELECT ... FROM posts INNER JOIN comments_posts ON ... INNER JOIN comments ...
  Post.find :all, :joins => [:comments, :special_comments], :joins => "inner join comments ..."
  # => SELECT ... FROM posts INNER JOIN comments comments_posts ON ...
                             INNER JOIN comments special_comments_posts ...
                             INNER JOIN comments ...

Table aliases are automatically truncated according to the maximum length of table identifiers according to the specific database.

Modules

By default, associations will look for objects within the current module scope. Consider:

  module MyApplication
    module Business
      class Firm < ActiveRecord::Base
         has_many :clients
       end

      class Client < ActiveRecord::Base; end
    end
  end

When Firm#clients is called, it will in turn call MyApplication::Business::Client.find_all_by_firm_id(firm.id). If you want to associate with a class in another module scope, this can be done by specifying the complete class name. Example:

  module MyApplication
    module Business
      class Firm < ActiveRecord::Base; end
    end

    module Billing
      class Account < ActiveRecord::Base
        belongs_to :firm, :class_name => "MyApplication::Business::Firm"
      end
    end
  end

Type safety with ActiveRecord::AssociationTypeMismatch

If you attempt to assign an object to an association that doesn’t match the inferred or specified :class_name, you’ll get an ActiveRecord::AssociationTypeMismatch.

Options

All of the association macros can be specialized through options. This makes cases more complex than the simple and guessable ones possible.

activerecord/lib/active_record/associations.rb