Class: WithAdvisoryLock::PostgreSQL

Inherits:
Base
  • Object
show all
Defined in:
lib/with_advisory_lock/postgresql.rb

Instance Attribute Summary

Attributes inherited from Base

#connection, #lock_name, #shared, #timeout_seconds, #transaction

Instance Method Summary collapse

Methods inherited from Base

#already_locked?, #initialize, lock_stack, #lock_stack_item, #lock_str, #stable_hashcode, #unique_column_name, #with_advisory_lock_if_needed, #yield_with_lock, #yield_with_lock_and_timeout

Constructor Details

This class inherits a constructor from WithAdvisoryLock::Base

Instance Method Details

#execute_successful?(pg_function) ⇒ Boolean

Returns:

  • (Boolean) 


23
24
25
26
27
28
29
 
# File 'lib/with_advisory_lock/postgresql.rb', line 23

def execute_successful?(pg_function)
  comment = lock_name.gsub(/(\/\*)|(\*\/)/, '--')
  sql = "SELECT #{pg_function}(#{lock_keys.join(',')}) AS #{unique_column_name} /* #{comment} */"
  result = connection.select_value(sql)
  # MRI returns 't', jruby returns true. YAY!
  (result == 't' || result == true)
end

#lock_keys ⇒ Object

PostgreSQL wants 2 32bit integers as the lock key.



32
33
34
35
36
37
38
39
 
# File 'lib/with_advisory_lock/postgresql.rb', line 32

def lock_keys
  @lock_keys ||= begin
    [stable_hashcode(lock_name), ENV['WITH_ADVISORY_LOCK_PREFIX']].map do |ea|
      # pg advisory args must be 31 bit ints
      ea.to_i & 0x7fffffff
    end
  end
end

#release_lock ⇒ Object 



9
10
11
12
13
14
15
16
17
18
19
20
21
 
# File 'lib/with_advisory_lock/postgresql.rb', line 9

def release_lock
  return if transaction
  pg_function = "pg_advisory_unlock#{shared ? '_shared' : ''}"
  execute_successful?(pg_function)
rescue ActiveRecord::StatementInvalid => e
  raise unless e.message =~ / ERROR: +current transaction is aborted,/
  begin
    connection.rollback_db_transaction
    execute_successful?(pg_function)
  ensure
    connection.begin_db_transaction
  end
end

#try_lock ⇒ Object

See www.postgresql.org/docs/9.1/static/functions-admin.html#FUNCTIONS-ADVISORY-LOCKS



4
5
6
7
 
# File 'lib/with_advisory_lock/postgresql.rb', line 4

def try_lock
  pg_function = "pg_try_advisory#{transaction ? '_xact' : ''}_lock#{shared ? '_shared' : ''}"
  execute_successful?(pg_function)
end