Module | ActiveRecord::Associations::ClassMethods |
In: |
vendor/rails/activerecord/lib/active_record/associations.rb
vendor/rails/activerecord/lib/active_record/deprecated_associations.rb |
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:
Both express a 1-1 relationship, the difference is mostly where to place the foreign key, which goes on the table for the class saying belongs_to. 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) )
You can manipulate objects and associations before they are saved to the database, but there is some special behaviour you should be aware of, mostly involving the saving of associated objects.
Similiar to the normal callbacks that hook into the lifecycle of an Active Record object, you can also define callbacks that get trigged when you add an object to or removing an object from a 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.
The proxy objects that controls 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:
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.
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 <tt>:as</tt> 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.
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 is a way to find objects of a certain class and a number of named associations along with it in a single SQL call. This is one of the easiest ways of to prevent the dreaded 1+N problem in which fetching 100 posts that each needs to display their author triggers 101 database queries. Through the use of eager loading, the 101 queries can be reduced to 1. Example:
class Post < ActiveRecord::Base belongs_to :author has_many :comments end
Consider the following loop using the class above:
for post in Post.find(: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, so the find will now weave in a join something like this: LEFT OUTER JOIN authors ON authors.id = posts.author_id. Doing so will cut down the number of queries from 201 to 101.
We can improve upon the situation further by referencing both associations in the finder with:
for post in Post.find(:all, :include => [ :author, :comments ])
That‘ll add another join along the lines of: LEFT OUTER JOIN comments ON comments.post_id = posts.id. And we’ll be down to 1 query. But that shouldn’t fool you to think 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.
Please note that limited eager loading with has_many and has_and_belongs_to_many associations is not compatible with describing conditions on these eager tables. This will work:
Post.find(:all, :include => :comments, :conditions => "posts.title = 'magic forest'", :limit => 2)
…but this will not (and an ArgumentError will be raised):
Post.find(:all, :include => :comments, :conditions => "comments.body like 'Normal%'", :limit => 2)
Also have in mind that since the eager loading is pulling from multiple tables, you’ll have to disambiguate any column references in both conditions and orders. So :order => "posts.id DESC" will work while :order => "id DESC" will not. This may require that you alter the :order and :conditions on the association definitions themselves. Because eager loading generates the SELECT statement too, the :select option is ignored.
It’s currently not possible to use eager loading on multiple associations from the same table. Eager loading will not pull additional attributes on join tables, so "rich associations" with has_and_belongs_to_many is not a good fit for eager loading.
ActiveRecord 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, :include => :comments # => SELECT ... FROM posts LEFT OUTER JOIN comments ON ... Post.find :all, :include => :special_comments # STI # => SELECT ... FROM posts LEFT OUTER JOIN comments ON ... AND comments.type = 'SpecialComment' Post.find :all, :include => [:comments, :special_comments] # special_comments is the reflection name, posts is the parent table name # => SELECT ... FROM posts LEFT OUTER JOIN comments ON ... LEFT OUTER JOIN comments special_comments_posts
Acts as tree example:
TreeMixin.find :all, :include => :children # => SELECT ... FROM mixins LEFT OUTER JOIN mixins childrens_mixins ... TreeMixin.find :all, :include => {:children => :parent} # using cascading eager includes # => SELECT ... FROM mixins LEFT OUTER JOIN mixins childrens_mixins ... LEFT OUTER JOIN parents_mixins ... TreeMixin.find :all, :include => {:children => {:parent => :children}} # => SELECT ... FROM mixins LEFT OUTER JOIN mixins childrens_mixins ... LEFT OUTER JOIN parents_mixins ...
LEFT OUTER JOIN mixins childrens_mixins_2
Has and Belongs to Many join tables use the same idea, but add a _join suffix:
Post.find :all, :include => :categories # => SELECT ... FROM posts LEFT OUTER JOIN categories_posts ... LEFT OUTER JOIN categories ... Post.find :all, :include => {:categories => :posts} # => SELECT ... FROM posts LEFT OUTER JOIN categories_posts ... LEFT OUTER JOIN categories ... LEFT OUTER JOIN categories_posts posts_categories_join LEFT OUTER JOIN posts posts_categories Post.find :all, :include => {:categories => {:posts => :categories}} # => SELECT ... FROM posts LEFT OUTER JOIN categories_posts ... LEFT OUTER JOIN categories ... LEFT OUTER JOIN categories_posts posts_categories_join LEFT OUTER JOIN posts posts_categories LEFT OUTER JOIN categories_posts categories_posts_join LEFT OUTER JOIN categories categories_posts
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, :include => :comments, :joins => "inner join comments ..." # => SELECT ... FROM posts LEFT OUTER JOIN comments_posts ON ... INNER JOIN comments ... Post.find :all, :include => [:comments, :special_comments], :joins => "inner join comments ..." # => SELECT ... FROM posts LEFT OUTER JOIN comments comments_posts ON ... LEFT OUTER 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.
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 Company < ActiveRecord::Base; end end end
When Firm#clients is called, it’ll in turn call MyApplication::Business::Company.find(firm.id). If you want to associate with a class in another module scope this can be done by specifying the complete class name, such as:
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
If you attempt to assign an object to an association that doesn’t match the inferred or specified :class_name, you’ll get a ActiveRecord::AssociationTypeMismatch.
All of the association macros can be specialized through options which makes more complex cases than the simple and guessable ones possible.
Adds the following methods for retrieval and query for a single associated object that this object holds an id to. association is replaced with the symbol passed as the first argument, so belongs_to :author would add among others author.nil?.
Example: A Post class declares belongs_to :author, which will add:
The declaration can also include an options hash to specialize the behavior of the association.
Options are:
Option examples:
belongs_to :firm, :foreign_key => "client_of" belongs_to :author, :class_name => "Person", :foreign_key => "author_id" belongs_to :valid_coupon, :class_name => "Coupon", :foreign_key => "coupon_id", :conditions => 'discounts > #{payments_count}' belongs_to :attachable, :polymorphic => true
# File vendor/rails/activerecord/lib/active_record/associations.rb, line 658 658: def belongs_to(association_id, options = {}) 659: if options.include?(:class_name) && !options.include?(:foreign_key) 660: ::ActiveSupport::Deprecation.warn( 661: "The inferred foreign_key name will change in Rails 2.0 to use the association name instead of its class name when they differ. When using :class_name in belongs_to, use the :foreign_key option to explicitly set the key name to avoid problems in the transition.", 662: caller) 663: end 664: 665: reflection = create_belongs_to_reflection(association_id, options) 666: 667: if reflection.options[:polymorphic] 668: association_accessor_methods(reflection, BelongsToPolymorphicAssociation) 669: 670: module_eval do 671: before_save "association = instance_variable_get(\"@\#{reflection.name}\")\nif association && association.target\nif association.new_record?\nassociation.save(true)\nend\n\nif association.updated?\nself[\"\#{reflection.primary_key_name}\"] = association.id\nself[\"\#{reflection.options[:foreign_type]}\"] = association.class.base_class.name.to_s\nend\nend\n" 672: end 673: else 674: association_accessor_methods(reflection, BelongsToAssociation) 675: association_constructor_method(:build, reflection, BelongsToAssociation) 676: association_constructor_method(:create, reflection, BelongsToAssociation) 677: 678: module_eval do 679: before_save "association = instance_variable_get(\"@\#{reflection.name}\")\nif !association.nil?\nif association.new_record?\nassociation.save(true)\nend\n\nif association.updated?\nself[\"\#{reflection.primary_key_name}\"] = association.id\nend\nend\n" 680: end 681: 682: # deprecated api 683: deprecated_has_association_method(reflection.name) 684: deprecated_association_comparison_method(reflection.name, reflection.class_name) 685: end 686: 687: if options[:counter_cache] 688: cache_column = options[:counter_cache] == true ? 689: "#{self.to_s.underscore.pluralize}_count" : 690: options[:counter_cache] 691: 692: module_eval( 693: "after_create '#{reflection.name}.class.increment_counter(\"#{cache_column}\", #{reflection.primary_key_name})" + 694: " unless #{reflection.name}.nil?'" 695: ) 696: 697: module_eval( 698: "before_destroy '#{reflection.name}.class.decrement_counter(\"#{cache_column}\", #{reflection.primary_key_name})" + 699: " unless #{reflection.name}.nil?'" 700: ) 701: end 702: end
Associates two classes via an intermediate join table. Unless the join table is explicitly specified as an option, it is guessed using the lexical order of the class names. So a join between Developer and Project will give the default join table name of "developers_projects" because "D" outranks "P".
Deprecated: Any additional fields added to the join table will be placed as attributes when pulling records out through has_and_belongs_to_many associations. Records returned from join tables with additional attributes will be marked as ReadOnly (because we can’t save changes to the additional attrbutes). It’s strongly recommended that you upgrade any associations with attributes to a real join model (see introduction).
Adds the following methods for retrieval and query. collection is replaced with the symbol passed as the first argument, so has_and_belongs_to_many :categories would add among others categories.empty?.
Example: An Developer class declares has_and_belongs_to_many :projects, which will add:
The declaration may include an options hash to specialize the behavior of the association.
Options are:
Option examples:
has_and_belongs_to_many :projects has_and_belongs_to_many :projects, :include => [ :milestones, :manager ] has_and_belongs_to_many :nations, :class_name => "Country" has_and_belongs_to_many :categories, :join_table => "prods_cats" has_and_belongs_to_many :active_projects, :join_table => 'developers_projects', :delete_sql => 'DELETE FROM developers_projects WHERE active=1 AND developer_id = #{id} AND project_id = #{record.id}'
# File vendor/rails/activerecord/lib/active_record/associations.rb, line 815 815: def has_and_belongs_to_many(association_id, options = {}, &extension) 816: reflection = create_has_and_belongs_to_many_reflection(association_id, options, &extension) 817: 818: add_multiple_associated_save_callbacks(reflection.name) 819: collection_accessor_methods(reflection, HasAndBelongsToManyAssociation) 820: 821: # Don't use a before_destroy callback since users' before_destroy 822: # callbacks will be executed after the association is wiped out. 823: old_method = "destroy_without_habtm_shim_for_#{reflection.name}" 824: class_eval "alias_method :\#{old_method}, :destroy_without_callbacks\ndef destroy_without_callbacks\n\#{reflection.name}.clear\n\#{old_method}\nend\n" 825: 826: add_association_callbacks(reflection.name, options) 827: 828: # deprecated api 829: deprecated_collection_count_method(reflection.name) 830: deprecated_add_association_relation(reflection.name) 831: deprecated_remove_association_relation(reflection.name) 832: deprecated_has_collection_method(reflection.name) 833: end
Adds the following methods for retrieval and query of collections of associated objects. collection is replaced with the symbol passed as the first argument, so has_many :clients would add among others clients.empty?.
Example: A Firm class declares has_many :clients, which will add:
The declaration can also include an options hash to specialize the behavior of the association.
Options are:
Option examples:
has_many :comments, :order => "posted_on" has_many :comments, :include => :author has_many :people, :class_name => "Person", :conditions => "deleted = 0", :order => "name" has_many :tracks, :order => "position", :dependent => :destroy has_many :comments, :dependent => :nullify has_many :tags, :as => :taggable has_many :subscribers, :through => :subscriptions, :source => :user has_many :subscribers, :class_name => "Person", :finder_sql => 'SELECT DISTINCT people.* ' + 'FROM people p, post_subscriptions ps ' + 'WHERE ps.post_id = #{id} AND ps.person_id = p.id ' + 'ORDER BY p.first_name'
# File vendor/rails/activerecord/lib/active_record/associations.rb, line 527 527: def has_many(association_id, options = {}, &extension) 528: reflection = create_has_many_reflection(association_id, options, &extension) 529: 530: configure_dependency_for_has_many(reflection) 531: 532: if options[:through] 533: collection_reader_method(reflection, HasManyThroughAssociation) 534: else 535: add_multiple_associated_save_callbacks(reflection.name) 536: add_association_callbacks(reflection.name, reflection.options) 537: collection_accessor_methods(reflection, HasManyAssociation) 538: end 539: 540: add_deprecated_api_for_has_many(reflection.name) 541: end
Adds the following methods for retrieval and query of a single associated object. association is replaced with the symbol passed as the first argument, so has_one :manager would add among others manager.nil?.
Example: An Account class declares has_one :beneficiary, which will add:
The declaration can also include an options hash to specialize the behavior of the association.
Options are:
an "ORDER BY" sql fragment, such as "last_name, first_name DESC"
Option examples:
has_one :credit_card, :dependent => :destroy # destroys the associated credit card has_one :credit_card, :dependent => :nullify # updates the associated records foriegn key value to null rather than destroying it has_one :last_comment, :class_name => "Comment", :order => "posted_on" has_one :project_manager, :class_name => "Person", :conditions => "role = 'project_manager'" has_one :attachment, :as => :attachable
# File vendor/rails/activerecord/lib/active_record/associations.rb, line 588 588: def has_one(association_id, options = {}) 589: reflection = create_has_one_reflection(association_id, options) 590: 591: module_eval do 592: after_save "association = instance_variable_get(\"@\#{reflection.name}\")\nif !association.nil? && (new_record? || association.new_record? || association[\"\#{reflection.primary_key_name}\"] != id)\nassociation[\"\#{reflection.primary_key_name}\"] = id\nassociation.save(true)\nend\n" 593: end 594: 595: association_accessor_methods(reflection, HasOneAssociation) 596: association_constructor_method(:build, reflection, HasOneAssociation) 597: association_constructor_method(:create, reflection, HasOneAssociation) 598: 599: configure_dependency_for_has_one(reflection) 600: 601: # deprecated api 602: deprecated_has_association_method(reflection.name) 603: deprecated_association_comparison_method(reflection.name, reflection.class_name) 604: end