module Sequel::Model::Associations::ClassMethods

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.

Attributes

association_reflections[R]

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

default_eager_limit_strategy[RW]

The default :eager_limit_strategy option to use for *_many associations (default: nil)

Public Instance Methods

all_association_reflections() click to toggle source

Array of all association reflections for this model class

# File lib/sequel/model/associations.rb, line 734
def all_association_reflections
  association_reflections.values
end
apply_association_dataset_opts(opts, ds) click to toggle source

Given an association reflection and a dataset, apply the :select, :conditions, :order, :eager, :distinct, and :eager_block association options to the given dataset and return the dataset or a modified copy of it.

# File lib/sequel/model/associations.rb, line 742
def apply_association_dataset_opts(opts, ds)
  ds = ds.select(*opts.select) if opts.select
  if c = opts[:conditions]
    ds = (c.is_a?(Array) && !Sequel.condition_specifier?(c)) ? ds.where(*c) : ds.where(c)
  end
  ds = ds.order(*opts[:order]) if opts[:order]
  ds = ds.eager(opts[:eager]) if opts[:eager]
  ds = ds.distinct if opts[:distinct]
  ds = opts[:eager_block].call(ds) if opts[:eager_block]
  ds
end
associate(type, name, opts = {}, &block) click to toggle source

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_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 and #one_to_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 or :one_to_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 the entries :self (the receiver of the eager_graph call), :table_alias (the alias to use for table to graph into the association), :implicit_qualifier (the alias that was used for the current table), and possibly :eager_block (a callback proc accepting the associated dataset, for per-call customization). Should return a copy of the dataset with the association graphed into it.

:eager_limit_strategy

Determines the strategy used for enforcing limits when eager loading associations via the eager method. For #one_to_one associations, no strategy is used by default, and for *_many associations, the :ruby strategy is used by default, which still retrieves all records but slices the resulting array after the association is retrieved. You can pass a true value for this option to have Sequel pick what it thinks is the best choice for the database, or specify a specific symbol to manually select a strategy. #one_to_one associations support :distinct_on and :window_function. *_many associations support :ruby, and :window_function.

: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.

: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_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).

: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 a #many_to_many association, 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).

: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 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 :“#{self.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 the model method differs from the primary key column, in conjunction with defining a model alias method for the primary key column.

:many_to_many

: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 :“#{self.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 :“#{name.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.

# File lib/sequel/model/associations.rb, line 958
def associate(type, name, opts = {}, &block)
  if opts[:one_to_one] && type == :one_to_many
    Sequel::Deprecation.deprecate('Raising an Error when the one_to_many type uses the :one_to_one option', "Use the one_to_one associationtype")
    raise(Error, 'one_to_many association type with :one_to_one option removed, used one_to_one association type')
  end
  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)
  raise(Error, ':eager_loader option must have an arity of 1 or 3') if opts[:eager_loader] && ![1, 3].include?(opts[:eager_loader].arity)
  raise(Error, ':eager_grapher option must have an arity of 1 or 3') if opts[:eager_grapher] && ![1, 3].include?(opts[:eager_grapher].arity)

  Sequel::Deprecation.deprecate('The :eager_loader association option accepting 3 arguments', "Please switch to accepting a single options hash") if opts[:eager_loader] && opts[:eager_loader].arity == 3
  Sequel::Deprecation.deprecate('The :eager_grapher association option accepting 3 arguments', "Please switch to accepting a single options hash") if opts[:eager_grapher] && opts[:eager_grapher].arity == 3

  # dup early so we don't modify opts
  orig_opts = opts.dup
  if opts[:clone]
    cloned_assoc = association_reflection(opts[:clone])
    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]})") unless cloned_assoc[:type] == type || [cloned_assoc[:type], type].all?{|t| [:one_to_many, :one_to_one].include?(t)}
    orig_opts = cloned_assoc[:orig_opts].merge(orig_opts)
  end
  opts = orig_opts.merge(:type => type, :name => name, :cache=>{}, :model => self)
  opts[:block] = block if block
  opts = assoc_class.new.merge!(opts)
  opts[:eager_block] = 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)
      
  orig_opts.delete(:clone)
  orig_opts.merge!(:class_name=>opts[:class_name], :class=>opts[:class], :block=>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) click to toggle source

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

# File lib/sequel/model/associations.rb, line 1010
def association_reflection(name)
  association_reflections[name]
end
associations() click to toggle source

Array of association name symbols

# File lib/sequel/model/associations.rb, line 1015
def associations
  association_reflections.keys
end
eager_loading_dataset(opts, ds, select, associations, eager_options={}) click to toggle source

Modify and return eager loading dataset based on association options.

# File lib/sequel/model/associations.rb, line 1020
def eager_loading_dataset(opts, ds, select, associations, eager_options={})
  ds = apply_association_dataset_opts(opts, ds)
  ds = ds.select(*select) if select
  if opts[:eager_graph]
    raise(Error, "cannot eagerly load a #{opts[:type]} association that uses :eager_graph") if opts.eager_loading_use_associated_key?
    ds = ds.eager_graph(opts[:eager_graph])
  end
  ds = ds.eager(associations) unless Array(associations).empty?
  ds = eager_options[:eager_block].call(ds) if eager_options[:eager_block]
  if opts.eager_loading_use_associated_key?
    ds = if opts[:uses_left_composite_keys]
      ds.select_append(*opts.associated_key_alias.zip(opts.predicate_keys).map{|a, k| SQL::AliasedExpression.new(k, a)})
    else
      ds.select_append(SQL::AliasedExpression.new(opts.predicate_key, opts.associated_key_alias))
    end
  end
  ds
end
many_to_many(name, opts={}, &block) click to toggle source

Shortcut for adding a #many_to_many association, see associate

# File lib/sequel/model/associations.rb, line 1040
def many_to_many(name, opts={}, &block)
  associate(:many_to_many, name, opts, &block)
end
many_to_one(name, opts={}, &block) click to toggle source

Shortcut for adding a #many_to_one association, see associate

# File lib/sequel/model/associations.rb, line 1045
def many_to_one(name, opts={}, &block)
  associate(:many_to_one, name, opts, &block)
end
one_to_many(name, opts={}, &block) click to toggle source

Shortcut for adding a #one_to_many association, see associate

# File lib/sequel/model/associations.rb, line 1050
def one_to_many(name, opts={}, &block)
  associate(:one_to_many, name, opts, &block)
end
one_to_one(name, opts={}, &block) click to toggle source

Shortcut for adding a #one_to_one association, see associate.

# File lib/sequel/model/associations.rb, line 1055
def one_to_one(name, opts={}, &block)
  associate(:one_to_one, name, opts, &block)
end

Private Instance Methods

apply_correlated_subquery_eager_limit_strategy(ds, opts) { |kds. unlimited. from(aliased_expression). select(*map{|k| qualified_identifier}). order(*order). limit(limit, offset)| ... } click to toggle source

Use a correlated subquery to limit the results of the eager loading dataset.

# File lib/sequel/model/associations.rb, line 1065
def apply_correlated_subquery_eager_limit_strategy(ds, opts)
  Sequel::Deprecation.deprecate('The correlated_subquery eager limit strategy',  'Switch to another eager limit strategy.')
  klass = opts.associated_class
  kds = klass.dataset
  dsa = ds.send(:dataset_alias, 1)
  raise Error, "can't use a correlated subquery if the associated class (#{opts.associated_class.inspect}) does not have a primary key" unless pk = klass.primary_key
  pka = Array(pk)
  raise Error, "can't use a correlated subquery if the associated class (#{opts.associated_class.inspect}) has a composite primary key and the database does not support multiple column IN" if pka.length > 1 && !ds.supports_multiple_column_in?
  table = kds.opts[:from]
  raise Error, "can't use a correlated subquery unless the associated class (#{opts.associated_class.inspect}) uses a single FROM table" unless table && table.length == 1
  table = table.first
  if order = ds.opts[:order]
    oproc = lambda do |x|
      case x
      when Symbol
        t, c, _ = ds.send(:split_symbol, x)
        if t && t.to_sym == table
          SQL::QualifiedIdentifier.new(dsa, c)
        else
          x
        end
      when SQL::QualifiedIdentifier
        if x.table == table
          SQL::QualifiedIdentifier.new(dsa, x.column)
        else
          x
        end
      when SQL::OrderedExpression
        SQL::OrderedExpression.new(oproc.call(x.expression), x.descending, :nulls=>x.nulls)
      else
        x
      end
    end
    order = order.map(&oproc) 
  end
  limit, offset = opts.limit_and_offset

  subquery = yield kds.
    unlimited.
    from(SQL::AliasedExpression.new(table, dsa)).
    select(*pka.map{|k| SQL::QualifiedIdentifier.new(dsa, k)}).
    order(*order).
    limit(limit, offset)

  pk = if pk.is_a?(Array)
    pk.map{|k| SQL::QualifiedIdentifier.new(table, k)}
  else
    SQL::QualifiedIdentifier.new(table, pk)
  end
  ds.where(pk=>subquery)
end
apply_window_function_eager_limit_strategy(ds, opts) click to toggle source

Use a window function to limit the results of the eager loading dataset.

# File lib/sequel/model/associations.rb, line 1118
def apply_window_function_eager_limit_strategy(ds, opts)
  rn = ds.row_number_column 
  limit, offset = opts.limit_and_offset
  ds = ds.unordered.select_append{row_number(:over, :partition=>opts.predicate_key, :order=>ds.opts[:order]){}.as(rn)}.from_self
  ds = if opts[:type] == :one_to_one
    ds.where(rn => 1)
  elsif offset
    offset += 1
    ds.where(rn => (offset...(offset+limit))) 
  else
    ds.where{SQL::Identifier.new(rn) <= limit} 
  end
end
association_module(opts={}) click to toggle source

The module to use for the association's methods. Defaults to the overridable_methods_module.

# File lib/sequel/model/associations.rb, line 1134
def association_module(opts={})
  opts.fetch(:methods_module, overridable_methods_module)
end
association_module_def(name, opts={}, &block) click to toggle source

Add a method to the module included in the class, so the method can be easily overridden in the class itself while allowing for super to be called.

# File lib/sequel/model/associations.rb, line 1141
def association_module_def(name, opts={}, &block)
  association_module(opts).module_eval{define_method(name, &block)}
end
association_module_private_def(name, opts={}, &block) click to toggle source

Add a private method to the module included in the class.

# File lib/sequel/model/associations.rb, line 1146
def association_module_private_def(name, opts={}, &block)
  association_module_def(name, opts, &block)
  association_module(opts).send(:private, name)
end
def_add_method(opts) click to toggle source

Add the add_ instance method

# File lib/sequel/model/associations.rb, line 1152
def def_add_method(opts)
  association_module_def(opts.add_method, opts){|o,*args| add_associated_object(opts, o, *args)}
end
def_association_dataset_methods(opts) click to toggle source

Adds the association dataset methods to the association methods module.

# File lib/sequel/model/associations.rb, line 1157
def def_association_dataset_methods(opts)
  association_module_def(opts.dataset_method, opts){_dataset(opts)}
  def_association_method(opts)
end
def_association_method(opts) click to toggle source

Adds the association method to the association methods module.

# File lib/sequel/model/associations.rb, line 1163
def def_association_method(opts)
  association_module_def(opts.association_method, opts){|*dynamic_opts, &block| load_associated_objects(opts, dynamic_opts[0], &block)}
end
def_many_to_many(opts) click to toggle source

Configures #many_to_many association reflection and adds the related association methods

# File lib/sequel/model/associations.rb, line 1168
def def_many_to_many(opts)
  name = opts[:name]
  model = self
  left = (opts[:left_key] ||= opts.default_left_key)
  lcks = opts[:left_keys] = Array(left)
  right = (opts[:right_key] ||= opts.default_right_key)
  rcks = opts[:right_keys] = Array(right)
  left_pk = (opts[:left_primary_key] ||= self.primary_key)
  opts[:eager_loader_key] = left_pk unless opts.has_key?(:eager_loader_key)
  lcpks = opts[:left_primary_keys] = Array(left_pk)
  lpkc = opts[:left_primary_key_column] ||= left_pk
  lpkcs = opts[:left_primary_key_columns] ||= Array(lpkc)
  raise(Error, "mismatched number of left keys: #{lcks.inspect} vs #{lcpks.inspect}") unless lcks.length == lcpks.length
  if opts[:right_primary_key]
    rcpks = Array(opts[:right_primary_key])
    raise(Error, "mismatched number of right keys: #{rcks.inspect} vs #{rcpks.inspect}") unless rcks.length == rcpks.length
  end
  uses_lcks = opts[:uses_left_composite_keys] = lcks.length > 1
  opts[:uses_right_composite_keys] = rcks.length > 1
  opts[:cartesian_product_number] ||= 1
  join_table = (opts[:join_table] ||= opts.default_join_table)
  left_key_alias = opts[:left_key_alias] ||= opts.default_associated_key_alias
  graph_jt_conds = opts[:graph_join_table_conditions] = opts.fetch(:graph_join_table_conditions, []).to_a
  opts[:graph_join_table_join_type] ||= opts[:graph_join_type]
  opts[:after_load].unshift(:array_uniq!) if opts[:uniq]
  opts[:dataset] ||= proc{opts.associated_dataset.inner_join(join_table, rcks.zip(opts.right_primary_keys) + opts.predicate_keys.zip(lcpks.map{|k| send(k)}), :qualify=>:deep)}

  opts[:eager_loader] ||= proc do |eo|
    h = eo[:id_map]
    rows = eo[:rows]
    rows.each{|object| object.associations[name] = []}
    r = rcks.zip(opts.right_primary_keys)
    l = [[opts.predicate_key, h.keys]]
    ds = model.eager_loading_dataset(opts, opts.associated_class.inner_join(join_table, r + l, :qualify=>:deep), nil, eo[:associations], eo)
    case opts.eager_limit_strategy
    when :window_function
      delete_rn = true
      rn = ds.row_number_column
      ds = apply_window_function_eager_limit_strategy(ds, opts)
    when :correlated_subquery
      ds = apply_correlated_subquery_eager_limit_strategy(ds, opts) do |xds|
        dsa = ds.send(:dataset_alias, 2)
        xds.inner_join(join_table, r + lcks.map{|k| [k, SQL::QualifiedIdentifier.new(opts.join_table_alias, k)]}, :table_alias=>dsa, :qualify=>:deep)
      end
    end
    ds.all do |assoc_record|
      assoc_record.values.delete(rn) if delete_rn
      hash_key = if uses_lcks
        left_key_alias.map{|k| assoc_record.values.delete(k)}
      else
        assoc_record.values.delete(left_key_alias)
      end
      next unless objects = h[hash_key]
      objects.each{|object| object.associations[name].push(assoc_record)}
    end
    if opts.eager_limit_strategy == :ruby
      limit, offset = opts.limit_and_offset
      rows.each{|o| o.associations[name] = o.associations[name].slice(offset||0, limit) || []}
    end
  end
  
  join_type = opts[:graph_join_type]
  select = opts[:graph_select]
  use_only_conditions = opts.include?(:graph_only_conditions)
  only_conditions = opts[:graph_only_conditions]
  conditions = opts[:graph_conditions]
  graph_block = opts[:graph_block]
  use_jt_only_conditions = opts.include?(:graph_join_table_only_conditions)
  jt_only_conditions = opts[:graph_join_table_only_conditions]
  jt_join_type = opts[:graph_join_table_join_type]
  jt_graph_block = opts[:graph_join_table_block]
  opts[:eager_grapher] ||= proc do |eo|
    ds = eo[:self]
    ds = ds.graph(join_table, use_jt_only_conditions ? jt_only_conditions : lcks.zip(lpkcs) + graph_jt_conds, :select=>false, :table_alias=>ds.unused_table_alias(join_table, [eo[:table_alias]]), :join_type=>jt_join_type, :implicit_qualifier=>eo[:implicit_qualifier], :qualify=>:deep, :from_self_alias=>ds.opts[:eager_graph][:master], &jt_graph_block)
    ds.graph(eager_graph_dataset(opts, eo), use_only_conditions ? only_conditions : opts.right_primary_keys.zip(rcks) + conditions, :select=>select, :table_alias=>eo[:table_alias], :qualify=>:deep, :join_type=>join_type, &graph_block)
  end
      
  def_association_dataset_methods(opts)
      
  return if opts[:read_only]
      
  adder = opts[:adder] || proc do |o|
    h = {}
    lcks.zip(lcpks).each{|k, pk| h[k] = send(pk)}
    rcks.zip(opts.right_primary_key_methods).each{|k, pk| h[k] = o.send(pk)}
    _join_table_dataset(opts).insert(h)
  end
  association_module_private_def(opts._add_method, opts, &adder) 

  remover = opts[:remover] || proc do |o|
    _join_table_dataset(opts).where(lcks.zip(lcpks.map{|k| send(k)}) + rcks.zip(opts.right_primary_key_methods.map{|k| o.send(k)})).delete
  end
  association_module_private_def(opts._remove_method, opts, &remover)

  clearer = opts[:clearer] || proc do
    _join_table_dataset(opts).where(lcks.zip(lcpks.map{|k| send(k)})).delete
  end
  association_module_private_def(opts._remove_all_method, opts, &clearer)
      
  def_add_method(opts)
  def_remove_methods(opts)
end
def_many_to_one(opts) click to toggle source

Configures #many_to_one association reflection and adds the related association methods

# File lib/sequel/model/associations.rb, line 1272
def def_many_to_one(opts)
  name = opts[:name]
  model = self
  opts[:key] = opts.default_key unless opts.has_key?(:key)
  key = opts[:key]
  opts[:eager_loader_key] = key unless opts.has_key?(:eager_loader_key)
  cks = opts[:graph_keys] = opts[:keys] = Array(key)
  opts[:key_column] ||= key
  opts[:graph_keys] = opts[:key_columns] = Array(opts[:key_column])
  opts[:qualified_key] = opts.qualify_cur(key)
  if opts[:primary_key]
    cpks = Array(opts[:primary_key])
    raise(Error, "mismatched number of keys: #{cks.inspect} vs #{cpks.inspect}") unless cks.length == cpks.length
  end
  uses_cks = opts[:uses_composite_keys] = cks.length > 1
  opts[:cartesian_product_number] ||= 0
  opts[:dataset] ||= proc do
    opts.associated_dataset.where(opts.predicate_keys.zip(cks.map{|k| send(k)}))
  end
  opts[:eager_loader] ||= proc do |eo|
    h = eo[:id_map]
    keys = h.keys
    # Default the cached association to nil, so any object that doesn't have it
    # populated will have cached the negative lookup.
    eo[:rows].each{|object| object.associations[name] = nil}
    # Skip eager loading if no objects have a foreign key for this association
    unless keys.empty?
      klass = opts.associated_class
      model.eager_loading_dataset(opts, klass.where(opts.predicate_key=>keys), nil, eo[:associations], eo).all do |assoc_record|
        hash_key = uses_cks ? opts.primary_key_methods.map{|k| assoc_record.send(k)} : assoc_record.send(opts.primary_key_method)
        next unless objects = h[hash_key]
        objects.each{|object| object.associations[name] = assoc_record}
      end
    end
  end
      
  join_type = opts[:graph_join_type]
  select = opts[:graph_select]
  use_only_conditions = opts.include?(:graph_only_conditions)
  only_conditions = opts[:graph_only_conditions]
  conditions = opts[:graph_conditions]
  graph_block = opts[:graph_block]
  graph_cks = opts[:graph_keys]
  opts[:eager_grapher] ||= proc do |eo|
    ds = eo[:self]
    ds.graph(eager_graph_dataset(opts, eo), use_only_conditions ? only_conditions : opts.primary_keys.zip(graph_cks) + conditions, eo.merge(:select=>select, :join_type=>join_type, :qualify=>:deep, :from_self_alias=>ds.opts[:eager_graph][:master]), &graph_block)
  end
      
  def_association_dataset_methods(opts)
  
  return if opts[:read_only]
      
  setter = opts[:setter] || proc{|o| cks.zip(opts.primary_key_methods).each{|k, pk| send(:"#{k}=", (o.send(pk) if o))}}
  association_module_private_def(opts._setter_method, opts, &setter)
  association_module_def(opts.setter_method, opts){|o| set_associated_object(opts, o)}
end
def_one_to_many(opts) click to toggle source

Configures #one_to_many and #one_to_one association reflections and adds the related association methods

# File lib/sequel/model/associations.rb, line 1330
def def_one_to_many(opts)
  one_to_one = opts[:type] == :one_to_one
  name = opts[:name]
  model = self
  key = (opts[:key] ||= opts.default_key)
  km = opts[:key_method] ||= opts[:key]
  cks = opts[:keys] = Array(key)
  opts[:key_methods] = Array(opts[:key_method])
  primary_key = (opts[:primary_key] ||= self.primary_key)
  opts[:eager_loader_key] = primary_key unless opts.has_key?(:eager_loader_key)
  cpks = opts[:primary_keys] = Array(primary_key)
  pkc = opts[:primary_key_column] ||= primary_key
  pkcs = opts[:primary_key_columns] ||= Array(pkc)
  raise(Error, "mismatched number of keys: #{cks.inspect} vs #{cpks.inspect}") unless cks.length == cpks.length
  uses_cks = opts[:uses_composite_keys] = cks.length > 1
  opts[:dataset] ||= proc do
    opts.associated_dataset.where(opts.predicate_keys.zip(cpks.map{|k| send(k)}))
  end
  opts[:eager_loader] ||= proc do |eo|
    h = eo[:id_map]
    rows = eo[:rows]
    if one_to_one
      rows.each{|object| object.associations[name] = nil}
    else
      rows.each{|object| object.associations[name] = []}
    end
    reciprocal = opts.reciprocal
    klass = opts.associated_class
    filter_keys = opts.predicate_key
    ds = model.eager_loading_dataset(opts, klass.where(filter_keys=>h.keys), nil, eo[:associations], eo)
    case opts.eager_limit_strategy
    when :distinct_on
      ds = ds.distinct(*filter_keys).order_prepend(*filter_keys)
    when :window_function
      delete_rn = true
      rn = ds.row_number_column
      ds = apply_window_function_eager_limit_strategy(ds, opts)
    when :correlated_subquery
      ds = apply_correlated_subquery_eager_limit_strategy(ds, opts) do |xds|
        xds.where(opts.associated_object_keys.map{|k| [SQL::QualifiedIdentifier.new(xds.first_source_alias, k), SQL::QualifiedIdentifier.new(xds.first_source_table, k)]})
      end
    end
    ds.all do |assoc_record|
      assoc_record.values.delete(rn) if delete_rn
      hash_key = uses_cks ? km.map{|k| assoc_record.send(k)} : assoc_record.send(km)
      next unless objects = h[hash_key]
      if one_to_one
        objects.each do |object| 
          unless object.associations[name]
            object.associations[name] = assoc_record
            assoc_record.associations[reciprocal] = object if reciprocal
          end
        end
      else
        objects.each do |object| 
          object.associations[name].push(assoc_record)
          assoc_record.associations[reciprocal] = object if reciprocal
        end
      end
    end
    if opts.eager_limit_strategy == :ruby
      limit, offset = opts.limit_and_offset
      rows.each{|o| o.associations[name] = o.associations[name].slice(offset||0, limit) || []}
    end
  end
  
  join_type = opts[:graph_join_type]
  select = opts[:graph_select]
  use_only_conditions = opts.include?(:graph_only_conditions)
  only_conditions = opts[:graph_only_conditions]
  conditions = opts[:graph_conditions]
  opts[:cartesian_product_number] ||= one_to_one ? 0 : 1
  graph_block = opts[:graph_block]
  opts[:eager_grapher] ||= proc do |eo|
    ds = eo[:self]
    ds = ds.graph(eager_graph_dataset(opts, eo), use_only_conditions ? only_conditions : cks.zip(pkcs) + conditions, eo.merge(:select=>select, :join_type=>join_type, :qualify=>:deep, :from_self_alias=>ds.opts[:eager_graph][:master]), &graph_block)
    # We only load reciprocals for one_to_many associations, as other reciprocals don't make sense
    ds.opts[:eager_graph][:reciprocals][eo[:table_alias]] = opts.reciprocal
    ds
  end
      
  def_association_dataset_methods(opts)
  
  ck_nil_hash ={}
  cks.each{|k| ck_nil_hash[k] = nil}

  unless opts[:read_only]
    validate = opts[:validate]

    if one_to_one
      setter = opts[:setter] || proc do |o|
        up_ds = _apply_association_options(opts, opts.associated_dataset.where(cks.zip(cpks.map{|k| send(k)})))
        if o
          up_ds = up_ds.exclude(o.pk_hash) unless o.new?
          cks.zip(cpks).each{|k, pk| o.send(:"#{k}=", send(pk))}
        end
        checked_transaction do
          up_ds.update(ck_nil_hash)
          o.save(:validate=>validate) || raise(Sequel::Error, "invalid associated object, cannot save") if o
        end
      end
      association_module_private_def(opts._setter_method, opts, &setter)
      association_module_def(opts.setter_method, opts){|o| set_one_to_one_associated_object(opts, o)}
    else 
      adder = opts[:adder] || proc do |o|
        cks.zip(cpks).each{|k, pk| o.send(:"#{k}=", send(pk))}
        o.save(:validate=>validate) || raise(Sequel::Error, "invalid associated object, cannot save")
      end
      association_module_private_def(opts._add_method, opts, &adder)
      
      remover = opts[:remover] || proc do |o|
        cks.each{|k| o.send(:"#{k}=", nil)}
        o.save(:validate=>validate) || raise(Sequel::Error, "invalid associated object, cannot save")
      end
      association_module_private_def(opts._remove_method, opts, &remover)

      clearer = opts[:clearer] || proc do
        _apply_association_options(opts, opts.associated_dataset.where(cks.zip(cpks.map{|k| send(k)}))).update(ck_nil_hash)
      end
      association_module_private_def(opts._remove_all_method, opts, &clearer)

      def_add_method(opts)
      def_remove_methods(opts)
    end
  end
end
def_one_to_one(opts) click to toggle source

Alias of #def_one_to_many, since they share pretty much the same code.

# File lib/sequel/model/associations.rb, line 1458
def def_one_to_one(opts)
  def_one_to_many(opts)
end
def_remove_methods(opts) click to toggle source

Add the remove_ and remove_all instance methods

# File lib/sequel/model/associations.rb, line 1463
def def_remove_methods(opts)
  association_module_def(opts.remove_method, opts){|o,*args| remove_associated_object(opts, o, *args)}
  association_module_def(opts.remove_all_method, opts){|*args| remove_all_associated_objects(opts, *args)}
end
eager_graph_dataset(opts, eager_options) click to toggle source

Return dataset to graph into given the association reflection, applying the :callback option if set.

# File lib/sequel/model/associations.rb, line 1469
def eager_graph_dataset(opts, eager_options)
  ds = opts.associated_class.dataset
  if cb = eager_options[:callback]
    ds = cb.call(ds)
  end
  ds
end