Class: ActiveRecord::LogSubscriber

Inherits:
ActiveSupport::LogSubscriber show all
Defined in:
activerecord/lib/active_record/log_subscriber.rb

Constant Summary collapse

IGNORE_PAYLOAD_NAMES = 
["SCHEMA", "EXPLAIN"]

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.reset_runtime ⇒ Object

[View source]

23
24
25
26
27
28
 
# File 'activerecord/lib/active_record/log_subscriber.rb', line 23

def self.reset_runtime
  ActiveRecord.deprecator.warn(<<-MSG.squish)
    ActiveRecord::LogSubscriber.reset_runtime is deprecated and will be removed in Rails 7.2.
  MSG
  ActiveRecord::RuntimeRegistry.reset
end

.runtime ⇒ Object

[View source]

16
17
18
19
20
21
 
# File 'activerecord/lib/active_record/log_subscriber.rb', line 16

def self.runtime
  ActiveRecord.deprecator.warn(<<-MSG.squish)
    ActiveRecord::LogSubscriber.runtime is deprecated and will be removed in Rails 7.2.
  MSG
  ActiveRecord::RuntimeRegistry.sql_runtime
end

.runtime=(value) ⇒ Object

[View source]

9
10
11
12
13
14
 
# File 'activerecord/lib/active_record/log_subscriber.rb', line 9

def self.runtime=(value)
  ActiveRecord.deprecator.warn(<<-MSG.squish)
    ActiveRecord::LogSubscriber.runtime= is deprecated and will be removed in Rails 7.2.
  MSG
  ActiveRecord::RuntimeRegistry.sql_runtime = value
end

Instance Method Details

#sql(event) ⇒ Object

[View source]

39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'activerecord/lib/active_record/log_subscriber.rb', line 39

def sql(event)
  payload = event.payload

  return if IGNORE_PAYLOAD_NAMES.include?(payload[:name])

  name = if payload[:async]
    "ASYNC #{payload[:name]} (#{payload[:lock_wait].round(1)}ms) (db time #{event.duration.round(1)}ms)"
  else
    "#{payload[:name]} (#{event.duration.round(1)}ms)"
  end
  name  = "CACHE #{name}" if payload[:cached]
  sql   = payload[:sql]
  binds = nil

  if payload[:binds]&.any?
    casted_params = type_casted_binds(payload[:type_casted_binds])

    binds = []
    payload[:binds].each_with_index do |attr, i|
      attribute_name = if attr.respond_to?(:name)
        attr.name
      elsif attr.respond_to?(:[]) && attr[i].respond_to?(:name)
        attr[i].name
      else
        nil
      end

      filtered_params = filter(attribute_name, casted_params[i])

      binds << render_bind(attr, filtered_params)
    end
    binds = binds.inspect
    binds.prepend("  ")
  end

  name = colorize_payload_name(name, payload[:name])
  sql  = color(sql, sql_color(sql), bold: true) if colorize_logging

  debug "  #{name}  #{sql}#{binds}"
end

#strict_loading_violation(event) ⇒ Object

[View source]

30
31
32
33
34
35
36
 
# File 'activerecord/lib/active_record/log_subscriber.rb', line 30

def strict_loading_violation(event)
  debug do
    owner = event.payload[:owner]
    reflection = event.payload[:reflection]
    color(reflection.strict_loading_violation_message(owner), RED)
  end
end