Sha256: 4196236b9fdeb4d0c89d94563b32f2798e4fdde4627d05ba087dba8e0bbf2a88

Contents?: true

Size: 1.75 KB

Versions: 13

Compression:

Stored size: 1.75 KB

Contents

require 'active_record/connection_adapters/sqlserver/showplan/printer_table'
require 'active_record/connection_adapters/sqlserver/showplan/printer_xml'

module ActiveRecord
  module ConnectionAdapters
    module Sqlserver
      module Showplan
        OPTION_ALL  = 'SHOWPLAN_ALL'
        OPTION_TEXT = 'SHOWPLAN_TEXT'
        OPTION_XML  = 'SHOWPLAN_XML'
        OPTIONS = [OPTION_ALL, OPTION_TEXT, OPTION_XML]

        def explain(arel, binds = [])
          sql = to_sql(arel)
          result = with_showplan_on { do_exec_query(sql, 'EXPLAIN', binds) }
          printer = showplan_printer.new(result)
          printer.pp
        end

        protected

        def with_showplan_on
          set_showplan_option(true)
          yield
        ensure
          set_showplan_option(false)
        end

        def set_showplan_option(enable = true)
          sql = "SET #{option} #{enable ? 'ON' : 'OFF'}"
          raw_connection_do(sql)
        rescue Exception
          raise ActiveRecordError, "#{option} could not be turned #{enable ? 'ON' : 'OFF'}, perhaps you do not have SHOWPLAN permissions?"
        end

        def option
          (SQLServerAdapter.showplan_option || OPTION_ALL).tap do |opt|
            raise(ArgumentError, "Unknown SHOWPLAN option #{opt.inspect} found.") if OPTIONS.exclude?(opt)
          end
        end

        def showplan_all?
          option == OPTION_ALL
        end

        def showplan_text?
          option == OPTION_TEXT
        end

        def showplan_xml?
          option == OPTION_XML
        end

        def showplan_printer
          case option
          when OPTION_XML then PrinterXml
          when OPTION_ALL, OPTION_TEXT then PrinterTable
          else PrinterTable
          end
        end
      end
    end
  end
end

Version data entries

13 entries across 13 versions & 1 rubygems

Version Path
activerecord-sqlserver-adapter-4.1.8 lib/active_record/connection_adapters/sqlserver/showplan.rb
activerecord-sqlserver-adapter-4.0.4 lib/active_record/connection_adapters/sqlserver/showplan.rb
activerecord-sqlserver-adapter-4.1.7 lib/active_record/connection_adapters/sqlserver/showplan.rb
activerecord-sqlserver-adapter-4.0.3 lib/active_record/connection_adapters/sqlserver/showplan.rb
activerecord-sqlserver-adapter-4.1.6 lib/active_record/connection_adapters/sqlserver/showplan.rb
activerecord-sqlserver-adapter-4.0.2 lib/active_record/connection_adapters/sqlserver/showplan.rb
activerecord-sqlserver-adapter-4.1.5 lib/active_record/connection_adapters/sqlserver/showplan.rb
activerecord-sqlserver-adapter-4.1.4 lib/active_record/connection_adapters/sqlserver/showplan.rb
activerecord-sqlserver-adapter-4.0.1 lib/active_record/connection_adapters/sqlserver/showplan.rb
activerecord-sqlserver-adapter-4.1.2 lib/active_record/connection_adapters/sqlserver/showplan.rb
activerecord-sqlserver-adapter-4.1.1 lib/active_record/connection_adapters/sqlserver/showplan.rb
activerecord-sqlserver-adapter-4.1.0 lib/active_record/connection_adapters/sqlserver/showplan.rb
activerecord-sqlserver-adapter-4.0.0 lib/active_record/connection_adapters/sqlserver/showplan.rb