Class Index [+]

Quicksearch

Sequel::Model::Associations::ManyToManyAssociationReflection

Public Instance Methods

associated_key_alias() click to toggle source

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
associated_key_column() click to toggle source

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
associated_key_table() click to toggle source
Alias for: join_table_alias
associated_object_keys() click to toggle source

Alias of right_primary_keys

     # File lib/sequel/model/associations.rb, line 468
468:         def associated_object_keys
469:           right_primary_keys
470:         end
can_have_associated_objects?(obj) click to toggle source

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
default_associated_key_alias() click to toggle source

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_x
482:         end
default_join_table() click to toggle source

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_left_key() click to toggle source

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:           :"#{underscore(demodulize(self[:model].name))}_id"
493:         end
default_right_key() click to toggle source

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:           :"#{singularize(self[:name])}_id"
499:         end
eager_loader_key() click to toggle source

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
eager_loading_predicate_key() click to toggle source

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
Also aliased as: qualified_left_key
eager_loading_use_associated_key?() click to toggle source

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

     # File lib/sequel/model/associations.rb, line 519
519:         def eager_loading_use_associated_key?
520:           true
521:         end
join_table_alias() click to toggle source

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
Also aliased as: associated_key_table
join_table_source() click to toggle 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, line 525
525:         def join_table_source
526:           cached_fetch(:join_table_source){split_join_table_alias[0]}
527:         end
need_associated_primary_key?() click to toggle source

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
qualified_left_key() click to toggle source
qualified_right_key() click to toggle source

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
qualified_right_primary_key() click to toggle source

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
reciprocal() click to toggle source

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
right_primary_key() click to toggle source

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
right_primary_key_method() click to toggle source

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
right_primary_key_methods() click to toggle source

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
right_primary_keys() click to toggle source

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

     # File lib/sequel/model/associations.rb, line 575
575:         def right_primary_keys
576:           cached_fetch(:right_primary_keys){Array(right_primary_key)}
577:         end
select() click to toggle source

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

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

Private Instance Methods

split_join_table_alias() click to toggle source

Split the join table into source and alias parts.

     # File lib/sequel/model/associations.rb, line 599
599:         def split_join_table_alias
600:           associated_class.dataset.split_alias(self[:join_table])
601:         end

Disabled; run with --debug to generate this.

[Validate]

Generated with the Darkfish Rdoc Generator 1.1.6.