rails-pg-extras 4.12.2 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 704a88d0240b75de358954e7c24399b580b112a0d39da66ebab10b1b6c873c68
-  data.tar.gz: 3323892eb17b871ff0980f782c92f90f7f6c482d4104d155dde4e05c94211704
+  metadata.gz: f1b2e490792ca16221528d9b86cc3631420e09ceeeb7162c4cdad45e520a9a03
+  data.tar.gz: f6e40c1f217b8d621e76420601d8f051f0cb897a46ed6cb0d5f1be86c882ef2f
 SHA512:
-  metadata.gz: 88564f72410fa57d18c7f8a6fd7531d98ae0a3bc46dcd98873bd0fba9821c68df542b875726c0db0c7e3a285019e5627130ac514c1c434361a12cd8a03ca4c9d
-  data.tar.gz: accc7532505e69f17382391d434cd4b610c5ee6a73a18fc8bcc40734b41c91fc5e10cd39e2c8125d41fd80ad6f4a836eb7596be67c00e56dfe0b3afc44b933d2
+  metadata.gz: e010da06f594274147283f6a9aba8cdf82efc9802564639ace819194897ce97108d96323049c7a718fd91a84a2e92a9270009278738414b592d7871ff3a6ff8d
+  data.tar.gz: fc6291563b877bcd6ad8af7bc25676c9ae5bf1843a1c551d6a57c36fa7a3571bb58c3124e931a4214a5859498ec9f6a8fb4fc9cee0a6bd23f265adcc4f657ef5

data/README.md

@@ -51,6 +51,12 @@ You should see the similar line in the output:
 RailsPgExtras.add_extensions
 ```
 
+By deafult a primary ActiveRecord database connection is used for running metadata queries, rake tasks and web UI. To connect to a different database you can specify an `ENV['RAILS_PG_EXTRAS_DATABASE_URL']` value in the following format:
+
+```ruby
+ENV["RAILS_PG_EXTRAS_DATABASE_URL"] = "postgresql://postgres:secret@localhost:5432/database_name"
+```
+
 ## Usage
 
 Each command can be used as a rake task, or a directly from the Ruby code.
@@ -134,6 +140,27 @@ end
 
 ## Available methods
 
+### `queries_data`
+
+This method allows checking query types executed when running a provided Ruby snippet. It can help debug N+1 issues and review the impact of adding eager loading:
+
+```ruby
+
+User.queries_data { User.limit(10).map(&:team) }
+
+# {:count=>11,
+#  :queries=>
+#   {"SELECT \"users\".* FROM \"users\" LIMIT $1"=>1,
+#    "SELECT \"teams\".* FROM \"teams\" WHERE \"teams\".\"id\" = $1 LIMIT $2"=>10}}
+
+User.queries_data { User.limit(10).includes(:team).map(&:team) }
+
+# {:count=>2,
+#  :queries=>
+#   {"SELECT \"users\".* FROM \"users\" LIMIT $1"=>1,
+#    "SELECT \"teams\".* FROM \"teams\" WHERE \"teams\".\"id\" IN ($1, $2, $3, $4, $5, $6, $7, $8)"=>1}}
+```
+
 ### `table_info`
 
 This method displays metadata metrics for all or a selected table. You can use it to check the table's size, its cache hit metrics, and whether it is correctly indexed. Many sequential scans or no index scans are potential indicators of misconfigured indexes. This method aggregates data provided by other methods in an easy to analyze summary format.

data/lib/rails-pg-extras.rb

@@ -62,6 +62,23 @@ module RailsPgExtras
     end
   end
 
+  def self.queries_data(&block)
+    queries = Hash.new(0)
+    subscriber = ActiveSupport::Notifications.subscribe("sql.active_record") do |_name, _start, _finish, _id, payload|
+      unless payload[:name] =~ /SCHEMA/
+        queries[payload[:sql]] += 1
+      end
+    end
+
+    block.call
+
+    ActiveSupport::Notifications.unsubscribe(subscriber)
+    {
+      count: queries.values.sum,
+      queries: queries
+    }
+  end
+
   def self.index_info(args: {}, in_format: :display_table)
     data = RailsPgExtras::IndexInfo.call(args[:table_name])
 
@@ -91,7 +108,11 @@ module RailsPgExtras
   end
 
   def self.connection
-    ActiveRecord::Base.connection
+    if (db_url = ENV['RAILS_PG_EXTRAS_DATABASE_URL'])
+      ActiveRecord::Base.establish_connection(db_url).connection
+    else
+      ActiveRecord::Base.connection
+    end
   end
 end
 

data/lib/rails_pg_extras/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsPgExtras
-  VERSION = "4.12.2"
+  VERSION = "5.0.0"
 end

data/spec/smoke_spec.rb

@@ -28,4 +28,19 @@ describe RailsPgExtras do
       RailsPgExtras.table_info(in_format: :hash)
     end.not_to raise_error
   end
+
+  it "collecting queries data works" do
+    output = RailsPgExtras.queries_data { RailsPgExtras.diagnose(in_format: :hash) }
+    expect(output.fetch(:count)).to eq 10
+  end
+
+  it "supports custom RAILS_PG_EXTRAS_DATABASE_URL" do
+    ENV['RAILS_PG_EXTRAS_DATABASE_URL'] = ENV['DATABASE_URL']
+
+    expect do
+      RailsPgExtras.calls
+    end.not_to raise_error
+
+    ENV['RAILS_PG_EXTRAS_DATABASE_URL'] = nil
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-pg-extras
 version: !ruby/object:Gem::Version
-  version: 4.12.2
+  version: 5.0.0
 platform: ruby
 authors:
 - pawurb
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-03 00:00:00.000000000 Z
+date: 2023-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-pg-extras
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.12.2
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.12.2
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement