rails-pg-extras 1.3.0 → 1.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb4905b231d556cd0a389c53a77b59e74f6d11faf45d6e3fa9e17b456cd0349a
-  data.tar.gz: 94e5c6c7ba1d48f403b069b5f7b7d24ae25e20f072166cf59d54fa891bf4662a
+  metadata.gz: ec78b739d900e56a89e3a2afd0f714538175d7ea7a816cd00115982ead78f0ed
+  data.tar.gz: ee936f6c5b7d6f48643d1dbe9a3e8245d36cb2369ec8675b3018b5ea9dad8c2a
 SHA512:
-  metadata.gz: 3c41ba2e65e0d892690469fb232d09e58e02aa138ee17155014795963fc86a9be94d4c1d6482ca6e3564ab14a8b9263e1f7828c18ab7173cc3d0f16190ad4e12
-  data.tar.gz: 1aa1554a5c26f89501e59462ed4af2efc90b7d3c16b07922d71a3c7d2140096ffac47c19584edda2b4af0bc45261ea8c35f48431c94451ba86d900b51dd5a705
+  metadata.gz: 98dae06049bf799eca77dfa53b7eb93ce9393c8fdd57e33bf70f993aba6067a507e3e6bb87b8cefee17868453337ca377ad315d9ef356b8980ecf14c4314f1a5
+  data.tar.gz: c34522f7495a1782e215fe07ccfcb0d8bdad630f1ba456e2e8609398137f2dd8cf869c64f0a823a689c814a84eec87bae8dda280150ce1260f4ae2213dd49520

data/README.md

@@ -78,11 +78,20 @@ RailsPGExtras.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
+RailsPGExtras.long_running_queries(args: { threshold: "200 milliseconds" })
+
+```
+
 ## Available methods
 
 ### `cache_hit`
 
 ```
+RailsPGExtras.cache_hit
+
 $ rake pg_extras:cache_hit
 
       name      |         ratio
@@ -98,6 +107,8 @@ This command provides information on the efficiency of the buffer cache, for bot
 
 ```
 
+RailsPGExtras.index_cache_hit
+
 $ rake pg_extras:index_cache_hit
 
 | name                  | buffer_hits | block_reads | total_read | ratio             |
@@ -114,6 +125,8 @@ The same as `cache_hit` with each table's indexes cache hit info displayed separ
 
 ```
 
+RailsPGExtras.table_cache_hit
+
 $ rake pg_extras:table_cache_hit
 
 | name                  | buffer_hits | block_reads | total_read | ratio             |
@@ -129,6 +142,8 @@ The same as `cache_hit` with each table's cache hit info displayed seperately.
 ### `index_usage`
 
 ```
+RailsPGExtras.index_usage
+
 $ rake pg_extras:index_usage
 
        relname       | percent_of_times_index_used | rows_in_table
@@ -146,6 +161,8 @@ This command provides information on the efficiency of indexes, represented as w
 ### `locks`
 
 ```
+RailsPGExtras.locks
+
 $ rake pg_extras:locks
 
  procpid | relname | transactionid | granted |     query_snippet     | mode             |       age
@@ -164,6 +181,8 @@ This command displays queries that have taken out an exclusive lock on a relatio
 ### `all_locks`
 
 ```
+RailsPGExtras.all_locks
+
 $ rake pg_extras:all_locks
 ```
 
@@ -172,6 +191,8 @@ This command displays all the current locks, regardless of their type.
 ### `outliers`
 
 ```
+RubyPGExtras.outliers(args: { limit: 20 })
+
 $ rake pg_extras:outliers
 
                    qry                   |    exec_time     | prop_exec_time |   ncalls    | sync_io_time
@@ -192,6 +213,8 @@ Typically, an efficient query will have an appropriate ratio of calls to total e
 ### `calls`
 
 ```
+RubyPGExtras.calls(args: { limit: 10 })
+
 $ rake pg_extras:calls
 
                    qry                   |    exec_time     | prop_exec_time |   ncalls    | sync_io_time
@@ -209,6 +232,8 @@ This command is much like `pg:outliers`, but ordered by the number of times a st
 ### `blocking`
 
 ```
+RubyPGExtras.blocking
+
 $ rake pg_extras:blocking
 
  blocked_pid |    blocking_statement    | blocking_duration | blocking_pid |                                        blocked_statement                           | blocked_duration
@@ -222,6 +247,8 @@ This command displays statements that are currently holding locks that other sta
 #### `total_index_size`
 
 ```
+RubyPGExtras.total_index_size
+
 $ rake pg_extras:total_index_size
 
   size
@@ -235,6 +262,8 @@ This command displays the total size of all indexes on the database, in MB. It i
 ### `index_size`
 
 ```
+RubyPGExtras.index_size
+
 $ rake pg_extras:index_size
                              name                              |  size
 ---------------------------------------------------------------+---------
@@ -256,6 +285,8 @@ This command displays the size of each each index in the database, in MB. It is
 ### `table_size`
 
 ```
+RubyPGExtras.table_size
+
 $ rake pg_extras:table_size
 
                              name                              |  size
@@ -273,6 +304,8 @@ This command displays the size of each table and materialized view in the databa
 ### `table_indexes_size`
 
 ```
+RubyPGExtras.table_indexes_size
+
 $ rake pg_extras:table_indexes_size
 
                              table                             | indexes_size
@@ -290,6 +323,8 @@ This command displays the total size of indexes for each table and materialized
 ### `total_table_size`
 
 ```
+RubyPGExtras.total_table_size
+
 $ rake pg_extras:total_table_size
 
                              name                              |  size
@@ -307,6 +342,8 @@ This command displays the total size of each table and materialized view in the
 ### `unused_indexes`
 
 ```
+RubyPGExtras.unused_indexes(args: { min_scans: 20 })
+
 $ rake pg_extras:unused_indexes
 
           table      |                       index                | index_size | index_scans
@@ -319,9 +356,29 @@ $ rake pg_extras: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
+
+RailsPGExtras.null_indexes(args: { min_relation_size_mb: 10 })
+
+$ rake pg_extras:null_indexes
+
+   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`
 
 ```
+RubyPGExtras.seq_scans
+
 $ rake pg_extras:seq_scans
 
                name                |  count
@@ -350,6 +407,8 @@ This command displays the number of sequential scans recorded against all tables
 ### `long_running_queries`
 
 ```
+RubyPGExtras.long_running_queries(args: { threshold: "200 milliseconds" })
+
 $ rake pg_extras:long_running_queries
 
   pid  |    duration     |                                      query
@@ -365,6 +424,8 @@ This command displays currently running queries, that have been running for long
 ### `records_rank`
 
 ```
+RubyPGExtras.records_rank
+
 $ rake pg_extras:records_rank
 
                name                | estimated_count
@@ -383,6 +444,8 @@ This command displays an estimated count of rows per table, descending by estima
 ### `bloat`
 
 ```
+RubyPGExtras.bloat
+
 $ rake pg_extras:bloat
 
  type  | schemaname |           object_name         | bloat |   waste
@@ -400,6 +463,8 @@ This command displays an estimation of table "bloat" – space allocated to a re
 ### `vacuum_stats`
 
 ```
+RubyPGExtras.vacuum_stats
+
 $ rake pg_extras:vacuum_stats
 
  schema |         table         | last_vacuum | last_autovacuum  |    rowcount    | dead_rowcount  | autovacuum_threshold | expect_autovacuum
@@ -425,10 +490,15 @@ This commands kills all the currently active connections to the database. It can
 
 ### `extensions`
 
-```ruby
+```
 
 RailsPGExtras.extensions
 
+$ rake pg_extras:extensions
+
+| pg_stat_statements | 1.7 | 1.7 | track execution statistics of all SQL statements executed
+ (truncated results for brevity)
+
 ```
 
 This command lists all the currently installed and available PostgreSQL extensions.
@@ -436,6 +506,8 @@ This command lists all the currently installed and available PostgreSQL extensio
 ### mandelbrot
 
 ```
+RailsPGExtras.mandelbrot
+
 $ rake pg_extras:mandelbrot
 ```
 

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-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: ruby-pg-extras
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.5.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.5.2
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement