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 1102
1102:         def associated_key_alias
1103:           self[:left_key_alias]
1104:         end

Array of associated keys used when eagerly loading.

[Source]

      # File lib/sequel/model/associations.rb, line 1107
1107:         def associated_key_array
1108:           cached_fetch(:associated_key_array) do
1109:             if self[:uses_left_composite_keys]
1110:               associated_key_alias.zip(predicate_keys).map{|a, k| SQL::AliasedExpression.new(k, a)}
1111:             else
1112:               [SQL::AliasedExpression.new(predicate_key, associated_key_alias)]
1113:             end
1114:           end
1115:         end

The column to use for the associated key when eagerly loading

[Source]

      # File lib/sequel/model/associations.rb, line 1118
1118:         def associated_key_column
1119:           self[:left_key]
1120:         end
associated_key_table()

Alias for join_table_alias

Alias of right_primary_keys

[Source]

      # File lib/sequel/model/associations.rb, line 1123
1123:         def associated_object_keys
1124:           right_primary_keys
1125:         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 1129
1129:         def can_have_associated_objects?(obj)
1130:           !self[:left_primary_keys].any?{|k| obj.get_column_value(k).nil?}
1131:         end

one_through_one and many_to_many associations can be clones

[Source]

      # File lib/sequel/model/associations.rb, line 1134
1134:         def cloneable?(ref)
1135:           ref[:type] == :many_to_many || ref[:type] == :one_through_one
1136:         end

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

[Source]

      # File lib/sequel/model/associations.rb, line 1140
1140:         def default_associated_key_alias
1141:           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
1142:         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.

[Source]

      # File lib/sequel/model/associations.rb, line 1146
1146:         def default_eager_loader(eo)
1147:           h = eo[:id_map]
1148:           assign_singular = assign_singular?
1149:           delete_rn = delete_row_number_column
1150:           uses_lcks = self[:uses_left_composite_keys]
1151:           left_key_alias = self[:left_key_alias]
1152:           name = self[:name]
1153: 
1154:           self[:model].eager_load_results(self, eo) do |assoc_record|
1155:             assoc_record.values.delete(delete_rn) if delete_rn
1156:             hash_key = if uses_lcks
1157:               left_key_alias.map{|k| assoc_record.values.delete(k)}
1158:             else
1159:               assoc_record.values.delete(left_key_alias)
1160:             end
1161:             next unless objects = h[hash_key]
1162:             if assign_singular
1163:               objects.each do |object| 
1164:                 object.associations[name] ||= assoc_record
1165:               end
1166:             else
1167:               objects.each do |object|
1168:                 object.associations[name].push(assoc_record)
1169:               end
1170:             end
1171:           end
1172:         end

Default name symbol for the join table.

[Source]

      # File lib/sequel/model/associations.rb, line 1175
1175:         def default_join_table
1176:           [self[:class_name], self[:model].name].map{|i| underscore(pluralize(demodulize(i)))}.sort.join('_').to_sym
1177:         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 1181
1181:         def default_left_key
1182: 
1183:           "#{underscore(demodulize(self[:model].name))}_id"
1184:         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 1187
1187:         def default_right_key
1188: 
1189:           "#{singularize(self[:name])}_id"
1190:         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 1204
1204:         def eager_loading_use_associated_key?
1205:           true
1206:         end

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

[Source]

      # File lib/sequel/model/associations.rb, line 1216
1216:         def join_table_alias
1217:           cached_fetch(:join_table_alias) do
1218:             s, a = split_join_table_alias
1219:             a || s
1220:           end
1221:         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 1210
1210:         def join_table_source
1211:           cached_fetch(:join_table_source){split_join_table_alias[0]}
1212:         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 1226
1226:         def need_associated_primary_key?
1227:           true
1228:         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 1193
1193:         def predicate_key
1194:           cached_fetch(:predicate_key){qualify(join_table_alias, self[:left_key])}
1195:         end
qualified_left_key()

Alias for predicate_key

The right key qualified by the join table.

[Source]

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

right_primary_key qualified by the associated table

[Source]

      # File lib/sequel/model/associations.rb, line 1231
1231:         def qualified_right_primary_key
1232:           cached_fetch(:qualified_right_primary_key){qualify_assoc(right_primary_key)}
1233:         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 1236
1236:         def right_primary_key
1237:           cached_fetch(:right_primary_key){associated_class.primary_key || raise(Error, "no primary key specified for #{associated_class.inspect}")}
1238:         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 1247
1247:         def right_primary_key_method
1248:           cached_fetch(:right_primary_key_method){right_primary_key}
1249:         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 1253
1253:         def right_primary_key_methods
1254:           cached_fetch(:right_primary_key_methods){Array(right_primary_key_method)}
1255:         end

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

[Source]

      # File lib/sequel/model/associations.rb, line 1241
1241:         def right_primary_keys
1242:           cached_fetch(:right_primary_keys){Array(right_primary_key)}
1243:         end

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

[Source]

      # File lib/sequel/model/associations.rb, line 1258
1258:         def select
1259:           cached_fetch(:select){default_select}
1260:         end

[Validate]