aboutsummaryrefslogblamecommitdiffstats
path: root/activerecord/lib/active_record/explain.rb
blob: 8bb54a24b7a386c072e6fa727a09f436899198a5 (plain) (tree)
1
2
3
4
5
6
7
8
9

                             
                                   
 
                   
                

                                                                             
                                                
                                    
           
                             
          
                           
       
 


                                                                               
                                       
                                       





                                                               
                    
 
                                                                                


                     
 
         
       











                                                                           

     
# frozen_string_literal: true

require_relative "explain_registry"

module ActiveRecord
  module Explain
    # Executes the block with the collect flag enabled. Queries are collected
    # asynchronously by the subscriber and returned.
    def collecting_queries_for_explain # :nodoc:
      ExplainRegistry.collect = true
      yield
      ExplainRegistry.queries
    ensure
      ExplainRegistry.reset
    end

    # Makes the adapter execute EXPLAIN for the tuples of queries and bindings.
    # Returns a formatted string ready to be logged.
    def exec_explain(queries) # :nodoc:
      str = queries.map do |sql, binds|
        msg = "EXPLAIN for: #{sql}".dup
        unless binds.empty?
          msg << " "
          msg << binds.map { |attr| render_bind(attr) }.inspect
        end
        msg << "\n"
        msg << connection.explain(sql, binds)
      end.join("\n")

      # Overriding inspect to be more human readable, especially in the console.
      def str.inspect
        self
      end

      str
    end

    private

      def render_bind(attr)
        value = if attr.type.binary? && attr.value
          "<#{attr.value_for_database.to_s.bytesize} bytes of binary data>"
        else
          connection.type_cast(attr.value_for_database)
        end

        [attr.name, value]
      end
  end
end