pgtk 0.32.6 → 0.32.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bff4002fc7f88a973b99757aa0b8be3b82b6631b87f94c8ade93b30983b21761
-  data.tar.gz: 707d5ec1bf05047d60a0f25103b7210751c4731f79caa8b08c3021e7e3810e6c
+  metadata.gz: 54a200f1f191d63b73c0137b1a1ace4aa34667f041d141365b47d9c90d96f191
+  data.tar.gz: 1518e5031b71a69e3955cabe77397d05917398fb87a12b94ee5c3aa57ab107eb
 SHA512:
-  metadata.gz: 210230feda441fdee55cb3c3b6ccf1e2335efcdef77e95996afe89d3a4caf4f21bd8aa4fb9fd19f9b636d1336cc821345aa7454ec474d1693dff21990f2a1b40
-  data.tar.gz: ab98c8f9cf29405c495bd4808855e1107889ccdc2ee9011f4abe431b561f05d033564dc587f5a3084f64f0842e935d4bee6b9c8265cc729fe762a0f99bab4eb9
+  metadata.gz: 28bbce0d3b2cfcbe2347f376738938e0e714f22b89fd2696052c56ecf7be83c242e9f0a87c76c235f109ec2008a45a1471ea157fc78f3ac9a8b8b71641ac2556
+  data.tar.gz: e94795ee7e4de524c77b5fddefb7a0d2ea9e85ec05beb09ebf81000919afec9a7b54d8a0fb480d9e24c16990fed7b7b142769caefddaefdd32d504f8086f5f46

data/README.md

@@ -243,6 +243,18 @@ You can exclude specific queries from timeout enforcement using regex patterns:
 impatient = Pgtk::Impatient.new(pool, 2, /^SELECT/, /^VACUUM/)
 ```
 
+Excluded queries are never wrapped in a transaction, because statements such as
+`VACUUM`, `REINDEX`, or `CREATE INDEX CONCURRENTLY` cannot run inside a
+transaction block. Instead, a longer fallback timeout (300 seconds by default,
+configurable via the `default:` argument) is applied at the session level with
+`SET statement_timeout` before the query runs, and reset afterwards. Pass
+`default: 0` to run excluded queries with no timeout at all:
+
+```ruby
+# Give excluded queries a 60-second fallback timeout
+impatient = Pgtk::Impatient.new(pool, 2, /^VACUUM/, default: 60)
+```
+
 The timeout is enforced on the server side: each query is wrapped in a tiny
 transaction that issues `SET LOCAL statement_timeout`, and PostgreSQL itself
 terminates the query at the deadline. This guarantees the server-side

data/lib/pgtk/impatient.rb

@@ -20,6 +20,14 @@ require_relative '../pgtk'
 # transaction-pool PgBouncer that does not forward client disconnects to in-flight
 # server queries). On timeout, +TooSlow+ is raised.
 #
+# Queries that match one of the +off+ regular expressions are excluded from
+# this checking. They are never wrapped in a transaction, because some
+# statements (such as +VACUUM+, +REINDEX+, or +CREATE INDEX CONCURRENTLY+)
+# cannot run inside a transaction block. Instead, a session-level
+# +SET statement_timeout+ is applied on the same connection before the query
+# runs (and reset afterwards), using the +default+ fallback timeout. Pass
+# +default: 0+ to run excluded queries with no timeout at all.
+#
 # Basic usage:
 #
 #   # Create and configure a regular pool
@@ -102,6 +110,13 @@ class Pgtk::Impatient
   # behind a transaction-pool PgBouncer). When the deadline fires, the
   # underlying +PG::QueryCanceled+ is translated to +TooSlow+.
   #
+  # Queries matching one of the +off+ regular expressions bypass this
+  # transaction. They run on a single connection without a transaction block,
+  # guarded by a session-level +SET statement_timeout+ (the +default+ fallback,
+  # reset afterwards) or by no timeout at all when +default+ is zero. This keeps
+  # statements that cannot run inside a transaction, such as +VACUUM+ or
+  # +REINDEX+, working as expected.
+  #
   # @param [String, Array] query The SQL query with params inside (possibly)
   # @param [Array] args List of arguments
   # @return [Array] Result rows
@@ -110,9 +125,10 @@ class Pgtk::Impatient
     sql = query.is_a?(Array) ? query.join(' ') : query
     if @off.any? { |re| re.match?(sql) }
       ms = Integer(@default * 1000)
-      return @pool.transaction do |t|
-        t.exec("SET LOCAL statement_timeout = #{ms}") unless ms.zero?
-        t.exec(sql, *args)
+      return @pool.exec(sql, *args) if ms.zero?
+      return @pool.session do |t|
+        t.exec("SET statement_timeout = #{ms}")
+        t.exec(sql, *args).tap { t.exec('RESET statement_timeout') }
       end
     end
     start = Time.now

data/lib/pgtk/pool.rb

@@ -214,6 +214,29 @@ class Pgtk::Pool
     end
   end
 
+  # Grab a single connection from the pool and yield an executor bound to it,
+  # WITHOUT starting a transaction. Unlike +transaction+, no +START TRANSACTION+
+  # is issued, which makes this suitable for statements that PostgreSQL refuses
+  # to run inside a transaction block, such as +VACUUM+, +REINDEX+, or
+  # +CREATE INDEX CONCURRENTLY+. All statements executed through the yielded
+  # object run on the same connection, so a session-level setting (for example
+  # +SET statement_timeout+) made earlier in the block stays in effect for the
+  # statements that follow:
+  #
+  #  pgsql.session do |s|
+  #    s.exec('SET statement_timeout = 5000')
+  #    s.exec('VACUUM book')
+  #    s.exec('RESET statement_timeout')
+  #  end
+  #
+  # @yield [Object] Yields an executor that responds to +exec+
+  # @return [Object] Result of the block
+  def session
+    connect do |c|
+      yield(Txn.new(c, @log))
+    end
+  end
+
   private
 
   def connect

data/lib/pgtk/spy.rb

@@ -97,4 +97,15 @@ class Pgtk::Spy
       yield(Pgtk::Spy.new(t, &@block))
     end
   end
+
+  # Run statements on a single connection (no transaction) with spying on
+  # each SQL query.
+  #
+  # @yield [Pgtk::Spy] Yields a spy bound to one connection
+  # @return [Object] Result of the block
+  def session
+    @pool.session do |t|
+      yield(Pgtk::Spy.new(t, &@block))
+    end
+  end
 end

data/lib/pgtk/stash.rb

@@ -149,6 +149,16 @@ class Pgtk::Stash
     end
   end
 
+  # Run statements on a single connection, without a transaction.
+  #
+  # @yield [Pgtk::Stash] A stash bound to the connection
+  # @return [Object] The result of the block
+  def session
+    @pool.session do |t|
+      yield(Pgtk::Stash.new(t, stash: @stash, loog: @loog, entrance: @entrance))
+    end
+  end
+
   private
 
   def queries

data/lib/pgtk/version.rb

@@ -10,5 +10,5 @@ require_relative '../pgtk'
 # Copyright:: Copyright (c) 2019-2026 Yegor Bugayenko
 # License:: MIT
 module Pgtk
-  VERSION = '0.32.6' unless defined?(VERSION)
+  VERSION = '0.32.7' unless defined?(VERSION)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pgtk
 version: !ruby/object:Gem::Version
-  version: 0.32.6
+  version: 0.32.7
 platform: ruby
 authors:
 - Yegor Bugayenko