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

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

Direct Known Subclasses

OneToOneAssociationReflection

Constant Summary collapse

FINALIZE_SETTINGS =
superclass::FINALIZE_SETTINGS.merge(
  :qualified_primary_key=>:qualified_primary_key
).freeze

Constants inherited from AssociationReflection

AssociationReflection::ASSOCIATION_DATASET_PROC

Instance Method Summary collapse

Methods inherited from AssociationReflection

#_add_method, #_remove_all_method, #_remove_method, #_setter_method, #add_method, #apply_dataset_changes, #apply_distinct_on_eager_limit_strategy, #apply_eager_dataset_changes, #apply_eager_limit_strategy, #apply_ruby_eager_limit_strategy, #apply_window_function_eager_limit_strategy, #assign_singular?, #associated_class, #associated_dataset, #association_dataset_for, #association_dataset_proc, #association_method, #dataset_method, #dataset_need_primary_key?, #delete_row_number_column, #eager_graph_lazy_dataset?, #eager_graph_limit_strategy, #eager_limit_strategy, #eager_load_results, #eager_loader_key, #eager_loading_use_associated_key?, #filter_by_associations_add_conditions?, #filter_by_associations_conditions_expression, #finalize, #initialize_association_cache, #inspect, #limit_and_offset, #need_associated_primary_key?, #placeholder_loader, #predicate_key_values, #predicate_keys, #qualify, #qualify_assoc, #qualify_cur, #reciprocal, #remove_all_method, #remove_method, #returns_array?, #select, #setter_method, #slice_range

Methods included from Inflections

clear, irregular, plural, singular, uncountable

Methods inherited from Hash

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

Instance Method Details

#apply_eager_graph_limit_strategy(strategy, ds) ⇒ Object

Support a correlated subquery limit strategy when using eager_graph.


963
964
965
966
967
968
969
970
# File 'lib/sequel/model/associations.rb', line 963

def apply_eager_graph_limit_strategy(strategy, ds)
  case strategy
  when :correlated_subquery
    apply_correlated_subquery_limit_strategy(ds)
  else
    super
  end
end

#associated_object_keysObject

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


973
974
975
# File 'lib/sequel/model/associations.rb', line 973

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)

979
980
981
# File 'lib/sequel/model/associations.rb', line 979

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

#cloneable?(ref) ⇒ Boolean

one_to_many and one_to_one associations can be clones

Returns:

  • (Boolean)

984
985
986
# File 'lib/sequel/model/associations.rb', line 984

def cloneable?(ref)
  ref[:type] == :one_to_many || ref[:type] == :one_to_one
end

#default_keyObject

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


990
991
992
# File 'lib/sequel/model/associations.rb', line 990

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

#finalize_settingsObject


997
998
999
# File 'lib/sequel/model/associations.rb', line 997

def finalize_settings
  FINALIZE_SETTINGS
end

#handle_silent_modification_failure?Boolean

Handle silent failure of add/remove methods if raise_on_save_failure is false.

Returns:

  • (Boolean)

1002
1003
1004
# File 'lib/sequel/model/associations.rb', line 1002

def handle_silent_modification_failure?
  self[:raise_on_save_failure] == false
end

#predicate_keyObject Also known as: qualified_key

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


1007
1008
1009
# File 'lib/sequel/model/associations.rb', line 1007

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

#primary_keyObject

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


1013
1014
1015
# File 'lib/sequel/model/associations.rb', line 1013

def primary_key
  self[:primary_key]
end

#qualified_primary_keyObject

#primary_key qualified by the current table


1018
1019
1020
# File 'lib/sequel/model/associations.rb', line 1018

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)

1024
1025
1026
# File 'lib/sequel/model/associations.rb', line 1024

def reciprocal_array?
  false
end

#remove_before_destroy?Boolean

Destroying one_to_many associated objects automatically deletes the foreign key.

Returns:

  • (Boolean)

1029
1030
1031
# File 'lib/sequel/model/associations.rb', line 1029

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)

1034
1035
1036
# File 'lib/sequel/model/associations.rb', line 1034

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)

1039
1040
1041
# File 'lib/sequel/model/associations.rb', line 1039

def set_reciprocal_to_self?
  true
end