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

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#association_reflections ⇒ Object (readonly)

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



67
68
69
 
# File 'lib/sequel/model/associations.rb', line 67

def association_reflections
  @association_reflections
end

Instance Method Details

#all_association_reflections ⇒ Object

Array of all association reflections for this model class



70
71
72
 
# File 'lib/sequel/model/associations.rb', line 70

def all_association_reflections
  association_reflections.values
end

#associate(type, name, 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. Similar to ActiveRecord’s belongs_to.

  • :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. Similar to ActiveRecord’s has_many.

  • :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. Similar to ActiveRecord’s has_and_belongs_to_many.

A one to one relationship can be set up with a many_to_one association on the table with the foreign key, and a one_to_many association with the :one_to_one option specified on the table without the foreign key. The two associations will operate similarly, except that the many_to_one association setter doesn’t update the database until you call save manually.

The following options can be supplied:

  • *ALL types*:

    • :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. Not called when eager loading via eager_graph, but called when eager loading via eager.

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

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

    • :class - The associated class or its name. If not given, uses the association’s name, which is camelized (and singularized unless the type is :many_to_one)

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

    • :dataset - A proc that is instance_evaled to get the base dataset to use for the _dataset method (before the other options are applied).

    • :eager - The associations to eagerly load via EagerLoading#eager when loading the associated object(s). For many_to_one associations, this is ignored unless this association is being eagerly loaded, as it doesn’t save queries unless multiple objects can be loaded at once.

    • :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 EagerLoading#eager_graph when loading the associated object(s). For many_to_one associations, this is ignored unless this association is being eagerly loaded, as it doesn’t save queries unless multiple objects can be loaded at once.

    • :eager_grapher - A proc to use to implement eager loading via eager graph, overriding the default. Takes three arguments, a dataset, an alias to use for the table to graph for this association, and the alias that was used for the current table (since you can cascade associations), Should return a copy of the dataset with the association graphed into it.

    • :eager_loader - A proc to use to implement eager loading, overriding the default. Takes three arguments, a key hash (used solely to enhance performance), an array of records, and a hash of dependent associations. The associated records should be queried from the database and the associations cache for each record should be populated for this to work correctly.

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

    • :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 all two pairs. If not specified, the :conditions option is used if it is a hash or array of all two pairs.

    • :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 arguments for the value to specify a limit and offset.

    • :order - the column(s) by which to order the association dataset. Can be a singular column or an array.

    • :order_eager_graph - Whether to add the order to the 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_many with :one_to_one), or add_/remove_/remove_all_ methods (for one_to_many, many_to_many)

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

    • :select - the attributes to select. Defaults to the associated class’s table_name.*, which means it doesn’t include the attributes from the join table in a many_to_many association. 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.

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

    • :primary_key - column in the associated table that :key option references, as a symbol. Defaults to the primary key of the associated table.

  • :one_to_many:

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

    • :one_to_one: Create a getter and setter similar to those of many_to_one associations. The getter returns a singular matching record, or raises an error if multiple records match. The setter updates the record given and removes associations with all other records. When this option is used, the other association methods usually added are either removed or made private, so using this is similar to using many_to_one, in terms of the methods it adds, the main difference is that the foreign key is in the associated table instead of the current table.

    • :primary_key - column in the current table that :key option references, as a symbol. Defaults to primary key of the current table.

  • :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 all two pairs.

    • :graph_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 ‘_’.

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

    • :left_primary_key - column in current table that :left_key points to, as a symbol. Defaults to primary key of current table.

    • :right_key - foreign key in join table that points to associated model’s primary key, as a symbol. Defaults to Defaults to :“#Sequel::Model::Associations::ClassMethods.namename.to_sname.to_s.singularize_id”.

    • :right_primary_key - column in associated table that :right_key points to, as a symbol. Defaults to primary key of the associated table.

    • :uniq - Adds a after_load callback that makes the array of objects unique.

Raises:



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/sequel/model/associations.rb', line 221

def associate(type, name, opts = {}, &block)
  raise(Error, 'invalid association type') unless assoc_class = ASSOCIATION_TYPES[type]
  raise(Error, 'Model.associate name argument must be a symbol') unless Symbol === name
      
  # merge early so we don't modify opts
  orig_opts = opts.dup
  orig_opts = association_reflection(opts[:clone])[:orig_opts].merge(orig_opts) if opts[:clone]
  opts = orig_opts.merge(:type => type, :name => name, :cache => true, :model => self)
  opts[:block] = block if block
  opts = assoc_class.new.merge!(opts)
  opts[:eager_block] = block unless opts.include?(:eager_block)
  opts[:graph_join_type] ||= :left_outer
  opts[:order_eager_graph] = true unless opts.include?(:order_eager_graph)
  conds = opts[:conditions]
  opts[:graph_conditions] = conds if !opts.include?(:graph_conditions) and (conds.is_a?(Hash) or (conds.is_a?(Array) and conds.all_two_pairs?))
  opts[:graph_conditions] = opts[:graph_conditions] ? opts[: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, :extend].each do |cb_type|
    opts[cb_type] = Array(opts[cb_type])
  end
      
  # find class
  case opts[:class]
    when String, Symbol
      # Delete :class to allow late binding
      opts[:class_name] ||= opts.delete(:class).to_s
    when Class
      opts[:class_name] ||= opts[:class].name
  end
      
  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) ⇒ Object

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



261
262
263
 
# File 'lib/sequel/model/associations.rb', line 261

def association_reflection(name)
  association_reflections[name]
end

#associations ⇒ Object

Array of association name symbols



266
267
268
 
# File 'lib/sequel/model/associations.rb', line 266

def associations
  association_reflections.keys
end

#eager_loading_dataset(opts, ds, select, associations) ⇒ Object

Modify and return eager loading dataset based on association options



271
272
273
274
275
276
277
278
279
280
 
# File 'lib/sequel/model/associations.rb', line 271

def eager_loading_dataset(opts, ds, select, associations)
  ds = ds.select(*select) if select
  ds = ds.filter(opts[:conditions]) if opts[:conditions]
  ds = ds.order(*opts[:order]) if opts[:order]
  ds = ds.eager(opts[:eager]) if opts[:eager]
  ds = ds.eager_graph(opts[:eager_graph]) if opts[:eager_graph]
  ds = ds.eager(associations) unless Array(associations).empty?
  ds = opts[:eager_block].call(ds) if opts[:eager_block]
  ds
end

#many_to_many(*args, &block) ⇒ Object

Shortcut for adding a many_to_many association, see associate



293
294
295
 
# File 'lib/sequel/model/associations.rb', line 293

def many_to_many(*args, &block)
  associate(:many_to_many, *args, &block)
end

#many_to_one(*args, &block) ⇒ Object

Shortcut for adding a many_to_one association, see associate



288
289
290
 
# File 'lib/sequel/model/associations.rb', line 288

def many_to_one(*args, &block)
  associate(:many_to_one, *args, &block)
end

#one_to_many(*args, &block) ⇒ Object

Shortcut for adding a one_to_many association, see associate



283
284
285
 
# File 'lib/sequel/model/associations.rb', line 283

def one_to_many(*args, &block)
  associate(:one_to_many, *args, &block)
end