activerecord-oracle_enhanced-adapter 1.5.6 → 1.6.0.beta1

data/lib/active_record/connection_adapters/oracle_enhanced_context_index.rb

@@ -1,350 +0,0 @@
-module ActiveRecord
-  module ConnectionAdapters
-    module OracleEnhancedContextIndex
-
-      # Define full text index with Oracle specific CONTEXT index type
-      #
-      # Oracle CONTEXT index by default supports full text indexing of one column.
-      # This method allows full text index creation also on several columns
-      # as well as indexing related table columns by generating stored procedure
-      # that concatenates all columns for indexing as well as generating trigger
-      # that will update main index column to trigger reindexing of record.
-      #
-      # Use +contains+ ActiveRecord model instance method to add CONTAINS where condition
-      # and order by score of matched results.
-      #
-      # Options:
-      #
-      # * <tt>:name</tt>
-      # * <tt>:index_column</tt>
-      # * <tt>:index_column_trigger_on</tt>
-      # * <tt>:tablespace</tt>
-      # * <tt>:sync</tt> - 'MANUAL', 'EVERY "interval-string"' or 'ON COMMIT' (defaults to 'MANUAL').
-      # * <tt>:lexer</tt> - Lexer options (e.g. <tt>:type => 'BASIC_LEXER', :base_letter => true</tt>).
-      # * <tt>:wordlist</tt> - Wordlist options (e.g. <tt>:type => 'BASIC_WORDLIST', :prefix_index => true</tt>).
-      # * <tt>:transactional</tt> - When +true+, the CONTAINS operator will process inserted and updated rows.
-      #
-      # ===== Examples
-      #
-      # ====== Creating single column index
-      #  add_context_index :posts, :title
-      # search with
-      #  Post.contains(:title, 'word')
-      #
-      # ====== Creating index on several columns
-      #  add_context_index :posts, [:title, :body]
-      # search with (use first column as argument for contains method but it will search in all index columns)
-      #  Post.contains(:title, 'word')
-      #
-      # ====== Creating index on several columns with dummy index column and commit option
-      #  add_context_index :posts, [:title, :body], :index_column => :all_text, :sync => 'ON COMMIT'
-      # search with
-      #  Post.contains(:all_text, 'word')
-      #
-      # ====== Creating index with trigger option (will reindex when specified columns are updated)
-      #  add_context_index :posts, [:title, :body], :index_column => :all_text, :sync => 'ON COMMIT',
-      #                     :index_column_trigger_on => [:created_at, :updated_at]
-      # search with
-      #  Post.contains(:all_text, 'word')
-      #
-      # ====== Creating index on multiple tables
-      #  add_context_index :posts,
-      #   [:title, :body,
-      #   # specify aliases always with AS keyword
-      #   "SELECT comments.author AS comment_author, comments.body AS comment_body FROM comments WHERE comments.post_id = :id"
-      #   ],
-      #   :name => 'post_and_comments_index',
-      #   :index_column => :all_text, :index_column_trigger_on => [:updated_at, :comments_count],
-      #   :sync => 'ON COMMIT'
-      # search in any table columns
-      #  Post.contains(:all_text, 'word')
-      # search in specified column
-      #  Post.contains(:all_text, "aaa within title")
-      #  Post.contains(:all_text, "bbb within comment_author")
-      #
-      # ====== Creating index using lexer
-      #  add_context_index :posts, :title, :lexer => { :type => 'BASIC_LEXER', :base_letter => true, ... }
-      #
-      # ====== Creating index using wordlist
-      #  add_context_index :posts, :title, :wordlist => { :type => 'BASIC_WORDLIST', :prefix_index => true, ... }
-      #
-      # ====== Creating transactional index (will reindex changed rows when querying)
-      #  add_context_index :posts, :title, :transactional => true
-      #
-      def add_context_index(table_name, column_name, options = {})
-        self.all_schema_indexes = nil
-        column_names = Array(column_name)
-        index_name = options[:name] || index_name(table_name, :column => options[:index_column] || column_names,
-          # CONEXT index name max length is 25
-          :identifier_max_length => 25)
-
-        quoted_column_name = quote_column_name(options[:index_column] || column_names.first)
-        if options[:index_column_trigger_on]
-          raise ArgumentError, "Option :index_column should be specified together with :index_column_trigger_on option" \
-            unless options[:index_column]
-          create_index_column_trigger(table_name, index_name, options[:index_column], options[:index_column_trigger_on])
-        end
-
-        sql = "CREATE INDEX #{quote_column_name(index_name)} ON #{quote_table_name(table_name)}"
-        sql << " (#{quoted_column_name})"
-        sql << " INDEXTYPE IS CTXSYS.CONTEXT"
-        parameters = []
-        if column_names.size > 1
-          procedure_name = default_datastore_procedure(index_name)
-          datastore_name = default_datastore_name(index_name)
-          create_datastore_procedure(table_name, procedure_name, column_names, options)
-          create_datastore_preference(datastore_name, procedure_name)
-          parameters << "DATASTORE #{datastore_name} SECTION GROUP CTXSYS.AUTO_SECTION_GROUP"
-        end
-        if options[:tablespace]
-          storage_name = default_storage_name(index_name)
-          create_storage_preference(storage_name, options[:tablespace])
-          parameters << "STORAGE #{storage_name}"
-        end
-        if options[:sync]
-          parameters << "SYNC(#{options[:sync]})"
-        end
-        if options[:lexer] && (lexer_type = options[:lexer][:type])
-          lexer_name = default_lexer_name(index_name)
-          (lexer_options = options[:lexer].dup).delete(:type)
-          create_lexer_preference(lexer_name, lexer_type, lexer_options)
-          parameters << "LEXER #{lexer_name}"
-        end
-        if options[:wordlist] && (wordlist_type = options[:wordlist][:type])
-          wordlist_name = default_wordlist_name(index_name)
-          (wordlist_options = options[:wordlist].dup).delete(:type)
-          create_wordlist_preference(wordlist_name, wordlist_type, wordlist_options)
-          parameters << "WORDLIST #{wordlist_name}"
-        end
-        if options[:transactional]
-          parameters << "TRANSACTIONAL"
-        end
-        unless parameters.empty?
-          sql << " PARAMETERS ('#{parameters.join(' ')}')"
-        end
-        execute sql
-      end
-
-      # Drop full text index with Oracle specific CONTEXT index type
-      def remove_context_index(table_name, options = {})
-        self.all_schema_indexes = nil
-        unless Hash === options # if column names passed as argument
-          options = {:column => Array(options)}
-        end
-        index_name = options[:name] || index_name(table_name,
-          :column => options[:index_column] || options[:column], :identifier_max_length => 25)
-        execute "DROP INDEX #{index_name}"
-        drop_ctx_preference(default_datastore_name(index_name))
-        drop_ctx_preference(default_storage_name(index_name))
-        procedure_name = default_datastore_procedure(index_name)
-        execute "DROP PROCEDURE #{quote_table_name(procedure_name)}" rescue nil
-        drop_index_column_trigger(index_name)
-      end
-
-      private
-
-      def create_datastore_procedure(table_name, procedure_name, column_names, options)
-        quoted_table_name = quote_table_name(table_name)
-        select_queries, column_names = column_names.partition { |c| c.to_s =~ /^\s*SELECT\s+/i }
-        select_queries = select_queries.map { |s| s.strip.gsub(/\s+/, ' ') }
-        keys, selected_columns = parse_select_queries(select_queries)
-        quoted_column_names = (column_names+keys).map{|col| quote_column_name(col)}
-        execute compress_lines(<<-SQL)
-          CREATE OR REPLACE PROCEDURE #{quote_table_name(procedure_name)}
-            (p_rowid IN	      ROWID,
-            p_clob	IN OUT NOCOPY CLOB) IS
-            -- add_context_index_parameters #{(column_names+select_queries).inspect}#{!options.empty? ? ', ' << options.inspect[1..-2] : ''}
-            #{
-            selected_columns.map do |cols|
-              cols.map do |col|
-                raise ArgumentError, "Alias #{col} too large, should be 28 or less characters long" unless col.length <= 28
-                "l_#{col} VARCHAR2(32767);\n"
-              end.join
-            end.join
-            } BEGIN
-            FOR r1 IN (
-              SELECT #{quoted_column_names.join(', ')}
-              FROM	 #{quoted_table_name}
-              WHERE  #{quoted_table_name}.ROWID = p_rowid
-            ) LOOP
-              #{
-              (column_names.map do |col|
-                col = col.to_s
-                "DBMS_LOB.WRITEAPPEND(p_clob, #{col.length+2}, '<#{col}>');\n" <<
-                "IF LENGTH(r1.#{col}) > 0 THEN\n" <<
-                "DBMS_LOB.WRITEAPPEND(p_clob, LENGTH(r1.#{col}), r1.#{col});\n" <<
-                "END IF;\n" <<
-                "DBMS_LOB.WRITEAPPEND(p_clob, #{col.length+3}, '</#{col}>');\n"
-              end.join) <<
-              (selected_columns.zip(select_queries).map do |cols, query|
-                (cols.map do |col|
-                  "l_#{col} := '';\n"
-                end.join) <<
-                "FOR r2 IN (\n" <<
-                query.gsub(/:(\w+)/,"r1.\\1") << "\n) LOOP\n" <<
-                (cols.map do |col|
-                  "l_#{col} := l_#{col} || r2.#{col} || CHR(10);\n"
-                end.join) <<
-                "END LOOP;\n" <<
-                (cols.map do |col|
-                  col = col.to_s
-                  "DBMS_LOB.WRITEAPPEND(p_clob, #{col.length+2}, '<#{col}>');\n" <<
-                  "IF LENGTH(l_#{col}) > 0 THEN\n" <<
-                  "DBMS_LOB.WRITEAPPEND(p_clob, LENGTH(l_#{col}), l_#{col});\n" <<
-                  "END IF;\n" <<
-                  "DBMS_LOB.WRITEAPPEND(p_clob, #{col.length+3}, '</#{col}>');\n"
-                end.join)
-              end.join)
-              }
-            END LOOP;
-          END;
-        SQL
-      end
-
-      def parse_select_queries(select_queries)
-        keys = []
-        selected_columns = []
-        select_queries.each do |query|
-          # get primary or foreign keys like :id or :something_id
-          keys << (query.scan(/:\w+/).map{|k| k[1..-1].downcase.to_sym})
-          select_part = query.scan(/^select\s.*\sfrom/i).first
-          selected_columns << select_part.scan(/\sas\s+(\w+)/i).map{|c| c.first}
-        end
-        [keys.flatten.uniq, selected_columns]
-      end
-
-      def create_datastore_preference(datastore_name, procedure_name)
-        drop_ctx_preference(datastore_name)
-        execute <<-SQL
-          BEGIN
-            CTX_DDL.CREATE_PREFERENCE('#{datastore_name}', 'USER_DATASTORE');
-            CTX_DDL.SET_ATTRIBUTE('#{datastore_name}', 'PROCEDURE', '#{procedure_name}');
-          END;
-        SQL
-      end
-
-      def create_storage_preference(storage_name, tablespace)
-        drop_ctx_preference(storage_name)
-        sql = "BEGIN\nCTX_DDL.CREATE_PREFERENCE('#{storage_name}', 'BASIC_STORAGE');\n"
-        ['I_TABLE_CLAUSE', 'K_TABLE_CLAUSE', 'R_TABLE_CLAUSE',
-        'N_TABLE_CLAUSE', 'I_INDEX_CLAUSE', 'P_TABLE_CLAUSE'].each do |clause|
-          default_clause = case clause
-          when 'R_TABLE_CLAUSE'; 'LOB(DATA) STORE AS (CACHE) '
-          when 'I_INDEX_CLAUSE'; 'COMPRESS 2 '
-          else ''
-          end
-          sql << "CTX_DDL.SET_ATTRIBUTE('#{storage_name}', '#{clause}', '#{default_clause}TABLESPACE #{tablespace}');\n"
-        end
-        sql << "END;\n"
-        execute sql
-      end
-
-      def create_lexer_preference(lexer_name, lexer_type, options)
-        drop_ctx_preference(lexer_name)
-        sql = "BEGIN\nCTX_DDL.CREATE_PREFERENCE('#{lexer_name}', '#{lexer_type}');\n"
-        options.each do |key, value|
-          plsql_value = case value
-          when String; "'#{value}'"
-          when true; "'YES'"
-          when false; "'NO'"
-          when nil; 'NULL'
-          else value
-          end
-          sql << "CTX_DDL.SET_ATTRIBUTE('#{lexer_name}', '#{key}', #{plsql_value});\n"
-        end
-        sql << "END;\n"
-        execute sql
-      end
-
-      def create_wordlist_preference(wordlist_name, wordlist_type, options)
-        drop_ctx_preference(wordlist_name)
-        sql = "BEGIN\nCTX_DDL.CREATE_PREFERENCE('#{wordlist_name}', '#{wordlist_type}');\n"
-        options.each do |key, value|
-          plsql_value = case value
-          when String; "'#{value}'"
-          when true; "'YES'"
-          when false; "'NO'"
-          when nil; 'NULL'
-          else value
-          end
-          sql << "CTX_DDL.SET_ATTRIBUTE('#{wordlist_name}', '#{key}', #{plsql_value});\n"
-        end
-        sql << "END;\n"
-        execute sql
-      end
-
-      def drop_ctx_preference(preference_name)
-        execute "BEGIN CTX_DDL.DROP_PREFERENCE('#{preference_name}'); END;" rescue nil
-      end
-
-      def create_index_column_trigger(table_name, index_name, index_column, index_column_source)
-        trigger_name = default_index_column_trigger_name(index_name)
-        columns = Array(index_column_source)
-        quoted_column_names = columns.map{|col| quote_column_name(col)}.join(', ')
-        execute compress_lines(<<-SQL)
-          CREATE OR REPLACE TRIGGER #{quote_table_name(trigger_name)}
-          BEFORE UPDATE OF #{quoted_column_names} ON #{quote_table_name(table_name)} FOR EACH ROW
-          BEGIN
-            :new.#{quote_column_name(index_column)} := '1';
-          END;
-        SQL
-      end
-
-      def drop_index_column_trigger(index_name)
-        trigger_name = default_index_column_trigger_name(index_name)
-        execute "DROP TRIGGER #{quote_table_name(trigger_name)}" rescue nil
-      end
-
-      def default_datastore_procedure(index_name)
-        "#{index_name}_prc"
-      end
-
-      def default_datastore_name(index_name)
-        "#{index_name}_dst"
-      end
-
-      def default_storage_name(index_name)
-        "#{index_name}_sto"
-      end
-
-      def default_index_column_trigger_name(index_name)
-        "#{index_name}_trg"
-      end
-
-      def default_lexer_name(index_name)
-        "#{index_name}_lex"
-      end
-
-      def default_wordlist_name(index_name)
-        "#{index_name}_wl"
-      end
-
-      module BaseClassMethods
-        # Declare that model table has context index defined.
-        # As a result <tt>contains</tt> class scope method is defined.
-        def has_context_index
-          extend ContextIndexClassMethods
-        end
-      end
-
-      module ContextIndexClassMethods
-        # Add context index condition.
-        def contains(column, query, options ={})
-          score_label = options[:label].to_i || 1
-          where("CONTAINS(#{connection.quote_column_name(column)}, ?, #{score_label}) > 0", query).
-            order("SCORE(#{score_label}) DESC")
-        end
-      end
-
-    end
-    
-  end
-end
-
-ActiveRecord::ConnectionAdapters::OracleEnhancedAdapter.class_eval do
-  include ActiveRecord::ConnectionAdapters::OracleEnhancedContextIndex
-end
-
-ActiveRecord::Base.class_eval do
-  extend ActiveRecord::ConnectionAdapters::OracleEnhancedContextIndex::BaseClassMethods
-end

data/lib/active_record/connection_adapters/oracle_enhanced_database_statements.rb

@@ -1,262 +0,0 @@
-module ActiveRecord
-  module ConnectionAdapters
-    module OracleEnhancedDatabaseStatements
-      # DATABASE STATEMENTS ======================================
-      #
-      # see: abstract/database_statements.rb
-
-      # Executes a SQL statement
-      def execute(sql, name = nil)
-        log(sql, name) { @connection.exec(sql) }
-      end
-
-      def substitute_at(column, index)
-        Arel::Nodes::BindParam.new (":a#{index + 1}")
-      end
-
-      def clear_cache!
-        @statements.clear
-      end
-
-      def exec_query(sql, name = 'SQL', binds = [])
-        type_casted_binds = binds.map { |col, val|
-          [col, type_cast(val, col)]
-        }
-        log(sql, name, type_casted_binds) do
-          cursor = nil
-          cached = false
-          if without_prepared_statement?(binds)
-            cursor = @connection.prepare(sql)
-          else
-            unless @statements.key? sql
-              @statements[sql] = @connection.prepare(sql)
-            end
-
-            cursor = @statements[sql]
-
-            binds.each_with_index do |bind, i|
-              col, val = bind
-              cursor.bind_param(i + 1, type_cast(val, col), col)
-            end
-
-            cached = true
-          end
-
-          cursor.exec
-
-          if name == 'EXPLAIN' and sql =~ /^EXPLAIN/
-            res = true
-          else
-            columns = cursor.get_col_names.map do |col_name|
-              @connection.oracle_downcase(col_name)
-            end
-            rows = []
-            fetch_options = {:get_lob_value => (name != 'Writable Large Object')}
-            while row = cursor.fetch(fetch_options)
-              rows << row
-            end
-            res = ActiveRecord::Result.new(columns, rows)
-          end
-
-          cursor.close unless cached
-          res
-        end
-      end
-
-      def supports_statement_cache?
-        true
-      end
-
-      def supports_explain?
-        true
-      end
-
-      def explain(arel, binds = [])
-        sql = "EXPLAIN PLAN FOR #{to_sql(arel, binds)}"
-        return if sql =~ /FROM all_/
-        if ORACLE_ENHANCED_CONNECTION == :jdbc
-          exec_query(sql, 'EXPLAIN', binds)
-        else
-          exec_query(sql, 'EXPLAIN')
-        end
-        select_values("SELECT * FROM TABLE(DBMS_XPLAN.DISPLAY)", 'EXPLAIN').join("\n")
-      end
-
-      # Returns an array of arrays containing the field values.
-      # Order is the same as that returned by #columns.
-      def select_rows(sql, name = nil, binds = [])
-        exec_query(sql, name, binds).rows
-      end
-
-      # Executes an INSERT statement and returns the new record's ID
-      def insert_sql(sql, name = nil, pk = nil, id_value = nil, sequence_name = nil) #:nodoc:
-        # if primary key value is already prefetched from sequence
-        # or if there is no primary key
-        if id_value || pk.nil?
-          execute(sql, name)
-          return id_value
-        end
-
-        sql_with_returning = sql + @connection.returning_clause(quote_column_name(pk))
-        log(sql, name) do
-          @connection.exec_with_returning(sql_with_returning)
-        end
-      end
-      protected :insert_sql
-
-      # New method in ActiveRecord 3.1
-      # Will add RETURNING clause in case of trigger generated primary keys
-      def sql_for_insert(sql, pk, id_value, sequence_name, binds)
-        unless id_value || pk.nil? || (defined?(CompositePrimaryKeys) && pk.kind_of?(CompositePrimaryKeys::CompositeKeys))
-          sql = "#{sql} RETURNING #{quote_column_name(pk)} INTO :returning_id"
-          returning_id_col = OracleEnhancedColumn.new("returning_id", nil, "number", true, "dual", :integer, true, true)
-          (binds = binds.dup) << [returning_id_col, nil]
-        end
-        [sql, binds]
-      end
-
-      # New method in ActiveRecord 3.1
-      def exec_insert(sql, name, binds, pk = nil, sequence_name = nil)
-        type_casted_binds = binds.map { |col, val|
-          [col, type_cast(val, col)]
-        }
-        log(sql, name, type_casted_binds) do
-          returning_id_col = returning_id_index = nil
-          if without_prepared_statement?(binds)
-            cursor = @connection.prepare(sql)
-          else
-            unless @statements.key? (sql)
-              @statements[sql] = @connection.prepare(sql)
-            end
-
-            cursor = @statements[sql]
-
-            binds.each_with_index do |bind, i|
-              col, val = bind
-              if col.returning_id?
-                returning_id_col = [col]
-                returning_id_index = i + 1
-                cursor.bind_returning_param(returning_id_index, Integer)
-              else
-                cursor.bind_param(i + 1, type_cast(val, col), col)
-              end
-            end
-          end
-
-          cursor.exec_update
-
-          rows = []
-          if returning_id_index
-            returning_id = cursor.get_returning_param(returning_id_index, Integer)
-            rows << [returning_id]
-          end
-          ActiveRecord::Result.new(returning_id_col || [], rows)
-        end
-      end
-
-      # New method in ActiveRecord 3.1
-      def exec_update(sql, name, binds)
-        log(sql, name, binds) do
-          cached = false
-          if without_prepared_statement?(binds)
-            cursor = @connection.prepare(sql)
-          else
-            cursor = if @statements.key?(sql)
-              @statements[sql]
-            else
-              @statements[sql] = @connection.prepare(sql)
-            end
-
-            binds.each_with_index do |bind, i|
-              col, val = bind
-              cursor.bind_param(i + 1, type_cast(val, col), col)
-            end
-            cached = true
-          end
-
-          res = cursor.exec_update
-          cursor.close unless cached
-          res
-        end
-      end
-
-      alias :exec_delete :exec_update
-
-      def begin_db_transaction #:nodoc:
-        @connection.autocommit = false
-      end
-
-      def transaction_isolation_levels
-        # Oracle database supports `READ COMMITTED` and `SERIALIZABLE`
-        # No read uncommitted nor repeatable read supppoted
-        # http://docs.oracle.com/cd/E11882_01/server.112/e26088/statements_10005.htm#SQLRF55422
-        {
-          read_committed:   "READ COMMITTED",
-          serializable:     "SERIALIZABLE"
-        }
-      end
-
-      def begin_isolated_db_transaction(isolation)
-        begin_db_transaction
-        execute "SET TRANSACTION ISOLATION LEVEL  #{transaction_isolation_levels.fetch(isolation)}"
-      end
-
-      def commit_db_transaction #:nodoc:
-        @connection.commit
-      ensure
-        @connection.autocommit = true
-      end
-
-      def rollback_db_transaction #:nodoc:
-        @connection.rollback
-      ensure
-        @connection.autocommit = true
-      end
-
-      def create_savepoint(name = current_savepoint_name) #:nodoc:
-        execute("SAVEPOINT #{current_savepoint_name}")
-      end
-
-      def rollback_to_savepoint(name = current_savepoint_name) #:nodoc:
-        execute("ROLLBACK TO #{current_savepoint_name}")
-      end
-
-      def release_savepoint(name = current_savepoint_name) #:nodoc:
-        # there is no RELEASE SAVEPOINT statement in Oracle
-      end
-
-      # Returns default sequence name for table.
-      # Will take all or first 26 characters of table name and append _seq suffix
-      def default_sequence_name(table_name, primary_key = nil)
-        table_name.to_s.gsub /(^|\.)([\w$-]{1,#{sequence_name_length-4}})([\w$-]*)$/, '\1\2_seq'
-      end
-
-      # Inserts the given fixture into the table. Overridden to properly handle lobs.
-      def insert_fixture(fixture, table_name) #:nodoc:
-        super
-
-        if ActiveRecord::Base.pluralize_table_names
-          klass = table_name.to_s.singularize.camelize
-        else
-          klass = table_name.to_s.camelize
-        end
-
-        klass = klass.constantize rescue nil
-        if klass.respond_to?(:ancestors) && klass.ancestors.include?(ActiveRecord::Base)
-          write_lobs(table_name, klass, fixture, klass.lob_columns)
-        end
-      end
-
-      private
-
-      def select(sql, name = nil, binds = [])
-        exec_query(sql, name, binds)
-      end
-
-    end
-  end
-end
-
-ActiveRecord::ConnectionAdapters::OracleEnhancedAdapter.class_eval do
-  include ActiveRecord::ConnectionAdapters::OracleEnhancedDatabaseStatements
-end