activerecord-oracle_enhanced-adapter 5.2.8 → 7.0.3

data/lib/active_record/connection_adapters/oracle_enhanced/database_tasks.rb

@@ -17,21 +17,20 @@ module ActiveRecord
             print "Please provide the SYSTEM password for your Oracle installation (set ORACLE_SYSTEM_PASSWORD to avoid this prompt)\n>"
             $stdin.gets.strip
           }
-          establish_connection(@config.merge("username" => "SYSTEM", "password" => system_password))
+          establish_connection(@config.merge(username: "SYSTEM", password: system_password))
           begin
-            connection.execute "CREATE USER #{@config['username']} IDENTIFIED BY #{@config['password']}"
+            connection.execute "CREATE USER #{@config[:username]} IDENTIFIED BY #{@config[:password]}"
           rescue => e
-            if e.message =~ /ORA-01920/ # user name conflicts with another user or role name
-              connection.execute "ALTER USER #{@config['username']} IDENTIFIED BY #{@config['password']}"
+            if /ORA-01920/.match?(e.message) # user name conflicts with another user or role name
+              connection.execute "ALTER USER #{@config[:username]} IDENTIFIED BY #{@config[:password]}"
             else
               raise e
             end
           end
-          connection.execute "GRANT unlimited tablespace TO #{@config['username']}"
-          connection.execute "GRANT create session TO #{@config['username']}"
-          connection.execute "GRANT create table TO #{@config['username']}"
-          connection.execute "GRANT create view TO #{@config['username']}"
-          connection.execute "GRANT create sequence TO #{@config['username']}"
+
+          OracleEnhancedAdapter.permissions.each do |permission|
+            connection.execute "GRANT #{permission} TO #{@config[:username]}"
+          end
         end
 
         def drop
@@ -47,7 +46,7 @@ module ActiveRecord
         def structure_dump(filename, extra_flags)
           establish_connection(@config)
           File.open(filename, "w:utf-8") { |f| f << connection.structure_dump }
-          if @config["structure_dump"] == "db_stored_code"
+          if @config[:structure_dump] == "db_stored_code"
             File.open(filename, "a") { |f| f << connection.structure_dump_db_stored_code }
           end
         end

data/lib/active_record/connection_adapters/oracle_enhanced/dbms_output.rb

@@ -31,8 +31,7 @@ module ActiveRecord
         end
 
       private
-
-        def log(sql, name = "SQL", binds = [], type_casted_binds = [], statement_name = nil)
+        def log(sql, name = "SQL", binds = [], type_casted_binds = [], statement_name = nil, async: false)
           super
         ensure
           log_dbms_output if dbms_output_enabled?

data/lib/active_record/connection_adapters/oracle_enhanced/jdbc_connection.rb

@@ -16,9 +16,10 @@ begin
   # Oracle 11g client ojdbc6.jar is also compatible with Java 1.7
   # Oracle 12c Release 1 client provides ojdbc7.jar
   # Oracle 12c Release 2 client provides ojdbc8.jar
-  ojdbc_jars = %w(ojdbc8.jar ojdbc7.jar ojdbc6.jar)
+  # Oracle 21c provides ojdbc11.jar for Java 11 and above
+  ojdbc_jars = %w(ojdbc11.jar ojdbc8.jar ojdbc7.jar ojdbc6.jar)
 
-  if ENV_JAVA["java.class.path"] !~ Regexp.new(ojdbc_jars.join("|"))
+  if !ENV_JAVA["java.class.path"]&.match?(Regexp.new(ojdbc_jars.join("|")))
     # On Unix environment variable should be PATH, on Windows it is sometimes Path
     env_path = (ENV["PATH"] || ENV["Path"] || "").split(File::PATH_SEPARATOR)
     # Look for JDBC driver at first in lib subdirectory (application specific JDBC file version)
@@ -26,7 +27,7 @@ begin
     ["./lib"].concat($LOAD_PATH).concat(env_path).detect do |dir|
       # check any compatible JDBC driver in the priority order
       ojdbc_jars.any? do |ojdbc_jar|
-        if File.exists?(file_path = File.join(dir, ojdbc_jar))
+        if File.exist?(file_path = File.join(dir, ojdbc_jar))
           require file_path
           true
         end
@@ -42,16 +43,16 @@ begin
     java.lang.System.set_property("oracle.net.tns_admin", ENV["TNS_ADMIN"])
   end
 
-rescue LoadError, NameError
+rescue LoadError, NameError => e
   # JDBC driver is unavailable.
-  raise LoadError, "ERROR: ActiveRecord oracle_enhanced adapter could not load Oracle JDBC driver. Please install #{ojdbc_jars.join(' or ') } library."
+  raise LoadError, "ERROR: ActiveRecord oracle_enhanced adapter could not load Oracle JDBC driver. Please install #{ojdbc_jars.join(' or ') } library.\n#{e.class}:#{e.message}"
 end
 
 module ActiveRecord
   module ConnectionAdapters
     # JDBC database interface for JRuby
     module OracleEnhanced
-      class JDBCConnection < OracleEnhanced::Connection #:nodoc:
+      class JDBCConnection < OracleEnhanced::Connection # :nodoc:
         attr_accessor :active
         alias :active? :active
 
@@ -98,6 +99,8 @@ module ActiveRecord
               @raw_connection = @raw_connection.underlying_connection
             end
 
+            # Workaround FrozenError (can't modify frozen Hash):
+            config = config.dup
             config[:driver] ||= @raw_connection.meta_data.connection.java_class.name
             username = @raw_connection.meta_data.user_name
           else
@@ -113,11 +116,11 @@ module ActiveRecord
             if database && (using_tns_alias || host == "connection-string")
               url = "jdbc:oracle:thin:@#{database}"
             else
-              unless database.match(/^(\:|\/)/)
+              unless database.match?(/^(:|\/)/)
                 # assume database is a SID if no colon or slash are supplied (backward-compatibility)
-                database = ":#{database}"
+                database = "/#{database}"
               end
-              url = config[:url] || "jdbc:oracle:thin:@#{host || 'localhost'}:#{port || 1521}#{database}"
+              url = config[:url] || "jdbc:oracle:thin:@//#{host || 'localhost'}:#{port || 1521}#{database}"
             end
 
             prefetch_rows = config[:prefetch_rows] || 100
@@ -125,6 +128,8 @@ module ActiveRecord
             time_zone = config[:time_zone] || ENV["TZ"] || java.util.TimeZone.default.getID
 
             properties = java.util.Properties.new
+            raise "username not set" unless username
+            raise "password not set" unless password
             properties.put("user", username)
             properties.put("password", password)
             properties.put("defaultRowPrefetch", "#{prefetch_rows}") if prefetch_rows
@@ -140,12 +145,18 @@ module ActiveRecord
             end
 
             # Set session time zone to current time zone
-            if ActiveRecord::Base.default_timezone == :local
+            if ActiveRecord.default_timezone == :local
               @raw_connection.setSessionTimeZone(time_zone)
-            elsif ActiveRecord::Base.default_timezone == :utc
+            elsif ActiveRecord.default_timezone == :utc
               @raw_connection.setSessionTimeZone("UTC")
             end
 
+            if config[:jdbc_statement_cache_size]
+              raise "Integer value expected for :jdbc_statement_cache_size" unless config[:jdbc_statement_cache_size].instance_of? Integer
+              @raw_connection.setImplicitCachingEnabled(true)
+              @raw_connection.setStatementCacheSize(config[:jdbc_statement_cache_size])
+            end
+
             # Set default number of rows to prefetch
             # @raw_connection.setDefaultRowPrefetch(prefetch_rows) if prefetch_rows
           end
@@ -161,6 +172,10 @@ module ActiveRecord
             end
           end
 
+          OracleEnhancedAdapter::FIXED_NLS_PARAMETERS.each do |key, value|
+            exec "alter session set #{key} = '#{value}'"
+          end
+
           self.autocommit = true
 
           schema = config[:schema] && config[:schema].to_s
@@ -232,7 +247,7 @@ module ActiveRecord
           begin
             yield if block_given?
           rescue Java::JavaSql::SQLException => e
-            raise unless e.message =~ /^(Closed Connection|Io exception:|No more data to read from socket|IO Error:)/
+            raise unless /^(Closed Connection|Io exception:|No more data to read from socket|IO Error:)/.match?(e.message)
             @active = false
             raise unless should_retry
             should_retry = false
@@ -312,6 +327,8 @@ module ActiveRecord
               @raw_statement.setClob(position, value)
             when Type::OracleEnhanced::Raw
               @raw_statement.setString(position, OracleEnhanced::Quoting.encode_raw(value))
+            when Type::OracleEnhanced::CharacterString::Data
+              @raw_statement.setFixedCHAR(position, value.to_s)
             when String
               @raw_statement.setString(position, value)
             when Java::OracleSql::DATE
@@ -470,19 +487,24 @@ module ActiveRecord
             end
           when :BINARY_FLOAT
             rset.getFloat(i)
-          when :VARCHAR2, :CHAR, :LONG, :NVARCHAR2, :NCHAR
+          when :VARCHAR2, :LONG, :NVARCHAR2
             rset.getString(i)
+          when :CHAR, :NCHAR
+            char_str = rset.getString(i)
+            if !char_str.nil?
+              char_str.rstrip
+            end
           when :DATE
             if dt = rset.getDATE(i)
               d = dt.dateValue
               t = dt.timeValue
-              Time.send(Base.default_timezone, d.year + 1900, d.month + 1, d.date, t.hours, t.minutes, t.seconds)
+              Time.send(ActiveRecord.default_timezone, d.year + 1900, d.month + 1, d.date, t.hours, t.minutes, t.seconds)
             else
               nil
             end
           when :TIMESTAMP, :TIMESTAMPTZ, :TIMESTAMPLTZ, :"TIMESTAMP WITH TIME ZONE", :"TIMESTAMP WITH LOCAL TIME ZONE"
             ts = rset.getTimestamp(i)
-            ts && Time.send(Base.default_timezone, ts.year + 1900, ts.month + 1, ts.date, ts.hours, ts.minutes, ts.seconds,
+            ts && Time.send(ActiveRecord.default_timezone, ts.year + 1900, ts.month + 1, ts.date, ts.hours, ts.minutes, ts.seconds,
               ts.nanos / 1000)
           when :CLOB
             get_lob_value ? lob_to_ruby_value(rset.getClob(i)) : rset.getClob(i)
@@ -499,7 +521,6 @@ module ActiveRecord
         end
 
       private
-
         def lob_to_ruby_value(val)
           case val
           when ::Java::OracleSql::CLOB

data/lib/active_record/connection_adapters/oracle_enhanced/jdbc_quoting.rb

@@ -4,7 +4,7 @@ module ActiveRecord
   module ConnectionAdapters
     module OracleEnhanced
       module JDBCQuoting
-        def _type_cast(value)
+        def type_cast(value)
           case value
           when ActiveModel::Type::Binary::Data
             blob = Java::OracleSql::BLOB.createTemporary(@connection.raw_connection, false, Java::OracleSql::BLOB::DURATION_SESSION)

data/lib/active_record/connection_adapters/oracle_enhanced/lob.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-module ActiveRecord #:nodoc:
-  module ConnectionAdapters #:nodoc:
-    module OracleEnhanced #:nodoc:
-      module Lob #:nodoc:
+module ActiveRecord # :nodoc:
+  module ConnectionAdapters # :nodoc:
+    module OracleEnhanced # :nodoc:
+      module Lob # :nodoc:
         extend ActiveSupport::Concern
 
         included do
@@ -18,13 +18,12 @@ module ActiveRecord #:nodoc:
         module ClassMethods
           def lob_columns
             columns.select do |column|
-              column.sql_type_metadata.sql_type =~ /LOB$/
+              column.sql_type_metadata.sql_type.end_with?("LOB")
             end
           end
         end
 
         private
-
           def enhanced_write_lobs
             if self.class.connection.is_a?(ConnectionAdapters::OracleEnhancedAdapter) &&
                 !(self.class.custom_create_method || self.class.custom_update_method)

data/lib/active_record/connection_adapters/oracle_enhanced/oci_connection.rb

@@ -15,7 +15,7 @@ end
 required_oci8_version = [2, 2, 4]
 oci8_version_ints = OCI8::VERSION.scan(/\d+/).map { |s| s.to_i }
 if (oci8_version_ints <=> required_oci8_version) < 0
-  $stderr.puts <<-EOS.strip_heredoc
+  $stderr.puts <<~EOS
     "ERROR: ruby-oci8 version #{OCI8::VERSION} is too old. Please install ruby-oci8 version #{required_oci8_version.join('.')} or later."
   EOS
 
@@ -26,7 +26,7 @@ module ActiveRecord
   module ConnectionAdapters
     # OCI database interface for MRI
     module OracleEnhanced
-      class OCIConnection < OracleEnhanced::Connection #:nodoc:
+      class OCIConnection < OracleEnhanced::Connection # :nodoc:
         def initialize(config)
           @raw_connection = OCI8EnhancedAutoRecover.new(config, OracleEnhancedOCIFactory)
           # default schema owner
@@ -97,6 +97,10 @@ module ActiveRecord
           @raw_connection.exec(sql, *bindvars, &block)
         end
 
+        def with_retry(&block)
+          @raw_connection.with_retry(&block)
+        end
+
         def prepare(sql)
           Cursor.new(self, @raw_connection.parse(sql))
         end
@@ -125,6 +129,8 @@ module ActiveRecord
               @raw_cursor.bind_param(position, OracleEnhanced::Quoting.encode_raw(value))
             when ActiveModel::Type::Decimal
               @raw_cursor.bind_param(position, BigDecimal(value.to_s))
+            when Type::OracleEnhanced::CharacterString::Data
+              @raw_cursor.bind_param(position, value.to_character_str)
             when NilClass
               @raw_cursor.bind_param(position, nil, String)
             else
@@ -151,8 +157,19 @@ module ActiveRecord
           def fetch(options = {})
             if row = @raw_cursor.fetch
               get_lob_value = options[:get_lob_value]
+              col_index = 0
               row.map do |col|
-                @connection.typecast_result_value(col, get_lob_value)
+                col_value = @connection.typecast_result_value(col, get_lob_value)
+                col_metadata = @raw_cursor.column_metadata.fetch(col_index)
+                if !col_metadata.nil?
+                  key = col_metadata.data_type
+                  case key.to_s.downcase
+                  when "char"
+                    col_value = col.to_s.rstrip
+                  end
+                end
+                col_index = col_index + 1
+                col_value
               end
             end
           end
@@ -184,7 +201,16 @@ module ActiveRecord
             hash = column_hash.dup
 
             cols.each_with_index do |col, i|
-              hash[col] = typecast_result_value(row[i], get_lob_value)
+              col_value = typecast_result_value(row[i], get_lob_value)
+              col_metadata = cursor.column_metadata.fetch(i)
+              if !col_metadata.nil?
+                key = col_metadata.data_type
+                case key.to_s.downcase
+                when "char"
+                  col_value = col_value.to_s.rstrip
+                end
+              end
+              hash[col] = col_value
             end
 
             rows << hash
@@ -200,17 +226,7 @@ module ActiveRecord
         end
 
         def describe(name)
-          # fall back to SELECT based describe if using database link
-          return super if name.to_s.include?("@")
-          quoted_name = OracleEnhanced::Quoting.valid_table_name?(name) ? name : "\"#{name}\""
-          @raw_connection.describe(quoted_name)
-        rescue OCIException => e
-          if e.code == 4043
-            raise OracleEnhanced::ConnectionException, %Q{"DESC #{name}" failed; does it exist?}
-          else
-            # fall back to SELECT which can handle synonyms to database links
-            super
-          end
+          super
         end
 
         # Return OCIError error code
@@ -253,7 +269,6 @@ module ActiveRecord
         end
 
       private
-
         def date_without_time?(value)
           case value
           when OraDate
@@ -274,9 +289,9 @@ module ActiveRecord
           end
           # code from Time.time_with_datetime_fallback
           begin
-            Time.send(Base.default_timezone, year, month, day, hour, min, sec, usec)
+            Time.send(ActiveRecord.default_timezone, year, month, day, hour, min, sec, usec)
           rescue
-            offset = Base.default_timezone.to_sym == :local ? ::DateTime.local_offset : 0
+            offset = ActiveRecord.default_timezone.to_sym == :local ? ::DateTime.local_offset : 0
             ::DateTime.civil(year, month, day, hour, min, sec, offset)
           end
         end
@@ -284,7 +299,7 @@ module ActiveRecord
 
       # The OracleEnhancedOCIFactory factors out the code necessary to connect and
       # configure an Oracle/OCI connection.
-      class OracleEnhancedOCIFactory #:nodoc:
+      class OracleEnhancedOCIFactory # :nodoc:
         DEFAULT_TCP_KEEPALIVE_TIME = 600
 
         def self.new_connection(config)
@@ -307,9 +322,9 @@ module ActiveRecord
           # connection using host, port and database name
           elsif host || port
             host ||= "localhost"
-            host = "[#{host}]" if host =~ /^[^\[].*:/  # IPv6
+            host = "[#{host}]" if /^[^\[].*:/.match?(host)  # IPv6
             port ||= 1521
-            database = "/#{database}" unless database.match(/^\//)
+            database = "/#{database}" unless database.start_with?("/")
             "//#{host}:#{port}#{database}"
           # if no host is specified then assume that
           # database parameter is TNS alias or TNS connection string
@@ -328,9 +343,9 @@ module ActiveRecord
           conn.non_blocking = true if async
           conn.prefetch_rows = prefetch_rows
           conn.exec "alter session set cursor_sharing = #{cursor_sharing}" rescue nil if cursor_sharing
-          if ActiveRecord::Base.default_timezone == :local
+          if ActiveRecord.default_timezone == :local
             conn.exec "alter session set time_zone = '#{time_zone}'" unless time_zone.blank?
-          elsif ActiveRecord::Base.default_timezone == :utc
+          elsif ActiveRecord.default_timezone == :utc
             conn.exec "alter session set time_zone = '+00:00'"
           end
           conn.exec "alter session set current_schema = #{schema}" unless schema.blank?
@@ -342,6 +357,10 @@ module ActiveRecord
               conn.exec "alter session set #{key} = '#{value}'"
             end
           end
+
+          OracleEnhancedAdapter::FIXED_NLS_PARAMETERS.each do |key, value|
+            conn.exec "alter session set #{key} = '#{value}'"
+          end
           conn
         end
       end
@@ -349,18 +368,6 @@ module ActiveRecord
   end
 end
 
-class OCI8 #:nodoc:
-  def describe(name)
-    info = describe_table(name.to_s)
-    raise %Q{"DESC #{name}" failed} if info.nil?
-    if info.respond_to?(:obj_link) && info.obj_link
-      [info.obj_schema, info.obj_name, "@" + info.obj_link]
-    else
-      [info.obj_schema, info.obj_name]
-    end
-  end
-end
-
 # 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
@@ -368,18 +375,18 @@ end
 # 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:
-class OCI8EnhancedAutoRecover < DelegateClass(OCI8) #:nodoc:
-  attr_accessor :active #:nodoc:
-  alias :active? :active #:nodoc:
+# :stopdoc:
+class OCI8EnhancedAutoRecover < DelegateClass(OCI8) # :nodoc:
+  attr_accessor :active # :nodoc:
+  alias :active? :active # :nodoc:
 
   cattr_accessor :auto_retry
   class << self
-    alias :auto_retry? :auto_retry #:nodoc:
+    alias :auto_retry? :auto_retry # :nodoc:
   end
   @@auto_retry = false
 
-  def initialize(config, factory) #:nodoc:
+  def initialize(config, factory) # :nodoc:
     @active = true
     @config = config
     @factory = factory
@@ -390,7 +397,7 @@ class OCI8EnhancedAutoRecover < DelegateClass(OCI8) #:nodoc:
   # Checks connection, returns true if active. Note that ping actively
   # checks the connection, while #active? simply returns the last
   # known state.
-  def ping #:nodoc:
+  def ping # :nodoc:
     @connection.exec("select 1 from dual") { |r| nil }
     @active = true
   rescue
@@ -399,7 +406,7 @@ class OCI8EnhancedAutoRecover < DelegateClass(OCI8) #:nodoc:
   end
 
   # Resets connection, by logging off and creating a new connection.
-  def reset! #:nodoc:
+  def reset! # :nodoc:
     logoff rescue nil
     begin
       @connection = @factory.new_connection @config
@@ -416,16 +423,14 @@ class OCI8EnhancedAutoRecover < DelegateClass(OCI8) #:nodoc:
   # ORA-03113: end-of-file on communication channel
   # ORA-03114: not connected to ORACLE
   # ORA-03135: connection lost contact
-  LOST_CONNECTION_ERROR_CODES = [ 28, 1012, 3113, 3114, 3135 ] #:nodoc:
+  LOST_CONNECTION_ERROR_CODES = [ 28, 1012, 3113, 3114, 3135 ] # :nodoc:
 
   # Adds auto-recovery functionality.
-  #
-  # See: http://www.jiubao.org/ruby-oci8/api.en.html#label-11
-  def exec(sql, *bindvars, &block) #:nodoc:
+  def with_retry # :nodoc:
     should_retry = self.class.auto_retry? && autocommit?
 
     begin
-      @connection.exec(sql, *bindvars, &block)
+      yield
     rescue OCIException => e
       raise unless e.is_a?(OCIError) && LOST_CONNECTION_ERROR_CODES.include?(e.code)
       @active = false
@@ -435,5 +440,9 @@ class OCI8EnhancedAutoRecover < DelegateClass(OCI8) #:nodoc:
       retry
     end
   end
+
+  def exec(sql, *bindvars, &block) # :nodoc:
+    with_retry { @connection.exec(sql, *bindvars, &block) }
+  end
 end
-#:startdoc:
+# :startdoc:

data/lib/active_record/connection_adapters/oracle_enhanced/oci_quoting.rb

@@ -4,7 +4,7 @@ module ActiveRecord
   module ConnectionAdapters
     module OracleEnhanced
       module OCIQuoting
-        def _type_cast(value)
+        def type_cast(value)
           case value
           when ActiveModel::Type::Binary::Data
             lob_value = value == "" ? " " : value

data/lib/active_record/connection_adapters/oracle_enhanced/procedures.rb

@@ -2,7 +2,7 @@
 
 require "active_support"
 
-module ActiveRecord #:nodoc:
+module ActiveRecord # :nodoc:
   # Custom create, update, delete methods functionality.
   #
   # Example:
@@ -33,7 +33,7 @@ module ActiveRecord #:nodoc:
   #     end
   #   end
   #
-  module OracleEnhancedProcedures #:nodoc:
+  module OracleEnhancedProcedures # :nodoc:
     module ClassMethods
       # Specify custom create method which should be used instead of Rails generated INSERT statement.
       # Provided block should return ID of new record.
@@ -83,7 +83,7 @@ module ActiveRecord #:nodoc:
       end
     end
 
-    def destroy #:nodoc:
+    def destroy # :nodoc:
       # check if class has custom delete method
       if self.class.custom_delete_method
         # wrap destroy in transaction
@@ -97,7 +97,6 @@ module ActiveRecord #:nodoc:
     end
 
     private
-
       # Creates a record with custom create method
       # and returns its id.
       def _create_record
@@ -151,7 +150,7 @@ module ActiveRecord #:nodoc:
               end
             end
             # update just dirty attributes
-            if partial_writes?
+            if partial_updates?
               # Serialized attributes should always be written in case they've been
               # changed in place.
               update_using_custom_method(changed | (attributes.keys & self.class.columns.select { |column| column.is_a?(Type::Serialized) }))
@@ -186,8 +185,8 @@ module ActiveRecord #:nodoc:
         freeze
       end
 
-      def log_custom_method(*args)
-        self.class.connection.send(:log, *args) { yield }
+      def log_custom_method(*args, &block)
+        self.class.connection.send(:log, *args, &block)
       end
 
       alias_method :update_record, :_update_record if private_method_defined?(:_update_record)