Module: Sequel::Model::Associations::ClassMethods

Defined in:
lib/sequel/model/associations.rb

Overview

Each kind of association adds a number of instance methods to the model class which are specialized according to the association type and optional parameters given in the definition. Example:

class Project < Sequel::Model
  many_to_one :portfolio
  # or: one_to_one :portfolio
  one_to_many :milestones
  # or: many_to_many :milestones 
end

The project class now has the following instance methods:

portfolio

Returns the associated portfolio.

portfolio=(obj)

Sets the associated portfolio to the object, but the change is not persisted until you save the record (for many_to_one associations).

portfolio_dataset

Returns a dataset that would return the associated portfolio, only useful in fairly specific circumstances.

milestones

Returns an array of associated milestones

add_milestone(obj)

Associates the passed milestone with this object.

remove_milestone(obj)

Removes the association with the passed milestone.

remove_all_milestones

Removes associations with all associated milestones.

milestones_dataset

Returns a dataset that would return the associated milestones, allowing for further filtering/limiting/etc.

If you want to override the behavior of the add_/remove_/remove_all_/ methods or the association setter method, use the :adder, :remover, :clearer, and/or :setter options. These options override the default behavior.

By default the classes for the associations are inferred from the association name, so for example the Project#portfolio will return an instance of Portfolio, and Project#milestones will return an array of Milestone instances. You can use the :class option to change which class is used.

Association definitions are also reflected by the class, e.g.:

Project.associations
=> [:portfolio, :milestones]
Project.association_reflection(:portfolio)
=> {:type => :many_to_one, :name => :portfolio, ...}

Associations should not have the same names as any of the columns in the model’s current table they reference. If you are dealing with an existing schema that has a column named status, you can’t name the association status, you’d have to name it foo_status or something else. If you give an association the same name as a column, you will probably end up with an association that doesn’t work, or a SystemStackError.

For a more in depth general overview, as well as a reference guide, see the Association Basics guide. For examples of advanced usage, see the Advanced Associations guide.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#association_reflections ⇒ Object (readonly)

All association reflections defined for this model (default: {}).



1406
1407
1408
 
# File 'lib/sequel/model/associations.rb', line 1406

def association_reflections
  @association_reflections
end

#autoreloading_associations ⇒ Object (readonly)

Hash with column symbol keys and arrays of many_to_one association symbols that should be cleared when the column value changes.



1411
1412
1413
 
# File 'lib/sequel/model/associations.rb', line 1411

def autoreloading_associations
  @autoreloading_associations
end

#cache_associations ⇒ Object

Whether association metadata should be cached in the association reflection. If not cached, it will be computed on demand. In general you only want to set this to default when using code reloading. When using code reloading, setting this will make sure that if an associated class is removed or modified, this class will not hang on to the previous class.



1417
1418
1419
 
# File 'lib/sequel/model/associations.rb', line 1417

def cache_associations
  @cache_associations
end

#default_eager_limit_strategy ⇒ Object

The default :eager_limit_strategy option to use for limited or offset associations (default: true, causing Sequel to use what it considers the most appropriate strategy).



1421
1422
1423
 
# File 'lib/sequel/model/associations.rb', line 1421

def default_eager_limit_strategy
  @default_eager_limit_strategy
end

Instance Method Details

#all_association_reflections ⇒ Object

Array of all association reflections for this model class



1424
1425
1426
 
# File 'lib/sequel/model/associations.rb', line 1424

def all_association_reflections
  association_reflections.values
end

#associate(type, name, opts = OPTS, &block) ⇒ Object

Associates a related model with the current model. The following types are supported:

:many_to_one

Foreign key in current model’s table points to associated model’s primary key. Each associated model object can be associated with more than one current model objects. Each current model object can be associated with only one associated model object.

:one_to_many

Foreign key in associated model’s table points to this model’s primary key. Each current model object can be associated with more than one associated model objects. Each associated model object can be associated with only one current model object.

:one_through_one

Similar to many_to_many in terms of foreign keys, but only one object is associated to the current object through the association. Provides only getter methods, no setter or modification methods.

:one_to_one

Similar to one_to_many in terms of foreign keys, but only one object is associated to the current object through the association. The methods created are similar to many_to_one, except that the one_to_one setter method saves the passed object.

:many_to_many

A join table is used that has a foreign key that points to this model’s primary key and a foreign key that points to the associated model’s primary key. Each current model object can be associated with many associated model objects, and each associated model object can be associated with many current model objects.

The following options can be supplied:

Multiple Types

:adder

Proc used to define the private add* method for doing the database work to associate the given object to the current object (*_to_many assocations).

:after_add

Symbol, Proc, or array of both/either specifying a callback to call after a new item is added to the association.

:after_load

Symbol, Proc, or array of both/either specifying a callback to call after the associated record(s) have been retrieved from the database.

:after_remove

Symbol, Proc, or array of both/either specifying a callback to call after an item is removed from the association.

:after_set

Symbol, Proc, or array of both/either specifying a callback to call after an item is set using the association setter method.

:allow_eager

If set to false, you cannot load the association eagerly via eager or eager_graph

:before_add

Symbol, Proc, or array of both/either specifying a callback to call before a new item is added to the association.

:before_remove

Symbol, Proc, or array of both/either specifying a callback to call before an item is removed from the association.

:before_set

Symbol, Proc, or array of both/either specifying a callback to call before an item is set using the association setter method.

:cartesian_product_number

the number of joins completed by this association that could cause more than one row for each row in the current table (default: 0 for many_to_one, one_to_one, and one_through_one associations, 1 for one_to_many and many_to_many associations).

:class

The associated class or its name as a string or symbol. If not given, uses the association’s name, which is camelized (and singularized unless the type is :many_to_one, :one_to_one, or one_through_one). If this is specified as a string or symbol, you must specify the full class name (e.g. “SomeModule::MyModel”).

:clearer

Proc used to define the private remove_all* method for doing the database work to remove all objects associated to the current object (*_to_many assocations).

:clone

Merge the current options and block into the options and block used in defining the given association. Can be used to DRY up a bunch of similar associations that all share the same options such as :class and :key, while changing the order and block used.

:conditions

The conditions to use to filter the association, can be any argument passed to where.

:dataset

A proc that is instance_execed to get the base dataset to use (before the other options are applied). If the proc accepts an argument, it is passed the related association reflection.

:distinct

Use the DISTINCT clause when selecting associating object, both when lazy loading and eager loading via .eager (but not when using .eager_graph).

:eager

The associations to eagerly load via eager when loading the associated object(s).

:eager_block

If given, use the block instead of the default block when eagerly loading. To not use a block when eager loading (when one is used normally), set to nil.

:eager_graph

The associations to eagerly load via eager_graph when loading the associated object(s). many_to_many associations with this option cannot be eagerly loaded via eager.

:eager_grapher

A proc to use to implement eager loading via eager_graph, overriding the default. Takes an options hash with at least the entries :self (the receiver of the eager_graph call), :table_alias (the alias to use for table to graph into the association), and :implicit_qualifier (the alias that was used for the current table). Should return a copy of the dataset with the association graphed into it.

:eager_limit_strategy

Determines the strategy used for enforcing limits and offsets when eager loading associations via the eager method.

:eager_loader

A proc to use to implement eager loading, overriding the default. Takes a single hash argument, with at least the keys: :rows, which is an array of current model instances, :associations, which is a hash of dependent associations, :self, which is the dataset doing the eager loading, :eager_block, which is a dynamic callback that should be called with the dataset, and :id_map, which is a mapping of key values to arrays of current model instances. In the proc, the associated records should be queried from the database and the associations cache for each record should be populated.

:eager_loader_key

A symbol for the key column to use to populate the key_hash for the eager loader. Can be set to nil to not populate the key_hash.

:extend

A module or array of modules to extend the dataset with.

:filter_limit_strategy

Determines the strategy used for enforcing limits and offsets when filtering by limited associations. Possible options are :window_function, :distinct_on, or :correlated_subquery depending on association type and database type.

:graph_alias_base

The base name to use for the table alias when eager graphing. Defaults to the name of the association. If the alias name has already been used in the query, Sequel will create a unique alias by appending a numeric suffix (e.g. alias_0, alias_1, …) until the alias is unique.

:graph_block

The block to pass to join_table when eagerly loading the association via eager_graph.

:graph_conditions

The additional conditions to use on the SQL join when eagerly loading the association via eager_graph. Should be a hash or an array of two element arrays. If not specified, the :conditions option is used if it is a hash or array of two element arrays.

:graph_join_type

The type of SQL join to use when eagerly loading the association via eager_graph. Defaults to :left_outer.

:graph_only_conditions

The conditions to use on the SQL join when eagerly loading the association via eager_graph, instead of the default conditions specified by the foreign/primary keys. This option causes the :graph_conditions option to be ignored.

:graph_order

Over the order to use when using eager_graph, instead of the default order. This should be used in the case where :order contains an identifier qualified by the table’s name, which may not match the alias used when eager graphing. By setting this to the unqualified identifier, it will be automatically qualified when using eager_graph.

:graph_select

A column or array of columns to select from the associated table when eagerly loading the association via eager_graph. Defaults to all columns in the associated table.

:limit

Limit the number of records to the provided value. Use an array with two elements for the value to specify a limit (first element) and an offset (second element).

:methods_module

The module that methods the association creates will be placed into. Defaults to the module containing the model’s columns.

:order

the column(s) by which to order the association dataset. Can be a singular column symbol or an array of column symbols.

:order_eager_graph

Whether to add the association’s order to the graphed dataset’s order when graphing via eager_graph. Defaults to true, so set to false to disable.

:read_only

Do not add a setter method (for many_to_one or one_to_one associations), or add_/remove_/remove_all_ methods (for one_to_many and many_to_many associations). Always true for one_through_one associations.

:reciprocal

the symbol name of the reciprocal association, if it exists. By default, Sequel will try to determine it by looking at the associated model’s assocations for a association that matches the current association’s key(s). Set to nil to not use a reciprocal.

:remover

Proc used to define the private remove* method for doing the database work to remove the association between the given object and the current object (*_to_many assocations).

:select

the columns to select. Defaults to the associated class’s table_name.* in an association that uses joins, which means it doesn’t include the attributes from the join table. If you want to include the join table attributes, you can use this option, but beware that the join table attributes can clash with attributes from the model table, so you should alias any attributes that have the same name in both the join table and the associated table.

:setter

Proc used to define the private _*= method for doing the work to setup the assocation between the given object and the current object (*_to_one associations).

:subqueries_per_union

The number of subqueries to use in each UNION query, for eager loading limited associations using the default :union strategy.

:validate

Set to false to not validate when implicitly saving any associated object.

:many_to_one

:key

foreign key in current model’s table that references associated model’s primary key, as a symbol. Defaults to :“#name_id”. Can use an array of symbols for a composite key association.

:key_column

Similar to, and usually identical to, :key, but :key refers to the model method to call, where :key_column refers to the underlying column. Should only be used if the model method differs from the foreign key column, in conjunction with defining a model alias method for the key column.

:primary_key

column in the associated table that :key option references, as a symbol. Defaults to the primary key of the associated table. Can use an array of symbols for a composite key association.

:primary_key_method

the method symbol or array of method symbols to call on the associated object to get the foreign key values. Defaults to :primary_key option.

:qualify

Whether to use qualifier primary keys when loading the association. The default is true, so you must set to false to not qualify. Qualification rarely causes problems, but it’s necessary to disable in some cases, such as when you are doing a JOIN USING operation on the column on Oracle.

:one_to_many and :one_to_one

:key

foreign key in associated model’s table that references current model’s primary key, as a symbol. Defaults to :“#Sequel::Model::Associations::ClassMethods.selfself.nameself.name.underscore_id”. Can use an array of symbols for a composite key association.

:key_method

the method symbol or array of method symbols to call on the associated object to get the foreign key values. Defaults to :key option.

:primary_key

column in the current table that :key option references, as a symbol. Defaults to primary key of the current table. Can use an array of symbols for a composite key association.

:primary_key_column

Similar to, and usually identical to, :primary_key, but :primary_key refers to the model method call, where :primary_key_column refers to the underlying column. Should only be used if the model method differs from the primary key column, in conjunction with defining a model alias method for the primary key column.

:raise_on_save_failure

Do not raise exceptions for hook or validation failures when saving associated objects in the add/remove methods (return nil instead) [one_to_many only].

:many_to_many and :one_through_one

:graph_join_table_block

The block to pass to join_table for the join table when eagerly loading the association via eager_graph.

:graph_join_table_conditions

The additional conditions to use on the SQL join for the join table when eagerly loading the association via eager_graph. Should be a hash or an array of two element arrays.

:graph_join_table_join_type

The type of SQL join to use for the join table when eagerly loading the association via eager_graph. Defaults to the :graph_join_type option or :left_outer.

:graph_join_table_only_conditions

The conditions to use on the SQL join for the join table when eagerly loading the association via eager_graph, instead of the default conditions specified by the foreign/primary keys. This option causes the :graph_join_table_conditions option to be ignored.

:join_table

name of table that includes the foreign keys to both the current model and the associated model, as a symbol. Defaults to the name of current model and name of associated model, pluralized, underscored, sorted, and joined with ‘_’.

:join_table_block

proc that can be used to modify the dataset used in the add/remove/remove_all methods. Should accept a dataset argument and return a modified dataset if present.

:left_key

foreign key in join table that points to current model’s primary key, as a symbol. Defaults to :“#Sequel::Model::Associations::ClassMethods.selfself.nameself.name.underscore_id”. Can use an array of symbols for a composite key association.

:left_primary_key

column in current table that :left_key points to, as a symbol. Defaults to primary key of current table. Can use an array of symbols for a composite key association.

:left_primary_key_column

Similar to, and usually identical to, :left_primary_key, but :left_primary_key refers to the model method to call, where :left_primary_key_column refers to the underlying column. Should only be used if the model method differs from the left primary key column, in conjunction with defining a model alias method for the left primary key column.

:right_key

foreign key in join table that points to associated model’s primary key, as a symbol. Defaults to :“#Sequel::Model::Associations::ClassMethods.namename.to_sname.to_s.singularize_id”. Can use an array of symbols for a composite key association.

:right_primary_key

column in associated table that :right_key points to, as a symbol. Defaults to primary key of the associated table. Can use an array of symbols for a composite key association.

:right_primary_key_method

the method symbol or array of method symbols to call on the associated object to get the foreign key values for the join table. Defaults to :right_primary_key option.

:uniq

Adds a after_load callback that makes the array of objects unique.

Raises:



1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
 
# File 'lib/sequel/model/associations.rb', line 1640

def associate(type, name, opts = OPTS, &block)
  raise(Error, 'invalid association type') unless assoc_class = ASSOCIATION_TYPES[type]
  raise(Error, 'Model.associate name argument must be a symbol') unless name.is_a?(Symbol)

  # dup early so we don't modify opts
  orig_opts = opts.dup

  if opts[:clone]
    cloned_assoc = association_reflection(opts[:clone])
    orig_opts = cloned_assoc[:orig_opts].merge(orig_opts)
  end

  opts = orig_opts.merge(:type => type, :name => name, :cache=>({} if cache_associations), :model => self)
  opts[:block] = block if block
  if block || orig_opts[:block] || orig_opts[:dataset]
    # It's possible the association is instance specific, in that it depends on
    # values other than the foreign key value.  This needs to be checked for
    # in certain places to disable optimizations.
    opts[:instance_specific] = true
  end
  opts = assoc_class.new.merge!(opts)

  if opts[:clone] && !opts.cloneable?(cloned_assoc)
    raise(Error, "cannot clone an association to an association of different type (association #{name} with type #{type} cloning #{opts[:clone]} with type #{cloned_assoc[:type]})")
  end

  opts[:eager_block] = opts[:block] unless opts.include?(:eager_block)
  if !opts.has_key?(:predicate_key) && opts.has_key?(:eager_loading_predicate_key)
    opts[:predicate_key] = opts[:eager_loading_predicate_key]
  end
  opts[:graph_join_type] ||= :left_outer
  opts[:order_eager_graph] = true unless opts.include?(:order_eager_graph)
  conds = opts[:conditions]
  opts[:graph_alias_base] ||= name
  opts[:graph_conditions] = conds if !opts.include?(:graph_conditions) and Sequel.condition_specifier?(conds)
  opts[:graph_conditions] = opts.fetch(:graph_conditions, []).to_a
  opts[:graph_select] = Array(opts[:graph_select]) if opts[:graph_select]
  [:before_add, :before_remove, :after_add, :after_remove, :after_load, :before_set, :after_set, :extend].each do |cb_type|
    opts[cb_type] = Array(opts[cb_type])
  end
  late_binding_class_option(opts, opts.returns_array? ? singularize(name) : name)
  
  # Remove :class entry if it exists and is nil, to work with cached_fetch
  opts.delete(:class) unless opts[:class]

  send(:"def_#{type}", opts)
  def_association_instance_methods(opts)
      
  orig_opts.delete(:clone)
  orig_opts.merge!(:class_name=>opts[:class_name], :class=>opts[:class], :block=>opts[:block])
  opts[:orig_opts] = orig_opts
  # don't add to association_reflections until we are sure there are no errors
  association_reflections[name] = opts
end

#association_reflection(name) ⇒ Object

The association reflection hash for the association of the given name.



1696
1697
1698
 
# File 'lib/sequel/model/associations.rb', line 1696

def association_reflection(name)
  association_reflections[name]
end

#associations ⇒ Object

Array of association name symbols



1701
1702
1703
 
# File 'lib/sequel/model/associations.rb', line 1701

def associations
  association_reflections.keys
end

#eager_load_results(opts, eo, &block) ⇒ Object

Eager load the association with the given eager loader options.



1706
1707
1708
 
# File 'lib/sequel/model/associations.rb', line 1706

def eager_load_results(opts, eo, &block)
  opts.eager_load_results(eo, &block)
end

#many_to_many(name, opts = OPTS, &block) ⇒ Object

Shortcut for adding a many_to_many association, see #associate



1711
1712
1713
 
# File 'lib/sequel/model/associations.rb', line 1711

def many_to_many(name, opts=OPTS, &block)
  associate(:many_to_many, name, opts, &block)
end

#many_to_one(name, opts = OPTS, &block) ⇒ Object

Shortcut for adding a many_to_one association, see #associate



1716
1717
1718
 
# File 'lib/sequel/model/associations.rb', line 1716

def many_to_one(name, opts=OPTS, &block)
  associate(:many_to_one, name, opts, &block)
end

#one_through_one(name, opts = OPTS, &block) ⇒ Object

Shortcut for adding a one_through_one association, see #associate.



1721
1722
1723
 
# File 'lib/sequel/model/associations.rb', line 1721

def one_through_one(name, opts=OPTS, &block)
  associate(:one_through_one, name, opts, &block)
end

#one_to_many(name, opts = OPTS, &block) ⇒ Object

Shortcut for adding a one_to_many association, see #associate



1726
1727
1728
 
# File 'lib/sequel/model/associations.rb', line 1726

def one_to_many(name, opts=OPTS, &block)
  associate(:one_to_many, name, opts, &block)
end

#one_to_one(name, opts = OPTS, &block) ⇒ Object

Shortcut for adding a one_to_one association, see #associate.



1731
1732
1733
 
# File 'lib/sequel/model/associations.rb', line 1731

def one_to_one(name, opts=OPTS, &block)
  associate(:one_to_one, name, opts, &block)
end