Sequel::Model::Associations::ManyToManyAssociationReflection

Constants

FINALIZE_SETTINGS = superclass::FINALIZE_SETTINGS.merge( :associated_key_array=>:associated_key_array, :qualified_right_key=>:qualified_right_key, :join_table_source=>:join_table_source, :join_table_alias=>:join_table_alias, :qualified_right_primary_key=>:qualified_right_primary_key, :right_primary_key=>:right_primary_key, :right_primary_keys=>:right_primary_keys, :right_primary_key_method=>:right_primary_key_method, :right_primary_key_methods=>:right_primary_key_methods, :select=>:select ).freeze

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

     # File lib/sequel/model/associations.rb
1361 def associated_key_alias
1362   self[:left_key_alias]
1363 end

associated_key_array()

Array of associated keys used when eagerly loading.

     # File lib/sequel/model/associations.rb
1366 def associated_key_array
1367   cached_fetch(:associated_key_array) do
1368     if self[:uses_left_composite_keys]
1369       associated_key_alias.zip(predicate_keys).map{|a, k| SQL::AliasedExpression.new(k, a)}
1370     else
1371       [SQL::AliasedExpression.new(predicate_key, associated_key_alias)]
1372     end
1373   end
1374 end

associated_key_column()

The column to use for the associated key when eagerly loading

     # File lib/sequel/model/associations.rb
1377 def associated_key_column
1378   self[:left_key]
1379 end

associated_object_keys()

Alias of right_primary_keys

     # File lib/sequel/model/associations.rb
1382 def associated_object_keys
1383   right_primary_keys
1384 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.

     # File lib/sequel/model/associations.rb
1388 def can_have_associated_objects?(obj)
1389   !self[:left_primary_keys].any?{|k| obj.get_column_value(k).nil?}
1390 end

cloneable?(ref)

one_through_one and many_to_many associations can be clones

     # File lib/sequel/model/associations.rb
1393 def cloneable?(ref)
1394   ref[:type] == :many_to_many || ref[:type] == :one_through_one
1395 end

default_associated_key_alias()

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

     # File lib/sequel/model/associations.rb
1399 def default_associated_key_alias
1400   self[:uses_left_composite_keys] ? (0...self[:left_keys].length).map{|i| :"x_foreign_key_#{i}_x"} : :x_foreign_key_x
1401 end

default_eager_loader(eo)

The default eager loader used if the user doesn’t override it. Extracted to a method so the code can be shared with the many_through_many plugin.

     # File lib/sequel/model/associations.rb
1405 def default_eager_loader(eo)
1406   h = eo[:id_map]
1407   assign_singular = assign_singular?
1408   delete_rn = delete_row_number_column
1409   uses_lcks = self[:uses_left_composite_keys]
1410   left_key_alias = self[:left_key_alias]
1411   name = self[:name]
1412 
1413   self[:model].eager_load_results(self, eo) do |assoc_record|
1414     assoc_record.remove_key!(delete_rn) if delete_rn
1415     hash_key = if uses_lcks
1416       left_key_alias.map{|k| assoc_record.remove_key!(k)}
1417     else
1418       assoc_record.remove_key!(left_key_alias)
1419     end
1420 
1421     objects = h[hash_key]
1422 
1423     if assign_singular
1424       objects.each do |object| 
1425         object.associations[name] ||= assoc_record
1426       end
1427     else
1428       objects.each do |object|
1429         object.associations[name].push(assoc_record)
1430       end
1431     end
1432   end
1433 end

default_join_table()

Default name symbol for the join table.

     # File lib/sequel/model/associations.rb
1436 def default_join_table
1437   [self[:class_name], self[:model].name].map{|i| underscore(pluralize(demodulize(i)))}.sort.join('_').to_sym
1438 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).

     # File lib/sequel/model/associations.rb
1442 def default_left_key
1443   :"#{underscore(demodulize(self[:model].name))}_id"
1444 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).

     # File lib/sequel/model/associations.rb
1448 def default_right_key
1449   :"#{singularize(self[:name])}_id"
1450 end

eager_loading_use_associated_key?()

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

     # File lib/sequel/model/associations.rb
1481 def eager_loading_use_associated_key?
1482   !separate_query_per_table?
1483 end

finalize_settings()

     # File lib/sequel/model/associations.rb
1464 def finalize_settings
1465   FINALIZE_SETTINGS
1466 end

join_table_alias()

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

     # File lib/sequel/model/associations.rb
1493 def join_table_alias
1494   cached_fetch(:join_table_alias) do
1495     s, a = split_join_table_alias
1496     a || s
1497   end
1498 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.

     # File lib/sequel/model/associations.rb
1487 def join_table_source
1488   cached_fetch(:join_table_source){split_join_table_alias[0]}
1489 end

need_associated_primary_key?()

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

     # File lib/sequel/model/associations.rb
1503 def need_associated_primary_key?
1504   true
1505 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.

     # File lib/sequel/model/associations.rb
1470 def predicate_key
1471   cached_fetch(:predicate_key){qualify(join_table_alias, self[:left_key])}
1472 end

qualified_right_key()

The right key qualified by the join table.

     # File lib/sequel/model/associations.rb
1476 def qualified_right_key
1477   cached_fetch(:qualified_right_key){qualify(join_table_alias, self[:right_key])}
1478 end

qualified_right_primary_key()

right_primary_key qualified by the associated table

     # File lib/sequel/model/associations.rb
1508 def qualified_right_primary_key
1509   cached_fetch(:qualified_right_primary_key){qualify_assoc(right_primary_key)}
1510 end

right_primary_key()

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

     # File lib/sequel/model/associations.rb
1513 def right_primary_key
1514   cached_fetch(:right_primary_key){associated_class.primary_key || raise(Error, "no primary key specified for #{associated_class.inspect}")}
1515 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.

     # File lib/sequel/model/associations.rb
1524 def right_primary_key_method
1525   cached_fetch(:right_primary_key_method){right_primary_key}
1526 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.

     # File lib/sequel/model/associations.rb
1530 def right_primary_key_methods
1531   cached_fetch(:right_primary_key_methods){Array(right_primary_key_method)}
1532 end

right_primary_keys()

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

     # File lib/sequel/model/associations.rb
1518 def right_primary_keys
1519   cached_fetch(:right_primary_keys){Array(right_primary_key)}
1520 end

select()

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

     # File lib/sequel/model/associations.rb
1535 def select
1536   cached_fetch(:select){default_select}
1537 end

separate_query_per_table?()

Whether a separate query should be used for the join table.

     # File lib/sequel/model/associations.rb
1540 def separate_query_per_table?
1541   self[:join_table_db]
1542 end