pgdexter 0.5.0 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65822d0d98c9641efdc3146295e098e09e83348ed109b856670a03d74ed2d70b
-  data.tar.gz: 6d16c9019172e5e69df056ac358588151fa52ae9e8256159547e1842e2f9b97c
+  metadata.gz: e51edc18f4049b9ca811e4662248aa7a23e748b000975a87fa4a431f49ec632b
+  data.tar.gz: f3aa243431e0aab1d84d4cbc48ee6a329581acedc7a9c70e2a13e7bb0e15b529
 SHA512:
-  metadata.gz: 4991adea5ee65493ea99abe94c19360fc6cc718048784431409abc08fbaf1b1efe3b304dedbd0994d8b66b38294b41ea6400bf5de1f03f09694723a7b709e77c
-  data.tar.gz: 00f47a3efd2de6565dd5f5a3a64caa4b610e282d16620975376876501130a6d0cdbbef9412254b8f3d09db2df7a1f3f62d3a8e581c4fcfecd27ea3224cb6f20f
+  metadata.gz: 67b04a3c336c3bec239490a386825153699c646a01f5fe30d84b42445695f2431b1545bace72c5b955e03e92ad531810b5a73971d559abb06f175a1965454b89
+  data.tar.gz: 63691b01566b54056201c2d0a5c73a8153252b7c2ce4619983feb3b20e58d49d4a738b210be61d46231d3b5c78c1787664c625c0eb0216ee0d9ba19dcc8a7621

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 0.5.2 (2024-01-10)
+
+- Added Docker image for `linux/arm64`
+- Switched to `GENERIC_PLAN` for Postgres 16
+- Fixed error with `auto_explain`
+- Fixed warning with Ruby 3.3
+
+## 0.5.1 (2023-05-27)
+
+- Fixed `JSON::NestingError`
+
 ## 0.5.0 (2023-04-18)
 
 - Added support for normalized queries

data/LICENSE.txt

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

data/README.md

@@ -4,7 +4,7 @@ The automatic indexer for Postgres
 
 [Read about how it works](https://ankane.org/introducing-dexter) or [watch the talk](https://www.youtube.com/watch?v=Mni_1yTaNbE)
 
-[![Build Status](https://github.com/ankane/dexter/workflows/build/badge.svg?branch=master)](https://github.com/ankane/dexter/actions)
+[![Build Status](https://github.com/ankane/dexter/actions/workflows/build.yml/badge.svg)](https://github.com/ankane/dexter/actions)
 
 ## Installation
 
@@ -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.3.1.tar.gz | tar xz
-cd hypopg-1.3.1
+curl -L https://github.com/HypoPG/hypopg/archive/1.4.0.tar.gz | tar xz
+cd hypopg-1.4.0
 make
 make install # may need sudo
 ```
@@ -174,26 +174,6 @@ When streaming logs, specify the time to wait between processing queries
 dexter --interval 60 # seconds
 ```
 
-## Examples
-
-Postgres package on Ubuntu 22.04
-
-```sh
-sudo -u postgres dexter -d dbname /var/log/postgresql/postgresql-14-main.log
-```
-
-Homebrew Postgres on Mac ARM
-
-```sh
-dexter -d dbname /opt/homebrew/var/log/postgresql@14.log
-```
-
-Homebrew Postgres on Mac x86-64
-
-```sh
-dexter -d dbname /usr/local/var/log/postgresql@14.log
-```
-
 ## Analyze
 
 For best results, make sure your tables have been recently analyzed so statistics are up-to-date. You can ask Dexter to analyze tables it comes across that haven’t been analyzed in the past hour with:
@@ -230,9 +210,8 @@ The `hypopg` extension, which Dexter needs to run, is available on [these provid
 
 For other providers, see [this guide](guides/Hosted-Postgres.md). To request a new extension:
 
-- Amazon RDS - follow the instructions on [this page](https://aws.amazon.com/rds/postgresql/faqs/)
 - Google Cloud SQL - vote or comment on [this page](https://issuetracker.google.com/issues/69250435)
-- DigitalOcean Managed Databases - vote or comment on [this page](https://ideas.digitalocean.com/app-framework-services/p/support-hypopg-for-postgres)
+- DigitalOcean Managed Databases - vote or comment on [this page](https://ideas.digitalocean.com/managed-database/p/support-hypopg-for-postgres)
 
 ## HypoPG Installation Notes
 

data/lib/dexter/indexer.rb

@@ -185,7 +185,7 @@ module Dexter
 
       # get initial costs for queries
       calculate_plan(queries)
-      explainable_queries = queries.select { |q| q.explainable? && q.high_cost? }
+      explainable_queries = queries.select { |q| q.plans.any? && q.high_cost? }
 
       # filter tables for performance
       tables = Set.new(explainable_queries.flat_map(&:tables))
@@ -197,10 +197,16 @@ module Dexter
         possible_columns = Set.new
         explainable_queries.each do |query|
           log "Finding columns: #{query.statement}" if @log_level == "debug3"
-          find_columns(query.tree).each do |col|
-            last_col = col["fields"].last
-            if last_col["String"]
-              possible_columns << last_col["String"]["sval"]
+          begin
+            find_columns(query.tree).each do |col|
+              last_col = col["fields"].last
+              if last_col["String"]
+                possible_columns << last_col["String"]["sval"]
+              end
+            end
+          rescue JSON::NestingError
+            if @log_level.start_with?("debug")
+              log colorize("ERROR: Cannot get columns", :red)
             end
           end
         end
@@ -226,7 +232,7 @@ module Dexter
     end
 
     def find_columns(plan)
-      plan = JSON.parse(plan.to_json)
+      plan = JSON.parse(plan.to_json, max_nesting: 1000)
       find_by_key(plan, "ColumnRef")
     end
 
@@ -515,8 +521,8 @@ module Dexter
       raise Dexter::Abort, e.message
     end
 
-    def execute(query, pretty: true, params: [])
-      # use exec_params instead of exec for security
+    def execute(query, pretty: true, params: [], use_exec: false)
+      # use exec_params instead of exec when possible for security
       #
       # Unlike PQexec, PQexecParams allows at most one SQL command in the given string.
       # (There can be semicolons in it, but not more than one nonempty command.)
@@ -527,7 +533,11 @@ module Dexter
       log colorize("[sql] #{query}#{params.any? ? " /*#{params.to_json}*/" : ""}", :cyan) if @log_sql
 
       @mutex.synchronize do
-        conn.exec_params("#{query} /*dexter*/", params).to_a
+        if use_exec
+          conn.exec("#{query} /*dexter*/").to_a
+        else
+          conn.exec_params("#{query} /*dexter*/", params).to_a
+        end
       end
     end
 
@@ -537,7 +547,9 @@ module Dexter
 
       # try to EXPLAIN normalized queries
       # https://dev.to/yugabyte/explain-from-pgstatstatements-normalized-queries-how-to-always-get-the-generic-plan-in--5cfi
-      explain_normalized = query.include?("$1")
+      normalized = query.include?("$1")
+      generic_plan = normalized && server_version_num >= 160000
+      explain_normalized = normalized && !generic_plan
       if explain_normalized
         prepared_name = "dexter_prepared"
         execute("PREPARE #{prepared_name} AS #{safe_statement(query)}", pretty: false)
@@ -560,12 +572,14 @@ module Dexter
         end
       end
 
+      explain_prefix = generic_plan ? "GENERIC_PLAN, " : ""
+
       # strip semi-colons as another measure of defense
-      plan = JSON.parse(execute("EXPLAIN (FORMAT JSON) #{safe_statement(query)}", pretty: false).first["QUERY PLAN"], max_nesting: 1000).first["Plan"]
+      plan = JSON.parse(execute("EXPLAIN (#{explain_prefix}FORMAT JSON) #{safe_statement(query)}", pretty: false, use_exec: generic_plan).first["QUERY PLAN"], max_nesting: 1000).first["Plan"]
 
       if @log_explain
         # Pass format to prevent ANALYZE
-        puts execute("EXPLAIN (FORMAT TEXT) #{safe_statement(query)}", pretty: false).map { |r| r["QUERY PLAN"] }.join("\n")
+        puts execute("EXPLAIN (#{explain_prefix}FORMAT TEXT) #{safe_statement(query)}", pretty: false, use_exec: generic_plan).map { |r| r["QUERY PLAN"] }.join("\n")
       end
 
       plan

data/lib/dexter/query.rb

@@ -31,7 +31,7 @@ module Dexter
     end
 
     def explainable?
-      plans.any?
+      plans.size >= 3
     end
 
     def costs

data/lib/dexter/version.rb

@@ -1,3 +1,3 @@
 module Dexter
-  VERSION = "0.5.0"
+  VERSION = "0.5.2"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: pgdexter
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.2
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-18 00:00:00.000000000 Z
+date: 2024-01-10 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -96,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: The automatic indexer for Postgres