The alias to use for the associated key when eagerly loading
# File lib/sequel/model/associations.rb, line 422 def associated_key_alias self[:left_key_alias] end
The column to use for the associated key when eagerly loading
# File lib/sequel/model/associations.rb, line 427 def associated_key_column self[:left_key] end
Alias of right_primary_keys
# File lib/sequel/model/associations.rb, line 432 def associated_object_keys right_primary_keys 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 438 def can_have_associated_objects?(obj) !self[:left_primary_keys].any?{|k| obj.send(k).nil?} end
The default associated key alias(es) to use when eager loading associations via eager.
# File lib/sequel/model/associations.rb, line 444 def default_associated_key_alias self[:uses_left_composite_keys] ? (0...self[:left_keys].length).map{|i| :"x_foreign_key_#{i}_x"} : :x_foreign_key_x end
Default name symbol for the join table.
# File lib/sequel/model/associations.rb, line 449 def default_join_table [self[:class_name], self[:model].name].map{|i| underscore(pluralize(demodulize(i)))}.sort.join('_').to_sym 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 455 def default_left_key :"#{underscore(demodulize(self[:model].name))}_id" 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 461 def default_right_key :"#{singularize(self[:name])}_id" end
The key to use for the key hash when eager loading
# File lib/sequel/model/associations.rb, line 466 def eager_loader_key self[:eager_loader_key] ||= self[:left_primary_key] 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 472 def eager_loading_predicate_key self[:eager_loading_predicate_key] ||= qualify(join_table_alias, self[:left_key]) end
many_to_many associations need to select a key in an associated table to eagerly load
# File lib/sequel/model/associations.rb, line 483 def eager_loading_use_associated_key? true end
The join table itself, unless it is aliased, in which case this is the alias.
# File lib/sequel/model/associations.rb, line 498 def join_table_alias fetch(:join_table_alias) do split_join_table_alias self[:join_table_alias] end 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 489 def join_table_source fetch(:join_table_source) do split_join_table_alias self[:join_table_source] end 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 508 def need_associated_primary_key? true end
The right key qualified by the join table.
# File lib/sequel/model/associations.rb, line 478 def qualified_right_key self[:qualified_right_key] ||= qualify(join_table_alias, self[:right_key]) end
right_primary_key qualified by the associated table
# File lib/sequel/model/associations.rb, line 529 def qualified_right_primary_key self[:qualified_right_primary_key] ||= qualify_assoc(right_primary_key) end
Returns the reciprocal association symbol, if one exists.
# File lib/sequel/model/associations.rb, line 513 def reciprocal return self[:reciprocal] if include?(:reciprocal) left_keys = self[:left_keys] right_keys = self[:right_keys] join_table = self[:join_table] associated_class.all_association_reflections.each do |assoc_reflect| if assoc_reflect[:type] == :many_to_many && assoc_reflect[:left_keys] == right_keys && assoc_reflect[:right_keys] == left_keys && assoc_reflect[:join_table] == join_table && assoc_reflect.associated_class == self[:model] return self[:reciprocal] = assoc_reflect[:name] end end self[:reciprocal] = nil end
The primary key column(s) to use in the associated table (can be symbol or array).
# File lib/sequel/model/associations.rb, line 534 def right_primary_key self[:right_primary_key] ||= associated_class.primary_key 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 545 def right_primary_key_method self[:right_primary_key_method] ||= right_primary_key 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 551 def right_primary_key_methods self[:right_primary_key_methods] ||= Array(right_primary_key_method) end
The primary key columns to use in the associated table (always array).
# File lib/sequel/model/associations.rb, line 539 def right_primary_keys self[:right_primary_keys] ||= Array(right_primary_key) end
The columns to select when loading the association, associated_class.table_name.* by default.
# File lib/sequel/model/associations.rb, line 556 def select return self[:select] if include?(:select) self[:select] ||= Sequel::SQL::ColumnAll.new(associated_class.table_name) end
Generated with the Darkfish Rdoc Generator 2.