Class: QueryConsole::ExplainRunner

Inherits:
Object
  • Object
show all
Defined in:
app/services/query_console/explain_runner.rb

Defined Under Namespace

Classes: ExplainResult

Instance Method Summary collapse

Constructor Details

#initialize(sql, config = QueryConsole.configuration) ⇒ ExplainRunner

Returns a new instance of ExplainRunner.



23
24
25
26
 
# File 'app/services/query_console/explain_runner.rb', line 23

def initialize(sql, config = QueryConsole.configuration)
  @sql = sql
  @config = config
end

Instance Method Details

#execute ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
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
 
# File 'app/services/query_console/explain_runner.rb', line 28

def execute
  return ExplainResult.new(error: "EXPLAIN feature is disabled") unless @config.enable_explain

  start_time = Time.now

  # Step 1: Validate SQL (same as regular runner)
  validator = SqlValidator.new(@sql, @config)
  validation_result = validator.validate

  if validation_result.invalid?
    return ExplainResult.new(error: validation_result.error)
  end

  sanitized_sql = validation_result.sanitized_sql

  # Step 2: Build EXPLAIN query based on adapter
  explain_sql = build_explain_query(sanitized_sql)

  # Step 3: Execute with timeout
  begin
    result, _ = execute_with_timeout(explain_sql, false)
    execution_time = ((Time.now - start_time) * 1000).round(2)

    # Format the result as plain text
    plan_text = format_explain_output(result)

    ExplainResult.new(
      plan_text: plan_text,
      execution_time_ms: execution_time
    )
  rescue Timeout::Error
    ExplainResult.new(
      error: "EXPLAIN timeout: exceeded #{@config.timeout_ms}ms limit"
    )
  rescue StandardError => e
    ExplainResult.new(
      error: "EXPLAIN error: #{e.message}"
    )
  end
end