pg 0.11.0-x86-mingw32 → 0.12.0-x86-mingw32

data/lib/pg.rb

@@ -2,7 +2,7 @@
 
 begin
 	require 'pg_ext'
-rescue LoadError => err
+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
@@ -14,7 +14,8 @@ rescue LoadError => err
 
 end
 
-### The PG connection class.
+#--
+# The PG connection class.
 class PGconn
 
 	# The order the options are passed to the ::connect method.
@@ -22,16 +23,13 @@ class PGconn
 
 
 	### Quote the given +value+ for use in a connection-parameter string.
-	### @param [String] value  the option value to be quoted.
-	### @return [String]
 	def self::quote_connstr( value )
 		return "'" + value.to_s.gsub( /[\\']/ ) {|m| '\\' + m } + "'"
 	end
 
 
-	### Parse the connection +args+ into a connection-parameter string
-	### @param [Array<String>] args  the connection parameters
-	### @return [String]  a connection parameters string
+	### Parse the connection +args+ into a connection-parameter string. See PGconn.new
+	### for valid arguments.
 	def self::parse_connect_args( *args )
 		return '' if args.empty?
 

data/misc/openssl-pg-segfault.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/env 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 = PGconn.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/sample/async_api.rb

@@ -0,0 +1,109 @@
+#!/usr/bin/env 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 PGconn#socket to some kind of reactor, you
+# could make this much nicer.
+
+TIMEOUT = 5.0 # seconds to wait for an async operation to complete
+CONN_OPTS = {
+	:host     => 'localhost',
+	:dbname   => 'test',
+	:user     => 'jrandom',
+	:password => 'banks!stealUR$',
+}
+
+# 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 = PGconn.connect_start( CONN_OPTS ) or abort "Unable to create a new connection!"
+abort "Connection failed: %s" % [ conn.error_message ] if
+	conn.status == PGconn::CONNECTION_BAD
+
+# Now grab a reference to the underlying socket so we know when the
+# connection is established
+socket = IO.for_fd( conn.socket )
+
+# Track the progress of the connection, waiting for the socket to become readable/writable
+# before polling it
+poll_status = PGconn::PGRES_POLLING_WRITING
+until poll_status == PGconn::PGRES_POLLING_OK ||
+	  poll_status == PGconn::PGRES_POLLING_FAILED
+
+	# If the socket needs to read, wait 'til it becomes readable to poll again
+	case poll_status
+	when PGconn::PGRES_POLLING_READING
+		output_progress "  waiting for socket to become readable"
+		select( [socket], nil, nil, TIMEOUT ) or
+			raise "Asynchronous connection timed out!"
+
+	# ...and the same for when the socket needs to write
+	when PGconn::PGRES_POLLING_WRITING
+		output_progress "  waiting for socket to become writable"
+		select( nil, [socket], nil, TIMEOUT ) or
+			raise "Asynchronous connection timed out!"
+	end
+
+	# Output a status message about the progress
+	case conn.status
+	when PGconn::CONNECTION_STARTED
+		output_progress "  waiting for connection to be made."
+	when PGconn::CONNECTION_MADE
+		output_progress "  connection OK; waiting to send."
+	when PGconn::CONNECTION_AWAITING_RESPONSE
+		output_progress "  waiting for a response from the server."
+	when PGconn::CONNECTION_AUTH_OK
+		output_progress "  received authentication; waiting for backend start-up to finish."
+	when PGconn::CONNECTION_SSL_STARTUP
+		output_progress "  negotiating SSL encryption."
+	when PGconn::CONNECTION_SETENV
+		output_progress "  negotiating environment-driven parameter settings."
+	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 == PGconn::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( [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
+
+	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 @@
+#!/usr/bin/env ruby
+
+require 'pg'
+require 'stringio'
+
+# Using COPY asynchronously
+
+$stderr.puts "Opening database connection ..."
+conn = PGconn.connect( :dbname => 'test' )
+conn.setnonblocking( true )
+
+socket = IO.for_fd( conn.socket )
+
+$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/copyfrom.rb

@@ -0,0 +1,81 @@
+#!/usr/bin/env ruby
+
+require 'pg'
+require 'stringio'
+
+$stderr.puts "Opening database connection ..."
+conn = PGconn.connect( :dbname => 'test' )
+
+conn.exec( <<END_SQL )
+DROP TABLE IF EXISTS logs;
+CREATE TABLE logs (
+	client_ip inet,
+	username text,
+	ts timestamp,
+	request text,
+	status smallint,
+	bytes int
+);
+END_SQL
+
+copy_data = StringIO.new( <<"END_DATA" )
+"127.0.0.1","","30/Aug/2010:08:21:24 -0700","GET /manual/ HTTP/1.1",404,205
+"127.0.0.1","","30/Aug/2010:08:21:24 -0700","GET /favicon.ico HTTP/1.1",404,209
+"127.0.0.1","","30/Aug/2010:08:21:24 -0700","GET /favicon.ico HTTP/1.1",404,209
+"127.0.0.1","","30/Aug/2010:08:22:29 -0700","GET /manual/ HTTP/1.1",200,11094
+"127.0.0.1","","30/Aug/2010:08:22:38 -0700","GET /manual/index.html HTTP/1.1",200,725
+"127.0.0.1","","30/Aug/2010:08:27:56 -0700","GET /manual/ HTTP/1.1",200,11094
+"127.0.0.1","","30/Aug/2010:08:27:57 -0700","GET /manual/ HTTP/1.1",200,11094
+"127.0.0.1","","30/Aug/2010:08:28:06 -0700","GET /manual/index.html HTTP/1.1",200,7709
+"127.0.0.1","","30/Aug/2010:08:28:06 -0700","GET /manual/images/feather.gif HTTP/1.1",200,6471
+"127.0.0.1","","30/Aug/2010:08:28:06 -0700","GET /manual/images/left.gif HTTP/1.1",200,60
+"127.0.0.1","","30/Aug/2010:08:28:06 -0700","GET /manual/style/css/manual.css HTTP/1.1",200,18674
+"127.0.0.1","","30/Aug/2010:08:28:06 -0700","GET /manual/style/css/manual-print.css HTTP/1.1",200,13200
+"127.0.0.1","","30/Aug/2010:08:28:06 -0700","GET /manual/images/favicon.ico HTTP/1.1",200,1078
+"127.0.0.1","","30/Aug/2010:08:28:06 -0700","GET /manual/style/css/manual-loose-100pc.css HTTP/1.1",200,3065
+"127.0.0.1","","30/Aug/2010:08:28:14 -0700","OPTIONS * HTTP/1.0",200,0
+"127.0.0.1","","30/Aug/2010:08:28:15 -0700","OPTIONS * HTTP/1.0",200,0
+"127.0.0.1","","30/Aug/2010:08:28:47 -0700","GET /manual/mod/directives.html HTTP/1.1",200,33561
+"127.0.0.1","","30/Aug/2010:08:28:53 -0700","GET /manual/mod/mpm_common.html HTTP/1.1",200,67683
+"127.0.0.1","","30/Aug/2010:08:28:53 -0700","GET /manual/images/down.gif HTTP/1.1",200,56
+"127.0.0.1","","30/Aug/2010:08:28:53 -0700","GET /manual/images/up.gif HTTP/1.1",200,57
+"127.0.0.1","","30/Aug/2010:09:19:58 -0700","GET /manual/mod/mod_log_config.html HTTP/1.1",200,28307
+"127.0.0.1","","30/Aug/2010:09:20:19 -0700","GET /manual/mod/core.html HTTP/1.1",200,194144
+"127.0.0.1","","30/Aug/2010:16:02:56 -0700","GET /manual/ HTTP/1.1",200,11094
+"127.0.0.1","","30/Aug/2010:16:03:00 -0700","GET /manual/ HTTP/1.1",200,11094
+"127.0.0.1","","30/Aug/2010:16:06:16 -0700","GET /manual/mod/mod_dir.html HTTP/1.1",200,10583
+"127.0.0.1","","30/Aug/2010:16:06:44 -0700","GET /manual/ HTTP/1.1",200,7709
+END_DATA
+
+### You can test the error case from the database side easily by
+### changing one of the numbers at the end of one of the above rows to
+### something non-numeric like "-".
+
+$stderr.puts "Running COPY command with data ..."
+buf = ''
+conn.transaction do
+	conn.exec( "COPY logs FROM STDIN WITH csv" )
+	begin
+		while copy_data.read( 256, buf )
+			### Uncomment this to test error-handling for exceptions from the reader side:
+			# raise Errno::ECONNRESET, "socket closed while reading"
+			$stderr.puts "	sending %d bytes of data..." % [ buf.length ]
+			until conn.put_copy_data( buf )
+				$stderr.puts "	waiting for connection to be writable..."
+				sleep 0.1
+			end
+		end
+	rescue Errno => err
+		errmsg = "%s while reading copy data: %s" % [ err.class.name, err.message ]
+		conn.put_copy_end( errmsg )
+	else
+		conn.put_copy_end
+		while res = conn.get_result
+			$stderr.puts "Result of COPY is: %s" % [ res.res_status(res.result_status) ]
+		end
+	end
+end
+
+
+conn.finish
+

data/sample/copyto.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+require 'pg'
+require 'stringio'
+
+# An example of how to stream data to your local host from the database as CSV.
+
+$stderr.puts "Opening database connection ..."
+conn = PGconn.connect( :dbname => 'test' )
+
+$stderr.puts "Running COPY command ..."
+buf = ''
+conn.transaction do
+	conn.exec( "COPY logs TO STDOUT WITH csv" )
+	$stdout.puts( buf ) while buf = conn.get_copy_data
+end
+
+conn.finish
+

data/sample/cursor.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+require 'pg'
+
+# An example of how to use SQL cursors. This is mostly a straight port of
+# the cursor portion of testlibpq.c from src/test/examples.
+
+$stderr.puts "Opening database connection ..."
+conn = PGconn.connect( :dbname => 'test' )
+
+# 
+conn.transaction do
+    conn.exec( "DECLARE myportal CURSOR FOR select * from pg_database" )
+    res = conn.exec( "FETCH ALL IN myportal" )
+
+    puts res.fields.collect {|fname| "%-15s" % [fname] }.join( '' )
+    res.values.collect do |row|
+        puts row.collect {|col| "%-15s" % [col] }.join( '' )
+    end
+end
+

data/sample/losample.rb

@@ -0,0 +1,69 @@
+#!/usr/bin/env ruby
+
+require 'pg'
+
+SAMPLE_WRITE_DATA = 'some sample data'
+SAMPLE_EXPORT_NAME = 'lowrite.txt'
+
+conn = PGconn.connect( :dbname => 'test', :host => 'localhost', :port => 5432 )
+puts "dbname: " + conn.db + "\thost: " + conn.host + "\tuser: " + conn.user
+
+# Start a transaction, as all large object functions require one.
+puts "Beginning transaction"
+conn.exec( 'BEGIN' )
+
+# Test importing from a file
+puts "Import test:"
+puts "  importing %s" % [ __FILE__ ]
+oid = conn.lo_import( __FILE__ )
+puts "  imported as large object %d" % [ oid ]
+
+# Read back 50 bytes of the imported data
+puts "Read test:"
+fd = conn.lo_open( oid, PGconn::INV_READ|PGconn::INV_WRITE )
+conn.lo_lseek( fd, 0, PGconn::SEEK_SET )
+buf = conn.lo_read( fd, 50 )
+puts "  read: %p" % [ buf ]
+puts "  read was ok!" if buf =~ /require 'pg'/
+
+# Append some test data onto the end of the object
+puts "Write test:"
+conn.lo_lseek( fd, 0, PGconn::SEEK_END )
+buf = SAMPLE_WRITE_DATA.dup
+totalbytes = 0
+until buf.empty?
+	bytes = conn.lo_write( fd, buf )
+	buf.slice!( 0, bytes )
+	totalbytes += bytes
+end
+puts "  appended %d bytes" % [ totalbytes ]
+
+# Now export it
+puts "Export test:"
+File.unlink( SAMPLE_EXPORT_NAME ) if File.exist?( SAMPLE_EXPORT_NAME )
+conn.lo_export( oid, SAMPLE_EXPORT_NAME )
+puts "  success!" if File.exist?( SAMPLE_EXPORT_NAME )
+puts "  exported as %s (%d bytes)" % [ SAMPLE_EXPORT_NAME, File.size(SAMPLE_EXPORT_NAME) ]
+
+conn.exec( 'COMMIT' )
+puts "End of transaction."
+
+
+puts 'Testing read and delete from a new transaction:'
+puts '  starting a new transaction'
+conn.exec( 'BEGIN' )
+
+fd = conn.lo_open( oid, PGconn::INV_READ )
+puts '  reopened okay.'
+conn.lo_lseek( fd, 50, PGconn::SEEK_END )
+buf = conn.lo_read( fd, 50 )
+puts '  read okay.' if buf == SAMPLE_WRITE_DATA
+
+puts 'Closing and unlinking:'
+conn.lo_close( fd )
+puts '  closed.'
+conn.lo_unlink( oid )
+puts '  unlinked.'
+conn.exec( 'COMMIT' )
+puts 'Done.'
+

data/sample/notify_wait.rb

@@ -0,0 +1,43 @@
+#!/usr/bin/env ruby
+#
+# Test script, demonstrating a non-poll notification for a table event.
+#
+# To use, create a table called 'test', and attach a NOTIFY trigger to it
+# like so:
+#
+#     CREATE OR REPLACE FUNCTION notify_test()
+#     RETURNS TRIGGER
+#     LANGUAGE plpgsql
+#     AS $$
+#         BEGIN
+#             NOTIFY woo;
+#             RETURN NULL;
+#         END
+#     $$
+#
+#     CREATE TRIGGER notify_trigger
+#     AFTER UPDATE OR INSERT OR DELETE
+#     ON test
+#     FOR EACH STATEMENT
+#     EXECUTE PROCEDURE notify_test()
+#
+
+BEGIN {
+        require 'pathname'
+        basedir = Pathname.new( __FILE__ ).expand_path.dirname.parent
+        libdir = basedir + 'lib'
+        $LOAD_PATH.unshift( libdir.to_s ) unless $LOAD_PATH.include?( libdir.to_s )
+}
+
+require 'pg'
+
+conn = PGconn.connect( :dbname => 'test' )
+conn.exec( 'LISTEN woo' )  # register interest in the 'woo' event
+
+puts "Waiting up to 30 seconds for for an event!"
+conn.wait_for_notify( 30 ) do |notify, pid|
+	puts "I got one from pid %d: %s" % [ pid, notify ]
+end
+
+puts "Awww, I didn't see any events."
+