Class | Sequel::Model::Associations::ManyToManyAssociationReflection |
In: |
lib/sequel/model/associations.rb
|
Parent: | AssociationReflection |
The alias to use for the associated key when eagerly loading
# File lib/sequel/model/associations.rb, line 1101 1101: def associated_key_alias 1102: self[:left_key_alias] 1103: end
Array of associated keys used when eagerly loading.
# File lib/sequel/model/associations.rb, line 1106 1106: def associated_key_array 1107: cached_fetch(:associated_key_array) do 1108: if self[:uses_left_composite_keys] 1109: associated_key_alias.zip(predicate_keys).map{|a, k| SQL::AliasedExpression.new(k, a)} 1110: else 1111: [SQL::AliasedExpression.new(predicate_key, associated_key_alias)] 1112: end 1113: end 1114: end
The column to use for the associated key when eagerly loading
# File lib/sequel/model/associations.rb, line 1117 1117: def associated_key_column 1118: self[:left_key] 1119: end
Alias of right_primary_keys
# File lib/sequel/model/associations.rb, line 1122 1122: def associated_object_keys 1123: right_primary_keys 1124: 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 1128 1128: def can_have_associated_objects?(obj) 1129: !self[:left_primary_keys].any?{|k| obj.get_column_value(k).nil?} 1130: end
one_through_one and many_to_many associations can be clones
# File lib/sequel/model/associations.rb, line 1133 1133: def cloneable?(ref) 1134: ref[:type] == :many_to_many || ref[:type] == :one_through_one 1135: end
The default associated key alias(es) to use when eager loading associations via eager.
# File lib/sequel/model/associations.rb, line 1139 1139: def default_associated_key_alias 1140: 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 1141: 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 1145 1145: def default_eager_loader(eo) 1146: h = eo[:id_map] 1147: assign_singular = assign_singular? 1148: delete_rn = delete_row_number_column 1149: uses_lcks = self[:uses_left_composite_keys] 1150: left_key_alias = self[:left_key_alias] 1151: name = self[:name] 1152: 1153: self[:model].eager_load_results(self, eo) do |assoc_record| 1154: assoc_record.values.delete(delete_rn) if delete_rn 1155: hash_key = if uses_lcks 1156: left_key_alias.map{|k| assoc_record.values.delete(k)} 1157: else 1158: assoc_record.values.delete(left_key_alias) 1159: end 1160: next unless objects = h[hash_key] 1161: if assign_singular 1162: objects.each do |object| 1163: object.associations[name] ||= assoc_record 1164: end 1165: else 1166: objects.each do |object| 1167: object.associations[name].push(assoc_record) 1168: end 1169: end 1170: end 1171: end
Default name symbol for the join table.
# File lib/sequel/model/associations.rb, line 1174 1174: def default_join_table 1175: [self[:class_name], self[:model].name].map{|i| underscore(pluralize(demodulize(i)))}.sort.join('_').to_sym 1176: 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 1180 1180: def default_left_key 1181: 1182: "#{underscore(demodulize(self[:model].name))}_id" 1183: 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 1186 1186: def default_right_key 1187: 1188: "#{singularize(self[:name])}_id" 1189: end
The join table itself, unless it is aliased, in which case this is the alias.
# File lib/sequel/model/associations.rb, line 1215 1215: def join_table_alias 1216: cached_fetch(:join_table_alias) do 1217: s, a = split_join_table_alias 1218: a || s 1219: end 1220: 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 1209 1209: def join_table_source 1210: cached_fetch(:join_table_source){split_join_table_alias[0]} 1211: 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 1225 1225: def need_associated_primary_key? 1226: true 1227: 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 1192 1192: def predicate_key 1193: cached_fetch(:predicate_key){qualify(join_table_alias, self[:left_key])} 1194: end
The right key qualified by the join table.
# File lib/sequel/model/associations.rb, line 1198 1198: def qualified_right_key 1199: cached_fetch(:qualified_right_key){qualify(join_table_alias, self[:right_key])} 1200: end
right_primary_key qualified by the associated table
# File lib/sequel/model/associations.rb, line 1230 1230: def qualified_right_primary_key 1231: cached_fetch(:qualified_right_primary_key){qualify_assoc(right_primary_key)} 1232: end
The primary key column(s) to use in the associated table (can be symbol or array).
# File lib/sequel/model/associations.rb, line 1235 1235: def right_primary_key 1236: cached_fetch(:right_primary_key){associated_class.primary_key || raise(Error, "no primary key specified for #{associated_class.inspect}")} 1237: 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 1246 1246: def right_primary_key_method 1247: cached_fetch(:right_primary_key_method){right_primary_key} 1248: 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 1252 1252: def right_primary_key_methods 1253: cached_fetch(:right_primary_key_methods){Array(right_primary_key_method)} 1254: end