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

Methods inherited from OCI8

#describe

Constructor Details

#initialize(config, factory) ⇒ OCI8EnhancedAutoRecover

:nodoc:



389
390
391
392
393
394
395
# File 'lib/active_record/connection_adapters/oracle_enhanced/oci_connection.rb', line 389

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

Instance Attribute Details

#activeObject Also known as: active?

:nodoc:



380
381
382
# File 'lib/active_record/connection_adapters/oracle_enhanced/oci_connection.rb', line 380

def active
  @active
end

Instance Method Details

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

Adds auto-recovery functionality.

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



431
432
433
434
435
436
437
438
439
440
441
442
443
444
# File 'lib/active_record/connection_adapters/oracle_enhanced/oci_connection.rb', line 431

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

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

#pingObject

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



400
401
402
403
404
405
406
# File 'lib/active_record/connection_adapters/oracle_enhanced/oci_connection.rb', line 400

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.



409
410
411
412
413
414
415
416
417
418
419
# File 'lib/active_record/connection_adapters/oracle_enhanced/oci_connection.rb', line 409

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