rails-pg-extras 1.1.0 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 780e5bd6ea4fb796ff83e4e249ac603ae7a74bf4a11d6e7414a72f82a433926c
-  data.tar.gz: 3499bfe705e3bcde82fa4b6417cbd275d3c9cbea6f57b03db384a3b370323020
+  metadata.gz: 808e77df9b7f529b420f7a88775e90e031b055dd26804fd61a80b6fc2e8d96b7
+  data.tar.gz: '01853117599237d182f2edb901550cf52ba46691a98e1f8a1f2594f139b90e4b'
 SHA512:
-  metadata.gz: a790f7359529dc48fce3ae4632742565a0de41b4d9463c419a1cd676361a40fed66f26e84e0d19611f466b533f67927813747a05d5e2d517b348e6be04bc5843
-  data.tar.gz: 5bb4bf5375df56cb3a48338e6e785cc9dd11d9859ab7c6290e5367c84b390f8c4433131920854f8fcc188df20f1bf55542c807d15a3bb3eee32d62a9888ec652
+  metadata.gz: e2d7d8a9558dea4637026b9c165942816c77527229172ca398c81ee0badc940e0c970f4049b2464d2aa667cef83ec43f11d8afd0c253203fda98b47f6703e87f
+  data.tar.gz: 7f4975baacf9d2822eeca20f260f03debec3dabb1e11544c48bf4b0a323393c8966a792b64e91777e95758c29cc69a1295660174195ddb66310c9601fd66d148

data/README.md

@@ -4,7 +4,17 @@ Rails port of [Heroku PG Extras](https://github.com/heroku/heroku-pg-extras) wit
 
 Included rake tasks and Ruby methods 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.
 
-Not using Rails? Check out the core dependency [pure Ruby version](https://github.com/pawurb/ruby-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:
+
+- Core dependency - [Ruby](https://github.com/pawurb/ruby-pg-extras)
+
+- [NodeJS](https://github.com/pawurb/node-postgres-extras)
+
+- [Elixir](https://github.com/pawurb/ecto_psql_extras)
+
+- [Python](https://github.com/pawurb/ecto_psql_extras)
 
 ## Installation
 
@@ -14,6 +24,19 @@ In your Gemfile
 gem "rails-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
+RailsPGExtras.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
 
 Each command can be used as a rake task, or a directly from the Ruby code.
@@ -243,12 +266,12 @@ $ rake pg_extras: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`
 
 ```
-$ rake pg_extras:table-indexes-size
+$ rake pg_extras:table_indexes_size
 
                              table                             | indexes_size
 ---------------------------------------------------------------+--------------
@@ -260,7 +283,7 @@ $ rake pg_extras: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`
 
@@ -277,7 +300,7 @@ $ rake pg_extras: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`
 
@@ -398,6 +421,16 @@ RailsPGExtras.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.
 
+### `extensions`
+
+```ruby
+
+RailsPGExtras.extensions
+
+```
+
+This command lists all the currently installed and available PostgreSQL extensions.
+
 ### mandelbrot
 
 ```
@@ -405,9 +438,3 @@ $ rake pg_extras:mandelbrot
 ```
 
 This command outputs the Mandelbrot set, calculated through SQL.
-
-## FAQ
-
-* Does is not violate the Heroku PG Extras license?
-
-The original plugin is MIT based so it means that copying and redistribution in any format is permitted.

data/lib/rails-pg-extras/tasks/all.rake

@@ -3,9 +3,19 @@
 require 'rails-pg-extras'
 
 namespace :pg_extras do
+  task :establish_connection do
+    if ENV['DATABASE_URL'].present?
+      ActiveRecord::Base.establish_connection(ENV['DATABASE_URL'])
+    else
+      db_config_file = File.read('config/database.yml')
+      db_config = YAML::load(ERB.new(db_config_file).result)
+      ActiveRecord::Base.establish_connection(db_config[Rails.env])
+    end
+  end
+
   RailsPGExtras::QUERIES.each do |query_name|
     desc RubyPGExtras.description_for(query_name: query_name)
-    task query_name.to_sym => :environment do
+    task query_name.to_sym => :establish_connection do
       RailsPGExtras.public_send(query_name)
     end
   end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsPGExtras
-  VERSION = "1.1.0"
+  VERSION = "1.2.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-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: ruby-pg-extras
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.4
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -93,7 +93,7 @@ homepage: http://github.com/pawurb/rails-pg-extras
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -108,8 +108,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: Rails PostgreSQL performance database insights
 test_files: