Class: Sequel::Model::Associations::OneToManyAssociationReflection

Inherits:
AssociationReflection show all
Defined in:
lib/sequel/model/associations.rb

Direct Known Subclasses

OneToOneAssociationReflection

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

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?, #eager_limit_strategy, #eager_loading_use_associated_key?, #limit_and_offset, #need_associated_primary_key?, #qualify, #qualify_assoc, #qualify_cur, #reciprocal, #remove_all_method, #remove_method, #returns_array?, #select, #setter_method

Methods included from Inflections

clear, irregular, plural, singular, uncountable

Methods inherited from Hash

#&, #case, #hstore, #sql_expr, #sql_negate, #sql_or, #|, #~

Instance Method Details

#associated_object_keys ⇒ Object

The keys in the associated model’s table related to this association



354
355
356
 
# File 'lib/sequel/model/associations.rb', line 354

def associated_object_keys
  self[:keys]
end

#can_have_associated_objects?(obj) ⇒ Boolean

one_to_many associations can only have associated objects if none of the :keys options have a nil value.

Returns:

  • (Boolean) 


360
361
362
 
# File 'lib/sequel/model/associations.rb', line 360

def can_have_associated_objects?(obj)
  !self[:primary_keys].any?{|k| obj.send(k).nil?}
end

#default_key ⇒ Object

Default foreign key name symbol for key in associated table that points to current table’s primary key.



366
367
368
 
# File 'lib/sequel/model/associations.rb', line 366

def default_key
  :"#{underscore(demodulize(self[:model].name))}_id"
end

#eager_loader_key ⇒ Object

The key to use for the key hash when eager loading



371
372
373
 
# File 'lib/sequel/model/associations.rb', line 371

def eager_loader_key
  cached_fetch(:eager_loader_key){primary_key}
end

#eager_loading_predicate_key ⇒ Object Also known as: qualified_key

The hash key to use for the eager loading predicate (left side of IN (1, 2, 3))



376
377
378
 
# File 'lib/sequel/model/associations.rb', line 376

def eager_loading_predicate_key
  cached_fetch(:eager_loading_predicate_key){qualify_assoc(self[:key])}
end

#primary_key ⇒ Object

The column in the current table that the key in the associated table references.



382
383
384
 
# File 'lib/sequel/model/associations.rb', line 382

def primary_key
 self[:primary_key]
end

#qualified_primary_key ⇒ Object

#primary_key qualified by the current table



387
388
389
 
# File 'lib/sequel/model/associations.rb', line 387

def qualified_primary_key
  cached_fetch(:qualified_primary_key){qualify_cur(primary_key)}
end

#reciprocal_array? ⇒ Boolean

Whether the reciprocal of this association returns an array of objects instead of a single object, false for a one_to_many association.

Returns:

  • (Boolean) 


393
394
395
 
# File 'lib/sequel/model/associations.rb', line 393

def reciprocal_array?
  false
end

#remove_before_destroy? ⇒ Boolean

Destroying one_to_many associated objects automatically deletes the foreign key.

Returns:

  • (Boolean) 


398
399
400
 
# File 'lib/sequel/model/associations.rb', line 398

def remove_before_destroy?
  false
end

#remove_should_check_existing? ⇒ Boolean

The one_to_many association needs to check that an object to be removed already is associated.

Returns:

  • (Boolean) 


403
404
405
 
# File 'lib/sequel/model/associations.rb', line 403

def remove_should_check_existing?
  true
end

#set_reciprocal_to_self? ⇒ Boolean

One to many associations set the reciprocal to self when loading associated records.

Returns:

  • (Boolean) 


408
409
410
 
# File 'lib/sequel/model/associations.rb', line 408

def set_reciprocal_to_self?
  true
end