Contents

# frozen_string_literal: true

require "active_record/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, options = []) # :nodoc:
      str = with_connection do |c|
        queries.map do |sql, binds|
          msg = +"#{build_explain_clause(c, options)} #{sql}"
          unless binds.empty?
            msg << " "
            msg << binds.map { |attr| render_bind(c, attr) }.inspect
          end
          msg << "\n"
          msg << c.explain(sql, binds, options)
        end.join("\n")
      end
      # Overriding inspect to be more human readable, especially in the console.
      def str.inspect
        self
      end

      str
    end

    private
      def render_bind(connection, attr)
        if ActiveModel::Attribute === 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
        else
          value = connection.type_cast(attr)
          attr  = nil
        end

        [attr&.name, value]
      end

      def build_explain_clause(connection, options = [])
        if connection.respond_to?(:build_explain_clause, true)
          connection.build_explain_clause(options)
        else
          "EXPLAIN for:"
        end
      end
  end
end

Version data entries

20 entries across 20 versions & 2 rubygems

Version	Path
activerecord-8.0.0	lib/active_record/explain.rb
activerecord-7.2.2	lib/active_record/explain.rb
activerecord-8.0.0.rc2	lib/active_record/explain.rb
activerecord-7.2.1.2	lib/active_record/explain.rb
activerecord-8.0.0.rc1	lib/active_record/explain.rb
activerecord-7.2.1.1	lib/active_record/explain.rb
activerecord-8.0.0.beta1	lib/active_record/explain.rb
omg-activerecord-8.0.0.alpha9	lib/active_record/explain.rb
omg-activerecord-8.0.0.alpha8	lib/active_record/explain.rb
omg-activerecord-8.0.0.alpha7	lib/active_record/explain.rb
omg-activerecord-8.0.0.alpha4	lib/active_record/explain.rb
omg-activerecord-8.0.0.alpha3	lib/active_record/explain.rb
omg-activerecord-8.0.0.alpha2	lib/active_record/explain.rb
omg-activerecord-8.0.0.alpha1	lib/active_record/explain.rb
activerecord-7.2.1	lib/active_record/explain.rb
activerecord-7.2.0	lib/active_record/explain.rb
activerecord-7.2.0.rc1	lib/active_record/explain.rb
activerecord-7.2.0.beta3	lib/active_record/explain.rb
activerecord-7.2.0.beta2	lib/active_record/explain.rb
activerecord-7.2.0.beta1	lib/active_record/explain.rb