pg_conn 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17a782e74c71e670d14ed38e258f7b9c99ee1e832866dd9fa972774b1a21d08c
-  data.tar.gz: 226ad145da3b41360080a255bb90b65c4a4bbd2ac1fef8bdc2f2e43bed9feab6
+  metadata.gz: 7708b08a6ef0fcc12d0241ef9a084fe8adcfee342e03933f0f48ec313b9c48b5
+  data.tar.gz: 716d8e6de64dacab36db01303a47480e0d603a31a8fd24025441ca3a5c8adc2e
 SHA512:
-  metadata.gz: c15ad10570d71104ac356f2f0da9a1e034cf400356357621300db3af872a73282a233c0a4258dc2bcc98ac2353143a768c1632f59439812965e4b00b41fc62be
-  data.tar.gz: eec1060c95e94fbb8f59fe56fb233d95dd4d111a6980947dbc8e609788f6b3652f01d9befe9d5af053b224fa1ff661b93fc53d77001ee14593fdfdea985104a4
+  metadata.gz: 12f8f90e3853a0882f93bccde0ea1ce564068612d5d876d26c159625eea4b541bd391b81fe10cbda24b96458129e7caf3c52fe0471d81efc210c151708224887
+  data.tar.gz: 5fd5a73696fbb9daa9dbc873daee9cf580974ab17bca8fc62743967160f2757e5aaafbb8ece7f8d8e32d122e5d0b3e7b6848a834b5bc16ee65099975ff7337dc

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.9.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
@@ -567,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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg_conn
 version: !ruby/object:Gem::Version
-  version: 0.9.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/