rails-pg-extras 3.0.6 → 3.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e964bd79450c28fff1d34129197b25e09b5dad8a3a6a355a1370ba7de725a2e
-  data.tar.gz: bf67d3b1929cd8495fce8cc9b4f867e8367564b26c118d9147af7dfb32e58115
+  metadata.gz: 4e031e302ba7d1d37ee90ac720128a69fb39c75d83b98bf2f7163e6689019b71
+  data.tar.gz: 5dc53d1aa42831aaa4b208efb60ea0757e2703e47260b63c886d5b242577a216
 SHA512:
-  metadata.gz: d82267114ee40e3ed8d39b2d12427f101a98a9c98f0505ca6ae84a60637e98e676193ba9e21727f1989bb32b95e41ac8414ab6dd6b7084d0f3bba381a4889901
-  data.tar.gz: 32a5bdee701af1f3407a092016a36360000d459ac447e770507c6ec723de072574f52270862f22c8d129bcb055402631121b83c55b54058347e05b098080ee84
+  metadata.gz: febe02de1484d4b29d444bdba8b74b731a6516c93ece6d3f798a39022a93c9447eb14b39edcaa5a6685c39da8d02e107fda3e5760a02922ef2172fbf08bb82a2
+  data.tar.gz: 863595f41a38414e4f8e2fc18cddea442b5f90f9ba2ebc2e906a8db704ef3a9a39c9fc7ad504ba332e8c780018fe1ebbd590d98914e5edadb664afae29b3ad49

data/README.md

@@ -103,6 +103,8 @@ The simplest way to start using pg-extras is to execute a `diagnose` method. It
 
 ```ruby
 RailsPGExtras.diagnose
+
+$ rake pg_extras:diagnose
 ```
 
 ![Diagnose report](https://github.com/pawurb/rails-pg-extras/raw/master/rails-pg-extras-diagnose.png)
@@ -111,6 +113,38 @@ Keep reading to learn about methods that `diagnose` uses under the hood.
 
 ## Available methods
 
+### `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.
+
+```ruby
+RailsPGExtras.table_info(args: { table_name: "users" })
+
+| Table name | Table size | Table cache hit   | Indexes cache hit  | Estimated rows | Sequential scans | Indexes scans |
++------------+------------+-------------------+--------------------+----------------+------------------+---------------+
+| users      | 2432 kB    | 0.999966685701511 | 0.9988780464661853 | 16650          | 2128             | 512496        |
+
+```
+
+### `index_info`
+
+This method returns summary info about database indexes. You can check index size, how often it is used and what percentage of its total size are NULL values. Like the previous method, it aggregates data from other helper methods in an easy-to-digest format.
+
+```ruby
+
+RailsPGExtras.index_info(args: { table_name: "users" })
+
+| Index name                    | Table name | Columns        | Index size | Index scans | Null frac |
++-------------------------------+------------+----------------+------------+-------------+-----------+
+| users_pkey                    | users      | id             | 1152 kB    | 163007      | 0.00%     |
+| index_users_on_slack_id       | users      | slack_id       | 1080 kB    | 258870      | 0.00%     |
+| index_users_on_team_id        | users      | team_id        | 816 kB     | 70962       | 0.00%     |
+| index_users_on_uuid           | users      | uuid           | 1032 kB    | 0           | 0.00%     |
+| index_users_on_block_uuid     | users      | block_uuid     | 776 kB     | 19502       | 100.00%  |
+| index_users_on_api_auth_token | users      | api_auth_token | 1744 kB    | 156         | 0.00%     |
+
+```
+
 ### `cache_hit`
 
 ```ruby

data/lib/rails-pg-extras/index_info.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RailsPGExtras
+  class IndexInfo < RubyPGExtras::IndexInfo
+    private
+
+    def query_module
+      RailsPGExtras
+    end
+  end
+end

data/lib/rails-pg-extras/index_info_print.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module RailsPGExtras
+  class IndexInfoPrint < RubyPGExtras::IndexInfoPrint
+  end
+end

data/lib/rails-pg-extras/table_info.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RailsPGExtras
+  class TableInfo < RubyPGExtras::TableInfo
+    private
+
+    def query_module
+      RailsPGExtras
+    end
+  end
+end

data/lib/rails-pg-extras/table_info_print.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module RailsPGExtras
+  class TableInfoPrint < RubyPGExtras::TableInfoPrint
+  end
+end

data/lib/rails-pg-extras/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsPGExtras
-  VERSION = "3.0.6"
+  VERSION = "3.2.4"
 end

data/lib/rails-pg-extras.rb

@@ -4,6 +4,10 @@ require 'terminal-table'
 require 'ruby-pg-extras'
 require 'rails-pg-extras/diagnose_data'
 require 'rails-pg-extras/diagnose_print'
+require 'rails-pg-extras/index_info'
+require 'rails-pg-extras/index_info_print'
+require 'rails-pg-extras/table_info'
+require 'rails-pg-extras/table_info_print'
 
 module RailsPGExtras
   QUERIES = RubyPGExtras::QUERIES
@@ -58,6 +62,34 @@ module RailsPGExtras
     end
   end
 
+  def self.index_info(args: {}, in_format: :display_table)
+    data = RailsPGExtras::IndexInfo.call(args[:table_name])
+
+    if in_format == :display_table
+      RailsPGExtras::IndexInfoPrint.call(data)
+    elsif in_format == :hash
+      data
+    elsif in_format == :array
+      data.map(&:values)
+    else
+      raise "Invalid 'in_format' argument!"
+    end
+  end
+
+  def self.table_info(args: {}, in_format: :display_table)
+    data = RailsPGExtras::TableInfo.call(args[:table_name])
+
+    if in_format == :display_table
+      RailsPGExtras::TableInfoPrint.call(data)
+    elsif in_format == :hash
+      data
+    elsif in_format == :array
+      data.map(&:values)
+    else
+      raise "Invalid 'in_format' argument!"
+    end
+  end
+
   def self.connection
     ActiveRecord::Base.connection
   end

data/spec/smoke_spec.rb

@@ -3,11 +3,6 @@
 require 'spec_helper'
 
 describe RailsPGExtras do
-  before(:all) do
-    RailsPGExtras.connection.execute("CREATE EXTENSION IF NOT EXISTS pg_buffercache;")
-    RubyPGExtras.connection.exec("CREATE EXTENSION IF NOT EXISTS pg_stat_statements;")
-  end
-
   RailsPGExtras::QUERIES.each do |query_name|
     it "#{query_name} query can be executed" do
       expect do
@@ -18,4 +13,18 @@ describe RailsPGExtras do
       end.not_to raise_error
     end
   end
+
+  it "runs the custom methods" do
+    expect do
+      RailsPGExtras.diagnose(in_format: :hash)
+    end.not_to raise_error
+
+    expect do
+      RailsPGExtras.index_info(in_format: :hash)
+    end.not_to raise_error
+
+    expect do
+      RailsPGExtras.table_info(in_format: :hash)
+    end.not_to raise_error
+  end
 end

data/spec/spec_helper.rb

@@ -24,6 +24,9 @@ RSpec.configure do |config|
     ActiveRecord::Base.establish_connection(
       ENV.fetch("DATABASE_URL")
     )
+    RailsPGExtras.connection.execute("CREATE EXTENSION IF NOT EXISTS pg_stat_statements;")
+    RailsPGExtras.connection.execute("CREATE EXTENSION IF NOT EXISTS pg_buffercache;")
+    RailsPGExtras.connection.execute("CREATE EXTENSION IF NOT EXISTS sslinfo;")
   end
 
   config.after :suite do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-pg-extras
 version: !ruby/object:Gem::Version
-  version: 3.0.6
+  version: 3.2.4
 platform: ruby
 authors:
 - pawurb
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-28 00:00:00.000000000 Z
+date: 2021-12-21 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: 3.0.6
+        version: 3.2.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.0.6
+        version: 3.2.4
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -85,7 +85,11 @@ files:
 - lib/rails-pg-extras.rb
 - lib/rails-pg-extras/diagnose_data.rb
 - lib/rails-pg-extras/diagnose_print.rb
+- lib/rails-pg-extras/index_info.rb
+- lib/rails-pg-extras/index_info_print.rb
 - lib/rails-pg-extras/railtie.rb
+- lib/rails-pg-extras/table_info.rb
+- lib/rails-pg-extras/table_info_print.rb
 - lib/rails-pg-extras/tasks/all.rake
 - lib/rails-pg-extras/version.rb
 - rails-pg-extras-diagnose.png
@@ -112,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.0.3
 signing_key:
 specification_version: 4
 summary: Rails PostgreSQL performance database insights