Module: Switchman::ActiveRecord::Base
- Defined in:
- lib/switchman/active_record/base.rb
Defined Under Namespace
Modules: ClassMethods
Class Method Summary collapse
Instance Method Summary collapse
- #_run_initialize_callbacks ⇒ Object
- #canonical? ⇒ Boolean
- #clone ⇒ Object
- #destroy ⇒ Object
- #destroy_shadow_records(target_shards: [Shard.current]) ⇒ Object
- #hash ⇒ Object
- #id_for_database ⇒ Object
- #initialize_dup(*args) ⇒ Object
-
#loaded_from_shard ⇒ Object
Returns “the shard that this record was actually loaded from” , as opposed to “the shard this record belongs on”, which might be different if this is a shadow record.
- #readonly! ⇒ Object
- #save ⇒ Object
- #save! ⇒ Object
- #save_shadow_record(new_attrs: attributes, target_shard: Shard.current) ⇒ Object
- #shadow_record? ⇒ Boolean
- #shard ⇒ Object
- #shard=(new_shard) ⇒ Object
- #to_param ⇒ Object
- #transaction ⇒ Object
- #update_columns ⇒ Object
- #with_transaction_returning_status ⇒ Object
Class Method Details
.prepended(klass) ⇒ Object
149 150 151 |
# File 'lib/switchman/active_record/base.rb', line 149 def self.prepended(klass) klass.singleton_class.prepend(ClassMethods) end |
Instance Method Details
#_run_initialize_callbacks ⇒ Object
153 154 155 156 157 158 159 160 161 162 163 164 165 166 |
# File 'lib/switchman/active_record/base.rb', line 153 def _run_initialize_callbacks @shard ||= if self.class.sharded_primary_key? Shard.shard_for(self[self.class.primary_key], Shard.current(self.class.connection_class_for_self)) else Shard.current(self.class.connection_class_for_self) end @loaded_from_shard ||= Shard.current(self.class.connection_class_for_self) if shadow_record? && !Switchman.config[:writable_shadow_records] @readonly = true @readonly_from_shadow ||= true end super end |
#canonical? ⇒ Boolean
180 181 182 |
# File 'lib/switchman/active_record/base.rb', line 180 def canonical? !shadow_record? end |
#clone ⇒ Object
259 260 261 262 263 264 265 266 |
# File 'lib/switchman/active_record/base.rb', line 259 def clone result = super # TODO: adjust foreign keys # don't use the setter, cause the foreign keys are already # relative to this shard result.instance_variable_set(:@shard, shard) result end |
#destroy ⇒ Object
255 256 257 |
# File 'lib/switchman/active_record/base.rb', line 255 def destroy shard.activate(self.class.connection_class_for_self) { super } end |
#destroy_shadow_records(target_shards: [Shard.current]) ⇒ Object
200 201 202 203 204 205 206 207 208 209 210 211 212 213 |
# File 'lib/switchman/active_record/base.rb', line 200 def destroy_shadow_records(target_shards: [Shard.current]) raise Errors::ShadowRecordError, "Cannot be called on a shadow record." if shadow_record? unless self.class.sharded_column?(self.class.primary_key) raise Errors::MethodUnsupportedForUnshardedTableError, "Cannot be called on a record belonging to an unsharded table." end Array(target_shards).each do |target_shard| next if target_shard == shard target_shard.activate { self.class.where("id = ?", global_id).delete_all } end end |
#hash ⇒ Object
281 282 283 |
# File 'lib/switchman/active_record/base.rb', line 281 def hash self.class.sharded_primary_key? ? [self.class, global_id].hash : super end |
#id_for_database ⇒ Object
301 302 303 304 305 306 307 308 309 310 311 |
# File 'lib/switchman/active_record/base.rb', line 301 def id_for_database if self.class.sharded_primary_key? # It's an int, so it's safe to just return it without passing it # through anything else. In theory we should do # `@attributes[@primary_key].type.serialize(id)`, but that seems to # have surprising side-effects id else super end end |
#initialize_dup(*args) ⇒ Object
290 291 292 293 294 |
# File 'lib/switchman/active_record/base.rb', line 290 def initialize_dup(*args) copy = super @shard_set_in_stone = false copy end |
#loaded_from_shard ⇒ Object
Returns “the shard that this record was actually loaded from” , as opposed to “the shard this record belongs on”, which might be different if this is a shadow record.
218 219 220 |
# File 'lib/switchman/active_record/base.rb', line 218 def loaded_from_shard @loaded_from_shard || shard end |
#readonly! ⇒ Object
168 169 170 171 |
# File 'lib/switchman/active_record/base.rb', line 168 def readonly! @readonly_from_shadow = false super end |
#save ⇒ Object
241 242 243 244 245 246 |
# File 'lib/switchman/active_record/base.rb', line 241 def save(*, **) raise Errors::ManuallyCreatedShadowRecordError if creating_shadow_record? @shard_set_in_stone = true super end |
#save! ⇒ Object
248 249 250 251 252 253 |
# File 'lib/switchman/active_record/base.rb', line 248 def save!(*, **) raise Errors::ManuallyCreatedShadowRecordError if creating_shadow_record? @shard_set_in_stone = true super end |
#save_shadow_record(new_attrs: attributes, target_shard: Shard.current) ⇒ Object
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 |
# File 'lib/switchman/active_record/base.rb', line 184 def save_shadow_record(new_attrs: attributes, target_shard: Shard.current) return if target_shard == shard shadow_attrs = {} new_attrs.each do |attr, value| shadow_attrs[attr] = if self.class.sharded_column?(attr) Shard.relative_id_for(value, shard, target_shard) else value end end target_shard.activate do self.class.upsert(shadow_attrs, unique_by: self.class.primary_key) end end |
#shadow_record? ⇒ Boolean
173 174 175 176 177 178 |
# File 'lib/switchman/active_record/base.rb', line 173 def shadow_record? pkey = self[self.class.primary_key] return false unless self.class.sharded_column?(self.class.primary_key) && pkey pkey > Shard::IDS_PER_SHARD end |
#shard ⇒ Object
222 223 224 |
# File 'lib/switchman/active_record/base.rb', line 222 def shard @shard || fallback_shard end |
#shard=(new_shard) ⇒ Object
226 227 228 229 230 231 232 233 234 235 236 237 238 239 |
# File 'lib/switchman/active_record/base.rb', line 226 def shard=(new_shard) raise ::ActiveRecord::ReadOnlyRecord if !new_record? || @shard_set_in_stone if shard == new_shard @loaded_from_shard = new_shard return end attributes.each do |attr, value| self[attr] = Shard.relative_id_for(value, shard, new_shard) if self.class.sharded_column?(attr) end @loaded_from_shard = new_shard @shard = new_shard end |
#to_param ⇒ Object
285 286 287 288 |
# File 'lib/switchman/active_record/base.rb', line 285 def to_param short_id = Shard.short_id_for(id) short_id&.to_s end |
#transaction ⇒ Object
268 269 270 271 272 |
# File 'lib/switchman/active_record/base.rb', line 268 def transaction(...) shard.activate(self.class.connection_class_for_self) do self.class.transaction(...) end end |
#update_columns ⇒ Object
296 297 298 299 |
# File 'lib/switchman/active_record/base.rb', line 296 def update_columns(*) db = shard.database_server db.unguard { super } end |
#with_transaction_returning_status ⇒ Object
274 275 276 277 278 279 |
# File 'lib/switchman/active_record/base.rb', line 274 def with_transaction_returning_status shard.activate(self.class.connection_class_for_self) do db = Shard.current(self.class.connection_class_for_self).database_server db.unguard { super } end end |