Class: ActiveRecord::ConnectionAdapters::Transaction

Inherits:
Object
  • Object
show all
Defined in:
activerecord/lib/active_record/connection_adapters/abstract/transaction.rb

Overview

:nodoc:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(connection, isolation: nil, joinable: true, run_commit_callbacks: false) ⇒ Transaction

Returns a new instance of Transaction.



123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/transaction.rb', line 123

def initialize(connection, isolation: nil, joinable: true, run_commit_callbacks: false)
  @connection = connection
  @state = TransactionState.new
  @records = nil
  @isolation_level = isolation
  @materialized = false
  @joinable = joinable
  @run_commit_callbacks = run_commit_callbacks
  @lazy_enrollment_records = nil
  @dirty = false
  @instrumenter = TransactionInstrumenter.new(connection: connection)
end

Instance Attribute Details

#connection ⇒ Object (readonly)

Returns the value of attribute connection.



118
119
120
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/transaction.rb', line 118

def connection
  @connection
end

#isolation_level ⇒ Object (readonly)

Returns the value of attribute isolation_level.



118
119
120
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/transaction.rb', line 118

def isolation_level
  @isolation_level
end

#savepoint_name ⇒ Object (readonly)

Returns the value of attribute savepoint_name.



118
119
120
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/transaction.rb', line 118

def savepoint_name
  @savepoint_name
end

#state ⇒ Object (readonly)

Returns the value of attribute state.



118
119
120
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/transaction.rb', line 118

def state
  @state
end

#written ⇒ Object

Returns the value of attribute written.



119
120
121
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/transaction.rb', line 119

def written
  @written
end

Instance Method Details

#add_record(record, ensure_finalize = true) ⇒ Object 



144
145
146
147
148
149
150
151
152
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/transaction.rb', line 144

def add_record(record, ensure_finalize = true)
  @records ||= []
  if ensure_finalize
    @records << record
  else
    @lazy_enrollment_records ||= ObjectSpace::WeakMap.new
    @lazy_enrollment_records[record] = record
  end
end

#before_commit_records ⇒ Object 



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/transaction.rb', line 204

def before_commit_records
  return unless records

  if @run_commit_callbacks
    if ActiveRecord.before_committed_on_all_records
      ite = unique_records

      instances_to_run_callbacks_on = records.each_with_object({}) do |record, candidates|
        candidates[record] = record
      end

      run_action_on_records(ite, instances_to_run_callbacks_on) do |record, should_run_callbacks|
        record.before_committed! if should_run_callbacks
      end
    else
      records.uniq.each(&:before_committed!)
    end
  end
end

#closed? ⇒ Boolean

Returns:

  • (Boolean) 


247
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/transaction.rb', line 247

def closed?; false; end

#commit_records ⇒ Object 



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/transaction.rb', line 224

def commit_records
  return unless records

  ite = unique_records

  if @run_commit_callbacks
    instances_to_run_callbacks_on = prepare_instances_to_run_callbacks_on(ite)

    run_action_on_records(ite, instances_to_run_callbacks_on) do |record, should_run_callbacks|
      record.committed!(should_run_callbacks: should_run_callbacks)
    end
  else
    while record = ite.shift
      # if not running callbacks, only adds the record to the parent transaction
      connection.add_transaction_record(record)
    end
  end
ensure
  ite&.each { |i| i.committed!(should_run_callbacks: false) }
end

#dirty! ⇒ Object 



136
137
138
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/transaction.rb', line 136

def dirty!
  @dirty = true
end

#dirty? ⇒ Boolean

Returns:

  • (Boolean) 


140
141
142
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/transaction.rb', line 140

def dirty?
  @dirty
end

#full_rollback? ⇒ Boolean

Returns:

  • (Boolean) 


245
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/transaction.rb', line 245

def full_rollback?; true; end

#incomplete! ⇒ Object 



168
169
170
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/transaction.rb', line 168

def incomplete!
  @instrumenter.finish(:incomplete)
end

#joinable? ⇒ Boolean

Returns:

  • (Boolean) 


246
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/transaction.rb', line 246

def joinable?; @joinable; end

#materialize! ⇒ Object 



172
173
174
175
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/transaction.rb', line 172

def materialize!
  @materialized = true
  @instrumenter.start
end

#materialized? ⇒ Boolean

Returns:

  • (Boolean) 


177
178
179
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/transaction.rb', line 177

def materialized?
  @materialized
end

#open? ⇒ Boolean

Returns:

  • (Boolean) 


248
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/transaction.rb', line 248

def open?; !closed?; end

#records ⇒ Object 



154
155
156
157
158
159
160
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/transaction.rb', line 154

def records
  if @lazy_enrollment_records
    @records.concat @lazy_enrollment_records.values
    @lazy_enrollment_records = nil
  end
  @records
end

#restartable? ⇒ Boolean

Can this transaction’s current state be recreated by rollback+begin ?

Returns:

  • (Boolean) 


164
165
166
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/transaction.rb', line 164

def restartable?
  joinable? && !dirty?
end

#restore! ⇒ Object 



181
182
183
184
185
186
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/transaction.rb', line 181

def restore!
  if materialized?
    @materialized = false
    materialize!
  end
end

#rollback_records ⇒ Object 



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/transaction.rb', line 188

def rollback_records
  return unless records

  ite = unique_records

  instances_to_run_callbacks_on = prepare_instances_to_run_callbacks_on(ite)

  run_action_on_records(ite, instances_to_run_callbacks_on) do |record, should_run_callbacks|
    record.rolledback!(force_restore_state: full_rollback?, should_run_callbacks: should_run_callbacks)
  end
ensure
  ite&.each do |i|
    i.rolledback!(force_restore_state: full_rollback?, should_run_callbacks: false)
  end
end