class Sequel::Model::Associations::OneToManyAssociationReflection

Constants

FINALIZE_SETTINGS

Public Instance Methods

apply_eager_graph_limit_strategy(strategy, ds) click to toggle source

Support a correlated subquery limit strategy when using eager_graph.

    # File lib/sequel/model/associations.rb
978 def apply_eager_graph_limit_strategy(strategy, ds)
979   case strategy
980   when :correlated_subquery
981     apply_correlated_subquery_limit_strategy(ds)
982   else
983     super
984   end
985 end
associated_object_keys() click to toggle source

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

    # File lib/sequel/model/associations.rb
988 def associated_object_keys
989   self[:keys]
990 end
can_have_associated_objects?(obj) click to toggle source

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

    # File lib/sequel/model/associations.rb
994 def can_have_associated_objects?(obj)
995   !self[:primary_keys].any?{|k| obj.get_column_value(k).nil?}
996 end
cloneable?(ref) click to toggle source

one_to_many and one_to_one associations can be clones

     # File lib/sequel/model/associations.rb
 999 def cloneable?(ref)
1000   ref[:type] == :one_to_many || ref[:type] == :one_to_one
1001 end
default_key() click to toggle source

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

     # File lib/sequel/model/associations.rb
1005 def default_key
1006   :"#{underscore(demodulize(self[:model].name))}_id"
1007 end
finalize_settings() click to toggle source
     # File lib/sequel/model/associations.rb
1012 def finalize_settings
1013   FINALIZE_SETTINGS
1014 end
handle_silent_modification_failure?() click to toggle source

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

     # File lib/sequel/model/associations.rb
1017 def handle_silent_modification_failure?
1018   self[:raise_on_save_failure] == false
1019 end
predicate_key() click to toggle source

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

     # File lib/sequel/model/associations.rb
1022 def predicate_key
1023   cached_fetch(:predicate_key){qualify_assoc(self[:key])}
1024 end
Also aliased as: qualified_key
primary_key() click to toggle source

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

     # File lib/sequel/model/associations.rb
1028 def primary_key
1029   self[:primary_key]
1030 end
qualified_key()
Alias for: predicate_key
qualified_primary_key() click to toggle source

primary_key qualified by the current table

     # File lib/sequel/model/associations.rb
1033 def qualified_primary_key
1034   cached_fetch(:qualified_primary_key){qualify_cur(primary_key)}
1035 end
reciprocal_array?() click to toggle source

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

     # File lib/sequel/model/associations.rb
1039 def reciprocal_array?
1040   false
1041 end
remove_before_destroy?() click to toggle source

Destroying one_to_many associated objects automatically deletes the foreign key.

     # File lib/sequel/model/associations.rb
1044 def remove_before_destroy?
1045   false
1046 end
remove_should_check_existing?() click to toggle source

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

     # File lib/sequel/model/associations.rb
1049 def remove_should_check_existing?
1050   true
1051 end
set_reciprocal_to_self?() click to toggle source

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

     # File lib/sequel/model/associations.rb
1054 def set_reciprocal_to_self?
1055   true
1056 end

Private Instance Methods

apply_correlated_subquery_limit_strategy(ds) click to toggle source

Use a correlated subquery to limit the dataset. Note that this will not work correctly if the associated dataset uses qualified identifers in the WHERE clause, as they would reference the containing query instead of the subquery.

     # File lib/sequel/model/associations.rb
1063 def apply_correlated_subquery_limit_strategy(ds)
1064   table = ds.first_source_table
1065   table_alias = ds.first_source_alias
1066   primary_key = associated_class.primary_key
1067   key = self[:key]
1068   cs_alias = :t1
1069   cs = associated_dataset.
1070     from(Sequel.as(table, :t1)).
1071     select(*qualify(cs_alias, primary_key)).
1072     where(Array(qualify(cs_alias, key)).zip(Array(qualify(table_alias, key)))).
1073     limit(*limit_and_offset)
1074   ds.where(qualify(table_alias, primary_key)=>cs)
1075 end
apply_filter_by_associations_limit_strategy(ds) click to toggle source

Support correlated subquery strategy when filtering by limited associations.

     # File lib/sequel/model/associations.rb
1078 def apply_filter_by_associations_limit_strategy(ds)
1079   case filter_by_associations_limit_strategy
1080   when :correlated_subquery
1081     apply_correlated_subquery_limit_strategy(ds)
1082   else
1083     super
1084   end
1085 end
filter_by_associations_conditions_associated_keys() click to toggle source
     # File lib/sequel/model/associations.rb
1087 def filter_by_associations_conditions_associated_keys
1088   qualify(associated_class.table_name, self[:keys])
1089 end
filter_by_associations_conditions_key() click to toggle source
     # File lib/sequel/model/associations.rb
1091 def filter_by_associations_conditions_key
1092   qualify(self[:model].table_name, self[:primary_key_column])
1093 end
filter_by_associations_limit_alias_key() click to toggle source
     # File lib/sequel/model/associations.rb
1095 def filter_by_associations_limit_alias_key
1096   Array(filter_by_associations_limit_key)
1097 end
filter_by_associations_limit_aliases() click to toggle source
     # File lib/sequel/model/associations.rb
1099 def filter_by_associations_limit_aliases
1100   filter_by_associations_limit_alias_key.map(&:column)
1101 end
filter_by_associations_limit_key() click to toggle source
     # File lib/sequel/model/associations.rb
1103 def filter_by_associations_limit_key
1104   qualify(associated_class.table_name, associated_class.primary_key)
1105 end
predicate_key_methods() click to toggle source
     # File lib/sequel/model/associations.rb
1107 def predicate_key_methods
1108   self[:primary_keys]
1109 end
reciprocal_association?(assoc_reflect) click to toggle source
     # File lib/sequel/model/associations.rb
1111 def reciprocal_association?(assoc_reflect)
1112   super && self[:keys] == assoc_reflect[:keys] && primary_key == assoc_reflect.primary_key
1113 end
reciprocal_type() click to toggle source

The reciprocal type of a one_to_many association is a many_to_one association.

     # File lib/sequel/model/associations.rb
1116 def reciprocal_type
1117   :many_to_one
1118 end
true_eager_graph_limit_strategy() click to toggle source

Support automatic use of correlated subqueries if :ruby option is best available option, the database supports them, and either the associated class has a non-composite primary key or the database supports multiple columns in IN.

     # File lib/sequel/model/associations.rb
1123 def true_eager_graph_limit_strategy
1124   r = super
1125   ds = associated_dataset
1126   if r == :ruby && ds.supports_limits_in_correlated_subqueries? && (Array(associated_class.primary_key).length == 1 || ds.supports_multiple_column_in?) && (!offset || ds.supports_offsets_in_correlated_subqueries?)
1127     :correlated_subquery
1128   else
1129     r
1130   end
1131 end