ruby-pg-extras 1.1.0 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6fe955faca71da76601e1e7d55ca59608a05ead32482d21bcba4fb86763b2916
-  data.tar.gz: c3605758915cee4edcc15e12424513acf5ba26b65d36adb52d8af626807513f6
+  metadata.gz: c1a8fb671f27484df51d29cc3e1a0be5eec628ae9146be825983b533ab88de05
+  data.tar.gz: e5b0857287abe7efd8049d0977f5091f96c73f3dd1684910883c9c3f2f0f3c39
 SHA512:
-  metadata.gz: 6414a45110bcd0404f3d36f3f074f65ed86560989c2e25f245c38d2ea694cdac961c94d58790235d3e5d80937ca62f27f0565dc007a0e8a9f32ecdeca1a9a711
-  data.tar.gz: 1808fb4368882f5727926c8722e018be2d25b98395374df129c8cd9238568d43cec29cc3bfae79aa775ec6100958579818aa158daeb84980c1a478dedaf053f5
+  metadata.gz: c54949bfff9d743bf9024b2b0c9a125cd714e7a1513ca61a3258c2ae5ee28019bbf83c94ceb4f7a0261fdf6ac7c72a720736e6010358d6d110324cd3ca1c2fb5
+  data.tar.gz: 1a7b95e8e1e8b4a38775f3f9b483c6061bcb0d423c42e839c6a78cd398b47b6f692e4b881c99f8644510baa027f3270722573fa6d2c300402ae7a88506fe66c2

data/README.md

@@ -4,7 +4,17 @@ 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).
+
+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
 
@@ -14,6 +24,19 @@ In your Gemfile
 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
 
 Gem expects the `ENV['DATABASE_URL']` value in the following format:
@@ -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`
 
@@ -424,18 +447,22 @@ RubyPGExtras.kill_all
 
 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.
 
-### `mandelbrot`
+### `extensions`
 
 ```ruby
 
-RubyPGExtras.mandelbrot
+RubyPGExtras.extensions
 
 ```
 
-This command outputs the Mandelbrot set, calculated through SQL.
+This command lists all the currently installed and available PostgreSQL extensions.
 
-## FAQ
+### `mandelbrot`
 
-* 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.mandelbrot
+
+```
+
+This command outputs the Mandelbrot set, calculated through SQL.

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.1.0"
+  VERSION = "1.2.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-pg-extras
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.4
 platform: ruby
 authors:
 - pawurb
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-23 00:00:00.000000000 Z
+date: 2020-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -114,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
@@ -129,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: