pg 1.2.3 → 1.5.3

data/sample/losample.rb

@@ -0,0 +1,69 @@
+# -*- ruby -*-
+
+require 'pg'
+
+SAMPLE_WRITE_DATA = 'some sample data'
+SAMPLE_EXPORT_NAME = 'lowrite.txt'
+
+conn = PG.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, PG::INV_READ|PG::INV_WRITE )
+conn.lo_lseek( fd, 0, PG::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, PG::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, PG::INV_READ )
+puts '  reopened okay.'
+conn.lo_lseek( fd, 50, PG::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/minimal-testcase.rb

@@ -0,0 +1,17 @@
+# -*- ruby -*-
+
+require 'pg'
+
+conn = PG.connect( :dbname => 'test' )
+$stderr.puts '---',
+	RUBY_DESCRIPTION,
+	PG.version_string( true ),
+	"Server version: #{conn.server_version}",
+	"Client version: #{PG.library_version}",
+	'---'
+
+result = conn.exec( "SELECT * from pg_stat_activity" )
+
+$stderr.puts %Q{Expected this to return: ["select * from pg_stat_activity"]}
+p result.field_values( 'current_query' )
+

data/sample/notify_wait.rb

@@ -0,0 +1,72 @@
+# -*- ruby -*-
+#
+# Test script, demonstrating a non-poll notification for a table event.
+#
+
+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'
+
+TRIGGER_TABLE = %{
+	CREATE TABLE IF NOT EXISTS test ( message text );
+}
+
+TRIGGER_FUNCTION = %{
+CREATE OR REPLACE FUNCTION notify_test()
+RETURNS TRIGGER
+LANGUAGE plpgsql
+AS $$
+    BEGIN
+        NOTIFY woo;
+        RETURN NULL;
+    END
+$$
+}
+
+DROP_TRIGGER = %{
+DROP TRIGGER IF EXISTS notify_trigger ON test
+}
+
+
+TRIGGER = %{
+CREATE TRIGGER notify_trigger
+AFTER UPDATE OR INSERT OR DELETE
+ON test
+FOR EACH STATEMENT
+EXECUTE PROCEDURE notify_test();
+}
+
+conn = PG.connect( :dbname => 'test' )
+
+conn.exec( TRIGGER_TABLE )
+conn.exec( TRIGGER_FUNCTION )
+conn.exec( DROP_TRIGGER )
+conn.exec( TRIGGER )
+
+conn.exec( 'LISTEN woo' )  # register interest in the 'woo' event
+
+notifications = []
+
+puts "Now switch to a different term and run:",
+     '',
+     %{  psql test -c "insert into test values ('A message.')"},
+	 ''
+
+puts "Waiting up to 30 seconds for for an event!"
+conn.wait_for_notify( 30 ) do |notify, pid|
+	notifications << [ pid, notify ]
+end
+
+if notifications.empty?
+	puts "Awww, I didn't see any events."
+else
+	puts "I got one from pid %d: %s" % notifications.first
+end
+
+
+

data/sample/pg_statistics.rb

@@ -0,0 +1,285 @@
+# -*- ruby -*-
+# vim: set noet nosta sw=4 ts=4 :
+#
+# PostgreSQL statistic gatherer.
+# Mahlon E. Smith <mahlon@martini.nu>
+#
+# Based on queries by Kenny Gorman.
+#     http://www.kennygorman.com/wordpress/?page_id=491
+#
+# An example gnuplot input script is included in the __END__ block
+# of this script.  Using it, you can feed the output this script
+# generates to gnuplot (after removing header lines) to generate
+# some nice performance charts.
+#
+
+require 'ostruct'
+require 'optparse'
+require 'etc'
+require 'pg'
+
+
+### PostgreSQL Stats.  Fetch information from pg_stat_* tables.
+### Optionally run in a continuous loop, displaying deltas.
+###
+class Stats
+	VERSION = %q$Id$
+
+	def initialize( opts )
+		@opts = opts
+		@db   = PG.connect(
+			:dbname   => opts.database,
+			:host     => opts.host,
+			:port     => opts.port,
+			:user     => opts.user,
+			:password => opts.pass,
+			:sslmode  => 'prefer'
+		)
+		@last = nil
+	end
+
+	######
+	public
+	######
+
+	### Primary loop.  Gather statistics and generate deltas.
+	###
+	def run
+		run_count = 0
+
+		loop do
+			current_stat = self.get_stats
+
+			# First run, store and continue
+			#
+			if @last.nil?
+				@last = current_stat
+				sleep @opts.interval
+				next
+			end
+
+			# headers
+			#
+			if run_count == 0 || run_count % 50 == 0
+				puts "%-20s%12s%12s%12s%12s%12s%12s%12s%12s%12s%12s%12s%12s%12s%12s" % %w[
+					time commits rollbks blksrd blkshit bkends seqscan
+					seqtprd idxscn idxtrd ins upd del locks activeq
+				]
+			end
+
+			# calculate deltas
+			#
+			delta = current_stat.inject({}) do |h, pair|
+				stat, val = *pair
+
+				if %w[ activeq locks bkends ].include?( stat )
+					h[stat] = current_stat[stat].to_i
+				else
+					h[stat] = current_stat[stat].to_i - @last[stat].to_i
+				end
+
+				h
+			end
+			delta[ 'time' ] = Time.now.strftime('%F %T')
+
+			# new values
+			#
+			puts "%-20s%12s%12s%12s%12s%12s%12s%12s%12s%12s%12s%12s%12s%12s%12s" % [
+				delta['time'], delta['commits'], delta['rollbks'], delta['blksrd'],
+				delta['blkshit'], delta['bkends'], delta['seqscan'],
+				delta['seqtprd'], delta['idxscn'], delta['idxtrd'],
+				delta['ins'], delta['upd'], delta['del'], delta['locks'], delta['activeq']
+			]
+
+			@last = current_stat
+			run_count += 1
+			sleep @opts.interval
+		end
+	end
+
+
+	### Query the database for performance measurements.  Returns a hash.
+	###
+	def get_stats
+		res = @db.exec %Q{
+			SELECT
+				MAX(stat_db.xact_commit)       AS commits,
+				MAX(stat_db.xact_rollback)     AS rollbks,
+				MAX(stat_db.blks_read)         AS blksrd,
+				MAX(stat_db.blks_hit)          AS blkshit,
+				MAX(stat_db.numbackends)       AS bkends,
+				SUM(stat_tables.seq_scan)      AS seqscan,
+				SUM(stat_tables.seq_tup_read)  AS seqtprd,
+				SUM(stat_tables.idx_scan)      AS idxscn,
+				SUM(stat_tables.idx_tup_fetch) AS idxtrd,
+				SUM(stat_tables.n_tup_ins)     AS ins,
+				SUM(stat_tables.n_tup_upd)     AS upd,
+				SUM(stat_tables.n_tup_del)     AS del,
+				MAX(stat_locks.locks)          AS locks,
+				MAX(activity.sess)             AS activeq
+			FROM
+				pg_stat_database    AS stat_db,
+				pg_stat_user_tables AS stat_tables,
+				(SELECT COUNT(*) AS locks FROM pg_locks ) AS stat_locks,
+				(SELECT COUNT(*) AS sess FROM pg_stat_activity WHERE current_query <> '<IDLE>') AS activity
+			WHERE
+				stat_db.datname = '%s';
+		} % [ @opts.database ]
+
+		return res[0]
+	end
+end
+
+
+### Parse command line arguments.  Return a struct of global options.
+###
+def parse_args( args )
+	options          = OpenStruct.new
+	options.database = Etc.getpwuid( Process.uid ).name
+	options.host     = '127.0.0.1'
+	options.port     = 5432
+	options.user     = Etc.getpwuid( Process.uid ).name
+	options.sslmode  = 'disable'
+	options.interval = 5
+
+	opts = OptionParser.new do |opts|
+		opts.banner = "Usage: #{$0} [options]"
+
+		opts.separator ''
+		opts.separator 'Connection options:'
+
+		opts.on( '-d', '--database DBNAME',
+				"specify the database to connect to (default: \"#{options.database}\")" ) do |db|
+			options.database = db
+		end
+
+		opts.on( '-h', '--host HOSTNAME', 'database server host' ) do |host|
+			options.host = host
+		end
+
+		opts.on( '-p', '--port PORT', Integer,
+				"database server port (default: \"#{options.port}\")" ) do |port|
+			options.port = port
+		end
+
+		opts.on( '-U', '--user NAME',
+				"database user name (default: \"#{options.user}\")" ) do |user|
+			options.user = user
+		end
+
+		opts.on( '-W', 'force password prompt' ) do |pw|
+			print 'Password: '
+			begin
+				system 'stty -echo'
+				options.pass = gets.chomp
+			ensure
+				system 'stty echo'
+				puts
+			end
+		end
+
+		opts.separator ''
+		opts.separator 'Other options:'
+
+		opts.on( '-i', '--interval SECONDS', Integer,
+				 "refresh interval in seconds (default: \"#{options.interval}\")") do |seconds|
+			options.interval = seconds
+		end
+
+		opts.on_tail( '--help', 'show this help, then exit' ) do
+			$stderr.puts opts
+			exit
+		end
+
+		opts.on_tail( '--version', 'output version information, then exit' ) do
+			puts Stats::VERSION
+			exit
+		end
+	end
+
+	opts.parse!( args )
+	return options
+end
+
+
+### Go!
+###
+if __FILE__ == $0
+	$stdout.sync = true
+	Stats.new( parse_args( ARGV ) ).run
+end
+
+
+__END__
+######################################################################
+### T E R M I N A L   O P T I O N S
+######################################################################
+
+#set terminal png nocrop enhanced font arial 8 size '800x600' x000000 xffffff x444444
+#set output 'graph.png'
+
+set terminal pdf linewidth 4 size 11,8
+set output 'graph.pdf'
+
+#set terminal aqua
+
+
+######################################################################
+### O P T I O N S   F O R   A L L   G R A P H S
+######################################################################
+
+set multiplot layout 2,1 title "PostgreSQL Statistics\n5 second sample rate (smoothed)"
+
+set grid x y
+set key right vertical outside
+set key nobox
+set xdata time
+set timefmt "%Y-%m-%d.%H:%M:%S"
+set format x "%l%p"
+set xtic rotate by -45
+input_file = "database_stats.txt"
+
+# edit to taste!
+set xrange ["2012-04-16.00:00:00":"2012-04-17.00:00:00"]
+
+
+######################################################################
+### G R A P H   1
+######################################################################
+
+set title "Database Operations and Connection Totals"
+set yrange [0:200]
+
+plot \
+    input_file using 1:2 title "Commits" with lines smooth bezier, \
+    input_file using 1:3 title "Rollbacks" with lines smooth bezier, \
+    input_file using 1:11 title "Inserts" with lines smooth bezier, \
+    input_file using 1:12 title "Updates" with lines smooth bezier, \
+    input_file using 1:13 title "Deletes" with lines smooth bezier, \
+    input_file using 1:6 title "Backends (total)" with lines, \
+    input_file using 1:15 title "Active queries (total)" with lines smooth bezier
+
+
+######################################################################
+### G R A P H   2
+######################################################################
+
+set title "Backend Performance"
+set yrange [0:10000]
+
+plot \
+    input_file using 1:4 title "Block (cache) reads" with lines smooth bezier, \
+    input_file using 1:5 title "Block (cache) hits" with lines smooth bezier, \
+    input_file using 1:7 title "Sequence scans" with lines smooth bezier, \
+    input_file using 1:8 title "Sequence tuple reads" with lines smooth bezier, \
+    input_file using 1:9 title "Index scans" with lines smooth bezier, \
+    input_file using 1:10 title "Index tuple reads" with lines smooth bezier
+
+
+######################################################################
+### C L E A N U P
+######################################################################
+
+unset multiplot
+reset
+

data/sample/replication_monitor.rb

@@ -0,0 +1,222 @@
+# -*- ruby -*-
+# vim: set noet nosta sw=4 ts=4 :
+#
+# Get the current WAL segment and offset from a master postgresql
+# server, and compare slave servers to see how far behind they
+# are in MB.  This script should be easily modified for use with
+# Nagios/Mon/Monit/Zabbix/whatever, or wrapping it in a display loop,
+# and is suitable for both WAL shipping or streaming forms of replication.
+#
+# Mahlon E. Smith <mahlon@martini.nu>
+#
+# First argument is the master server, all other arguments are treated
+# as slave machines.
+#
+#	db_replication.monitor db-master.example.com ...
+#
+
+require 'ostruct'
+require 'optparse'
+require 'pathname'
+require 'etc'
+require 'pg'
+require 'pp'
+
+
+### A class to encapsulate the PG handles.
+###
+class PGMonitor
+
+	VERSION = %q$Id$
+
+	# When to consider a slave as 'behind', measured in WAL segments.
+	# The default WAL segment size is 16, so we'll alert after
+	# missing two WAL files worth of data.
+	#
+	LAG_ALERT = 32
+
+	### Create a new PGMonitor object.
+	###
+	def initialize( opts, hosts )
+		@opts        = opts
+		@master      = hosts.shift
+		@slaves      = hosts
+		@current_wal = {}
+		@failures    = []
+	end
+
+	attr_reader :opts, :current_wal, :master, :slaves, :failures
+
+
+	### Perform the connections and check the lag.
+	###
+	def check
+		# clear prior failures, get current xlog info
+		@failures = []
+		return unless self.get_current_wal
+
+		# check all slaves
+		self.slaves.each do |slave|
+			begin
+				slave_db = PG.connect(
+					:dbname   => self.opts.database,
+					:host     => slave,
+					:port     => self.opts.port,
+					:user     => self.opts.user,
+					:password => self.opts.pass,
+					:sslmode  => 'prefer'
+				)
+
+				xlog = slave_db.exec( 'SELECT pg_last_xlog_receive_location()' ).getvalue( 0, 0 )
+				slave_db.close
+
+				lag_in_megs = ( self.find_lag( xlog ).to_f / 1024 / 1024 ).abs
+				if lag_in_megs >= LAG_ALERT
+					failures << { :host => slave,
+						:error => "%0.2fMB behind the master." % [ lag_in_megs ] }
+				end
+			rescue => err
+				failures << { :host => slave, :error => err.message }
+			end
+		end
+	end
+
+
+	#########
+	protected
+	#########
+
+	### Ask the master for the current xlog information, to compare
+	### to slaves.  Returns true on success.  On failure, populates
+	### the failures array and returns false.
+	###
+	def get_current_wal
+		master_db = PG.connect(
+			:dbname   => self.opts.database,
+			:host     => self.master,
+			:port     => self.opts.port,
+			:user     => self.opts.user,
+			:password => self.opts.pass,
+			:sslmode  => 'prefer'
+		)
+
+		self.current_wal[ :segbytes ] = master_db.exec( 'SHOW wal_segment_size' ).
+			getvalue( 0, 0 ).sub( /\D+/, '' ).to_i << 20
+
+		current = master_db.exec( 'SELECT pg_current_xlog_location()' ).getvalue( 0, 0 )
+		self.current_wal[ :segment ], self.current_wal[ :offset ] = current.split( /\// )
+
+		master_db.close
+		return true
+
+	# If we can't get any of the info from the master, then there is no
+	# point in a comparison with slaves.
+	#
+	rescue => err
+		self.failures << { :host => self.master,
+			:error => 'Unable to retrieve required info from the master (%s)' % [ err.message ] }
+
+		return false
+	end
+
+
+	### Given an +xlog+ position from a slave server, return
+	### the number of bytes the slave needs to replay before it
+	### is caught up to the master.
+	###
+	def find_lag( xlog )
+		s_segment, s_offset = xlog.split( /\// )
+		m_segment  = self.current_wal[ :segment ]
+		m_offset   = self.current_wal[ :offset ]
+		m_segbytes = self.current_wal[ :segbytes ]
+
+		return (( m_segment.hex - s_segment.hex ) * m_segbytes) + ( m_offset.hex - s_offset.hex )
+	end
+
+end
+
+
+### Parse command line arguments.  Return a struct of global options.
+###
+def parse_args( args )
+	options          = OpenStruct.new
+	options.database = 'postgres'
+	options.port     = 5432
+	options.user     = Etc.getpwuid( Process.uid ).name
+	options.sslmode  = 'prefer'
+
+	opts = OptionParser.new do |opts|
+		opts.banner = "Usage: #{$0} [options] <master> <slave> [slave2, slave3...]"
+
+		opts.separator ''
+		opts.separator 'Connection options:'
+
+		opts.on( '-d', '--database DBNAME',
+				"specify the database to connect to (default: \"#{options.database}\")" ) do |db|
+			options.database = db
+		end
+
+		opts.on( '-h', '--host HOSTNAME', 'database server host' ) do |host|
+			options.host = host
+		end
+
+		opts.on( '-p', '--port PORT', Integer,
+				"database server port (default: \"#{options.port}\")" ) do |port|
+			options.port = port
+		end
+
+		opts.on( '-U', '--user NAME',
+				"database user name (default: \"#{options.user}\")" ) do |user|
+			options.user = user
+		end
+
+		opts.on( '-W', 'force password prompt' ) do |pw|
+			print 'Password: '
+			begin
+				system 'stty -echo'
+				options.pass = $stdin.gets.chomp
+			ensure
+				system 'stty echo'
+				puts
+			end
+		end
+
+		opts.separator ''
+		opts.separator 'Other options:'
+
+		opts.on_tail( '--help', 'show this help, then exit' ) do
+			$stderr.puts opts
+			exit
+		end
+
+		opts.on_tail( '--version', 'output version information, then exit' ) do
+			puts PGMonitor::VERSION
+			exit
+		end
+	end
+
+	opts.parse!( args )
+	return options
+end
+
+
+
+if __FILE__ == $0
+	opts = parse_args( ARGV )
+	raise ArgumentError, "At least two PostgreSQL servers are required." if ARGV.length < 2
+	mon = PGMonitor.new( opts, ARGV )
+
+	mon.check
+	if mon.failures.empty?
+		puts "All is well!"
+		exit 0
+	else
+		puts "Database replication delayed or broken."
+		mon.failures.each do |bad|
+			puts "%s: %s" % [ bad[ :host ], bad[ :error ] ]
+		end
+		exit 1
+	end
+end
+
+

data/sample/test_binary_values.rb

@@ -0,0 +1,33 @@
+# -*- ruby -*-1.9.1
+
+require 'pg'
+
+db = PG.connect( :dbname => 'test' )
+db.exec "DROP TABLE IF EXISTS test"
+db.exec "CREATE TABLE test (a INTEGER, b BYTEA)"
+
+a = 42
+b = [1, 2, 3]
+db.exec "INSERT INTO test(a, b) VALUES($1::int, $2::bytea)",
+	[a, {:value => b.pack('N*'), :format => 1}]
+
+db.exec( "SELECT a::int, b::bytea FROM test LIMIT 1", [], 1 ) do |res|
+
+	res.nfields.times do |i|
+		puts "Field %d is: %s, a %s (%s) column from table %p" % [
+			i,
+			res.fname( i ),
+			db.exec( "SELECT format_type($1,$2)", [res.ftype(i), res.fmod(1)] ).getvalue(0,0),
+			res.fformat( i ).zero? ? "string" : "binary",
+			res.ftable( i ),
+		]
+	end
+
+	res.each do |row|
+		puts "a = #{row['a'].inspect}"
+		puts "a (unpacked) = #{row['a'].unpack('N*').inspect}"
+		puts "b = #{row['b'].unpack('N*').inspect}"
+	end
+end
+
+