Class: Sequel::Model::Associations::ManyToManyAssociationReflection
- Inherits:
-
AssociationReflection
- Object
- Hash
- AssociationReflection
- Sequel::Model::Associations::ManyToManyAssociationReflection
- Defined in:
- lib/sequel/model/associations.rb
Direct Known Subclasses
Plugins::ManyThroughMany::ManyThroughManyAssociationReflection
Constant Summary
Constants included from Inflections
Inflections::CAMELIZE_CONVERT_REGEXP, Inflections::CAMELIZE_MODULE_REGEXP, Inflections::DASH, Inflections::DEMODULIZE_CONVERT_REGEXP, Inflections::EMPTY_STRING, Inflections::SLASH, Inflections::UNDERSCORE, Inflections::UNDERSCORE_CONVERT_REGEXP1, Inflections::UNDERSCORE_CONVERT_REGEXP2, Inflections::UNDERSCORE_CONVERT_REPLACE, Inflections::UNDERSCORE_MODULE_REGEXP, Inflections::VALID_CONSTANT_NAME_REGEXP
Instance Method Summary collapse
-
#associated_key_alias ⇒ Object
The alias to use for the associated key when eagerly loading.
-
#associated_key_column ⇒ Object
The column to use for the associated key when eagerly loading.
-
#associated_key_table ⇒ Object
The table containing the column to use for the associated key when eagerly loading.
-
#associated_object_keys ⇒ Object
Alias of right_primary_keys.
-
#can_have_associated_objects?(obj) ⇒ Boolean
many_to_many associations can only have associated objects if none of the :left_primary_keys options have a nil value.
-
#default_associated_key_alias ⇒ Object
The default associated key alias(es) to use when eager loading associations via eager.
-
#default_join_table ⇒ Object
Default name symbol for the join table.
-
#default_left_key ⇒ Object
Default foreign key name symbol for key in join table that points to current table’s primary key (or :left_primary_key column).
-
#default_right_key ⇒ Object
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).
-
#eager_loader_key ⇒ Object
The key to use for the key hash when eager loading.
-
#eager_loading_use_associated_key? ⇒ Boolean
many_to_many associations need to select a key in an associated table to eagerly load.
-
#need_associated_primary_key? ⇒ Boolean
Whether the associated object needs a primary key to be added/removed, true for many_to_many associations.
-
#reciprocal ⇒ Object
Returns the reciprocal association symbol, if one exists.
-
#right_primary_key ⇒ Object
The primary key column(s) to use in the associated table (can be symbol or array).
-
#right_primary_keys ⇒ Object
The primary key columns to use in the associated table (always array).
-
#select ⇒ Object
The columns to select when loading the association, associated_class.table_name.* by default.
Methods inherited from AssociationReflection
#_add_method, #_dataset_method, #_remove_all_method, #_remove_method, #_setter_method, #add_method, #associated_class, #association_method, #dataset_helper_method, #dataset_method, #dataset_need_primary_key?, #eager_graph_lazy_dataset?, #reciprocal_array?, #remove_all_method, #remove_before_destroy?, #remove_method, #remove_should_check_existing?, #returns_array?, #set_reciprocal_to_self?, #setter_method
Methods included from Inflections
clear, irregular, plural, singular, uncountable
Methods inherited from Hash
#&, #case, #sql_expr, #sql_negate, #sql_or, #|, #~
Instance Method Details
#associated_key_alias ⇒ Object
The alias to use for the associated key when eagerly loading
310 311 312 |
# File 'lib/sequel/model/associations.rb', line 310 def associated_key_alias self[:left_key_alias] end |
#associated_key_column ⇒ Object
The column to use for the associated key when eagerly loading
315 316 317 |
# File 'lib/sequel/model/associations.rb', line 315 def associated_key_column self[:left_key] end |
#associated_key_table ⇒ Object
The table containing the column to use for the associated key when eagerly loading
320 321 322 323 324 |
# File 'lib/sequel/model/associations.rb', line 320 def associated_key_table self[:associated_key_table] ||= ( syms = associated_class.dataset.split_alias(self[:join_table]); syms[1] || syms[0]) end |
#associated_object_keys ⇒ Object
Alias of right_primary_keys
327 328 329 |
# File 'lib/sequel/model/associations.rb', line 327 def associated_object_keys right_primary_keys end |
#can_have_associated_objects?(obj) ⇒ Boolean
many_to_many associations can only have associated objects if none of the :left_primary_keys options have a nil value.
333 334 335 |
# File 'lib/sequel/model/associations.rb', line 333 def can_have_associated_objects?(obj) !self[:left_primary_keys].any?{|k| obj.send(k).nil?} end |
#default_associated_key_alias ⇒ Object
The default associated key alias(es) to use when eager loading associations via eager.
339 340 341 |
# File 'lib/sequel/model/associations.rb', line 339 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_join_table ⇒ Object
Default name symbol for the join table.
344 345 346 |
# File 'lib/sequel/model/associations.rb', line 344 def default_join_table [self[:class_name], self[:model].name].map{|i| underscore(pluralize(demodulize(i)))}.sort.join('_').to_sym end |
#default_left_key ⇒ Object
Default foreign key name symbol for key in join table that points to current table’s primary key (or :left_primary_key column).
350 351 352 |
# File 'lib/sequel/model/associations.rb', line 350 def default_left_key :"#{underscore(demodulize(self[:model].name))}_id" end |
#default_right_key ⇒ Object
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).
356 357 358 |
# File 'lib/sequel/model/associations.rb', line 356 def default_right_key :"#{singularize(self[:name])}_id" end |
#eager_loader_key ⇒ Object
The key to use for the key hash when eager loading
361 362 363 |
# File 'lib/sequel/model/associations.rb', line 361 def eager_loader_key self[:eager_loader_key] ||= self[:left_primary_key] end |
#eager_loading_use_associated_key? ⇒ Boolean
many_to_many associations need to select a key in an associated table to eagerly load
366 367 368 |
# File 'lib/sequel/model/associations.rb', line 366 def eager_loading_use_associated_key? true end |
#need_associated_primary_key? ⇒ Boolean
Whether the associated object needs a primary key to be added/removed, true for many_to_many associations.
372 373 374 |
# File 'lib/sequel/model/associations.rb', line 372 def need_associated_primary_key? true end |
#reciprocal ⇒ Object
Returns the reciprocal association symbol, if one exists.
377 378 379 380 381 382 383 384 385 386 387 388 389 390 |
# File 'lib/sequel/model/associations.rb', line 377 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 |
#right_primary_key ⇒ Object
The primary key column(s) to use in the associated table (can be symbol or array).
393 394 395 |
# File 'lib/sequel/model/associations.rb', line 393 def right_primary_key self[:right_primary_key] ||= associated_class.primary_key end |
#right_primary_keys ⇒ Object
The primary key columns to use in the associated table (always array).
398 399 400 |
# File 'lib/sequel/model/associations.rb', line 398 def right_primary_keys self[:right_primary_keys] ||= Array(right_primary_key) end |
#select ⇒ Object
The columns to select when loading the association, associated_class.table_name.* by default.
403 404 405 406 |
# File 'lib/sequel/model/associations.rb', line 403 def select return self[:select] if include?(:select) self[:select] ||= Sequel::SQL::ColumnAll.new(associated_class.table_name) end |