Class/Module Index [+]

Quicksearch

Sequel::Model::Associations::ManyToManyAssociationReflection

Public Instance Methods

associated_key_alias() click to toggle source

The alias to use for the associated key when eagerly loading

# File lib/sequel/model/associations.rb, line 410
def associated_key_alias
  self[:left_key_alias]
end
associated_key_column() click to toggle source

The column to use for the associated key when eagerly loading

# File lib/sequel/model/associations.rb, line 415
def associated_key_column
  self[:left_key]
end
associated_key_table() click to toggle source
Alias for: join_table_alias
associated_object_keys() click to toggle source

Alias of right_primary_keys

# File lib/sequel/model/associations.rb, line 420
def associated_object_keys
  right_primary_keys
end
can_have_associated_objects?(obj) click to toggle source

many_to_many associations can only have associated objects if none of the :left_primary_keys options have a nil value.

# File lib/sequel/model/associations.rb, line 426
def can_have_associated_objects?(obj)
  !self[:left_primary_keys].any?{|k| obj.send(k).nil?}
end
default_associated_key_alias() click to toggle source

The default associated key alias(es) to use when eager loading associations via eager.

# File lib/sequel/model/associations.rb, line 432
def default_associated_key_alias
  self[:uses_left_composite_keys] ? (0...self[:left_keys].length).map{|i| :"x_foreign_key_#{i}_x"} : :x_foreign_key_x
end
default_join_table() click to toggle source

Default name symbol for the join table.

# File lib/sequel/model/associations.rb, line 437
def default_join_table
  [self[:class_name], self[:model].name].map{|i| underscore(pluralize(demodulize(i)))}.sort.join('_').to_sym
end
default_left_key() click to toggle source

Default foreign key name symbol for key in join table that points to current table's primary key (or :left_primary_key column).

# File lib/sequel/model/associations.rb, line 443
def default_left_key
  :"#{underscore(demodulize(self[:model].name))}_id"
end
default_right_key() click to toggle source

Default foreign key name symbol for foreign key in join table that points to the association's table's primary key (or :right_primary_key column).

# File lib/sequel/model/associations.rb, line 449
def default_right_key
  :"#{singularize(self[:name])}_id"
end
eager_loader_key() click to toggle source

The key to use for the key hash when eager loading

# File lib/sequel/model/associations.rb, line 454
def eager_loader_key
  self[:eager_loader_key] ||= self[:left_primary_key]
end
eager_loading_predicate_key() click to toggle source

The hash key to use for the eager loading predicate (left side of IN (1, 2, 3)). The left key qualified by the join table.

# File lib/sequel/model/associations.rb, line 460
def eager_loading_predicate_key
  self[:eager_loading_predicate_key] ||= qualify(join_table_alias, self[:left_key])
end
Also aliased as: qualified_left_key
eager_loading_use_associated_key?() click to toggle source

many_to_many associations need to select a key in an associated table to eagerly load

# File lib/sequel/model/associations.rb, line 471
def eager_loading_use_associated_key?
  true
end
join_table_alias() click to toggle source

The join table itself, unless it is aliased, in which case this is the alias.

# File lib/sequel/model/associations.rb, line 486
def join_table_alias
  fetch(:join_table_alias) do
    split_join_table_alias
    self[:join_table_alias]
  end
end
Also aliased as: associated_key_table
join_table_source() click to toggle source

The source of the join table. This is the join table itself, unless it is aliased, in which case it is the unaliased part.

# File lib/sequel/model/associations.rb, line 477
def join_table_source
  fetch(:join_table_source) do
    split_join_table_alias
    self[:join_table_source]
  end
end
need_associated_primary_key?() click to toggle source

Whether the associated object needs a primary key to be added/removed, true for many_to_many associations.

# File lib/sequel/model/associations.rb, line 496
def need_associated_primary_key?
  true
end
qualified_left_key() click to toggle source
qualified_right_key() click to toggle source

The right key qualified by the join table.

# File lib/sequel/model/associations.rb, line 466
def qualified_right_key
  self[:qualified_right_key] ||= qualify(join_table_alias, self[:right_key])
end
qualified_right_primary_key() click to toggle source

right_primary_key qualified by the associated table

# File lib/sequel/model/associations.rb, line 517
def qualified_right_primary_key
  self[:qualified_right_primary_key] ||= qualify_assoc(right_primary_key)
end
reciprocal() click to toggle source

Returns the reciprocal association symbol, if one exists.

# File lib/sequel/model/associations.rb, line 501
def reciprocal
  return self[:reciprocal] if include?(:reciprocal)
  left_keys = self[:left_keys]
  right_keys = self[:right_keys]
  join_table = self[:join_table]
  associated_class.all_association_reflections.each do |assoc_reflect|
    if assoc_reflect[:type] == :many_to_many && assoc_reflect[:left_keys] == right_keys &&
       assoc_reflect[:right_keys] == left_keys && assoc_reflect[:join_table] == join_table &&
       assoc_reflect.associated_class == self[:model]
      return self[:reciprocal] = assoc_reflect[:name]
    end
  end
  self[:reciprocal] = nil
end
right_primary_key() click to toggle source

The primary key column(s) to use in the associated table (can be symbol or array).

# File lib/sequel/model/associations.rb, line 522
def right_primary_key
  self[:right_primary_key] ||= associated_class.primary_key
end
right_primary_keys() click to toggle source

The primary key columns to use in the associated table (always array).

# File lib/sequel/model/associations.rb, line 527
def right_primary_keys
  self[:right_primary_keys] ||= Array(right_primary_key)
end
select() click to toggle source

The columns to select when loading the association, associated_class.table_name.* by default.

# File lib/sequel/model/associations.rb, line 532
def select
 return self[:select] if include?(:select)
 self[:select] ||= Sequel::SQL::ColumnAll.new(associated_class.table_name)
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.