activerecord-analyze 0.1.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2c1961ed7400cf716abcc28764176bdf02b4c3eb
-  data.tar.gz: c982bed6eb37c9413bbec9785416f96b9c55490c
+SHA256:
+  metadata.gz: 1f3e8c5511121ff7c9a7e2aab56d1638e1f42286477bfb97a72ae6d284f719b1
+  data.tar.gz: 0a6eba3afdf108a616ad837d9520148a2a387ab0ab3441afbbe2e9851e974e1e
 SHA512:
-  metadata.gz: 5f57e1be57c643f06a0ba3036a0e2709ce9ac799c3a02ca7a0c1cce99d92340b9b0a7d574f8c8652d52ee522a3c5edbccec8ea5f8d1d8fbd21468c1c20372ec7
-  data.tar.gz: 432321449fdff40d5f410cb635b4f20448437c471526c87de4eaa25782cae474a816abf4f64a871804a8009d8d80e68989cac75fa09d342b7fa590ac89d59163
+  metadata.gz: 94223f7a2f15534a7b1d648cb5a019f4aeab0efef044a104ff70e4ee876cdc332de67dfdc86fb325aac5b847a515ae6b02846fed2a19c1b342df4e43b14c7e3d
+  data.tar.gz: 14aa9186a5e14d00dc6b6475d9d7052e00942d82bb5deafcb14f7c170a80282216c05597e102e9ce55c934807ceee145462d6f416ece2030ae21cfbbd495f3d8

data/README.md

@@ -1,2 +1,112 @@
 # ActiveRecord Analyze
 
+This gem adds an `analyze` method to Active Record query objects. It executes `EXPLAIN ANALYZE` on a query SQL.
+
+You can check out this blog post for more info on how to [debug and fix slow queries in Rails apps](https://pawelurbanek.com/slow-rails-queries).
+
+## Installation
+
+In your Gemfile:
+
+```ruby
+
+gem 'activerecord-analyze'
+
+```
+
+## Options
+
+The `analyze` method supports the following EXPLAIN query options ([PostgreSQL docs reference](https://www.postgresql.org/docs/12/sql-explain.html)):
+
+```
+VERBOSE [ boolean ]
+COSTS [ boolean ]
+SETTINGS [ boolean ]
+BUFFERS [ boolean ]
+TIMING [ boolean ]
+SUMMARY [ boolean ]
+FORMAT { TEXT | XML | JSON | YAML }
+```
+
+You can execute it like that:
+
+```ruby
+
+User.all.analyze(
+  format: :json,
+  verbose: true,
+  costs: true,
+  settings: true,
+  buffers: true,
+  timing: true,
+  summary: true
+)
+
+# EXPLAIN (FORMAT JSON, ANALYZE, VERBOSE, COSTS, SETTINGS, BUFFERS, TIMING, SUMMARY)
+# SELECT "users".* FROM "users"
+# [
+#   {
+#     "Plan": {
+#       "Node Type": "Seq Scan",
+#       "Parallel Aware": false,
+#       "Relation Name": "users",
+#       "Schema": "public",
+#       "Alias": "users",
+#       "Startup Cost": 0.00,
+#       "Total Cost": 11.56,
+#       "Plan Rows": 520,
+#       "Plan Width": 127,
+#       "Actual Startup Time": 0.006,
+#       "Actual Total Time": 0.007,
+#       "Actual Rows": 2,
+#       "Actual Loops": 1,
+#       "Output": ["id", "team_id", "email"],
+#       "Shared Hit Blocks": 1,
+#       "Shared Read Blocks": 0,
+#       "Shared Dirtied Blocks": 0,
+#       "Shared Written Blocks": 0,
+#       "Local Hit Blocks": 0,
+#       "Local Read Blocks": 0,
+#       "Local Dirtied Blocks": 0,
+#       "Local Written Blocks": 0,
+#       "Temp Read Blocks": 0,
+#       "Temp Written Blocks": 0,
+#       "I/O Read Time": 0.000,
+#       "I/O Write Time": 0.000
+#     },
+#     "Settings": {
+#       "cpu_index_tuple_cost": "0.001",
+#       "cpu_operator_cost": "0.0005",
+#       "cpu_tuple_cost": "0.003",
+#       "effective_cache_size": "10800000kB",
+#       "max_parallel_workers_per_gather": "1",
+#       "random_page_cost": "2",
+#       "work_mem": "100MB"
+#     },
+#     "Planning Time": 0.033,
+#     "Triggers": [
+#     ],
+#     "Execution Time": 0.018
+#   }
+# ]
+
+```
+
+The following `format` options are supported `:json, :hash, :yaml, :text, :xml`. Especially the `:json` format is useful because it allows you to visualize a query plan using [a visualizer tool](https://tatiyants.com/pev/#/plans/new).
+
+Optionally you can disable running the `ANALYZE` query and only generate the plan:
+
+```ruby
+
+User.all.analyze(analyze: false)
+
+# EXPLAIN ANALYZE for: SELECT "users".* FROM "users"
+#                         QUERY PLAN
+# ----------------------------------------------------------
+#  Seq Scan on users  (cost=0.00..15.20 rows=520 width=127)
+
+```
+
+### Disclaimer
+
+It is a bit experimental and can break with new Rails release.

data/activerecord-analyze.gemspec

@@ -15,5 +15,5 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(spec)/})
   gem.require_paths = ["lib"]
   gem.license       = "MIT"
-  gem.add_dependency "rails", "~> 5.1.0"
+  gem.add_dependency "rails", ">= 5.1.0"
 end

data/lib/activerecord-analyze.rb

@@ -1,2 +1,4 @@
+require 'activerecord-analyze/main'
+
 module ActiveRecordAnalyze
 end

data/lib/activerecord-analyze/main.rb

@@ -2,9 +2,60 @@ module ActiveRecord
   module ConnectionAdapters
     module PostgreSQL
       module DatabaseStatements
-        def analyze(arel, binds = [])
-          sql = "EXPLAIN ANALYZE #{to_sql(arel, binds)}"
-          PostgreSQL::ExplainPrettyPrinter.new.pp(exec_query(sql, "EXPLAIN ANALYZE", binds))
+        def analyze(arel, binds = [], opts = {})
+          format_sql = if fmt = opts[:format].presence
+            case fmt
+            when :json
+              "FORMAT JSON,"
+            when :hash
+              "FORMAT JSON,"
+            when :yaml
+              "FORMAT YAML,"
+            when :text
+              "FORMAT TEXT,"
+            when :xml
+              "FORMAT XML,"
+            end
+          end
+
+          verbose_sql = if opts[:verbose] == true
+            ", VERBOSE"
+          end
+
+          costs_sql = if opts[:costs] == true
+            ", COSTS"
+          end
+
+          settings_sql = if opts[:settings] == true
+            ", SETTINGS"
+          end
+
+          buffers_sql = if opts[:buffers] == true
+            ", BUFFERS"
+          end
+
+          timing_sql = if opts[:timing] == true
+            ", TIMING"
+          end
+
+          summary_sql = if opts[:summary] == true
+            ", SUMMARY"
+          end
+
+          analyze_sql = if opts[:analyze] == false
+            ""
+          else
+            "ANALYZE"
+          end
+
+          opts_sql = "(#{format_sql} #{analyze_sql}#{verbose_sql}#{costs_sql}#{settings_sql}#{buffers_sql}#{timing_sql}#{summary_sql})"
+          .strip.gsub(/\s+/, " ")
+          .gsub(/\(\s?\s?\s?,/, "(")
+          .gsub(/\s,\s/, " ")
+          .gsub(/\(\s?\)/, "")
+
+          sql = "EXPLAIN #{opts_sql} #{to_sql(arel, binds)}"
+          PostgreSQL::ExplainPrettyPrinter.new.pp(exec_query(sql, "EXPLAIN #{opts_sql}".strip, binds))
         end
       end
     end
@@ -13,23 +64,40 @@ end
 
 module ActiveRecord
   class Relation
-    def analyze
-      exec_analyze(collecting_queries_for_explain { exec_queries })
+    def analyze(opts = {})
+      res = exec_analyze(collecting_queries_for_explain { exec_queries }, opts)
+      if [:json, :hash].include?(opts[:format])
+        raw_json = "[" + res[/\[(.*?)(\(\d row)/m, 1]
+
+        if opts[:format] == :json
+          JSON.parse(raw_json).to_json
+        elsif opts[:format] == :hash
+          JSON.parse(raw_json)
+        end
+      else
+        res
+      end
     end
   end
 end
 
 module ActiveRecord
   module Explain
-    def exec_analyze(queries) # :nodoc:
+    def exec_analyze(queries, opts = {}) # :nodoc:
       str = queries.map do |sql, binds|
-        msg = "EXPLAIN ANALYZE for: #{sql}".dup
+        analyze_msg = if opts[:analyze] == false
+          ""
+        else
+          " ANALYZE"
+        end
+
+        msg = "EXPLAIN#{analyze_msg} for: #{sql}".dup
         unless binds.empty?
           msg << " "
           msg << binds.map { |attr| render_bind(attr) }.inspect
         end
         msg << "\n"
-        msg << connection.analyze(sql, binds)
+        msg << connection.analyze(sql, binds, opts)
       end.join("\n")
 
       # Overriding inspect to be more human readable, especially in the console.

data/lib/activerecord-analyze/version.rb

@@ -1,3 +1,3 @@
 module ActiveRecordAnalyze
-  VERSION = "0.1.0"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-analyze
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.5.0
 platform: ruby
 authors:
 - pawurb
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-03-11 00:00:00.000000000 Z
+date: 2021-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 5.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 5.1.0
 description: ' Gem adds an "analyze" method to all Active Record query objects. Compatible
@@ -45,7 +45,7 @@ homepage: http://github.com/pawurb/activerecord-analyze
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -60,9 +60,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Add EXPLAIN ANALYZE to Active Record query objects
 test_files: []