class Sequel::Model::Associations::ManyToManyAssociationReflection

  1. lib/sequel/model/associations.rb
Parent: Associations

Public Instance Aliases

associated_key_table -> join_table_alias
qualified_left_key -> predicate_key

Public Instance methods

associated_key_alias ()

The alias to use for the associated key when eagerly loading

[show source] 
# File lib/sequel/model/associations.rb, line 585
def associated_key_alias
  self[:left_key_alias]
end
associated_key_column ()

The column to use for the associated key when eagerly loading

[show source] 
# File lib/sequel/model/associations.rb, line 590
def associated_key_column
  self[:left_key]
end
associated_object_keys ()

Alias of #right_primary_keys

[show source] 
# File lib/sequel/model/associations.rb, line 595
def associated_object_keys
  right_primary_keys
end
can_have_associated_objects? (obj)

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

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

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

[show source] 
# File lib/sequel/model/associations.rb, line 607
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 ()

Default name symbol for the join table.

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

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

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

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

[show source] 
# File lib/sequel/model/associations.rb, line 624
def default_right_key
  :"#{singularize(self[:name])}_id"
end
eager_loading_use_associated_key? ()

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

[show source] 
# File lib/sequel/model/associations.rb, line 641
def eager_loading_use_associated_key?
  true
end
join_table_alias ()

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

[show source] 
# File lib/sequel/model/associations.rb, line 653
def join_table_alias
  cached_fetch(:join_table_alias) do
    s, a = split_join_table_alias
    a || s
  end
end
join_table_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.

[show source] 
# File lib/sequel/model/associations.rb, line 647
def join_table_source
  cached_fetch(:join_table_source){split_join_table_alias[0]}
end
need_associated_primary_key? ()

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

[show source] 
# File lib/sequel/model/associations.rb, line 663
def need_associated_primary_key?
  true
end
predicate_key ()

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.

[show source] 
# File lib/sequel/model/associations.rb, line 630
def predicate_key
  cached_fetch(:predicate_key){qualify(join_table_alias, self[:left_key])}
end
qualified_right_key ()

The right key qualified by the join table.

[show source] 
# File lib/sequel/model/associations.rb, line 636
def qualified_right_key
  cached_fetch(:qualified_right_key){qualify(join_table_alias, self[:right_key])}
end
qualified_right_primary_key ()

#right_primary_key qualified by the associated table

[show source] 
# File lib/sequel/model/associations.rb, line 668
def qualified_right_primary_key
  cached_fetch(:qualified_right_primary_key){qualify_assoc(right_primary_key)}
end
right_primary_key ()

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

[show source] 
# File lib/sequel/model/associations.rb, line 673
def right_primary_key
  cached_fetch(:right_primary_key){associated_class.primary_key}
end
right_primary_key_method ()

The method symbol or array of method symbols to call on the associated objects to get the foreign key values for the join table.

[show source] 
# File lib/sequel/model/associations.rb, line 684
def right_primary_key_method
  cached_fetch(:right_primary_key_method){right_primary_key}
end
right_primary_key_methods ()

The array of method symbols to call on the associated objects to get the foreign key values for the join table.

[show source] 
# File lib/sequel/model/associations.rb, line 690
def right_primary_key_methods
  cached_fetch(:right_primary_key_methods){Array(right_primary_key_method)}
end
right_primary_keys ()

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

[show source] 
# File lib/sequel/model/associations.rb, line 678
def right_primary_keys
  cached_fetch(:right_primary_keys){Array(right_primary_key)}
end
select ()

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

[show source] 
# File lib/sequel/model/associations.rb, line 695
def select
 cached_fetch(:select){Sequel::SQL::ColumnAll.new(associated_class.table_name)}
end