ruby-pg-extras 1.0.0 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31f7c01df2a34c5808c2b8453093e6ce9bf2d55511ac88375279fea78a8d46e9
-  data.tar.gz: a1f285519deb70a92aeb1680a3babb4bca74e7b91ed7d55ff11f188200611046
+  metadata.gz: 390b7ac85682a6c91029781a9cf2e639993048c0c2b9b80a93e0b83ef52ba457
+  data.tar.gz: d84e02a04eaba3ef8d899cfd137139d5bb9d00310480fe0d7a2b70786538a14d
 SHA512:
-  metadata.gz: cd2503652ba87050811d301fa47fff20614c0d3821aea52001c2acb6c6f22b4d1f2de7294408c57b48fe7c657fb8f65c26690f5459f8d0c8c1cd2a4003426c60
-  data.tar.gz: ded972ab987058cbdc701e40a3046a02fa0ca70a315a83effa01a6925adfbb26418e42c1fa7c1413308b411ec73f6ff4179c8957dece6a427686d88c059c1c73
+  metadata.gz: e07b9007849b685743727d590ed095c68868c364a5090f2a030a50bafcfa25b15132f3954d3daa301506ec82210b4a2e2e78ddf21b92bfbcb8643bf8825f38e9
+  data.tar.gz: eda59a08e3ac273743897ab2460a1653ae4c33d1d4ec1b38e38f8a6f7cc44275f984f5231703435191b660181e23c5d75469d9fec498c73f67b3a9a70921ddad

data/README.md

@@ -4,17 +4,40 @@ Ruby port of [Heroku PG Extras](https://github.com/heroku/heroku-pg-extras) with
 
 Queries can be used to obtain information about a Postgres instance, that may be useful when analyzing performance issues. This includes information about locks, index usage, buffer cache hit ratios and vacuum statistics. Ruby API enables developers to easily integrate the tool into e.g. automatic monitoring tasks.
 
-Are you riding on Rails? Check out the [Rails version](https://github.com/pawurb/rails-pg-extras).
+You can check out this blog post for detailed step by step tutorial on how to [optimize PostgreSQL using PG Extras library](https://pawelurbanek.com/postgresql-fix-performance).
 
-### Installation
+Alternative versions:
+
+- [Ruby on Rails](https://github.com/pawurb/rails-pg-extras)
+
+- [NodeJS](https://github.com/pawurb/node-postgres-extras)
+
+- [Elixir](https://github.com/pawurb/ecto_psql_extras)
+
+- [Python](https://github.com/pawurb/python-pg-extras)
+
+## Installation
 
 In your Gemfile
 
 ```ruby
-gem 'ruby-pg-extras'
+gem "ruby-pg-extras"
+```
+
+Some of the queries (e.g., `calls` and `outliers`) require [pg_stat_statements](https://www.postgresql.org/docs/current/pgstatstatements.html) extension enabled.
+
+You can check if it is enabled in your database by running:
+
+```ruby
+RubyPGExtras.extensions
+```
+You should see the similar line in the output:
+
+```bash
+| pg_stat_statements  | 1.7  | 1.7 | track execution statistics of all SQL statements executed |
 ```
 
-### Usage
+## Usage
 
 Gem expects the `ENV['DATABASE_URL']` value in the following format:
 
@@ -60,9 +83,9 @@ RubyPGExtras.cache_hit(in_format: :raw) =>
  #<PG::Result:0x00007f75777f7328 status=PGRES_TUPLES_OK ntuples=2 nfields=2 cmd_tuples=2>
 ```
 
-### Available methods
+## Available methods
 
-#### `cache_hit`
+### `cache_hit`
 
 ```ruby
 
@@ -77,7 +100,7 @@ RubyPGExtras.cache_hit
 
 This command provides information on the efficiency of the buffer cache, for both index reads (`index hit rate`) as well as table reads (`table hit rate`). A low buffer cache hit ratio can be a sign that the Postgres instance is too small for the workload.
 
-#### `index_cache_hit`
+### `index_cache_hit`
 
 ```ruby
 
@@ -93,7 +116,7 @@ RubyPGExtras.index_cache_hit
 
 The same as `cache_hit` with each table's indexes cache hit info displayed seperately.
 
-#### `table_cache_hit`
+### `table_cache_hit`
 
 ```ruby
 
@@ -109,7 +132,7 @@ RubyPGExtras.table_cache_hit
 
 The same as `cache_hit` with each table's cache hit info displayed seperately.
 
-#### `index_usage`
+### `index_usage`
 
 ```ruby
 
@@ -212,7 +235,7 @@ RubyPGExtras.blocking
 
 This command displays statements that are currently holding locks that other statements are waiting to be released. This can be used in conjunction with `pg:locks` to determine which statements need to be terminated in order to resolve lock contention.
 
-#### `total_index_size`
+### `total_index_size`
 
 ```ruby
 
@@ -265,7 +288,7 @@ RubyPGExtras.table_size
 (truncated results for brevity)
 ```
 
-This command displays the size of each table in the database, in MB. It is calculated by using the system administration function `pg_table_size()`, which includes the size of the main data fork, free space map, visibility map and TOAST data.
+This command displays the size of each table and materialized view in the database, in MB. It is calculated by using the system administration function `pg_table_size()`, which includes the size of the main data fork, free space map, visibility map and TOAST data.
 
 ### `table_indexes_size`
 
@@ -283,7 +306,7 @@ RubyPGExtras.table_indexes_size
 (truncated results for brevity)
 ```
 
-This command displays the total size of indexes for each table, in MB. It is calcualtes by using the system administration function `pg_indexes_size()`.
+This command displays the total size of indexes for each table and materialized view, in MB. It is calcualtes by using the system administration function `pg_indexes_size()`.
 
 ### `total_table_size`
 
@@ -301,7 +324,7 @@ RubyPGExtras.total_table_size
 (truncated results for brevity)
 ```
 
-This command displays the total size of each table in the database, in MB. It is calculated by using the system administration function `pg_total_relation_size()`, which includes table size, total index size and TOAST data.
+This command displays the total size of each table and materialized view in the database, in MB. It is calculated by using the system administration function `pg_total_relation_size()`, which includes table size, total index size and TOAST data.
 
 ### `unused_indexes`
 
@@ -341,7 +364,7 @@ RubyPGExtras.seq_scans
 
 This command displays the number of sequential scans recorded against all tables, descending by count of sequential scans. Tables that have very high numbers of sequential scans may be underindexed, and it may be worth investigating queries that read from these tables.
 
-### long_running_queries
+### `long_running_queries`
 
 ```ruby
 
@@ -358,7 +381,7 @@ RubyPGExtras.long_running_queries
 
 This command displays currently running queries, that have been running for longer than 5 minutes, descending by duration. Very long running queries can be a source of multiple issues, such as preventing DDL statements completing or vacuum being unable to update `relfrozenxid`.
 
-### records_rank
+### `records_rank`
 
 ```ruby
 
@@ -377,7 +400,7 @@ RubyPGExtras.records_rank
 
 This command displays an estimated count of rows per table, descending by estimated count. The estimated count is derived from `n_live_tup`, which is updated by vacuum operations. Due to the way `n_live_tup` is populated, sparse vs. dense pages can result in estimations that are significantly out from the real count of rows.
 
-### bloat
+### `bloat`
 
 ```ruby
 
@@ -396,7 +419,7 @@ RubyPGExtras.bloat
 
 This command displays an estimation of table "bloat" – space allocated to a relation that is full of dead tuples, that has yet to be reclaimed. Tables that have a high bloat ratio, typically 10 or greater, should be investigated to see if vacuuming is aggressive enough, and can be a sign of high table churn.
 
-### vacuum_stats
+### `vacuum_stats`
 
 ```ruby
 
@@ -414,22 +437,32 @@ RubyPGExtras.vacuum_stats
 
 This command displays statistics related to vacuum operations for each table, including an estiamtion of dead rows, last autovacuum and the current autovacuum threshold. This command can be useful when determining if current vacuum thresholds require adjustments, and to determine when the table was last vacuumed.
 
-### mandelbrot
+### `kill_all`
 
 ```ruby
 
-RubyPGExtras.mandelbrot
+RubyPGExtras.kill_all
 
 ```
 
-This command outputs the Mandelbrot set, calculated through SQL.
+This commands kills all the currently active connections to the database. It can be useful as a last resort when your database is stuck in a deadlock.
 
-## FAQ
+### `extensions`
 
-* Does is not violate the Heroku PG Extras license?
+```ruby
 
-The original plugin is MIT based so it means that copying and redistribution in any format is permitted.
+RubyPGExtras.extensions
 
-## Disclaimer
+```
 
-This tool is in beta state.
+This command lists all the currently installed and available PostgreSQL extensions.
+
+### `mandelbrot`
+
+```ruby
+
+RubyPGExtras.mandelbrot
+
+```
+
+This command outputs the Mandelbrot set, calculated through SQL.

data/lib/ruby-pg-extras.rb

@@ -14,7 +14,7 @@ module RubyPGExtras
     long_running_queries mandelbrot outliers
     records_rank seq_scans table_indexes_size
     table_size total_index_size total_table_size
-    unused_indexes vacuum_stats
+    unused_indexes vacuum_stats kill_all
   )
 
   QUERIES.each do |query_name|

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

@@ -0,0 +1,6 @@
+/* Kill all the active database connections */
+
+SELECT pg_terminate_backend(pid) FROM pg_stat_activity
+  WHERE pid <> pg_backend_pid()
+  AND query <> '<insufficient privilege>'
+  AND datname = current_database();

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

@@ -6,5 +6,5 @@ FROM pg_class c
 LEFT JOIN pg_namespace n ON (n.oid = c.relnamespace)
 WHERE n.nspname NOT IN ('pg_catalog', 'information_schema')
 AND n.nspname !~ '^pg_toast'
-AND c.relkind='r'
+AND c.relkind IN ('r', 'm')
 ORDER BY pg_indexes_size(c.oid) DESC;

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

@@ -6,5 +6,5 @@ FROM pg_class c
 LEFT JOIN pg_namespace n ON (n.oid = c.relnamespace)
 WHERE n.nspname NOT IN ('pg_catalog', 'information_schema')
 AND n.nspname !~ '^pg_toast'
-AND c.relkind='r'
+AND c.relkind IN ('r', 'm')
 ORDER BY pg_table_size(c.oid) DESC;

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

@@ -6,5 +6,5 @@ FROM pg_class c
 LEFT JOIN pg_namespace n ON (n.oid = c.relnamespace)
 WHERE n.nspname NOT IN ('pg_catalog', 'information_schema')
 AND n.nspname !~ '^pg_toast'
-AND c.relkind='r'
+AND c.relkind IN ('r', 'm')
 ORDER BY pg_total_relation_size(c.oid) DESC;

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RubyPGExtras
-  VERSION = "1.0.0"
+  VERSION = "1.2.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-pg-extras
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.3
 platform: ruby
 authors:
 - pawurb
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-18 00:00:00.000000000 Z
+date: 2020-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -92,6 +92,7 @@ files:
 - lib/ruby-pg-extras/queries/index_cache_hit.sql
 - lib/ruby-pg-extras/queries/index_size.sql
 - lib/ruby-pg-extras/queries/index_usage.sql
+- lib/ruby-pg-extras/queries/kill_all.sql
 - lib/ruby-pg-extras/queries/locks.sql
 - lib/ruby-pg-extras/queries/long_running_queries.sql
 - lib/ruby-pg-extras/queries/mandelbrot.sql
@@ -113,7 +114,7 @@ homepage: http://github.com/pawurb/ruby-pg-extras
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -128,8 +129,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Ruby PostgreSQL performance database insights
 test_files: