pg_conn 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ecdb9e5679acd6da6db9b98fc179941b5752727f7ec064bbb3168ed3ca33d33
-  data.tar.gz: 28152343bf4490ad17f770799e4fa211662cab13cc19c639049d465a4c610f2a
+  metadata.gz: 410aa55b50b2d9c16aa9ab8a220475b83b91aa78e5ecb1a012e1a3524b2bcedb
+  data.tar.gz: '037319c6f45a570caedbcbb1ba1a725c738fa17771a1379ccab530d541d3270d'
 SHA512:
-  metadata.gz: 68767284661c94cc8c0a5e610d967bfe8e31db67cf3a6998b68895ba1f0ca30e003e68036ac6e23788e0175226cb77a06c1ea883362dfb5386874aeeed21928c
-  data.tar.gz: 251335c7c53cfd1cfac031576bb854aada2e034e64587a58932eb63cce35f48e9867579c52bcc48d91368e93d6d7beaddc1c5334c2207d063684cdbea4335ec4
+  metadata.gz: 6d1b677fbefbffd5189c29be2a185f76d5a85227c27f8e3a2883fe8db2a5b4c6054525975a93c5b3b4c0439009a70fe41d5a762493046090fa85d18dc381f87e
+  data.tar.gz: 03b617328dd1acd4bcfc1069c3d47b7bfc80771b924c39e7b91ad0c310f72577e6da3106e818769052f5fff7ee80ec43f2df6d127d76615b0278c353594ab70d

data/lib/pg_conn/rdbms_methods.rb

@@ -44,7 +44,7 @@ module PgConn
       conn.values stmt
     end
 
-    # Return the owner of the database
+    # Return the owner of a given database
     def owner(database)
       conn.value %(
         select r.rolname
@@ -54,13 +54,13 @@ module PgConn
       )
     end
 
-    # Return list of users currently logged in to the database or to any
+    # Return list of users currently logged in to the given database or to any
     # database if database is nil
     #
-    # FIXME: There is a possible race-condition here where some process
-    # (auto-vacuum) is logged in to the database but has a nil username. The
-    # easy fix is to have usename not null but it would be nice to know what
-    # exactly is triggering this problem
+    # FIXME: There is a possible race-condition here where some process (eg.
+    # auto-vacuum) is logged in to the database but has a nil username.  The
+    # easy fix is to have 'usename is not null' but it would be nice to know
+    # what exactly is triggering this problem
     #
     def users(database)
       database_clause = database ? "datname = '#{database}'" : nil
@@ -69,7 +69,7 @@ module PgConn
     end
 
     # Hollow-out a database by removing all schemas in the database. The public
-    # schema is recreated afterwards if :public is true. Uses the current
+    # schema is recreated afterwards unless if :public is false. Uses the current
     # database if @database is nil
     #
     # Note that the database can have active users logged in while the database
@@ -85,9 +85,11 @@ module PgConn
               .select { |schema| !exclude.include?(schema) }
               .join(", ")
         conn.exec "drop schema #{schemas} cascade"
+
+        # FIXME SECURITY Why grant 'create' to public?
         conn.exec %(
             create schema public authorization postgres;
-            grant usage, create on schema public to public
+            grant usage, create on schema public to public 
         ) if public
       ensure
         conn&.terminate if local

data/lib/pg_conn/version.rb

@@ -1,3 +1,3 @@
 module PgConn
-  VERSION = "0.6.1"
+  VERSION = "0.7.0"
 end

data/lib/pg_conn.rb

@@ -49,8 +49,7 @@ module PgConn
     def name() @pg_connection.db end
     alias_method :database, :name # Obsolete
 
-    # Database manipulation methods: #exist?, #create, #drop, #list. It is
-    # named 'rdbms' because #database is already defined
+    # Database manipulation methods: #exist?, #create, #drop, #list
     attr_reader :rdbms
 
     # Role manipulation methods: #exist?, #create, #drop, #list
@@ -64,6 +63,17 @@ module PgConn
     # #exec or #transaction block
     attr_reader :timestamp
 
+    # PG::Error object if the last statement failed; otherwise nil
+    attr_reader :err
+
+    # Last error message. The error message is the first line of the PG error
+    # message that may contain additional info. It doesn't contain a
+    # terminating newline
+    def errmsg = err && err.message.sub(/\n.*/m, "")
+
+    # The line number of the last PG::Error. It is not always present
+    def errline() err && err.message =~ /\n\s*LINE\s+(\d+):/m and $1.to_i end
+        
     # :call-seq:
     #     initialize(dbname = nil, user = nil, field_name_class: Symbol)
     #     initialize(connection_hash, field_name_class: Symbol)
@@ -79,10 +89,6 @@ module PgConn
     # of <key>=<value> pairs with the same keys as the hash, or a URI with the
     # format 'postgres[ql]://[user[:password]@][host][:port][/name]
     #
-    # The :field_name_class option controls the Ruby type of column names. It can be
-    # Symbol (the default) or String. The :timestamp option is used
-    # internally to set the timestamp for transactions
-    #
     # If given an array argument, PgConn will not connect to the database and
     # instead write its commands to the array. In this case, methods extracting
     # values from the database (eg. #value) will return nil or raise an
@@ -93,6 +99,10 @@ module PgConn
     # recommended except in cases where you want to piggyback on an existing
     # connection (eg. a Rails connection)
     #
+    # The :field_name_class option controls the Ruby type of column names. It can be
+    # Symbol (the default) or String. The :timestamp option is used
+    # internally to set the timestamp for transactions
+    #
     # Note that the connection hash and the connection string may support more
     # parameters than documented here. Consult
     # https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING
@@ -478,9 +488,10 @@ module PgConn
 
     # Execute SQL statement(s) in a transaction and return the number of
     # affected records (if any). Also sets #timestamp unless a transaction is
-    # already in progress. The +sql+ argument can be a String or an arbitrarily
-    # nested array of strings. The empty array is a NOP but the empty string is
-    # not.
+    # already in progress. The +sql+ argument can be a command (String) or an
+    # arbitrarily nested array of commands. Note that you can't have commands
+    # 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
@@ -495,10 +506,10 @@ module PgConn
 
     # Execute SQL statement(s) without a transaction block and return the
     # number of affected records (if any). This used to call procedures that
-    # may manipulate transactions. The +sql+ argument can be a String or
-    # an arbitrarily nested array of strings. The empty array is a NOP but the
-    # empty string is not. #exec pass Postgres exceptions to the caller unless
-    # :fail is false in which case it returns nil
+    # may manipulate transactions. The +sql+ argument can be a SQL command or
+    # an arbitrarily nested array of commands. The empty array is a NOP but the
+    # empty string is not. #execute pass Postgres exceptions to the caller
+    # unless :fail is false in which case it returns nil
     #
     # TODO: Handle postgres exceptions wrt transaction state and stack
     def execute(sql, fail: true, silent: false)
@@ -589,7 +600,7 @@ module PgConn
         push_transaction
         result = yield
       rescue PgConn::Rollback
-        pop_trancaction(commit: false)
+        pop_transaction(commit: false)
         return nil
       # FIXME: Rescue other postgres errors and wipe-out stack
       end
@@ -626,25 +637,27 @@ module PgConn
         PG::Connection.new *args, **opts
       end
     end
-        
+
     # :call-seq:
     #   pg_exec(string)
     #   pg_exec(array)
     #
-    # +arg+ can be a statement or an array of statements. The statements are
-    # concatenated before being sent to the server. It returns a PG::Result
-    # object or nil if +arg+ was empty. #exec pass Postgres exceptions to the
-    # caller unless :fail is false
+    # 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
     #
     # FIXME: Error message prints the last statement but what if another
     # statement failed?
     #
-    # TODO WILD: Parse sql and split it into statements that are executed
-    # one-by-one so we're able to pinpoint errors in the source
+    # TODO: Connsider executing statements one-by-one so we're able to
+    # pin-point Postgres errors without a line number. This may be expensive,
+    # though
     #
     # TODO: Fix silent by not handling exceptions
     def pg_exec(arg, fail: true, silent: false)
       if @pg_connection
+        @err = nil
         begin
           last_stmt = nil # To make the current SQL statement visible to the rescue clause. FIXME Not used?
           if arg.is_a?(String)
@@ -659,6 +672,7 @@ module PgConn
           end
           
         rescue PG::Error => ex
+          @err = ex
           if fail
             if !silent # FIXME Why do we handle this? 
               $stderr.puts arg
@@ -670,6 +684,7 @@ module PgConn
             return nil
           end
         end
+
       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.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Claus Rasmussen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-06 00:00:00.000000000 Z
+date: 2024-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg