Class Sequel::Model::Associations::ManyToManyAssociationReflection
In: lib/sequel/model/associations.rb
Parent: AssociationReflection

Methods

Public Instance methods

The alias to use for the associated key when eagerly loading

[Source]

     # File lib/sequel/model/associations.rb, line 476
476:         def associated_key_alias
477:           self[:left_key_alias]
478:         end

The column to use for the associated key when eagerly loading

[Source]

     # File lib/sequel/model/associations.rb, line 481
481:         def associated_key_column
482:           self[:left_key]
483:         end
associated_key_table()

Alias for join_table_alias

Alias of right_primary_keys

[Source]

     # File lib/sequel/model/associations.rb, line 486
486:         def associated_object_keys
487:           right_primary_keys
488:         end

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

[Source]

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

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

[Source]

     # File lib/sequel/model/associations.rb, line 498
498:         def default_associated_key_alias
499:           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
500:         end

Default name symbol for the join table.

[Source]

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

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

[Source]

     # File lib/sequel/model/associations.rb, line 509
509:         def default_left_key
510: 
511:           "#{underscore(demodulize(self[:model].name))}_id"
512:         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).

[Source]

     # File lib/sequel/model/associations.rb, line 515
515:         def default_right_key
516: 
517:           "#{singularize(self[:name])}_id"
518:         end

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

[Source]

     # File lib/sequel/model/associations.rb, line 532
532:         def eager_loading_use_associated_key?
533:           true
534:         end

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

[Source]

     # File lib/sequel/model/associations.rb, line 544
544:         def join_table_alias
545:           cached_fetch(:join_table_alias) do
546:             s, a = split_join_table_alias
547:             a || s
548:           end
549:         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.

[Source]

     # File lib/sequel/model/associations.rb, line 538
538:         def join_table_source
539:           cached_fetch(:join_table_source){split_join_table_alias[0]}
540:         end

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

[Source]

     # File lib/sequel/model/associations.rb, line 554
554:         def need_associated_primary_key?
555:           true
556:         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.

[Source]

     # File lib/sequel/model/associations.rb, line 521
521:         def predicate_key
522:           cached_fetch(:predicate_key){qualify(join_table_alias, self[:left_key])}
523:         end
qualified_left_key()

Alias for predicate_key

The right key qualified by the join table.

[Source]

     # File lib/sequel/model/associations.rb, line 527
527:         def qualified_right_key
528:           cached_fetch(:qualified_right_key){qualify(join_table_alias, self[:right_key])}
529:         end

right_primary_key qualified by the associated table

[Source]

     # File lib/sequel/model/associations.rb, line 578
578:         def qualified_right_primary_key
579:           cached_fetch(:qualified_right_primary_key){qualify_assoc(right_primary_key)}
580:         end

Returns the reciprocal association symbol, if one exists.

[Source]

     # File lib/sequel/model/associations.rb, line 559
559:         def reciprocal
560:           cached_fetch(:reciprocal) do
561:             left_keys = self[:left_keys]
562:             right_keys = self[:right_keys]
563:             join_table = self[:join_table]
564:             recip = nil
565:             associated_class.all_association_reflections.each do |assoc_reflect|
566:               if assoc_reflect[:type] == :many_to_many && assoc_reflect[:left_keys] == right_keys &&
567:                  assoc_reflect[:right_keys] == left_keys && assoc_reflect[:join_table] == join_table &&
568:                  assoc_reflect.associated_class == self[:model]
569:                 recip = assoc_reflect[:name]
570:                 break
571:               end
572:             end
573:             recip
574:           end
575:         end

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

[Source]

     # File lib/sequel/model/associations.rb, line 583
583:         def right_primary_key
584:           cached_fetch(:right_primary_key){associated_class.primary_key}
585:         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.

[Source]

     # File lib/sequel/model/associations.rb, line 594
594:         def right_primary_key_method
595:           cached_fetch(:right_primary_key_method){right_primary_key}
596:         end

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

[Source]

     # File lib/sequel/model/associations.rb, line 600
600:         def right_primary_key_methods
601:           cached_fetch(:right_primary_key_methods){Array(right_primary_key_method)}
602:         end

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

[Source]

     # File lib/sequel/model/associations.rb, line 588
588:         def right_primary_keys
589:           cached_fetch(:right_primary_keys){Array(right_primary_key)}
590:         end

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

[Source]

     # File lib/sequel/model/associations.rb, line 605
605:         def select
606:          cached_fetch(:select){Sequel::SQL::ColumnAll.new(associated_class.table_name)}
607:         end

[Validate]