Class: SolidObjects::DatabaseAdapters::Sqlite

Inherits:
SolidObjects::DatabaseAdapter show all
Defined in:
lib/solid_objects/database_adapters/sqlite.rb,
sig/generated/lib/solid_objects/database_adapters/sqlite.rbs

Constant Summary collapse

LOCK_RETRY_INTERVAL =

Returns:

  • (::Float) 
0.001
LOCK_RETRY_MUTEX =

Returns:

  • (Object) 
Thread::Mutex.new
LOCK_RETRY_CONDITION =

Returns:

  • (Object) 
Thread::ConditionVariable.new

Instance Attribute Summary

Attributes inherited from SolidObjects::DatabaseAdapter

#connection_pool, #fixed_connection

Instance Method Summary collapse

Methods inherited from SolidObjects::DatabaseAdapter

#claim_lock, #configure_transaction_deadline, #database_now, for, #initialize, #lock_candidates, #supports_skip_locked?, #with_connection

Constructor Details

This class inherits a constructor from SolidObjects::DatabaseAdapter

Instance Method Details

#configured_busy_handler_timeout(connection) ⇒ Integer?

RBS:

  • (untyped) -> Integer?

Parameters:

  • (Object)

Returns:

  • (Integer, nil) 


104
105
106
107
108
109
110
111
112
113
 
# File 'lib/solid_objects/database_adapters/sqlite.rb', line 104

def configured_busy_handler_timeout(connection)
  return nil unless connection.respond_to?(:raw_connection)
  return nil unless connection.raw_connection.respond_to?(:busy_handler_timeout=)

  pool = connection.respond_to?(:pool) ? connection.pool : nil
  return nil unless pool.respond_to?(:db_config)

  timeout = pool.db_config.configuration_hash[:timeout]
  timeout&.to_i
end

#current_time_expression ⇒ String

RBS:

  • () -> String

Returns:

  • (String) 


11
12
13
 
# File 'lib/solid_objects/database_adapters/sqlite.rb', line 11

def current_time_expression
  "STRFTIME('%Y-%m-%d %H:%M:%f', 'NOW')"
end

#deadline_error?(error) ⇒ Boolean

RBS:

  • (Exception) -> bool

Parameters:

  • (Exception)

Returns:

  • (Boolean) 


116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/solid_objects/database_adapters/sqlite.rb', line 116

def deadline_error?(error)
  return false unless SyncDeadline.active?

  cause = error
  while cause
    return true if cause.class.name.match?(/BusyException|BusyError/)

    cause = cause.cause
  end
  false
end

#restorable_busy_wait(connection) ⇒ Hash[Symbol, untyped]?

RBS:

  • (untyped) -> Hash[Symbol, untyped]?

Parameters:

  • (Object)

Returns:

  • (Hash[Symbol, untyped], nil) 


82
83
84
85
86
87
88
89
90
 
# File 'lib/solid_objects/database_adapters/sqlite.rb', line 82

def restorable_busy_wait(connection)
  pragma_timeout = connection.select_value("PRAGMA busy_timeout").to_i
  return { pragma_timeout: } if pragma_timeout.positive?

  handler_timeout = configured_busy_handler_timeout(connection)
  return nil unless handler_timeout

  { pragma_timeout:, handler_timeout: }
end

#restore_busy_wait(connection, busy_wait) ⇒ void

This method returns an undefined value.

RBS:

  • (untyped, Hash[Symbol, untyped]) -> void

Parameters:

  • (Object)
  • (Hash[Symbol, untyped]) 


93
94
95
96
97
98
99
100
101
 
# File 'lib/solid_objects/database_adapters/sqlite.rb', line 93

def restore_busy_wait(connection, busy_wait)
  handler_timeout = busy_wait[:handler_timeout]
  if handler_timeout
    connection.raw_connection.busy_handler_timeout = handler_timeout
    return
  end

  connection.execute("PRAGMA busy_timeout = #{busy_wait.fetch(:pragma_timeout)}")
end

#transaction { ... } ⇒ Object

RBS:

  • () { () -> untyped } -> untyped

Yields:

Yield Returns:

  • (Object)

Returns:

  • (Object) 


16
17
18
19
20
 
# File 'lib/solid_objects/database_adapters/sqlite.rb', line 16

def transaction(&block)
  return super unless SyncDeadline.active?

  with_lock_retry { super }
end

#wait_before_retry ⇒ void

This method returns an undefined value.

RBS:

  • () -> void



129
130
131
132
133
134
135
136
 
# File 'lib/solid_objects/database_adapters/sqlite.rb', line 129

def wait_before_retry
  LOCK_RETRY_MUTEX.synchronize do
    LOCK_RETRY_CONDITION.wait(
      LOCK_RETRY_MUTEX,
      [ LOCK_RETRY_INTERVAL, SyncDeadline.remaining ].min
    )
  end
end

#with_lock_probe { ... } ⇒ Object

RBS:

  • () { () -> untyped } -> untyped

Yields:

Yield Returns:

  • (Object)

Returns:

  • (Object) 


50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/solid_objects/database_adapters/sqlite.rb', line 50

def with_lock_probe
  return yield unless SyncDeadline.active?

  with_connection do |connection|
    with_transaction_deadline(connection) { yield }
  end
rescue => error
  raise unless deadline_error?(error)

  raise DatabaseDeadlineExceeded,
    "database remained locked at the synchronous invocation deadline",
    cause: error
end

#with_lock_retry { ... } ⇒ Object

RBS:

  • () { () -> untyped } -> untyped

Yields:

Yield Returns:

  • (Object)

Returns:

  • (Object) 


23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/solid_objects/database_adapters/sqlite.rb', line 23

def with_lock_retry
  return yield unless SyncDeadline.active?

  raise DatabaseDeadlineExceeded, "synchronous invocation deadline expired" if SyncDeadline.expired?

  with_connection do |connection|
    with_transaction_deadline(connection) { yield }
  end
rescue DatabaseDeadlineExceeded
  raise if SyncDeadline.expired?

  wait_before_retry
  retry
rescue => error
  raise unless deadline_error?(error)

  if SyncDeadline.expired?
    raise DatabaseDeadlineExceeded,
      "database lock wait exceeded the synchronous invocation deadline",
      cause: error
  end

  wait_before_retry
  retry
end

#with_transaction_deadline(connection) { ... } ⇒ Object

RBS:

  • (untyped) { () -> untyped } -> untyped

Parameters:

  • (Object)

Yields:

Yield Returns:

  • (Object)

Returns:

  • (Object) 


67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/solid_objects/database_adapters/sqlite.rb', line 67

def with_transaction_deadline(connection)
  return yield unless SyncDeadline.active?

  busy_wait = restorable_busy_wait(connection)
  return yield unless busy_wait

  begin
    connection.execute("PRAGMA busy_timeout = 0")
    yield
  ensure
    restore_busy_wait(connection, busy_wait)
  end
end