pg_conn 0.9.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17a782e74c71e670d14ed38e258f7b9c99ee1e832866dd9fa972774b1a21d08c
-  data.tar.gz: 226ad145da3b41360080a255bb90b65c4a4bbd2ac1fef8bdc2f2e43bed9feab6
+  metadata.gz: 634f61e3bd96889ad4207509c73c8b3e6a78c836db9aecbfc974ec5e206c84da
+  data.tar.gz: ded665cb58df11f269d951ee0d4cf176c0b99d24c6439edba96f9cf3b03508f0
 SHA512:
-  metadata.gz: c15ad10570d71104ac356f2f0da9a1e034cf400356357621300db3af872a73282a233c0a4258dc2bcc98ac2353143a768c1632f59439812965e4b00b41fc62be
-  data.tar.gz: eec1060c95e94fbb8f59fe56fb233d95dd4d111a6980947dbc8e609788f6b3652f01d9befe9d5af053b224fa1ff661b93fc53d77001ee14593fdfdea985104a4
+  metadata.gz: 3ad32ff6b5f33b2ec0cd2e309e243177ba1b9b3b5d24281b8e1e2aa8c956f193df64babe15691c80f50807ff7a5dd7c58c966de872b39695354f3aefaaf89343
+  data.tar.gz: 6bba6d97558b0c7750971dbc23a3d1eacf1c83072c4fcad3d327324e5547d0607b4f427810bfda3fb0e4d27b3e5f679c437fd5a57572309b9156bfc6d313daef

data/TODO

@@ -1,4 +1,20 @@
 TODO
+  o Create aliases
+
+      tuple   ->  array
+      tuples      arrays
+      field
+      fields              # aka. 'column'
+      record      hash
+      records     hashes
+                  struct  # exists
+                  structs
+
+
+  o Make rdbms, role, schema, and session methods part of a PgModel file that
+    monkey patch PgConn objects to include a #model method that returns the 
+    top-level rdbms object
+
   o #group method
 
     group(query, column: nil)
@@ -59,6 +75,7 @@ TODO
   o Allow a :type argument to all query methods that can be used to specify the
     composition of anonymous record types
 
+  + Quote methods (value, identier, ... -> Postgres string)
 
 REFACTOR
   #!/usr/bin/env ruby

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.11.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
@@ -221,12 +226,40 @@ module PgConn
       end
     end
 
+    # Quote value as an identifier. Value should be a non-nil string
+    def quote_identifier(s) = @pg_connection.escape_identifier(s)
+
+    # Quote the value as a string. Emit 'null' if value is nil
+    #
+    # The value can be of any type but is converted to a string using #to_s
+    # before quoting. This works by default for the regular types Integer,
+    # true/false, Time/Date/DateTime, and arrays. Other types may require
+    # special handling
+    def quote_literal(value) 
+      case value
+        when String; @pg_connection.escape_literal(value)
+        when Integer, Float; value.to_s
+        when true, false; value.to_s
+        when nil; 'null'
+        when Date, DateTime; "'#{value}'"
+        when Time; "'#{value.strftime("%FT%T%:z")}'"
+        when Array; "array[#{value.map { |elem| quote_literal(elem) }.join(', ')}]"
+      else
+        @pg_connection.escape_literal(value.to_s)
+      end
+    end
+
+    def quote_array(value)
+      
+    end
+
     # :call-seq:
     #   exist?(query)
     #   exist?(table, id)
     #   eists?(table, where_clause)
     #
-    # Return true iff the query returns exactly one value
+    # Return true iff the query returns exactly one value. Use '!empty?' to
+    # check if the query returns one or more records
     def exist?(*args)
       arg1, arg2 = *args
       query = 
@@ -268,8 +301,9 @@ module PgConn
 
     # Return a single value. It is an error if the query doesn't return a
     # single record with a single column. If :transaction is true, the query
-    # will be executed in a transaction and be committed it :commit is true
-    # (the default). This can be used in 'insert ... returning ...' statements
+    # will be executed in a transaction and also be committed if :commit is
+    # true (this is the default). It can be used to execute 'insert' statements
+    # with a 'returning' clause
     def value(query) #, transaction: false, commit: true)
       r = pg_exec(query)
       check_1c(r)
@@ -416,6 +450,12 @@ module PgConn
       h
     end
 
+    # TODO: #group - same as table but partitions a table on the given keys
+    #       returning a map from key to array of records
+
+    # 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 +607,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.11.0
 platform: ruby
 authors:
 - Claus Rasmussen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-06 00:00:00.000000000 Z
+date: 2024-02-25 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/