The alias to use for the associated key when eagerly loading
# File lib/sequel/model/associations.rb, line 1095 def associated_key_alias self[:left_key_alias] end
Array of associated keys used when eagerly loading.
# File lib/sequel/model/associations.rb, line 1100 def associated_key_array cached_fetch(:associated_key_array) do if self[:uses_left_composite_keys] associated_key_alias.zip(predicate_keys).map{|a, k| SQL::AliasedExpression.new(k, a)} else [SQL::AliasedExpression.new(predicate_key, associated_key_alias)] end end end
The column to use for the associated key when eagerly loading
# File lib/sequel/model/associations.rb, line 1111 def associated_key_column self[:left_key] end
Alias of right_primary_keys
# File lib/sequel/model/associations.rb, line 1116 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 1122 def can_have_associated_objects?(obj) !self[:left_primary_keys].any?{|k| obj.send(k).nil?} end
one_through_one and many_to_many associations can be clones
# File lib/sequel/model/associations.rb, line 1127 def cloneable?(ref) ref[:type] == :many_to_many || ref[:type] == :one_through_one end
The default associated key alias(es) to use when eager loading associations via eager.
# File lib/sequel/model/associations.rb, line 1133 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
The default eager loader used if the user doesn't override it. Extracted to a method so the code can be shared with the many_through_many plugin.
# File lib/sequel/model/associations.rb, line 1139 def default_eager_loader(eo) h = eo[:id_map] assign_singular = assign_singular? delete_rn = delete_row_number_column uses_lcks = self[:uses_left_composite_keys] left_key_alias = self[:left_key_alias] name = self[:name] self[:model].eager_load_results(self, eo) do |assoc_record| assoc_record.values.delete(delete_rn) if delete_rn hash_key = if uses_lcks left_key_alias.map{|k| assoc_record.values.delete(k)} else assoc_record.values.delete(left_key_alias) end next unless objects = h[hash_key] if assign_singular objects.each do |object| object.associations[name] ||= assoc_record end else objects.each do |object| object.associations[name].push(assoc_record) end end end end
Default name symbol for the join table.
# File lib/sequel/model/associations.rb, line 1168 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 1174 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 1180 def default_right_key :"#{singularize(self[:name])}_id" end
many_to_many associations need to select a key in an associated table to eagerly load
# File lib/sequel/model/associations.rb, line 1197 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 1209 def join_table_alias cached_fetch(:join_table_alias) do s, a = split_join_table_alias a || s 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 1203 def join_table_source cached_fetch(:join_table_source){split_join_table_alias[0]} 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 1219 def need_associated_primary_key? true 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 1186 def predicate_key cached_fetch(:predicate_key){qualify(join_table_alias, self[:left_key])} end
The right key qualified by the join table.
# File lib/sequel/model/associations.rb, line 1192 def qualified_right_key cached_fetch(: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 1224 def qualified_right_primary_key cached_fetch(:qualified_right_primary_key){qualify_assoc(right_primary_key)} end
The primary key column(s) to use in the associated table (can be symbol or array).
# File lib/sequel/model/associations.rb, line 1229 def right_primary_key cached_fetch(:right_primary_key){associated_class.primary_key || raise(Error, "no primary key specified for #{associated_class.inspect}")} 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 1240 def right_primary_key_method cached_fetch(: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 1246 def right_primary_key_methods cached_fetch(:right_primary_key_methods){Array(right_primary_key_method)} end
Generated with the Darkfish Rdoc Generator 2.