instance method `with_lock`

Ruby on Rails 8.1.2

Since v3.2.22.5

Available in: v3.2.22.5 v4.0.13 v4.1.16 v4.2.9 v5.2.8.1 v6.0.6 v6.1.7.10 v7.0.10 v7.1.6 v7.2.3 v8.0.4 v8.1.2

Compare with:

with_lock(*args)

Wraps the passed block in a transaction, reloading the object with a lock before yielding. You can pass the SQL locking clause as an optional argument (see #lock!).

You can also pass options like requires_new:, isolation:, and joinable: to the wrapping transaction (see ActiveRecord::ConnectionAdapters::DatabaseStatements#transaction).

Parameters

args rest

Source

# File activerecord/lib/active_record/locking/pessimistic.rb, line 97
      def with_lock(*args)
        transaction_opts = args.extract_options!
        lock = args.present? ? args.first : true
        transaction(**transaction_opts) do
          lock!(lock)
          yield
        end
      end

Defined in activerecord/lib/active_record/locking/pessimistic.rb line 97 · View on GitHub · Improve this page · Find usages on GitHub

Defined in ActiveRecord::Locking::Pessimistic

Signature

Parameters