Class: OCI8EnhancedAutoRecover

Inherits:
OCI8
  • Object
show all
Defined in:
lib/active_record/connection_adapters/oracle_enhanced_oci_connection.rb

Overview

The OCI8AutoRecover class enhances the OCI8 driver with auto-recover and reset functionality. If a call to #exec fails, and autocommit is turned on (ie., we’re not in the middle of a longer transaction), it will automatically reconnect and try again. If autocommit is turned off, this would be dangerous (as the earlier part of the implied transaction may have failed silently if the connection died) – so instead the connection is marked as dead, to be reconnected on it’s next use. :stopdoc:

Constant Summary collapse

LOST_CONNECTION_ERROR_CODES =

ORA-00028: your session has been killed ORA-01012: not logged on ORA-03113: end-of-file on communication channel ORA-03114: not connected to ORACLE ORA-03135: connection lost contact

[ 28, 1012, 3113, 3114, 3135 ]
@@auto_retry = 
false

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config, factory) ⇒ OCI8EnhancedAutoRecover

:nodoc:



303
304
305
306
307
308
309
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_oci_connection.rb', line 303

def initialize(config, factory) #:nodoc:
  @active = true
  @config = config
  @factory = factory
  @connection  = @factory.new_connection @config
  super @connection
end

Instance Attribute Details

#active ⇒ Object Also known as: active?

:nodoc:



294
295
296
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_oci_connection.rb', line 294

def active
  @active
end

Instance Method Details

#describe(name) ⇒ Object

:nodoc:



362
363
364
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_oci_connection.rb', line 362

def describe(name) #:nodoc:
  @connection.describe(name)
end

#exec(sql, *bindvars, &block) ⇒ Object

Adds auto-recovery functionality.

See: www.jiubao.org/ruby-oci8/api.en.html#label-11



345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_oci_connection.rb', line 345

def exec(sql, *bindvars, &block) #:nodoc:
  should_retry = self.class.auto_retry? && autocommit?

  begin
    @connection.exec(sql, *bindvars, &block)
  rescue OCIException => e
    raise unless LOST_CONNECTION_ERROR_CODES.include?(e.code)
    @active = false
    raise unless should_retry
    should_retry = false
    reset! rescue nil
    retry
  end
end

#ping ⇒ Object

Checks connection, returns true if active. Note that ping actively checks the connection, while #active? simply returns the last known state.



314
315
316
317
318
319
320
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_oci_connection.rb', line 314

def ping #:nodoc:
  @connection.exec("select 1 from dual") { |r| nil }
  @active = true
rescue
  @active = false
  raise
end

#reset! ⇒ Object

Resets connection, by logging off and creating a new connection.



323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_oci_connection.rb', line 323

def reset! #:nodoc:
  logoff rescue nil
  begin
    @connection = @factory.new_connection @config
    __setobj__ @connection
    @active = true
  rescue
    @active = false
    raise
  end
end