pgdexter 0.3.5 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c797cdeb10797636a6406b017fc9276ea6522656f6592769b5088bee56165cfb
-  data.tar.gz: 76dc688fcea9ccde4aead259ef582f6103d62a5f40e7be668ee2b03347a14470
+  metadata.gz: 24fcff313ea4c5d059012c11e379f67c204608abe7445ca46c758d5e4a60cf0b
+  data.tar.gz: d9d78cbb690e6882f6218ae4b2280d6ae8857dff03fe633b9e4dee15be3c218d
 SHA512:
-  metadata.gz: a5ac6bf812b56648ac0b1f864baf025b7cd4e81cccf6d6de65f1780fd63f8f1e640aff53aca771cece0ce54267ad7a428aaba8f42773591380547fac05bfe94a
-  data.tar.gz: 7c0f8b36467cc5eacbc96f6e5e2132de3526ea9827cab9c5ede7e1eff2b471f22948e0b202f1a00fd8b37b785934eec8508ad561947e50efa9b9ffb07e5eb9ae
+  metadata.gz: b95d985d0179089bf824f5822664a4dfa6590e3886cc9e40166d3c621cc752b92563a7900bfc4d2a6774117b8580f77509e510e617e9a0538390529b45556e68
+  data.tar.gz: 7033709e507a94e75b3e5d6c326ebad361665c5172465fdc7090aebe58719a4c3e95ce1553a6e8d19990ff892955737594d08a5f7b3f60ea88056c208128a3d0

data/CHANGELOG.md

@@ -1,34 +1,38 @@
-## 0.3.5
+## 0.3.6 (2020-03-30)
+
+- Fixed warning with Ruby 2.7
+
+## 0.3.5 (2018-04-30)
 
 - Added `sql` input format
 - Fixed error for queries with double dash comments
 - Fixed connection threading issue with `--pg-stat-activity` option
 
-## 0.3.4
+## 0.3.4 (2018-04-09)
 
 - Fixed `--username` option
 - Fixed `JSON::NestingError`
 - Added `--pg-stat-activity` option
 
-## 0.3.3
+## 0.3.3 (2018-02-22)
 
 - Added support for views and materialized views
 - Better handle case when multiple indexes are found for a query
 - Added `--min-cost-savings-pct` option
 
-## 0.3.2
+## 0.3.2 (2018-01-04)
 
 - Fixed parsing issue with named prepared statements
 - Fixed parsing issue with multiline queries in csv format
 - Better explanations for indexing decisions
 
-## 0.3.1
+## 0.3.1 (2017-12-28)
 
 - Added support for queries with bind variables
 - Fixed error with streaming logs as csv format
 - Handle malformed CSV gracefully
 
-## 0.3.0
+## 0.3.0 (2017-12-22)
 
 - Added support for schemas
 - Added support for csv format
@@ -36,12 +40,12 @@
 - Added `--min-calls` option
 - Fixed debug output when indexes not found
 
-## 0.2.1
+## 0.2.1 (2017-09-02)
 
 - Fixed bad suggestions
 - Improved debugging output
 
-## 0.2.0
+## 0.2.0 (2017-08-27)
 
 - Added same connection options as `psql`
 - Added support for multiple files
@@ -52,38 +56,38 @@ Breaking
 
 - `-h` option changed to `--host` instead of `--help` for consistency with `psql`
 
-## 0.1.6
+## 0.1.6 (2017-08-26)
 
 - Significant performance improvements
 - Added `--include` option
 
-## 0.1.5
+## 0.1.5 (2017-08-14)
 
 - Added support for non-`SELECT` queries
 - Added `--pg-stat-statements` option
 - Added advisory locks
 - Added support for running as a non-superuser
 
-## 0.1.4
+## 0.1.4 (2017-07-02)
 
 - Added support for multicolumn indexes
 
-## 0.1.3
+## 0.1.3 (2017-06-30)
 
 - Fixed error with non-lowercase columns
 - Fixed error with `json` columns
 
-## 0.1.2
+## 0.1.2 (2017-06-26)
 
 - Added `--exclude` option
 - Added `--log-sql` option
 
-## 0.1.1
+## 0.1.1 (2017-06-25)
 
 - Added `--interval` option
 - Added `--min-time` option
 - Added `--log-level` option
 
-## 0.1.0
+## 0.1.0 (2017-06-24)
 
 - Launched

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2017 Andrew Kane
+Copyright (c) 2017-2020 Andrew Kane
 
 MIT License
 

data/README.md

@@ -2,7 +2,7 @@
 
 The automatic indexer for Postgres
 
-[Read about how it works](https://medium.com/@ankane/introducing-dexter-the-automatic-indexer-for-postgres-5f8fa8b28f27)
+[Read about how it works](https://ankane.org/introducing-dexter)
 
 [![Build Status](https://travis-ci.org/ankane/dexter.svg?branch=master)](https://travis-ci.org/ankane/dexter)
 
@@ -12,8 +12,8 @@ First, install [HypoPG](https://github.com/HypoPG/hypopg) on your database serve
 
 ```sh
 cd /tmp
-curl -L https://github.com/HypoPG/hypopg/archive/1.1.1.tar.gz | tar xz
-cd hypopg-1.1.1
+curl -L https://github.com/HypoPG/hypopg/archive/1.1.3.tar.gz | tar xz
+cd hypopg-1.1.3
 make
 make install # may need sudo
 ```
@@ -228,18 +228,18 @@ Everyone is encouraged to help improve this project. Here are a few ways you can
 - Write, clarify, or fix documentation
 - Suggest or add new features
 
-To get started, run:
+To get started with development, run:
 
 ```sh
 git clone https://github.com/ankane/dexter.git
 cd dexter
-bundle
-rake install
+bundle install
+bundle exec rake install
 ```
 
 To run tests, use:
 
 ```sh
 createdb dexter_test
-rake test
+bundle exec rake test
 ```

data/exe/dexter

@@ -1,10 +1,11 @@
 #!/usr/bin/env ruby
 
+# disable Slop warning with Ruby 2.7
+# TODO remove when Slop > 4.8.0 is released
+$VERBOSE = nil
+
+# handle interrupts
+trap("SIGINT") { abort }
+
 require "dexter"
-begin
-  Dexter::Client.new(ARGV).perform
-rescue Dexter::Abort => e
-  abort e.message
-rescue Interrupt => e
-  # do nothing
-end
+Dexter::Client.start

data/lib/dexter.rb

@@ -1,10 +1,14 @@
-require "dexter/version"
-require "slop"
+# dependencies
 require "pg"
 require "pg_query"
-require "time"
+require "slop"
+
+# stdlib
 require "set"
-require "thread"
+require "time"
+
+# modules
+require "dexter/version"
 require "dexter/logging"
 require "dexter/client"
 require "dexter/collector"

data/lib/dexter/client.rb

@@ -4,6 +4,12 @@ module Dexter
 
     attr_reader :arguments, :options
 
+    def self.start
+      Dexter::Client.new(ARGV).perform
+    rescue Dexter::Abort => e
+      abort e.message
+    end
+
     def initialize(args)
       @arguments, @options = parse_args(args)
     end

data/lib/dexter/indexer.rb

@@ -107,13 +107,13 @@ module Dexter
       analyze_tables(tables) if tables.any? && (@analyze || @log_level == "debug2")
 
       # create hypothetical indexes and explain queries
-      candidates = tables.any? ? create_hypothetical_indexes(queries.select(&:candidate_tables), tables) : {}
+      candidates = tables.any? ? create_hypothetical_indexes(queries.select(&:candidate_tables)) : {}
 
       # see if new indexes were used and meet bar
       new_indexes = determine_indexes(queries, candidates, tables)
 
       # display and create new indexes
-      show_and_create_indexes(new_indexes, queries, tables)
+      show_and_create_indexes(new_indexes, queries)
     end
 
     private
@@ -193,7 +193,7 @@ module Dexter
       end
     end
 
-    def create_hypothetical_indexes(queries, tables)
+    def create_hypothetical_indexes(queries)
       candidates = {}
 
       # get initial costs for queries
@@ -417,7 +417,7 @@ module Dexter
       end
     end
 
-    def show_and_create_indexes(new_indexes, queries, tables)
+    def show_and_create_indexes(new_indexes, queries)
       # print summary
       if new_indexes.any?
         new_indexes.each do |index|

data/lib/dexter/sql_log_parser.rb

@@ -3,7 +3,7 @@ module Dexter
     def perform
       # TODO support streaming
       @logfile.read.split(";").each do |statement|
-        process_entry(statement, 1)
+        process_entry(statement, 0)
       end
     end
   end

data/lib/dexter/version.rb

@@ -1,3 +1,3 @@
 module Dexter
-  VERSION = "0.3.5"
+  VERSION = "0.3.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pgdexter
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.6
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-30 00:00:00.000000000 Z
+date: 2020-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slop
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.18.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.18.2
 - !ruby/object:Gem::Dependency
   name: pg_query
   requirement: !ruby/object:Gem::Requirement
@@ -95,23 +95,16 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: 
-email:
-- andrew@chartkick.com
+email: andrew@chartkick.com
 executables:
 - dexter
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - exe/dexter
-- guides/Hosted-Postgres.md
-- guides/Linux.md
 - lib/dexter.rb
 - lib/dexter/client.rb
 - lib/dexter/collector.rb
@@ -124,9 +117,9 @@ files:
 - lib/dexter/query.rb
 - lib/dexter/sql_log_parser.rb
 - lib/dexter/version.rb
-- pgdexter.gemspec
 homepage: https://github.com/ankane/dexter
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -136,15 +129,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: The automatic indexer for Postgres

data/.gitignore

@@ -1,9 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/

data/.travis.yml

@@ -1,18 +0,0 @@
-language: ruby
-rvm: 2.4.1
-cache: bundler
-script: bundle exec rake test
-addons:
-  postgresql: "9.6"
-before_script:
-  - sudo apt-get install postgresql-server-dev-9.6
-  - git clone https://github.com/HypoPG/hypopg.git
-  - cd hypopg
-  - git checkout 1.1.1
-  - make
-  - sudo make install
-  - psql -c 'create database dexter_test;' -U postgres
-notifications:
-  email:
-    on_success: never
-    on_failure: change

data/Gemfile

@@ -1,4 +0,0 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in dexter.gemspec
-gemspec

data/Rakefile

@@ -1,11 +0,0 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
-  t.warning = false
-end
-
-task default: :test

data/guides/Hosted-Postgres.md

@@ -1,102 +0,0 @@
-# Hosted Postgres
-
-Some hosted providers like Amazon RDS and Heroku do not support the HypoPG extension, which Dexter needs to run. Hopefully this will change with time. For now, we can spin up a separate database instance to run Dexter. It’s not super convenient, but can be useful to do from time to time.
-
-### Install Postgres and Ruby
-
-Linux
-
-```sh
-sudo sh -c 'echo "deb http://apt.postgresql.org/pub/repos/apt/ $(lsb_release -cs)-pgdg main" > /etc/apt/sources.list.d/pgdg.list'
-sudo apt-get install -y wget ca-certificates
-wget --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | sudo apt-key add -
-sudo apt-get update
-sudo apt-get install -y postgresql-9.6 postgresql-server-dev-9.6
-sudo -u postgres createuser $(whoami) -s
-sudo apt-get install -y ruby2.2 ruby2.2-dev
-```
-
-Mac
-
-```sh
-brew install postgresql
-brew install ruby
-```
-
-### Install HypoPG and Dexter
-
-HypoPG
-
-```sh
-cd /tmp
-curl -L https://github.com/dalibo/hypopg/archive/1.0.0.tar.gz | tar xz
-cd hypopg-1.0.0
-make
-make install # may need sudo
-```
-
-Dexter
-
-```sh
-gem install pgdexter # may need sudo
-```
-
-### Download logs
-
-#### Amazon RDS
-
-Create an IAM user with the policy below:
-
-```
-{
-  "Statement": [
-    {
-      "Action": [
-        "rds:DescribeDBLogFiles",
-        "rds:DownloadDBLogFilePortion"
-      ],
-      "Effect": "Allow",
-      "Resource": "*"
-    }
-  ]
-}
-```
-
-And run:
-
-```sh
-aws configure
-gem install pghero_logs # may need sudo
-pghero_logs download <instance-id>
-```
-
-#### Heroku
-
-Production-tier databases only
-
-```sh
-heroku logs -p postgres > postgresql.log
-```
-
-### Dump and restore
-
-We recommend creating a new instance from a snapshot for the dump to avoid affecting customers.
-
-```sh
-pg_dump -v -j 8 -Fd -f /tmp/newout.dir <connection-options>
-```
-
-Then shutdown the dump instance. Restore with:
-
-```sh
-createdb dexter_restore
-pg_restore -v -j 8 -x -O --format=d -d dexter_restore /tmp/newout.dir/
-```
-
-### Run Dexter
-
-```sh
-dexter dexter_restore postgresql.log* --analyze
-```
-
-:tada:

data/guides/Linux.md

@@ -1,72 +0,0 @@
-# Linux Packages
-
-Distributions
-
-- [Ubuntu 16.04 (Xenial)](#ubuntu-1604-xenial)
-- [Ubuntu 14.04 (Trusty)](#ubuntu-1404-trusty)
-- [Debian 9 (Stretch)](#debian-9-stretch)
-- [Debian 8 (Jesse)](#debian-8-jesse)
-- [CentOS / RHEL 7](#centos--rhel-7)
-- [SUSE Linux Enterprise Server 12](#suse-linux-enterprise-server-12)
-
-### Ubuntu 16.04 (Xenial)
-
-```sh
-wget -qO- https://dl.packager.io/srv/pghero/dexter/key | sudo apt-key add -
-sudo wget -O /etc/apt/sources.list.d/dexter.list \
-  https://dl.packager.io/srv/pghero/dexter/master/installer/ubuntu/16.04.repo
-sudo apt-get update
-sudo apt-get -y install dexter
-```
-
-### Ubuntu 14.04 (Trusty)
-
-```sh
-wget -qO- https://dl.packager.io/srv/pghero/dexter/key | sudo apt-key add -
-sudo wget -O /etc/apt/sources.list.d/dexter.list \
-  https://dl.packager.io/srv/pghero/dexter/master/installer/ubuntu/14.04.repo
-sudo apt-get update
-sudo apt-get install dexter
-```
-
-### Debian 9 (Stretch)
-
-```sh
-sudo apt-get -y install apt-transport-https
-wget -qO- https://dl.packager.io/srv/pghero/dexter/key | sudo apt-key add -
-sudo wget -O /etc/apt/sources.list.d/dexter.list \
-  https://dl.packager.io/srv/pghero/dexter/master/installer/debian/9.repo
-sudo apt-get update
-sudo apt-get install dexter
-```
-
-### Debian 8 (Jesse)
-
-```sh
-sudo apt-get -y install apt-transport-https
-wget -qO- https://dl.packager.io/srv/pghero/dexter/key | sudo apt-key add -
-sudo wget -O /etc/apt/sources.list.d/dexter.list \
-  https://dl.packager.io/srv/pghero/dexter/master/installer/debian/8.repo
-sudo apt-get update
-sudo apt-get install dexter
-```
-
-### CentOS / RHEL 7
-
-```sh
-sudo wget -O /etc/yum.repos.d/dexter.repo \
-  https://dl.packager.io/srv/pghero/dexter/master/installer/el/7.repo
-sudo yum install dexter
-```
-
-### SUSE Linux Enterprise Server 12
-
-```sh
-sudo wget -O /etc/zypp/repos.d/dexter.repo \
-  https://dl.packager.io/srv/pghero/dexter/master/installer/sles/12.repo
-sudo zypper install dexter
-```
-
-## Credits
-
-:heart: Made possible by [Packager](https://packager.io/)

data/pgdexter.gemspec

@@ -1,30 +0,0 @@
-# coding: utf-8
-
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "dexter/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "pgdexter"
-  spec.version       = Dexter::VERSION
-  spec.authors       = ["Andrew Kane"]
-  spec.email         = ["andrew@chartkick.com"]
-
-  spec.summary       = "The automatic indexer for Postgres"
-  spec.homepage      = "https://github.com/ankane/dexter"
-
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "slop", ">= 4.2.0"
-  spec.add_dependency "pg"
-  spec.add_dependency "pg_query"
-
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "minitest"
-end