ruby-pg-extras 1.3.0 → 1.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d6fbc5ab6b75d6afab360ce585c6b99da6f7c7622da5c7d41ef5c9a352cf1d0
-  data.tar.gz: d6065e2b079138d523ea47dd5855793e6c53d45d7d0f59f6035a3f0cc22e97d1
+  metadata.gz: 5536e950d12ba0a63deee72240de7d657f7cf33e8c5bb93622a5a29c6ba4898f
+  data.tar.gz: 8fa1ecf9537e4d4b8774e5fbbd37e7f329dd3d31a37ad83a93a7c1b5ad4fa9c4
 SHA512:
-  metadata.gz: 06235baa16b1433f94c6df83cdd764792ab85217ea0dae0880fedf981f84e7e4a12748e267462bc99a69096dd7706cf6893680d24f7b1e7da5fc8c502e4bc9fb
-  data.tar.gz: 0cce03aa9d5e05cc826c4d4835fc4fc8c3d50f3d062dfbdd7deec85d4b51366de68e264d3e3023f509464144ab80ae983975cecb50aaf3d333b1a8e0962df878
+  metadata.gz: 836b17e1988508f27adcd8138f3d5d5c070e93bbb7ce28ad9e8f254582092798225d3cc96d5dce827662d9fcd98e82cbf08d5ea789cb2c3d65614f9865a7d134
+  data.tar.gz: de4d8f3511a66e1d636fa47fcccf828ad3bb9a6a3e0bb0f26fcf120674c7381b0422c94a210e102b78f4b1f82e56299762bfff85916dd0ee7b5800dfac10bc8d

data/README.md

@@ -85,6 +85,13 @@ RubyPGExtras.cache_hit(in_format: :raw) =>
  #<PG::Result:0x00007f75777f7328 status=PGRES_TUPLES_OK ntuples=2 nfields=2 cmd_tuples=2>
 ```
 
+Some methods accept an optional `args` param allowing you to customize queries:
+
+```ruby
+RubyPGExtras.long_running_queries(args: { threshold: "200 milliseconds" })
+
+```
+
 ## Available methods
 
 ### `cache_hit`
@@ -185,7 +192,7 @@ This command displays all the current locks, regardless of their type.
 
 ```ruby
 
-RubyPGExtras.outliers
+RubyPGExtras.outliers(args: { limit: 20 })
 
                    qry                   |    exec_time     | prop_exec_time |   ncalls    | sync_io_time
 -----------------------------------------+------------------+----------------+-------------+--------------
@@ -207,7 +214,7 @@ Typically, an efficient query will have an appropriate ratio of calls to total e
 
 ```ruby
 
-RubyPGExtras.calls
+RubyPGExtras.calls(args: { limit: 10 })
 
                    qry                   |    exec_time     | prop_exec_time |   ncalls    | sync_io_time
 -----------------------------------------+------------------+----------------+-------------+--------------
@@ -332,7 +339,7 @@ This command displays the total size of each table and materialized view in the
 
 ```ruby
 
-RubyPGExtras.unused_indexes
+RubyPGExtras.unused_indexes(args: { min_scans: 20 })
 
           table      |                       index                | index_size | index_scans
 ---------------------+--------------------------------------------+------------+-------------
@@ -344,6 +351,22 @@ RubyPGExtras.unused_indexes
 
 This command displays indexes that have < 50 scans recorded against them, and are greater than 5 pages in size, ordered by size relative to the number of index scans. This command is generally useful for eliminating indexes that are unused, which can impact write performance, as well as read performance should they occupy space in memory.
 
+### `null_indexes`
+
+```ruby
+
+RubyPGExtras.null_indexes(args: { min_relation_size_mb: 10 })
+
+   oid   |         index      | index_size | unique | indexed_column | null_frac | expected_saving
+---------+--------------------+------------+--------+----------------+-----------+-----------------
+  183764 | users_reset_token  | 1445 MB    | t      | reset_token    |   97.00%  | 1401 MB
+   88732 | plan_cancelled_at  | 539 MB     | f      | cancelled_at   |    8.30%  | 44 MB
+ 9827345 | users_email        | 18 MB      | t      | email          |   28.67%  | 5160 kB
+
+```
+
+This commands displays indexes that contain `NULL` values. A high ratio of `NULL` values means that using a partial index excluding them will be beneficial in case they are not used for searching. [Source and more info](https://hakibenita.com/postgresql-unused-index-size).
+
 ### `seq_scans`
 
 ```ruby
@@ -370,7 +393,7 @@ This command displays the number of sequential scans recorded against all tables
 
 ```ruby
 
-RubyPGExtras.long_running_queries
+RubyPGExtras.long_running_queries(args: { threshold: "200 milliseconds" })
 
 
   pid  |    duration     |                                      query

data/lib/ruby-pg-extras.rb

@@ -10,7 +10,7 @@ module RubyPGExtras
   QUERIES = %i(
     bloat blocking cache_hit
     calls extensions table_cache_hit index_cache_hit
-    index_size index_usage locks all_locks
+    index_size index_usage null_indexes locks all_locks
     long_running_queries mandelbrot outliers
     records_rank seq_scans table_indexes_size
     table_size total_index_size total_table_size
@@ -19,9 +19,10 @@ module RubyPGExtras
 
   DEFAULT_ARGS = Hash.new({}).merge({
     calls: { limit: 10 },
-    long_running_queries: { interval: '5 seconds' },
+    long_running_queries: { threshold: "500 milliseconds" },
     outliers: { limit: 10 },
-    unused_indexes: { min_scans: 50 }
+    unused_indexes: { min_scans: 50 },
+    null_indexes: { min_relation_size_mb: 10 }
   })
 
   QUERIES.each do |query_name|

data/lib/ruby-pg-extras/queries/long_running_queries.sql

@@ -1,4 +1,4 @@
-/* All queries longer than five minutes by descending duration */
+/* All queries longer than the threshold by descending duration */
 
 SELECT
   pid,
@@ -9,6 +9,6 @@ FROM
 WHERE
   pg_stat_activity.query <> ''::text
   AND state <> 'idle'
-  AND now() - pg_stat_activity.query_start > interval '%{interval}'
+  AND now() - pg_stat_activity.query_start > interval '%{threshold}'
 ORDER BY
   now() - pg_stat_activity.query_start DESC;

data/lib/ruby-pg-extras/queries/null_indexes.sql

@@ -0,0 +1,33 @@
+/* Find indexes with a high ratio of NULL values */
+
+SELECT
+    c.oid,
+    c.relname AS index,
+    pg_size_pretty(pg_relation_size(c.oid)) AS index_size,
+    i.indisunique AS unique,
+    a.attname AS indexed_column,
+    CASE s.null_frac
+        WHEN 0 THEN ''
+        ELSE to_char(s.null_frac * 100, '999.00%%')
+    END AS null_frac,
+    pg_size_pretty((pg_relation_size(c.oid) * s.null_frac)::bigint) AS expected_saving
+FROM
+    pg_class c
+    JOIN pg_index i ON i.indexrelid = c.oid
+    JOIN pg_attribute a ON a.attrelid = c.oid
+    JOIN pg_class c_table ON c_table.oid = i.indrelid
+    JOIN pg_indexes ixs ON c.relname = ixs.indexname
+    LEFT JOIN pg_stats s ON s.tablename = c_table.relname AND a.attname = s.attname
+WHERE
+    -- Primary key cannot be partial
+    NOT i.indisprimary
+    -- Exclude already partial indexes
+    AND i.indpred IS NULL
+    -- Exclude composite indexes
+    AND array_length(i.indkey, 1) = 1
+    -- Exclude indexes without null_frac ratio
+    AND coalesce(s.null_frac, 0) != 0
+    -- Larger than threshold
+    AND pg_relation_size(c.oid) > %{min_relation_size_mb} * 1024 ^ 2
+ORDER BY
+  pg_relation_size(c.oid) * s.null_frac DESC;

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubyPGExtras
-  VERSION = "1.3.0"
+  VERSION = "1.5.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-pg-extras
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.5.2
 platform: ruby
 authors:
 - pawurb
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-22 00:00:00.000000000 Z
+date: 2021-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -96,6 +96,7 @@ files:
 - lib/ruby-pg-extras/queries/locks.sql
 - lib/ruby-pg-extras/queries/long_running_queries.sql
 - lib/ruby-pg-extras/queries/mandelbrot.sql
+- lib/ruby-pg-extras/queries/null_indexes.sql
 - lib/ruby-pg-extras/queries/outliers.sql
 - lib/ruby-pg-extras/queries/records_rank.sql
 - lib/ruby-pg-extras/queries/seq_scans.sql