Class | Sequel::Model::Associations::AssociationReflection |
In: |
lib/sequel/model/associations.rb
|
Parent: | Hash |
AssociationReflection is a Hash subclass that keeps information on Sequel::Model associations. It provides methods to reduce internal code duplication. It should not be instantiated by the user.
Name symbol for the _add internal association method
# File lib/sequel/model/associations.rb, line 21 21: def _add_method 22: 23: "_add_#{singularize(self[:name])}" 24: end
Name symbol for the _dataset association method
# File lib/sequel/model/associations.rb, line 26 26: def _dataset_method 27: 28: "_#{self[:name]}_dataset" 29: end
Name symbol for the _remove_all internal association method
# File lib/sequel/model/associations.rb, line 31 31: def _remove_all_method 32: 33: "_remove_all_#{self[:name]}" 34: end
Name symbol for the _remove internal association method
# File lib/sequel/model/associations.rb, line 36 36: def _remove_method 37: 38: "_remove_#{singularize(self[:name])}" 39: end
Name symbol for the _setter association method
# File lib/sequel/model/associations.rb, line 41 41: def _setter_method 42: 43: "_#{self[:name]}=" 44: end
Name symbol for the add association method
# File lib/sequel/model/associations.rb, line 46 46: def add_method 47: 48: "add_#{singularize(self[:name])}" 49: end
The class associated to the current model class via this association
# File lib/sequel/model/associations.rb, line 56 56: def associated_class 57: cached_fetch(:class){constantize(self[:class_name])} 58: end
Name symbol for association method, the same as the name of the association.
# File lib/sequel/model/associations.rb, line 51 51: def association_method 52: self[:name] 53: end
Whether this association can have associated objects, given the current object. Should be false if obj cannot have associated objects because the necessary key columns are NULL.
# File lib/sequel/model/associations.rb, line 63 63: def can_have_associated_objects?(obj) 64: true 65: end
Name symbol for the _helper internal association method
# File lib/sequel/model/associations.rb, line 73 73: def dataset_helper_method 74: 75: "_#{self[:name]}_dataset_helper" 76: end
Name symbol for the dataset association method
# File lib/sequel/model/associations.rb, line 68 68: def dataset_method 69: 70: "#{self[:name]}_dataset" 71: end
Whether the dataset needs a primary key to function, true by default.
# File lib/sequel/model/associations.rb, line 78 78: def dataset_need_primary_key? 79: true 80: end
Whether to eagerly graph a lazy dataset, true by default. If this is false, the association won‘t respect the :eager_graph option when loading the association for a single record.
# File lib/sequel/model/associations.rb, line 122 122: def eager_graph_lazy_dataset? 123: true 124: end
The eager limit strategy to use for this dataset.
# File lib/sequel/model/associations.rb, line 83 83: def eager_limit_strategy 84: cached_fetch(:_eager_limit_strategy) do 85: if self[:limit] 86: case s = cached_fetch(:eager_limit_strategy){self[:model].default_eager_limit_strategy || :ruby} 87: when true 88: ds = associated_class.dataset 89: if ds.supports_window_functions? 90: :window_function 91: else 92: :ruby 93: end 94: else 95: s 96: end 97: else 98: nil 99: end 100: end 101: end
The key to use for the key hash when eager loading
# File lib/sequel/model/associations.rb, line 104 104: def eager_loader_key 105: self[:eager_loader_key] 106: end
Alias of predicate_key, only for backwards compatibility.
# File lib/sequel/model/associations.rb, line 115 115: def eager_loading_predicate_key 116: predicate_key 117: end
The limit and offset for this association (returned as a two element array).
# File lib/sequel/model/associations.rb, line 127 127: def limit_and_offset 128: if (v = self[:limit]).is_a?(Array) 129: v 130: else 131: [v, nil] 132: end 133: end
Whether the associated object needs a primary key to be added/removed, false by default.
# File lib/sequel/model/associations.rb, line 137 137: def need_associated_primary_key? 138: false 139: end
The keys to use for loading of the regular dataset, as an array.
# File lib/sequel/model/associations.rb, line 142 142: def predicate_keys 143: cached_fetch(:predicate_keys){Array(predicate_key)} 144: end
Qualify col with the given table name. If col is an array of columns, return an array of qualified columns. Only qualifies Symbols and SQL::Identifier values, other values are not modified.
# File lib/sequel/model/associations.rb, line 149 149: def qualify(table, col) 150: transform(col) do |k| 151: case k 152: when Symbol, SQL::Identifier 153: SQL::QualifiedIdentifier.new(table, k) 154: else 155: Sequel::Qualifier.new(self[:model].dataset, table).transform(k) 156: end 157: end 158: end
Qualify col with the associated model‘s table name.
# File lib/sequel/model/associations.rb, line 161 161: def qualify_assoc(col) 162: qualify(associated_class.table_name, col) 163: end
Qualify col with the current model‘s table name.
# File lib/sequel/model/associations.rb, line 166 166: def qualify_cur(col) 167: qualify(self[:model].table_name, col) 168: end
Returns the reciprocal association variable, if one exists. The reciprocal association is the association in the associated class that is the opposite of the current association. For example, Album.many_to_one :artist and Artist.one_to_many :albums are reciprocal associations. This information is to populate reciprocal associations. For example, when you do this_artist.add_album(album) it sets album.artist to this_artist.
# File lib/sequel/model/associations.rb, line 176 176: def reciprocal 177: cached_fetch(:reciprocal) do 178: r_types = Array(reciprocal_type) 179: keys = self[:keys] 180: recip = nil 181: associated_class.all_association_reflections.each do |assoc_reflect| 182: if r_types.include?(assoc_reflect[:type]) && assoc_reflect[:keys] == keys && assoc_reflect.associated_class == self[:model] 183: cached_set(:reciprocal_type, assoc_reflect[:type]) 184: recip = assoc_reflect[:name] 185: break 186: end 187: end 188: recip 189: end 190: end
Whether the reciprocal of this association returns an array of objects instead of a single object, true by default.
# File lib/sequel/model/associations.rb, line 194 194: def reciprocal_array? 195: true 196: end
Name symbol for the remove_all_ association method
# File lib/sequel/model/associations.rb, line 199 199: def remove_all_method 200: 201: "remove_all_#{self[:name]}" 202: end
Whether associated objects need to be removed from the association before being destroyed in order to preserve referential integrity.
# File lib/sequel/model/associations.rb, line 205 205: def remove_before_destroy? 206: true 207: end
Name symbol for the remove_ association method
# File lib/sequel/model/associations.rb, line 210 210: def remove_method 211: 212: "remove_#{singularize(self[:name])}" 213: end
Whether to check that an object to be disassociated is already associated to this object, false by default.
# File lib/sequel/model/associations.rb, line 215 215: def remove_should_check_existing? 216: false 217: end
Whether this association returns an array of objects instead of a single object, true by default.
# File lib/sequel/model/associations.rb, line 221 221: def returns_array? 222: true 223: end
Whether to set the reciprocal association to self when loading associated records, false by default.
# File lib/sequel/model/associations.rb, line 232 232: def set_reciprocal_to_self? 233: false 234: end