pg_conn 0.8.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 599ccb65823ae32d0a3baf96ba0d636104c7994f2473d71eafa1927228f47302
-  data.tar.gz: b08bb15804c363fb25c03e102f35de6f64694220b9865e5a9d0525516cc6db24
+  metadata.gz: 7708b08a6ef0fcc12d0241ef9a084fe8adcfee342e03933f0f48ec313b9c48b5
+  data.tar.gz: 716d8e6de64dacab36db01303a47480e0d603a31a8fd24025441ca3a5c8adc2e
 SHA512:
-  metadata.gz: 1dba080845fa70f52f4b0614392be42169822809a6a436da49f3c8a2453614c5b9586927ee5abfa5546933d43370d691458fb0677b350a0c40d1257acd42b79b
-  data.tar.gz: 8cd9e0b2481ba760dd250a7e68bda460ddf38564843929143ca3622904484866818b75bad0bc9c8a9fbbacd8bd9980eaa53b8670f4e68d9f0f04886fe24f573c
+  metadata.gz: 12f8f90e3853a0882f93bccde0ea1ce564068612d5d876d26c159625eea4b541bd391b81fe10cbda24b96458129e7caf3c52fe0471d81efc210c151708224887
+  data.tar.gz: 5fd5a73696fbb9daa9dbc873daee9cf580974ab17bca8fc62743967160f2757e5aaafbb8ece7f8d8e32d122e5d0b3e7b6848a834b5bc16ee65099975ff7337dc

data/lib/pg_conn/role_methods.rb

@@ -57,22 +57,26 @@ module PgConn
     end
 
     # Drop existing users. Return true if any role was dropped. Drop depending
-    # privileges and objects too if :cascade is true. Note that cascade only
-    # works if connected to the database where the privileges exist. The
-    # :silent option is used in tests - fix it somehow!
+    # privileges and objects too if :cascade is true. Returns true if the
+    # user(s) was deleted and false if :fail is true and one or more user
+    # counldn't be deleted
+    #
+    # Note that cascade only works if connected to the database where the
+    # privileges exist. 
+    #
+    # TODO The :silent option is used in tests - fix it somehow!
     def drop(*rolenames, cascade: false, fail: true, silent: false)
       rolenames = Array(rolenames).flatten.compact.select { |role| exist?(role) }
       return false if rolenames.empty?
       rolenames_sql = PgConn.sql_idents(rolenames)
-      begin
-        conn.exec("drop owned by #{rolenames_sql} cascade", fail: false, silent: silent) if cascade
-        conn.exec("drop role #{rolenames_sql}", fail: fail, silent: silent)
-      rescue PG::Error
-        raise if fail
-        conn.cancel_transaction
-        return false
-      end
-      true
+#     begin
+      conn.exec("drop owned by #{rolenames_sql} cascade", fail: false, silent: silent) if cascade
+      conn.exec("drop role #{rolenames_sql}", fail: fail, silent: silent) && true
+#     rescue PG::Error
+#       raise if fail
+#       conn.cancel_transaction
+#       return false
+#     end
     end
 
     # List users. TODO Use RE instead of database argument. Also doc this shit

data/lib/pg_conn/session_methods.rb

@@ -0,0 +1,82 @@
+module PgConn
+  # Schema methods
+  class SessionMethods
+    attr_reader :conn
+
+    def initialize(conn)
+      @conn = conn
+    end
+
+    # Returns a list of users connected to the given database. If database is
+    # nil, it returns a list of database/username tuples for all connected users
+    def list(database)
+      if database
+        conn.values "select usename from pg_stat_activity where datname = '#{database}'"
+      else
+        conn.tuples %(
+          select datname, usename
+          from pg_stat_activity 
+          where datname is not null and usename is not null
+        )
+      end
+    end
+
+    # Terminate sessions in the database of the given users or of all users if
+    # the users is nil. Note that 'terminate(database)' is a nop because the
+    # absent users argument defaults to an empty list
+    #
+    # TODO: Make is possible to terminate a single session of a user with
+    #       multiple sessions (is this ever relevant?)
+    def terminate(database, *users)
+      !database.nil? or raise ArgumentError
+      users = Array(users).flatten
+      case users
+        when []; return
+        when [nil]; users = list(database)
+        else users = Array(users).flatten
+      end
+      pids = self.pids(database, users)
+      return if pids.empty?
+      pids_sql = pids.map { |pid| "(#{pid})" }.join(", ")
+      conn.execute "select pg_terminate_backend(pid) from ( values #{pids_sql} ) as x(pid)"
+    end
+
+    def disable(database)
+      !database.nil? or raise ArgumentError
+      conn.execute "alter database #{database} allow_connections = false"
+    end
+
+    def enable(database)
+      !database.nil? or raise ArgumentError
+      conn.execute "alter database #{database} allow_connections = true"
+    end
+
+    # Run block without any connected users. Existing sessions are terminated
+    def exclusive(database, &block) 
+      !database.nil? or raise ArgumentError
+      begin
+        disable(database)
+        users = list(database)
+        terminate(database, users)
+        yield
+      ensure
+        enable(database)
+      end
+    end
+
+  private
+    # Like #list but returns the PIDs of the users
+    def pids(database, users)
+      users ||= list(database)
+      if !users.empty?
+        users_sql = "(" + users.map { |user| "'#{user}'" }.join(", ") + ")"
+        conn.values "select pid from pg_stat_activity where datname = '#{database}' and usename in #{users_sql}"
+      else
+        conn.values "select pid from pg_stat_activity where datname = '#{database}'"
+      end
+    end
+  end
+end
+
+
+

data/lib/pg_conn/version.rb

@@ -1,3 +1,3 @@
 module PgConn
-  VERSION = "0.8.0"
+  VERSION = "0.10.0"
 end

data/lib/pg_conn.rb

@@ -5,6 +5,7 @@ require "pg_conn/version"
 require "pg_conn/role_methods"
 require "pg_conn/schema_methods"
 require "pg_conn/rdbms_methods"
+require "pg_conn/session_methods"
 
 module PgConn
   class Error < StandardError; end
@@ -59,6 +60,9 @@ module PgConn
     # #exist?/#list for relations/tables/views/columns
     attr_reader :schema
 
+    # Session manipulation methods: #list, #terminate, #disable, #enable
+    attr_reader :session
+
     # The transaction timestamp of the most recent SQL statement executed by
     # #exec or #transaction block
     attr_reader :timestamp
@@ -198,11 +202,12 @@ module PgConn
       @schema = SchemaMethods.new(self)
       @role = RoleMethods.new(self)
       @rdbms = RdbmsMethods.new(self)
+      @session = SessionMethods.new(self)
       @timestamp = nil
       @savepoints = nil # Stack of savepoint names. Nil if no transaction in progress
     end
 
-    # Close the database connection
+    # Close the database connection. TODO: Rename 'close'
     def terminate()
       @pg_connection.close if @pg_connection && !@pg_connection.finished? 
     end
@@ -416,6 +421,9 @@ module PgConn
       h
     end
 
+    # TODO: An #array method that returns a map from id to tuple. Hmm... almost
+    # the same as #map
+
     # Return a hash from the record id column to an OpenStruct representation
     # of the record. If the :key_column option is defined it will be used
     # instead of id as the key. It is an error if the id field value is not
@@ -509,15 +517,23 @@ module PgConn
     # that span multiple lines. The empty array is a NOP but the empty string
     # is not.
     #
-    # #exec pass Postgres exceptions to the caller unless :fail is false. If
-    # fail is false #exec instead return nil but note that postgres doesn't
-    # ignore it so that if you're inside a transaction, the transaction will be
-    # in an error state and if you're also using subtransactions the whole
+    # #exec pass Postgres exceptions to the caller unless :fail is false in which case
+    # it returns nil. 
+    #
+    # Note that postgres crashes the whole transaction stack if any error is
+    # met so if you're inside a transaction, the transaction will be in an
+    # error state and if you're also using subtransactions the whole
     # transaction stack has collapsed
     #
     # TODO: Make sure the transaction stack is emptied on postgres errors
     def exec(sql, commit: true, fail: true, silent: false)
-      transaction(commit: commit) { execute(sql, fail: fail, silent: silent) }
+      begin
+        transaction(commit: commit) { execute(sql, fail: fail, silent: silent) }
+      rescue PG::Error
+        raise if fail
+        cancel_transaction
+        return nil
+      end
     end
 
     # Like #exec but returns true/false depending on if the command succeeded.
@@ -528,6 +544,7 @@ module PgConn
       begin
         exec(sql, commit: commit, fail: true, silent: silent)
       rescue PG::Error
+        cancel_transaction
         return false
       end
       return true
@@ -543,9 +560,14 @@ module PgConn
     # TODO: Handle postgres exceptions wrt transaction state and stack
     def execute(sql, fail: true, silent: false)
       if @pg_connection
-        pg_exec(sql, fail: fail, silent: silent)&.cmd_tuples
+        begin
+          pg_exec(sql, silent: silent)&.cmd_tuples
+        rescue PG::Error
+          raise if fail
+          return nil
+        end
       else
-        pg_exec(sql, fail: fail, silent: silent)
+        pg_exec(sql, silent: silent)
       end
     end
 
@@ -553,6 +575,7 @@ module PgConn
     # back to the original user
     #
     # FIXME: The out-commented transaction block makes postspec fail for some reason
+    # TODO: Rename 'sudo' because it acts just like it. 
     def su(username, &block)
       raise Error, "Missing block in call to PgConn::Connection#su" if !block_given?
       realuser = self.value "select current_user"
@@ -611,10 +634,16 @@ module PgConn
     end
 
     # Does a rollback and empties the stack. This should be called in response
-    # to PG::Error exceptions because then the whole transaction stack is
-    # invalid
+    # to PG::Error exceptions because the whole transaction stack is
+    # invalid and the server is in an invalid state
+    #
+    # It is not an error to call #cancel_transaction when no transaction is in
+    # progress
     def cancel_transaction
-      pg_exec("rollback")
+      begin
+        pg_exec("rollback")
+      rescue PG::Error
+      end
       @savepoints = nil
     end
 
@@ -631,7 +660,9 @@ module PgConn
       rescue PgConn::Rollback
         pop_transaction(commit: false)
         return nil
-      # FIXME: Rescue other postgres errors and wipe-out stack
+      rescue PG::Error
+        @savepoints = nil
+        raise
       end
       pop_transaction(commit: commit)
       result
@@ -640,7 +671,6 @@ module PgConn
   private
     # Wrapper around PG::Connection.new that switches to the postgres user
     # before connecting if the current user is the root user
-    #
     def make_connection(*args, **opts)
       if Process.euid == 0
         begin
@@ -673,8 +703,10 @@ module PgConn
     #
     # Execute statement(s) on the server. If the argument is an array of
     # commands, the commands are concatenated with ';' before being sent to the
-    # server. #pg_exec returns a PG::Result object or nil if +arg+ was empty.
-    # #exec pass Postgres exceptions to the caller unless :fail is false
+    # server. #pg_exec returns a PG::Result object or nil if +arg+ was empty
+    #
+    # Postgres errors are passed through and #error and #err set to the last
+    # statement's SQL errors or nil if it succeeded
     #
     # FIXME: Error message prints the last statement but what if another
     # statement failed?
@@ -684,7 +716,7 @@ module PgConn
     # though
     #
     # TODO: Fix silent by not handling exceptions
-    def pg_exec(arg, fail: true, silent: false)
+    def pg_exec(arg, silent: false)
       if @pg_connection
         @error = @err = nil
         begin
@@ -703,19 +735,16 @@ module PgConn
           
         rescue PG::Error => ex
           @error = ex
-          if fail
-            if !silent # FIXME Why do we handle this? 
-              $stderr.puts arg
-              $stderr.puts
-              $stderr.puts ex.message
-              $stderr.flush
-            end
-            raise
-          else
-            return nil
+          if !silent # FIXME Why do we handle this? 
+            $stderr.puts arg
+            $stderr.puts
+            $stderr.puts ex.message
+            $stderr.flush
           end
+          raise
         end
 
+      # For dump of SQL statements
       else # @pg_commands is defined
         if arg.is_a?(String)
           @pg_commands << arg if arg != ""

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg_conn
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Claus Rasmussen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-06 00:00:00.000000000 Z
+date: 2024-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -85,6 +85,7 @@ files:
 - lib/pg_conn/rdbms_methods.rb
 - lib/pg_conn/role_methods.rb
 - lib/pg_conn/schema_methods.rb
+- lib/pg_conn/session_methods.rb
 - lib/pg_conn/version.rb
 - pg_conn.gemspec
 homepage: http://www.nowhere.com/