sequel 3.21.0 → 3.41.0

data/lib/sequel/adapters/oracle.rb

@@ -13,6 +13,21 @@ module Sequel
       # ORA-03114: not connected to ORACLE
       CONNECTION_ERROR_CODES = [ 28, 1012, 3113, 3114 ]      
       
+      ORACLE_TYPES = {
+        :blob=>lambda{|b| Sequel::SQL::Blob.new(b.read)},
+        :clob=>lambda{|b| b.read}
+      }
+
+      # Hash of conversion procs for this database.
+      attr_reader :conversion_procs
+
+      def initialize(opts={})
+        super
+        @autosequence = opts[:autosequence]
+        @primary_key_sequences = {}
+        @conversion_procs = ORACLE_TYPES.dup
+      end
+
       def connect(server)
         opts = server_opts(server)
         if opts[:database]
@@ -22,115 +37,407 @@ module Sequel
           dbname = opts[:host]
         end
         conn = OCI8.new(opts[:user], opts[:password], dbname, opts[:privilege])
+        conn.prefetch_rows = typecast_value_integer(opts[:prefetch_rows]) if opts[:prefetch_rows]
         conn.autocommit = true
         conn.non_blocking = true
+        
+        # The ruby-oci8 gem which retrieves oracle columns with a type of
+        # DATE, TIMESTAMP, TIMESTAMP WITH TIME ZONE is complex based on the
+        # ruby version (1.9.2 or later) and Oracle version (9 or later)
+        # In the now standard case of 1.9.2 and Oracle 9 or later, the timezone
+        # is determined by the Oracle session timezone. Thus if the user
+        # requests Sequel provide UTC timezone to the application,
+        # we need to alter the session timezone to be UTC
+        if Sequel.application_timezone == :utc
+          conn.exec("ALTER SESSION SET TIME_ZONE='-00:00'")
+        end
+        
+        class << conn
+          attr_reader :prepared_statements
+        end
+        conn.instance_variable_set(:@prepared_statements, {})
+        
         conn
       end
-      
-      def dataset(opts = nil)
-        Oracle::Dataset.new(self, opts)
+
+      def disconnect_connection(c)
+        c.logoff
+      rescue OCIInvalidHandle
+        nil
       end
 
-      def schema_parse_table(table, opts={})
-        ds = dataset
-        ds.identifier_output_method = :downcase
-        schema_and_table = "#{"#{quote_identifier(opts[:schema])}." if opts[:schema]}#{quote_identifier(table)}"
-        table_schema = []
-        metadata = transaction(opts){|conn| conn.describe_table(schema_and_table)}
-        metadata.columns.each do |column|
-          table_schema << [
-            column.name.downcase.to_sym,
-            {
-              :type => column.data_type,
-              :db_type => column.type_string.split(' ')[0],
-              :type_string => column.type_string,
-              :charset_form => column.charset_form,
-              :char_used => column.char_used?,
-              :char_size => column.char_size,
-              :data_size => column.data_size,
-              :precision => column.precision,
-              :scale => column.scale,
-              :fsprecision => column.fsprecision,
-              :lfprecision => column.lfprecision,
-              :allow_null => column.nullable?
-            }
-          ]
-        end
-        table_schema
+      def execute(sql, opts={}, &block)
+        _execute(nil, sql, opts, &block)
       end
+      alias do execute
+
+      def execute_insert(sql, opts={})
+        _execute(:insert, sql, opts)
+      end
+
+      private
 
-      def execute(sql, opts={})
+      def _execute(type, sql, opts={}, &block)
         synchronize(opts[:server]) do |conn|
           begin
-            r = log_yield(sql){conn.exec(sql)}
-            yield(r) if block_given?
-            r
-          rescue OCIException => e
-            raise_error(e, :disconnect=>CONNECTION_ERROR_CODES.include?(e.code))
+            return execute_prepared_statement(conn, type, sql, opts, &block) if sql.is_a?(Symbol)
+            if args = opts[:arguments]
+              r = conn.parse(sql)
+              args = cursor_bind_params(conn, r, args)
+              nr = log_yield(sql, args){r.exec}
+              r = nr unless block_given?
+            else
+              r = log_yield(sql){conn.exec(sql)}
+            end
+            if block_given?
+              begin
+                yield(r)
+              ensure
+                r.close
+              end
+            elsif type == :insert
+              last_insert_id(conn, opts)
+            else
+              r
+            end
+          rescue OCIException, RuntimeError => e
+            # ruby-oci8 is naughty and raises strings in some places
+            raise_error(e)
+          end
+        end
+      end
+
+      PS_TYPES = {'string'.freeze=>String, 'integer'.freeze=>Integer, 'float'.freeze=>Float,
+        'decimal'.freeze=>Float, 'date'.freeze=>Time, 'datetime'.freeze=>Time,
+        'time'.freeze=>Time, 'boolean'.freeze=>String, 'blob'.freeze=>OCI8::BLOB}
+      def cursor_bind_params(conn, cursor, args)
+        cursor
+        i = 0
+        args.map do |arg, type|
+          i += 1
+          case arg
+          when true
+            arg = 'Y'
+          when false
+            arg = 'N'
+          when BigDecimal
+            arg = arg.to_f
+          when ::Sequel::SQL::Blob
+            raise Error, "Sequel's oracle adapter does not currently support using a blob in a bound variable"
+          end
+          if t = PS_TYPES[type]
+            cursor.bind_param(i, arg, t)
+          else
+            cursor.bind_param(i, arg, arg.class)
+          end
+          arg
+        end
+      end
+
+      def connection_execute_method
+        :exec
+      end
+
+      def database_error_classes
+        [OCIException, RuntimeError]
+      end
+
+      def execute_prepared_statement(conn, type, name, opts)
+        ps = prepared_statement(name)
+        sql = ps.prepared_sql
+        if cursora = conn.prepared_statements[name]
+          cursor, cursor_sql = cursora
+          if cursor_sql != sql
+            cursor.close
+            cursor = nil
+          end
+        end
+        unless cursor
+          cursor = log_yield("PREPARE #{name}: #{sql}"){conn.parse(sql)}
+          conn.prepared_statements[name] = [cursor, sql]
+        end
+        args = cursor_bind_params(conn, cursor, opts[:arguments])
+        log_sql = "EXECUTE #{name}"
+        if ps.log_sql
+          log_sql << " ("
+          log_sql << sql
+          log_sql << ")"
+        end
+        r = log_yield(log_sql, args){cursor.exec}
+        if block_given?
+          yield(cursor)
+        elsif type == :insert
+          last_insert_id(conn, opts)
+        else
+          r
+        end
+      end
+
+      def last_insert_id(conn, opts)
+        unless sequence = opts[:sequence]
+          if t = opts[:table]
+            sequence = sequence_for_table(t)
+          end
+        end
+        if sequence
+          sql = "SELECT #{literal(sequence)}.currval FROM dual"
+          begin
+            cursor = log_yield(sql){conn.exec(sql)}
+            row = cursor.fetch
+            row.each{|v| return (v.to_i if v)}
+          rescue OCIError
+            nil
+          ensure
+            cursor.close if cursor
           end
         end
       end
-      alias_method :do, :execute
 
-      private
-      
       def begin_transaction(conn, opts={})
         log_yield(TRANSACTION_BEGIN){conn.autocommit = false}
-        conn
       end
       
       def commit_transaction(conn, opts={})
         log_yield(TRANSACTION_COMMIT){conn.commit}
       end
 
-      def disconnect_connection(c)
-        c.logoff
-      rescue OCIInvalidHandle
-        nil
+      def disconnect_error?(e, opts)
+        super || (e.is_a?(::OCIError) && CONNECTION_ERROR_CODES.include?(e.code))
       end
       
-      def remove_transaction(conn)
-        conn.autocommit = true if conn
+      def oracle_column_type(h)
+        case h[:oci8_type]
+        when :number
+          case h[:scale]
+          when 0
+            :integer
+          when -127
+            :float
+          else
+            :decimal
+          end
+        when :date
+          :datetime
+        else
+          schema_column_type(h[:db_type])
+        end
+      end
+
+      def remove_transaction(conn, committed)
+        conn.autocommit = true
+      ensure
         super
       end
       
       def rollback_transaction(conn, opts={})
         log_yield(TRANSACTION_ROLLBACK){conn.rollback}
       end
+
+      def schema_parse_table(table, opts={})
+        schema, table = schema_and_table(table)
+        schema ||= opts[:schema]
+        schema_and_table = if ds = opts[:dataset]
+          ds.literal(schema ? SQL::QualifiedIdentifier.new(schema, table) : SQL::Identifier.new(table))
+        else
+          "#{"#{quote_identifier(schema)}." if schema}#{quote_identifier(table)}"
+        end
+        table_schema = []
+        m = output_identifier_meth(ds)
+        im = input_identifier_meth(ds)
+
+        # Primary Keys
+        ds = metadata_dataset.from(:all_constraints___cons, :all_cons_columns___cols).
+          where(:cols__table_name=>im.call(table), :cons__constraint_type=>'P',
+                :cons__constraint_name=>:cols__constraint_name, :cons__owner=>:cols__owner)
+        ds = ds.where(:cons__owner=>im.call(schema)) if schema
+        pks = ds.select_map(:cols__column_name)
+
+        # Default values
+        defaults = begin
+          metadata_dataset.from(:user_tab_cols).
+            where(:table_name=>im.call(table)).
+            to_hash(:column_name, :data_default)
+        rescue DatabaseError
+          {}
+        end
+
+        metadata = synchronize(opts[:server]) do |conn|
+          begin
+          log_yield("Connection.describe_table"){conn.describe_table(schema_and_table)}
+          rescue OCIError => e
+            raise_error(e)
+          end
+        end
+        metadata.columns.each do |column|
+          h = {
+              :primary_key => pks.include?(column.name),
+              :default => defaults[column.name],
+              :oci8_type => column.data_type,
+              :db_type => column.type_string.split(' ')[0],
+              :type_string => column.type_string,
+              :charset_form => column.charset_form,
+              :char_used => column.char_used?,
+              :char_size => column.char_size,
+              :data_size => column.data_size,
+              :precision => column.precision,
+              :scale => column.scale,
+              :fsprecision => column.fsprecision,
+              :lfprecision => column.lfprecision,
+              :allow_null => column.nullable?
+          }
+          h[:type] = oracle_column_type(h)
+          table_schema << [m.call(column.name), h]
+        end
+        table_schema
+      end
     end
     
     class Dataset < Sequel::Dataset
       include DatasetMethods
 
+      Database::DatasetClass = self
+
+      PREPARED_ARG_PLACEHOLDER = ':'.freeze
+      
+      # Oracle already supports named bind arguments, so use directly.
+      module ArgumentMapper
+        include Sequel::Dataset::ArgumentMapper
+        
+        protected
+        
+        # Return a hash with the same values as the given hash,
+        # but with the keys converted to strings.
+        def map_to_prepared_args(bind_vars)
+          prepared_args.map{|v, t| [bind_vars[v], t]}
+        end
+        
+        private
+        
+        # Oracle uses a : before the name of the argument for named
+        # arguments.
+        def prepared_arg(k)
+          y, type = k.to_s.split("__", 2)
+          prepared_args << [y.to_sym, type]
+          i = prepared_args.length
+          LiteralString.new(":#{i}")
+        end
+
+        # Always assume a prepared argument.
+        def prepared_arg?(k)
+          true
+        end
+      end
+      
+      # Oracle prepared statement uses a new prepared statement each time
+      # it is called, but it does use the bind arguments.
+      module BindArgumentMethods
+        include ArgumentMapper
+
+        private
+        
+        # Run execute_select on the database with the given SQL and the stored
+        # bind arguments.
+        def execute(sql, opts={}, &block)
+          super(prepared_sql, {:arguments=>bind_arguments}.merge(opts), &block)
+        end
+        
+        # Same as execute, explicit due to intricacies of alias and super.
+        def execute_dui(sql, opts={}, &block)
+          super(prepared_sql, {:arguments=>bind_arguments}.merge(opts), &block)
+        end
+        
+        # Same as execute, explicit due to intricacies of alias and super.
+        def execute_insert(sql, opts={}, &block)
+          super(prepared_sql, {:arguments=>bind_arguments}.merge(opts), &block)
+        end
+      end
+
+      module PreparedStatementMethods
+        include BindArgumentMethods
+          
+        private
+          
+        # Execute the stored prepared statement name and the stored bind
+        # arguments instead of the SQL given.
+        def execute(sql, opts={}, &block)
+          super(prepared_statement_name, opts, &block)
+        end
+         
+        # Same as execute, explicit due to intricacies of alias and super.
+        def execute_dui(sql, opts={}, &block)
+          super(prepared_statement_name, opts, &block)
+        end
+          
+        # Same as execute, explicit due to intricacies of alias and super.
+        def execute_insert(sql, opts={}, &block)
+          super(prepared_statement_name, opts, &block)
+        end
+      end
+        
+      # Execute the given type of statement with the hash of values.
+      def call(type, bind_vars={}, *values, &block)
+        ps = to_prepared_statement(type, values)
+        ps.extend(BindArgumentMethods)
+        ps.call(bind_vars, &block)
+      end
+      
       def fetch_rows(sql)
         execute(sql) do |cursor|
-          begin
-            @columns = cursor.get_col_names.map{|c| output_identifier(c)}
-            while r = cursor.fetch
-              row = {}
-              r.each_with_index {|v, i| row[@columns[i]] = v unless @columns[i] == :raw_rnum_}
-              yield row
-            end
-          ensure
-            cursor.close
+          offset = @opts[:offset]
+          rn = row_number_column
+          cps = db.conversion_procs
+          cols = columns = cursor.get_col_names.map{|c| output_identifier(c)}
+          metadata = cursor.column_metadata
+          cm = cols.zip(metadata).map{|c, m| [c, cps[m.data_type]]}
+          columns = cols.reject{|x| x == rn} if offset
+          @columns = columns
+          while r = cursor.fetch
+            row = {}
+            r.zip(cm).each{|v, (c, cp)| row[c] = ((v && cp) ? cp.call(v) : v)}
+            row.delete(rn) if offset
+            yield row
           end
         end
         self
       end
 
+      # Prepare the given type of query with the given name and store
+      # it in the database.  Note that a new native prepared statement is
+      # created on each call to this prepared statement.
+      def prepare(type, name=nil, *values)
+        ps = to_prepared_statement(type, values)
+        ps.extend(PreparedStatementMethods)
+        if name
+          ps.prepared_statement_name = name
+          db.set_prepared_statement(name, ps)
+        end
+        ps
+      end
+      
+      # Oracle requires type specifiers for placeholders, at least
+      # if you ever want to use a nil/NULL value as the value for
+      # the placeholder.
+      def requires_placeholder_type_specifiers?
+        true
+      end
+
       private
 
-      def literal_other(v)
+      def literal_other_append(sql, v)
         case v
         when OraDate
-          literal(Sequel.database_to_application_timestamp(v))
+          literal_append(sql, db.to_application_timestamp(v))
         when OCI8::CLOB
           v.rewind
-          literal(v.read)
+          literal_append(sql, v.read)
         else
           super
         end
       end
+
+      def prepared_arg_placeholder
+        PREPARED_ARG_PLACEHOLDER
+      end
     end
   end
 end