pg 0.15.0.pre.454-x64-mingw32

data/lib/pg.rb

@@ -0,0 +1,52 @@
+#!/usr/bin/env ruby
+
+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}"
+		require "#{major_minor}/pg_ext"
+	else
+		raise
+	end
+
+end
+
+
+# The top-level PG namespace.
+module PG
+
+	# Library version
+	VERSION = '0.15.0.pre.454'
+
+	# VCS revision
+	REVISION = %q$Revision$
+
+
+	### 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
+	end
+
+
+	### Convenience alias for PG::Connection.new.
+	def self::connect( *args )
+		return PG::Connection.new( *args )
+	end
+
+
+	require 'pg/exceptions'
+	require 'pg/constants'
+	require 'pg/connection'
+	require 'pg/result'
+
+end # module PG
+
+
+# Backward-compatible aliase
+PGError = PG::Error
+

data/lib/pg/connection.rb

@@ -0,0 +1,71 @@
+#!/usr/bin/env ruby
+
+require 'pg' unless defined?( PG )
+
+# The PG connection class.
+class PG::Connection
+
+	# The order the options are passed to the ::connect method.
+	CONNECT_ARGUMENT_ORDER = %w[host port options tty dbname user password]
+
+
+	### Quote the given +value+ for use in a connection-parameter string.
+	def self::quote_connstr( value )
+		return "'" + value.to_s.gsub( /[\\']/ ) {|m| '\\' + m } + "'"
+	end
+
+
+	### Parse the connection +args+ into a connection-parameter string. See PG::Connection.new
+	### for valid arguments.
+	def self::parse_connect_args( *args )
+		return '' if args.empty?
+
+		# This will be swapped soon for code that makes options like those required for
+		# PQconnectdbParams()/PQconnectStartParams(). For now, stick to an options string for
+		# PQconnectdb()/PQconnectStart().
+
+		# Parameter 'fallback_application_name' was introduced in PostgreSQL 9.0
+		# together with PQescapeLiteral().
+		if PG::Connection.instance_methods.find{|m| m.to_sym == :escape_literal }
+			appname = PG::Connection.quote_connstr( $0 )
+			connopts = ["fallback_application_name=#{appname}"]
+		else
+			connopts = []
+		end
+
+		# Handle an options hash first
+		if args.last.is_a?( Hash )
+			opthash = args.pop
+			opthash.each do |key, val|
+				connopts.push( "%s=%s" % [key, PG::Connection.quote_connstr(val)] )
+			end
+		end
+
+		# Option string style
+		if args.length == 1 && args.first.to_s.index( '=' )
+			connopts.unshift( args.first )
+
+		# Append positional parameters
+		else
+			args.each_with_index do |val, i|
+				next unless val # Skip nil placeholders
+
+				key = CONNECT_ARGUMENT_ORDER[ i ] or
+					raise ArgumentError, "Extra positional parameter %d: %p" % [ i+1, val ]
+				connopts.push( "%s=%s" % [key, PG::Connection.quote_connstr(val.to_s)] )
+			end
+		end
+
+		return connopts.join(' ')
+	end
+
+
+	# Backward-compatibility aliases for stuff that's moved into PG.
+	class << self
+		define_method( :isthreadsafe, &PG.method(:isthreadsafe) )
+	end
+end # class PG::Connection
+
+# Backward-compatible alias
+PGconn = PG::Connection
+

data/lib/pg/constants.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require 'pg' unless defined?( PG )
+
+
+module PG::Constants
+
+	# Most of these are defined in the extension.
+
+end # module PG::Constants
+

data/lib/pg/exceptions.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require 'pg' unless defined?( PG )
+
+
+module PG
+	
+	class Error < StandardError; end
+	
+end # module PG
+

data/lib/pg/result.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require 'pg' unless defined?( PG )
+
+
+class PG::Result
+
+	### Returns all tuples as an array of arrays
+	def values
+		return enum_for(:each_row).to_a
+	end
+
+end # class PG::Result
+
+# Backward-compatible alias
+PGresult = PG::Result

data/sample/array_insert.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/env 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,106 @@
+#!/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 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
+
+# Now grab a reference to the underlying socket so we know when the
+# connection is established
+socket = conn.socket_io
+
+# 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( [socket], 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, [socket], 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( [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 = 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 @@
+#!/usr/bin/env 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 @@
+#!/usr/bin/env 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 )
+

data/sample/copyfrom.rb

@@ -0,0 +1,81 @@
+#!/usr/bin/env ruby
+
+require 'pg'
+require 'stringio'
+
+$stderr.puts "Opening database connection ..."
+conn = PG.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
+