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
- #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.
- #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(**kwargs, &block) ⇒ 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 |
# 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) readonly! if shadow_record? && !Switchman.config[:writable_shadow_records] super end |
#clone ⇒ Object
247 248 249 250 251 252 253 254 |
# File 'lib/switchman/active_record/base.rb', line 247 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
243 244 245 |
# File 'lib/switchman/active_record/base.rb', line 243 def destroy shard.activate(self.class.connection_class_for_self) { super } end |
#destroy_shadow_records(target_shards: [Shard.current]) ⇒ Object
188 189 190 191 192 193 194 195 196 197 198 199 200 201 |
# File 'lib/switchman/active_record/base.rb', line 188 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
269 270 271 |
# File 'lib/switchman/active_record/base.rb', line 269 def hash self.class.sharded_primary_key? ? [self.class, global_id].hash : super end |
#id_for_database ⇒ Object
289 290 291 292 293 294 295 296 297 298 299 |
# File 'lib/switchman/active_record/base.rb', line 289 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
278 279 280 281 282 |
# File 'lib/switchman/active_record/base.rb', line 278 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.
206 207 208 |
# File 'lib/switchman/active_record/base.rb', line 206 def loaded_from_shard @loaded_from_shard || shard end |
#save ⇒ Object
229 230 231 232 233 234 |
# File 'lib/switchman/active_record/base.rb', line 229 def save(*, **) raise Errors::ManuallyCreatedShadowRecordError if creating_shadow_record? @shard_set_in_stone = true super end |
#save! ⇒ Object
236 237 238 239 240 241 |
# File 'lib/switchman/active_record/base.rb', line 236 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
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 |
# File 'lib/switchman/active_record/base.rb', line 172 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
165 166 167 168 169 170 |
# File 'lib/switchman/active_record/base.rb', line 165 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
210 211 212 |
# File 'lib/switchman/active_record/base.rb', line 210 def shard @shard || fallback_shard end |
#shard=(new_shard) ⇒ Object
214 215 216 217 218 219 220 221 222 223 224 225 226 227 |
# File 'lib/switchman/active_record/base.rb', line 214 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
273 274 275 276 |
# File 'lib/switchman/active_record/base.rb', line 273 def to_param short_id = Shard.short_id_for(id) short_id&.to_s end |
#transaction(**kwargs, &block) ⇒ Object
256 257 258 259 260 |
# File 'lib/switchman/active_record/base.rb', line 256 def transaction(**kwargs, &block) shard.activate(self.class.connection_class_for_self) do self.class.transaction(**kwargs, &block) end end |
#update_columns ⇒ Object
284 285 286 287 |
# File 'lib/switchman/active_record/base.rb', line 284 def update_columns(*) db = shard.database_server db.unguard { super } end |
#with_transaction_returning_status ⇒ Object
262 263 264 265 266 267 |
# File 'lib/switchman/active_record/base.rb', line 262 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 |