Class | Sequel::Model::Associations::ManyToManyAssociationReflection |
In: |
lib/sequel/model/associations.rb
|
Parent: | AssociationReflection |
The alias to use for the associated key when eagerly loading
# File lib/sequel/model/associations.rb, line 458 458: def associated_key_alias 459: self[:left_key_alias] 460: end
The column to use for the associated key when eagerly loading
# File lib/sequel/model/associations.rb, line 463 463: def associated_key_column 464: self[:left_key] 465: end
Alias of right_primary_keys
# File lib/sequel/model/associations.rb, line 468 468: def associated_object_keys 469: right_primary_keys 470: end
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 474 474: def can_have_associated_objects?(obj) 475: !self[:left_primary_keys].any?{|k| obj.send(k).nil?} 476: end
The default associated key alias(es) to use when eager loading associations via eager.
# File lib/sequel/model/associations.rb, line 480 480: def default_associated_key_alias 481: self[:uses_left_composite_keys] ? (0...self[:left_keys].length).map{|i| "x_foreign_key_#{i}_x""x_foreign_key_#{i}_x"} : :x_foreign_key_x 482: end
Default name symbol for the join table.
# File lib/sequel/model/associations.rb, line 485 485: def default_join_table 486: [self[:class_name], self[:model].name].map{|i| underscore(pluralize(demodulize(i)))}.sort.join('_').to_sym 487: end
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 491 491: def default_left_key 492: 493: "#{underscore(demodulize(self[:model].name))}_id" 494: end
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 497 497: def default_right_key 498: 499: "#{singularize(self[:name])}_id" 500: end
The key to use for the key hash when eager loading
# File lib/sequel/model/associations.rb, line 502 502: def eager_loader_key 503: cached_fetch(:eager_loader_key){self[:left_primary_key]} 504: end
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 508 508: def eager_loading_predicate_key 509: cached_fetch(:eager_loading_predicate_key){qualify(join_table_alias, self[:left_key])} 510: end
The join table itself, unless it is aliased, in which case this is the alias.
# File lib/sequel/model/associations.rb, line 531 531: def join_table_alias 532: cached_fetch(:join_table_alias) do 533: s, a = split_join_table_alias 534: a || s 535: end 536: end
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 525 525: def join_table_source 526: cached_fetch(:join_table_source){split_join_table_alias[0]} 527: end
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 541 541: def need_associated_primary_key? 542: true 543: end
The right key qualified by the join table.
# File lib/sequel/model/associations.rb, line 514 514: def qualified_right_key 515: cached_fetch(:qualified_right_key){qualify(join_table_alias, self[:right_key])} 516: end
right_primary_key qualified by the associated table
# File lib/sequel/model/associations.rb, line 565 565: def qualified_right_primary_key 566: cached_fetch(:qualified_right_primary_key){qualify_assoc(right_primary_key)} 567: end
Returns the reciprocal association symbol, if one exists.
# File lib/sequel/model/associations.rb, line 546 546: def reciprocal 547: cached_fetch(:reciprocal) do 548: left_keys = self[:left_keys] 549: right_keys = self[:right_keys] 550: join_table = self[:join_table] 551: recip = nil 552: associated_class.all_association_reflections.each do |assoc_reflect| 553: if assoc_reflect[:type] == :many_to_many && assoc_reflect[:left_keys] == right_keys && 554: assoc_reflect[:right_keys] == left_keys && assoc_reflect[:join_table] == join_table && 555: assoc_reflect.associated_class == self[:model] 556: recip = assoc_reflect[:name] 557: break 558: end 559: end 560: recip 561: end 562: end
The primary key column(s) to use in the associated table (can be symbol or array).
# File lib/sequel/model/associations.rb, line 570 570: def right_primary_key 571: cached_fetch(:right_primary_key){associated_class.primary_key} 572: end
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, line 581 581: def right_primary_key_method 582: cached_fetch(:right_primary_key_method){right_primary_key} 583: end
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, line 587 587: def right_primary_key_methods 588: cached_fetch(:right_primary_key_methods){Array(right_primary_key_method)} 589: end