pg 1.2.3 → 1.4.6

data/lib/pg/exceptions.rb

@@ -6,7 +6,20 @@ require 'pg' unless defined?( PG )
 
 module PG
 
-	class Error < StandardError; end
+	class Error < StandardError
+		def initialize(msg=nil, connection: nil, result: nil)
+			@connection = connection
+			@result = result
+			super(msg)
+		end
+	end
+
+	class NotAllCopyDataRetrieved < PG::Error
+	end
+	class LostCopyState < PG::Error
+	end
+	class NotInBlockingMode < PG::Error
+	end
 
 end # module PG
 

data/lib/pg/version.rb

@@ -0,0 +1,4 @@
+module PG
+	# Library version
+	VERSION = '1.4.6'
+end

data/lib/pg.rb

@@ -1,15 +1,28 @@
+
 # -*- ruby -*-
 # frozen_string_literal: true
 
-begin
-	require 'pg_ext'
-rescue LoadError
-	# If it's a Windows binary gem, try the <major>.<minor> subdirectory
-	if RUBY_PLATFORM =~/(mswin|mingw)/i
-		major_minor = RUBY_VERSION[ /^(\d+\.\d+)/ ] or
-			raise "Oops, can't extract the major/minor version from #{RUBY_VERSION.dump}"
+# The top-level PG namespace.
+module PG
 
-		add_dll_path = proc do |path, &block|
+	# Is this file part of a fat binary gem with bundled libpq?
+	bundled_libpq_path = File.join(__dir__, RUBY_PLATFORM.gsub(/^i386-/, "x86-"))
+	if File.exist?(bundled_libpq_path)
+		POSTGRESQL_LIB_PATH = bundled_libpq_path
+	else
+		bundled_libpq_path = nil
+		# Try to load libpq path as found by extconf.rb
+		begin
+			require "pg/postgresql_lib_path"
+		rescue LoadError
+			# rake-compiler doesn't use regular "make install", but uses it's own install tasks.
+			# It therefore doesn't copy pg/postgresql_lib_path.rb in case of "rake compile".
+			POSTGRESQL_LIB_PATH = false
+		end
+	end
+
+	add_dll_path = proc do |path, &block|
+		if RUBY_PLATFORM =~/(mswin|mingw)/i && path && File.exist?(path)
 			begin
 				require 'ruby_installer/runtime'
 				RubyInstaller::Runtime.add_dll_directory(path, &block)
@@ -19,43 +32,35 @@ rescue LoadError
 				block.call
 				ENV['PATH'] = old_path
 			end
+		else
+			# No need to set a load path manually - it's set as library rpath.
+			block.call
 		end
+	end
 
-		# Temporary add this directory for DLL search, so that libpq.dll can be found.
-		# mingw32-platform strings differ (RUBY_PLATFORM=i386-mingw32 vs. x86-mingw32 for rubygems)
-		add_dll_path.call(File.join(__dir__, RUBY_PLATFORM.gsub(/^i386-/, "x86-"))) do
+	# Add a load path to the one retrieved from pg_config
+	add_dll_path.call(POSTGRESQL_LIB_PATH) do
+		if bundled_libpq_path
+			# It's a Windows binary gem, try the <major>.<minor> subdirectory
+			major_minor = RUBY_VERSION[ /^(\d+\.\d+)/ ] or
+				raise "Oops, can't extract the major/minor version from #{RUBY_VERSION.dump}"
 			require "#{major_minor}/pg_ext"
+		else
+			require 'pg_ext'
 		end
-	else
-		raise
-	end
-
-end
-
-
-# The top-level PG namespace.
-module PG
-
-	# Library version
-	VERSION = '1.2.3'
-
-	# VCS revision
-	REVISION = %q$Revision: 6f611e78845a $
-
-	class NotAllCopyDataRetrieved < PG::Error
 	end
 
-	### Get the PG library version. If +include_buildnum+ is +true+, include the build ID.
-	def self::version_string( include_buildnum=false )
-		vstring = "%s %s" % [ self.name, VERSION ]
-		vstring << " (build %s)" % [ REVISION[/: ([[:xdigit:]]+)/, 1] || '0' ] if include_buildnum
-		return vstring
+	# Get the PG library version.
+	#
+	# +include_buildnum+ is no longer used and any value passed will be ignored.
+	def self.version_string( include_buildnum=nil )
+		"%s %s" % [ self.name, VERSION ]
 	end
 
 
 	### Convenience alias for PG::Connection.new.
-	def self::connect( *args )
-		return PG::Connection.new( *args )
+	def self.connect( *args, &block )
+		Connection.new( *args, &block )
 	end
 
 
@@ -65,10 +70,14 @@ module PG
 	require 'pg/binary_decoder'
 	require 'pg/text_encoder'
 	require 'pg/text_decoder'
-	require 'pg/basic_type_mapping'
+	require 'pg/basic_type_registry'
+	require 'pg/basic_type_map_based_on_result'
+	require 'pg/basic_type_map_for_queries'
+	require 'pg/basic_type_map_for_results'
 	require 'pg/type_map_by_column'
 	require 'pg/connection'
 	require 'pg/result'
 	require 'pg/tuple'
+	require 'pg/version'
 
 end # module PG

data/misc/openssl-pg-segfault.rb

@@ -0,0 +1,31 @@
+# -*- ruby -*-
+
+PGHOST   = 'localhost'
+PGDB     = 'test'
+#SOCKHOST = 'github.com'
+SOCKHOST = 'it-trac.laika.com'
+
+# Load pg first, so the libssl.so that libpq is linked against is loaded.
+require 'pg'
+$stderr.puts "connecting to postgres://#{PGHOST}/#{PGDB}"
+conn = PG.connect( PGHOST, :dbname => PGDB )
+
+# Now load OpenSSL, which might be linked against a different libssl.
+require 'socket'
+require 'openssl'
+$stderr.puts "Connecting to #{SOCKHOST}"
+sock = TCPSocket.open( SOCKHOST, 443 )
+ctx = OpenSSL::SSL::SSLContext.new
+sock = OpenSSL::SSL::SSLSocket.new( sock, ctx )
+sock.sync_close = true
+
+# The moment of truth...
+$stderr.puts "Attempting to connect..."
+begin
+	sock.connect
+rescue Errno
+	$stderr.puts "Got an error connecting, but no segfault."
+else
+	$stderr.puts "Nope, no segfault!"
+end
+

data/misc/postgres/History.txt

@@ -0,0 +1,9 @@
+== v0.8.0 [2012-02-09] Michael Granger <ged@FaerieMUD.org>
+
+This placeholder version.
+
+
+== v0.7.9.2008.01.28 [2008-01-28] Jeff Davis <<ruby-pg@j-davis.com>>
+
+The last actual version.
+

data/misc/postgres/Manifest.txt

@@ -0,0 +1,5 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/postgres.rb

data/misc/postgres/README.txt

@@ -0,0 +1,21 @@
+= postgres
+
+* https://github.com/ged/ruby-pg
+
+== Description
+
+This is an old, deprecated version of the Ruby PostgreSQL driver that hasn't
+been maintained or supported since early 2008.
+
+You should install/require 'pg' instead.
+
+If you need the 'postgres' gem for legacy code that can't be converted, you can
+still install it using an explicit version, like so:
+
+  gem install postgres -v '0.7.9.2008.01.28'
+  gem uninstall postgres -v '>0.7.9.2008.01.28'
+
+If you have any questions, the nice folks in the Google group can help:
+
+  http://goo.gl/OjOPP / ruby-pg@googlegroups.com
+

data/misc/postgres/Rakefile

@@ -0,0 +1,21 @@
+# -*- ruby -*-
+
+require 'date'
+require 'rubygems'
+require 'hoe'
+require 'pp'
+
+Hoe.spec 'postgres' do
+	self.developer 'Michael Granger', 'ged@FaerieMUD.org'
+	self.dependency 'pg', '~> 0'
+	self.spec_extras[:date] = Date.parse( '2008/01/30' )
+
+	line = '-' * 75
+	msg = paragraphs_of( 'README.txt', 3..-1 )
+	msg.unshift( line )
+	msg.push( line )
+
+	self.spec_extras[:post_install_message] = msg.join( "\n\n" ) + "\n"
+end
+
+# vim: syntax=ruby

data/misc/postgres/lib/postgres.rb

@@ -0,0 +1,16 @@
+# -*- ruby -*-
+
+require 'pathname'
+
+module Postgres
+
+	VERSION = '0.8.1'
+
+	gemdir = Pathname( __FILE__ ).dirname.parent
+	readme = gemdir + 'README.txt'
+
+	header, message = readme.read.split( /^== Description/m )
+	abort( message.strip )
+
+end
+

data/misc/ruby-pg/History.txt

@@ -0,0 +1,9 @@
+== v0.8.0 [2012-02-09] Michael Granger <ged@FaerieMUD.org>
+
+This placeholder version.
+
+
+== v0.7.9.2008.01.28 [2008-01-28] Jeff Davis <<ruby-pg@j-davis.com>>
+
+The last actual version.
+

data/misc/ruby-pg/Manifest.txt

@@ -0,0 +1,5 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/ruby/pg.rb

data/misc/ruby-pg/README.txt

@@ -0,0 +1,21 @@
+= ruby-pg
+
+* https://github.com/ged/ruby-pg
+
+== Description
+
+This is an old, deprecated version of the 'pg' gem that hasn't been
+maintained or supported since early 2008.
+
+You should install/require 'pg' instead.
+
+If you need ruby-pg for legacy code that can't be converted, you can still
+install it using an explicit version, like so:
+
+  gem install ruby-pg -v '0.7.9.2008.01.28'
+  gem uninstall ruby-pg -v '>0.7.9.2008.01.28'
+
+If you have any questions, the nice folks in the Google group can help:
+
+  http://goo.gl/OjOPP / ruby-pg@googlegroups.com
+

data/misc/ruby-pg/Rakefile

@@ -0,0 +1,21 @@
+# -*- ruby -*-
+
+require 'date'
+require 'rubygems'
+require 'hoe'
+require 'pp'
+
+Hoe.spec 'ruby-pg' do
+	self.developer 'Michael Granger', 'ged@FaerieMUD.org'
+	self.dependency 'pg', '~> 0'
+	self.spec_extras[:date] = Date.parse( '2008/01/30' )
+
+	line = '-' * 75
+	msg = paragraphs_of( 'README.txt', 3..-1 )
+	msg.unshift( line )
+	msg.push( line )
+
+	self.spec_extras[:post_install_message] = msg.join( "\n\n" ) + "\n"
+end
+
+# vim: syntax=ruby

data/misc/ruby-pg/lib/ruby/pg.rb

@@ -0,0 +1,16 @@
+# -*- ruby -*-
+
+require 'pathname'
+
+module Pg
+
+	VERSION = '0.8.0'
+
+	gemdir = Pathname( __FILE__ ).dirname.parent.parent
+	readme = gemdir + 'README.txt'
+
+	header, message = readme.read.split( /^== Description/m )
+	abort( message.strip )
+
+end
+

data/pg.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+# -*- encoding: utf-8 -*-
+
+require_relative 'lib/pg/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pg"
+  spec.version       = PG::VERSION
+  spec.authors       = ["Michael Granger", "Lars Kanis"]
+  spec.email         = ["ged@FaerieMUD.org", "lars@greiz-reinsdorf.de"]
+
+  spec.summary       = "Pg is the Ruby interface to the PostgreSQL RDBMS"
+  spec.description   = "Pg is the Ruby interface to the PostgreSQL RDBMS. It works with PostgreSQL 9.3 and later."
+  spec.homepage      = "https://github.com/ged/ruby-pg"
+  spec.license       = "BSD-2-Clause"
+  spec.required_ruby_version = ">= 2.5"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/ged/ruby-pg"
+  spec.metadata["changelog_uri"] = "https://github.com/ged/ruby-pg/blob/master/History.md"
+  spec.metadata["documentation_uri"] = "http://deveiate.org/code/pg"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.extensions    = ["ext/extconf.rb"]
+  spec.require_paths = ["lib"]
+  spec.cert_chain    = ["certs/ged.pem"]
+  spec.rdoc_options  = ["--main", "README.md",
+                        "--title", "PG: The Ruby PostgreSQL Driver"]
+  spec.extra_rdoc_files = `git ls-files -z *.rdoc *.md lib/*.rb lib/*/*.rb ext/*.c ext/*.h`.split("\x0")
+end

data/rakelib/task_extension.rb

@@ -0,0 +1,46 @@
+# This source code is borrowed from:
+# https://github.com/oneclick/rubyinstaller2/blob/b3dcbf69f131e44c78ea3a1c5e0041c223f266ce/lib/ruby_installer/build/utils.rb#L104-L144
+
+module TaskExtension
+  # Extend rake's file task to be defined only once and to check the expected file is indeed generated
+  #
+  # The same as #task, but for #file.
+  # In addition this file task raises an error, if the file that is expected to be generated is not present after the block was executed.
+  def file(name, *args, &block)
+    task_once(name, block) do
+      super(name, *args) do |ta|
+        block&.call(ta).tap do
+          raise "file #{ta.name} is missing after task executed" unless File.exist?(ta.name)
+        end
+      end
+    end
+  end
+
+  # Extend rake's task definition to be defined only once, even if called several times
+  #
+  # This allows to define common tasks next to specific tasks.
+  # It is expected that any variation of the task's block is reflected in the task name or namespace.
+  # If the task name is identical, the task block is executed only once, even if the file task definition is executed twice.
+  def task(name, *args, &block)
+    task_once(name, block) do
+      super
+    end
+  end
+
+  private def task_once(name, block)
+    name = name.keys.first if name.is_a?(Hash)
+    if block &&
+        Rake::Task.task_defined?(name) &&
+        Rake::Task[name].instance_variable_get('@task_block_location') == block.source_location
+      # task is already defined for this target and the same block
+      # So skip double definition of the same action
+      Rake::Task[name]
+    elsif block
+      yield.tap do
+        Rake::Task[name].instance_variable_set('@task_block_location', block.source_location)
+      end
+    else
+      yield
+    end
+  end
+end

data/sample/array_insert.rb

@@ -0,0 +1,20 @@
+# -*- ruby -*-
+
+require 'pg'
+
+c = PG.connect( dbname: 'test' )
+
+# this one works:
+c.exec( "DROP TABLE IF EXISTS foo" )
+c.exec( "CREATE TABLE foo (strings character varying[]);" )
+
+# But using a prepared statement works:
+c.set_error_verbosity( PG::PQERRORS_VERBOSE )
+c.prepare( 'stmt', "INSERT INTO foo VALUES ($1);" )
+
+# This won't work
+#c.exec_prepared( 'stmt', ["ARRAY['this','that']"] )
+
+# but this will:
+c.exec_prepared( 'stmt', ["{'this','that'}"] )
+

data/sample/async_api.rb

@@ -0,0 +1,102 @@
+# -*- ruby -*-
+
+require 'pg'
+
+# This is a example of how to use the asynchronous API to query the
+# server without blocking other threads. It's intentionally low-level;
+# if you hooked up the PG::Connection#socket to some kind of reactor, you
+# could make this much nicer.
+
+TIMEOUT = 5.0 # seconds to wait for an async operation to complete
+
+# Print 'x' continuously to demonstrate that other threads aren't
+# blocked while waiting for the connection, for the query to be sent,
+# for results, etc. You might want to sleep inside the loop or
+# comment this out entirely for cleaner output.
+progress_thread = Thread.new { loop { print 'x' } }
+
+# Output progress messages
+def output_progress( msg )
+	puts "\n>>> #{msg}\n"
+end
+
+# Start the connection
+output_progress "Starting connection..."
+conn = PG::Connection.connect_start( :dbname => 'test' ) or
+	abort "Unable to create a new connection!"
+abort "Connection failed: %s" % [ conn.error_message ] if
+	conn.status == PG::CONNECTION_BAD
+
+# Track the progress of the connection, waiting for the socket to become readable/writable
+# before polling it
+poll_status = PG::PGRES_POLLING_WRITING
+until poll_status == PG::PGRES_POLLING_OK ||
+	  poll_status == PG::PGRES_POLLING_FAILED
+
+	# If the socket needs to read, wait 'til it becomes readable to poll again
+	case poll_status
+	when PG::PGRES_POLLING_READING
+		output_progress "  waiting for socket to become readable"
+		select( [conn.socket_io], nil, nil, TIMEOUT ) or
+			raise "Asynchronous connection timed out!"
+
+	# ...and the same for when the socket needs to write
+	when PG::PGRES_POLLING_WRITING
+		output_progress "  waiting for socket to become writable"
+		select( nil, [conn.socket_io], nil, TIMEOUT ) or
+			raise "Asynchronous connection timed out!"
+	end
+
+	# Output a status message about the progress
+	case conn.status
+	when PG::CONNECTION_STARTED
+		output_progress "  waiting for connection to be made."
+	when PG::CONNECTION_MADE
+		output_progress "  connection OK; waiting to send."
+	when PG::CONNECTION_AWAITING_RESPONSE
+		output_progress "  waiting for a response from the server."
+	when PG::CONNECTION_AUTH_OK
+		output_progress "  received authentication; waiting for backend start-up to finish."
+	when PG::CONNECTION_SSL_STARTUP
+		output_progress "  negotiating SSL encryption."
+	when PG::CONNECTION_SETENV
+		output_progress "  negotiating environment-driven parameter settings."
+	when PG::CONNECTION_NEEDED
+		output_progress "  internal state: connect() needed."
+	end
+
+	# Check to see if it's finished or failed yet
+	poll_status = conn.connect_poll
+end
+
+abort "Connect failed: %s" % [ conn.error_message ] unless conn.status == PG::CONNECTION_OK
+
+output_progress "Sending query"
+conn.send_query( "SELECT * FROM pg_stat_activity" )
+
+# Fetch results until there aren't any more
+loop do
+	output_progress "  waiting for a response"
+
+	# Buffer any incoming data on the socket until a full result is ready.
+	conn.consume_input
+	while conn.is_busy
+		select( [conn.socket_io], nil, nil, TIMEOUT ) or
+			raise "Timeout waiting for query response."
+		conn.consume_input
+	end
+
+	# Fetch the next result. If there isn't one, the query is finished
+	result = conn.get_result or break
+
+	puts "\n\nQuery result:\n%p\n" % [ result.values ]
+end
+
+output_progress "Done."
+conn.finish
+
+if defined?( progress_thread )
+	progress_thread.kill
+	progress_thread.join
+end
+

data/sample/async_copyto.rb

@@ -0,0 +1,39 @@
+# -*- ruby -*-
+
+require 'pg'
+require 'stringio'
+
+# Using COPY asynchronously
+
+$stderr.puts "Opening database connection ..."
+conn = PG.connect( :dbname => 'test' )
+conn.setnonblocking( true )
+
+socket = conn.socket_io
+
+$stderr.puts "Running COPY command ..."
+buf = ''
+conn.transaction do
+	conn.send_query( "COPY logs TO STDOUT WITH csv" )
+	buf = nil
+
+	# #get_copy_data returns a row if there's a whole one to return, false
+	# if there isn't one but the COPY is still running, or nil when it's
+	# finished.
+	begin
+		$stderr.puts "COPY loop"
+		conn.consume_input
+		while conn.is_busy
+			$stderr.puts "  ready loop"
+			select( [socket], nil, nil, 5.0 ) or
+				raise "Timeout (5s) waiting for query response."
+			conn.consume_input
+		end
+
+		buf = conn.get_copy_data
+		$stdout.puts( buf ) if buf
+	end until buf.nil?
+end
+
+conn.finish
+

data/sample/async_mixed.rb

@@ -0,0 +1,56 @@
+# -*- ruby -*-
+
+require 'pg'
+
+$stdout.sync = true
+
+# This is a example of how to mix and match synchronous and async APIs. In this case,
+# the connection to the server is made syncrhonously, and then queries are
+# asynchronous.
+
+TIMEOUT = 5.0 # seconds to wait for an async operation to complete
+CONN_OPTS = {
+	:host     => 'localhost',
+	:dbname   => 'test',
+}
+
+# Output progress messages
+def output_progress( msg )
+	puts ">>> #{msg}\n"
+end
+
+# Start the (synchronous) connection
+output_progress "Starting connection..."
+conn = PG.connect( CONN_OPTS ) or abort "Unable to create a new connection!"
+
+abort "Connect failed: %s" % [ conn.error_message ] unless conn.status == PG::CONNECTION_OK
+
+# Now grab a reference to the underlying socket to select() on while the query is running
+socket = conn.socket_io
+
+# Send the (asynchronous) query
+output_progress "Sending query"
+conn.send_query( "SELECT * FROM pg_stat_activity" )
+
+# Fetch results until there aren't any more
+loop do
+	output_progress "  waiting for a response"
+
+	# Buffer any incoming data on the socket until a full result is ready.
+	conn.consume_input
+	while conn.is_busy
+		output_progress "  waiting for data to be available on %p..." % [ socket ]
+		select( [socket], nil, nil, TIMEOUT ) or
+			raise "Timeout waiting for query response."
+		conn.consume_input
+	end
+
+	# Fetch the next result. If there isn't one, the query is finished
+	result = conn.get_result or break
+
+	output_progress "Query result:\n%p\n" % [ result.values ]
+end
+
+output_progress "Done."
+conn.finish
+

data/sample/check_conn.rb

@@ -0,0 +1,21 @@
+# -*- ruby -*-
+# vim: set nosta noet ts=4 sw=4:
+# encoding: utf-8
+
+require 'pg'
+
+# This is a minimal example of a function that can test an existing PG::Connection and
+# reset it if necessary.
+
+def check_connection( conn )
+	begin
+		conn.exec( "SELECT 1" )
+	rescue PG::Error => err
+		$stderr.puts "%p while testing connection: %s" % [ err.class, err.message ]
+		conn.reset
+	end
+end
+
+conn = PG.connect( dbname: 'test' )
+check_connection( conn )
+