pgdexter 0.6.0 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 234a20833730445c80e03b5d789f174f9f50e9fb443614938912aaa1f74a7bd8
-  data.tar.gz: b286dd2c8735f17cd943c71405a2863699d4540487f5f1c730f5c19e6337da79
+  metadata.gz: 8c6d5363b46c95785cf87964a0d1226161b43433e10d7700c71342ebcf3c10bc
+  data.tar.gz: 89edef30213d5ec288c9c7ab8bcb8b371649f569408a34abb4fe9038050729dc
 SHA512:
-  metadata.gz: 6464fe3a0d24567a1759272ca8ab82b6462c88c5221f10a7784a0fdf41234268896b0368fbd20e442ce8f7a307d917c6779f484006c1c4f7971be07a8ba26de1
-  data.tar.gz: e3b0e7abc058f8f250e431d8b332e761a83bbc737b782449804a663f251dd7f33dc3213cc247dfb6be06b636c1d166af54803c13d7541dd9a8479baecaa86e8c
+  metadata.gz: d65547dc4e985162671f3a5d32b66534ad9ceb7e17dbe1bbf516e16b0b820abadbf32aa045a0a431b36e92ea5ab1347539db220bc08d67c50095b501c6b56b62
+  data.tar.gz: c86be55126a037ddeba3170076ac94b3d10cbe0f29e530aa5a2e077b62719998427668420c3802f2ae612cea4127f4536db16683466c8f9184678ec2284481f5

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.6.2 (2025-07-27)
+
+- Fixed error with utility statements
+
+## 0.6.1 (2025-06-08)
+
+- Fixed error with column types without `btree` support
+
 ## 0.6.0 (2025-06-01)
 
 - Added Linux packages for Ubuntu 24.04 and Debian 12

data/README.md

@@ -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.4.1.tar.gz | tar xz
-cd hypopg-1.4.1
+curl -L https://github.com/HypoPG/hypopg/archive/1.4.2.tar.gz | tar xz
+cd hypopg-1.4.2
 make
 make install # may need sudo
 ```
@@ -232,10 +232,10 @@ If compilation fails with `fatal error: postgres.h: No such file or directory`,
 For Ubuntu and Debian, use:
 
 ```sh
-sudo apt-get install postgresql-server-dev-16
+sudo apt-get install postgresql-server-dev-17
 ```
 
-Note: Replace `16` with your Postgres server version
+Note: Replace `17` with your Postgres server version
 
 ## Additional Installation Methods
 

data/lib/dexter/client.rb

@@ -112,7 +112,7 @@ module Dexter
 
       options[:dbname] = arguments.shift unless options[:dbname]
 
-      # TODO don't use global var
+      # TODO remove global variable
       $log_level = options[:log_level].to_s.downcase
       unless ["error", "info", "debug", "debug2", "debug3"].include?($log_level)
         raise Error, "Unknown log level"

data/lib/dexter/connection.rb

@@ -41,6 +41,10 @@ module Dexter
       end
     end
 
+    def quote_ident(value)
+      value.split(".").map { |v| conn.quote_ident(v) }.join(".")
+    end
+
     def server_version_num
       @server_version_num ||= execute("SHOW server_version_num").first["server_version_num"].to_i
     end

data/lib/dexter/index_creator.rb

@@ -0,0 +1,72 @@
+module Dexter
+  class IndexCreator
+    include Logging
+
+    def initialize(connection, indexer, new_indexes, tablespace)
+      @connection = connection
+      @indexer = indexer
+      @new_indexes = new_indexes
+      @tablespace = tablespace
+    end
+
+    # 1. create lock
+    # 2. refresh existing index list
+    # 3. create indexes that still don't exist
+    # 4. release lock
+    def perform
+      with_advisory_lock do
+        @new_indexes.each do |index|
+          unless index_exists?(index)
+            statement = String.new("CREATE INDEX CONCURRENTLY ON #{@connection.quote_ident(index[:table])} (#{index[:columns].map { |c| @connection.quote_ident(c) }.join(", ")})")
+            statement << " TABLESPACE #{@connection.quote_ident(@tablespace)}" if @tablespace
+            log "Creating index: #{statement}"
+            started_at = monotonic_time
+            begin
+              @connection.execute(statement)
+              log "Index created: #{((monotonic_time - started_at) * 1000).to_i} ms"
+            rescue PG::LockNotAvailable
+              log "Could not acquire lock: #{index[:table]}"
+            end
+          end
+        end
+      end
+    end
+
+    private
+
+    def monotonic_time
+      Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    end
+
+    def with_advisory_lock
+      lock_id = 123456
+      first_time = true
+      while @connection.execute("SELECT pg_try_advisory_lock($1)", params: [lock_id]).first["pg_try_advisory_lock"] != "t"
+        if first_time
+          log "Waiting for lock..."
+          first_time = false
+        end
+        sleep(1)
+      end
+      yield
+    ensure
+      suppress_messages do
+        @connection.execute("SELECT pg_advisory_unlock($1)", params: [lock_id])
+      end
+    end
+
+    def suppress_messages
+      @connection.send(:conn).set_notice_processor do |message|
+        # do nothing
+      end
+      yield
+    ensure
+      # clear notice processor
+      @connection.send(:conn).set_notice_processor
+    end
+
+    def index_exists?(index)
+      @indexer.send(:indexes, [index[:table]]).find { |i| i["columns"] == index[:columns] }
+    end
+  end
+end

data/lib/dexter/indexer.rb

@@ -30,6 +30,7 @@ module Dexter
 
       if tables.any?
         # analyze tables if needed
+        # TODO remove @log_level in 0.7.0
         analyze_tables(tables) if @analyze || @log_level == "debug2"
 
         # get initial costs for queries
@@ -41,7 +42,8 @@ module Dexter
         ColumnResolver.new(@connection, candidate_queries, log_level: @log_level).perform
         candidate_queries.each do |query|
           # no reason to use btree index for json columns
-          query.candidate_columns = query.columns.reject { |c| ["json", "jsonb"].include?(c[:type]) }.sort_by { |c| [c[:table], c[:column]] }
+          # TODO check type supports btree
+          query.candidate_columns = query.columns.reject { |c| ["json", "jsonb", "point"].include?(c[:type]) }.sort_by { |c| [c[:table], c[:column]] }
         end
         candidate_queries.select! { |q| q.candidate_columns.any? }
 
@@ -59,7 +61,7 @@ module Dexter
       show_debug_info(new_indexes, queries) if @log_level.start_with?("debug")
 
       # create new indexes
-      create_indexes(new_indexes) if @create && new_indexes.any?
+      IndexCreator.new(@connection, self, new_indexes, @tablespace).perform if @create && new_indexes.any?
     end
 
     private
@@ -120,7 +122,7 @@ module Dexter
         end
 
         if @analyze && (!la || la < Time.now - 3600)
-          statement = "ANALYZE #{quote_ident(table)}"
+          statement = "ANALYZE #{@connection.quote_ident(table)}"
           log "Running analyze: #{statement}"
           execute(statement)
         end
@@ -134,7 +136,8 @@ module Dexter
           puts
         end
         begin
-          query.plans << plan(query.statement)
+          plan = self.plan(query.statement)
+          query.plans << plan if plan && plan["Total Cost"]
         rescue PG::Error, JSON::NestingError => e
           if @log_explain
             log e.message
@@ -183,8 +186,12 @@ module Dexter
 
     def create_candidate_indexes(candidate_indexes, index_mapping)
       candidate_indexes.each do |columns|
-        index_name = create_hypothetical_index(columns[0][:table], columns.map { |c| c[:column] })
-        index_mapping[index_name] = columns
+        begin
+          index_name = create_hypothetical_index(columns[0][:table], columns.map { |c| c[:column] })
+          index_mapping[index_name] = columns
+        rescue PG::UndefinedObject
+          # data type x has no default operator class for access method "btree"
+        end
       end
     rescue PG::InternalError
       # hypopg: not more oid available
@@ -446,37 +453,6 @@ module Dexter
       end
     end
 
-    # 1. create lock
-    # 2. refresh existing index list
-    # 3. create indexes that still don't exist
-    # 4. release lock
-    def create_indexes(new_indexes)
-      with_advisory_lock do
-        new_indexes.each do |index|
-          unless index_exists?(index)
-            statement = String.new("CREATE INDEX CONCURRENTLY ON #{quote_ident(index[:table])} (#{index[:columns].map { |c| quote_ident(c) }.join(", ")})")
-            statement << " TABLESPACE #{quote_ident(@tablespace)}" if @tablespace
-            log "Creating index: #{statement}"
-            started_at = monotonic_time
-            begin
-              execute(statement)
-              log "Index created: #{((monotonic_time - started_at) * 1000).to_i} ms"
-            rescue PG::LockNotAvailable
-              log "Could not acquire lock: #{index[:table]}"
-            end
-          end
-        end
-      end
-    end
-
-    def monotonic_time
-      Process.clock_gettime(Process::CLOCK_MONOTONIC)
-    end
-
-    def conn
-      @connection.send(:conn)
-    end
-
     def execute(...)
       @connection.execute(...)
     end
@@ -522,38 +498,7 @@ module Dexter
     end
 
     def create_hypothetical_index(table, columns)
-      execute("SELECT * FROM hypopg_create_index('CREATE INDEX ON #{quote_ident(table)} (#{columns.map { |c| quote_ident(c) }.join(", ")})')").first["indexname"]
-    end
-
-    def with_advisory_lock
-      lock_id = 123456
-      first_time = true
-      while execute("SELECT pg_try_advisory_lock($1)", params: [lock_id]).first["pg_try_advisory_lock"] != "t"
-        if first_time
-          log "Waiting for lock..."
-          first_time = false
-        end
-        sleep(1)
-      end
-      yield
-    ensure
-      suppress_messages do
-        execute("SELECT pg_advisory_unlock($1)", params: [lock_id])
-      end
-    end
-
-    def suppress_messages
-      conn.set_notice_processor do |message|
-        # do nothing
-      end
-      yield
-    ensure
-      # clear notice processor
-      conn.set_notice_processor
-    end
-
-    def index_exists?(index)
-      indexes([index[:table]]).find { |i| i["columns"] == index[:columns] }
+      execute("SELECT * FROM hypopg_create_index('CREATE INDEX ON #{@connection.quote_ident(table)} (#{columns.map { |c| @connection.quote_ident(c) }.join(", ")})')").first["indexname"]
     end
 
     def indexes(tables)
@@ -590,10 +535,6 @@ module Dexter
       end
     end
 
-    def quote_ident(value)
-      value.split(".").map { |v| conn.quote_ident(v) }.join(".")
-    end
-
     def safe_statement(statement)
       statement.gsub(";", "")
     end

data/lib/dexter/logging.rb

@@ -8,7 +8,7 @@ module Dexter
     }
 
     def output
-      $stdout
+      $dexter_output || $stdout
     end
 
     def log(message = "")

data/lib/dexter/parsers/stderr_log_parser.rb

@@ -1,6 +1,6 @@
 module Dexter
   class StderrLogParser < LogParser
-    LINE_SEPERATOR = ":  ".freeze
+    LINE_SEPARATOR = ":  ".freeze
     DETAIL_LINE = "DETAIL:  ".freeze
 
     def perform(collector)
@@ -11,7 +11,7 @@ module Dexter
         if active_line
           if line.include?(DETAIL_LINE)
             add_parameters(active_line, line.chomp.split(DETAIL_LINE)[1])
-          elsif line.include?(LINE_SEPERATOR)
+          elsif line.include?(LINE_SEPARATOR)
             collector.add(active_line, duration)
             active_line = nil
           else

data/lib/dexter/version.rb

@@ -1,3 +1,3 @@
 module Dexter
-  VERSION = "0.6.0"
+  VERSION = "0.6.2"
 end

data/lib/dexter.rb

@@ -15,6 +15,7 @@ require_relative "dexter/client"
 require_relative "dexter/collector"
 require_relative "dexter/column_resolver"
 require_relative "dexter/connection"
+require_relative "dexter/index_creator"
 require_relative "dexter/indexer"
 require_relative "dexter/processor"
 require_relative "dexter/query"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pgdexter
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.2
 platform: ruby
 authors:
 - Andrew Kane
@@ -80,6 +80,7 @@ files:
 - lib/dexter/collector.rb
 - lib/dexter/column_resolver.rb
 - lib/dexter/connection.rb
+- lib/dexter/index_creator.rb
 - lib/dexter/indexer.rb
 - lib/dexter/logging.rb
 - lib/dexter/parsers/csv_log_parser.rb
@@ -114,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: The automatic indexer for Postgres
 test_files: []