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 523
523:         def associated_key_alias
524:           self[:left_key_alias]
525:         end

The column to use for the associated key when eagerly loading

[Source]

     # File lib/sequel/model/associations.rb, line 528
528:         def associated_key_column
529:           self[:left_key]
530:         end
associated_key_table()

Alias for join_table_alias

Alias of right_primary_keys

[Source]

     # File lib/sequel/model/associations.rb, line 533
533:         def associated_object_keys
534:           right_primary_keys
535:         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 539
539:         def can_have_associated_objects?(obj)
540:           !self[:left_primary_keys].any?{|k| obj.send(k).nil?}
541:         end

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

[Source]

     # File lib/sequel/model/associations.rb, line 545
545:         def default_associated_key_alias
546:           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
547:         end

Default name symbol for the join table.

[Source]

     # File lib/sequel/model/associations.rb, line 550
550:         def default_join_table
551:           [self[:class_name], self[:model].name].map{|i| underscore(pluralize(demodulize(i)))}.sort.join('_').to_sym
552:         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 556
556:         def default_left_key
557: 
558:           "#{underscore(demodulize(self[:model].name))}_id"
559:         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 562
562:         def default_right_key
563: 
564:           "#{singularize(self[:name])}_id"
565:         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 579
579:         def eager_loading_use_associated_key?
580:           true
581:         end

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

[Source]

     # File lib/sequel/model/associations.rb, line 591
591:         def join_table_alias
592:           cached_fetch(:join_table_alias) do
593:             s, a = split_join_table_alias
594:             a || s
595:           end
596:         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 585
585:         def join_table_source
586:           cached_fetch(:join_table_source){split_join_table_alias[0]}
587:         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 601
601:         def need_associated_primary_key?
602:           true
603:         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 568
568:         def predicate_key
569:           cached_fetch(:predicate_key){qualify(join_table_alias, self[:left_key])}
570:         end
qualified_left_key()

Alias for predicate_key

The right key qualified by the join table.

[Source]

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

right_primary_key qualified by the associated table

[Source]

     # File lib/sequel/model/associations.rb, line 606
606:         def qualified_right_primary_key
607:           cached_fetch(:qualified_right_primary_key){qualify_assoc(right_primary_key)}
608:         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 611
611:         def right_primary_key
612:           cached_fetch(:right_primary_key){associated_class.primary_key}
613:         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 622
622:         def right_primary_key_method
623:           cached_fetch(:right_primary_key_method){right_primary_key}
624:         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 628
628:         def right_primary_key_methods
629:           cached_fetch(:right_primary_key_methods){Array(right_primary_key_method)}
630:         end

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

[Source]

     # File lib/sequel/model/associations.rb, line 616
616:         def right_primary_keys
617:           cached_fetch(:right_primary_keys){Array(right_primary_key)}
618:         end

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

[Source]

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

[Validate]