pg 0.7.9.2008.03.18 → 0.7.9.2008.08.17

data/sample/psqlHelp.rb

@@ -0,0 +1,158 @@
+#
+# Help for query language syntax
+#
+# Original source code is written by C.
+#  Copyright (c) 1996, Regents of the University of California
+#
+# ruby version is written by ematsu
+#  Copyright (c) 1997  Eiji-usagi-MATSUmoto <ematsu@pfu.co.jp>
+#
+# $Id: psqlHelp.rb,v 1.1.1.2 2002/04/24 05:46:44 noboru Exp $
+
+
+QL_HELP = [
+  [ "abort",
+      "abort the current transaction",
+      "abort [transaction];"],
+  [ "abort transaction",
+      "abort the current transaction",
+      "abort [transaction];"],
+  [ "alter table",
+      "add/rename attributes, rename tables",
+      "\talter table <class_name> [*] add column <attr> <type>;\n\talter table <class_name> [*] rename [column] <attr1> to <attr2>;\n\talter table <class_name1> rename to <class_name2>"],
+  [ "begin",
+      "begin a new transaction",
+      "begin [transaction|work];"],
+  [ "begin transaction",
+      "begin a new transaction",
+      "begin [transaction|work];"],
+  [ "begin work",
+      "begin a new transaction",
+      "begin [transaction|work];"],
+  [ "cluster",
+      "create a clustered index (from an existing index)",
+      "cluster <index_name> on <relation_name>"],
+  [ "close",
+      "close an existing cursor (cursor)",
+      "close <cursorname>;"],
+  [ "commit",
+      "commit a transaction",
+      "commit [work]"],
+  [ "commit work",
+      "commit a transaction",
+      "commit [work]"],
+  [ "copy",
+      "copy data to and from a table",
+      "copy [binary] <class_name> [with oids]\n\t{to|from} {<filename>|stdin|stdout} [using delimiters <delim>];"],
+  [ "create",   
+      "Please more be specific:",
+      "\tcreate aggregate\n\tcreate database\n\tcreate function\n\tcreate index\n\tcreate operator\n\tcreate rule\n\tcreate table\n\tcreate type\n\tcreate view"],
+  [ "create aggregate",
+      "define an aggregate function",
+      "create aggregate <agg_name> [as] (basetype = <data_type>, \n\t[sfunc1 = <sfunc_1>, stype1 = <sfunc1_return_type>]\n\t[sfunc2 = <sfunc_2>, stype2 = <sfunc2_return_type>]\n\t[,finalfunc = <final-function>]\n\t[,initcond1 = <initial-cond1>][,initcond2 = <initial-cond2>]);"],
+  [ "create database", 
+    "create a database",
+    "create database <dbname>"],
+  [ "create function",
+      "create a user-defined function",
+      "create function <function_name> ([<type1>,...<typeN>]) returns <return_type>\n\tas '<object_filename>'|'<sql-queries>'\n\tlanguage 'c'|'sql'|'internal';"],
+  [ "create index",
+      "construct an index",
+      "create [unique] index <indexname> on <class_name> [using <access_method>] (<attr1>|<funcname>(<attr1>,...) [<type_class1>]);"],
+  [ "create operator",
+      "create a user-defined operator",
+      "create operator <operator_name> (\n\t[leftarg = <type1>][,rightarg = <type2>]\n\t,procedure = <func_name>,\n\t[,commutator = <com_op>][,negator = <neg_op>]\n\t[,restrict = <res_proc>][,hashes]\n\t[,join = <join_proc>][,sort = <sort_op1>...<sort_opN>]);"],
+  [ "create rule",
+      "define a new rule",
+      "create rule <rule_name> as on\n\t[select|update|delete|insert]\n\tto <object> [where <qual>]\n\tdo [instead] [<action>|nothing| [<actions>]];"],
+  [ "create table",
+      "create a new table",
+      "create table <class_name> ( <attr1> <type1>,... <attrN> <typeN>)\n\t[inherits (<class_name1>,...<class_nameN>\n\tarchive=<archive_mode>\n\tstore=<smgr_name>\n\tarch_store=<smgr_name>];"],
+  [ "create type",
+      "create a new user-defined base data type",
+      "create type <typename> (\n\tinternallength = (<number> | variable),\n\t[externallength = (<number>|variable),]\n\tinput=<input_function>, output = <output_function>\n\t[,element = <typename>][,delimiter=<character>][,default=\'<string>\']\n\t[,send = <send_function>][,receive = <receive_function>][,passedbyvalue]);"],
+  [ "create view",
+      "create a view",
+      "create view <view_name> as select <expr1>[as <attr1>][,... <exprN>[as <attrN>]] [from <from_list>] [where <qual>];"],
+  [ "declare",
+      "set up a cursor",
+      "declare <cursorname> [binary] cursor for\n\tselect [distinct]\n\t<expr1> [as <attr1>],...<exprN> [as <attrN>]\n\t[from <from_list>] [where <qual>]\n\t[order by <attr1> [using <op1>],... <attrN> [using <opN>]];"],
+  [ "delete",
+      "delete tuples",
+      "delete from <class_name> [where <qual>];"],
+  [ "drop",   
+      "Please more be specific:",
+      "\tdrop aggregate\n\tdrop database\n\tdrop function\n\tdrop index\n\tdrop operator\n\tdrop rule\n\tdrop table\n\tdrop type\n\tdrop view"],
+  [ "drop aggregate",
+      "remove an aggregate function",
+      "drop aggregate <agg_name>;"],
+  [ "drop database",
+     "remove a database",
+     "drop database <dbname>"],
+  [ "drop function",
+      "remove a user-defined function",
+      "drop function <funcname> ([<type1>,....<typeN>]);"],
+  [ "drop index", 
+      "remove an existing index",
+      "drop index <indexname>;"],
+  [ "drop operator",
+      "remove a user-defined operator",
+      "drop operator <operator_name> ([<ltype>|none],[<rtype>|none]);"],
+  [ "drop rule",
+      "remove a rule",
+      "drop rule <rulename>;"],
+  [ "drop table", 
+      "remove a table", 
+      "drop table <class_name>[,...<class_nameN];"],
+  [ "drop type",
+      "remove a user-defined base type",
+      "drop type <typename>;"],
+  [ "drop view",
+      "remove a view",
+      "drop view <view_name>"],
+  [ "end",
+      "end the current transaction",
+      "end [transaction];"],
+  [ "end transaction",
+      "end the current transaction",
+      "end [transaction];"],
+  [ "explain",
+      "explain the query execution plan",
+      "explain [with {cost|plan|full}] <query>"],
+  [ "fetch",
+      "retrieve tuples from a cursor",
+      "fetch [forward|backward] [<number>|all] [in <cursorname>];"],
+  [ "grant",
+      "grant access control to a user or group",
+      "grant <privilege[,privilege,...]> on <rel1>[,...<reln>] to \n[public | group <group> | <username>]\n\t privilege is {ALL | SELECT | INSERT | UPDATE | DELETE | RULE}"],
+  [ "insert",
+      "insert tuples",
+      "insert into <class_name> [(<attr1>...<attrN>)]\n\t[values (<expr1>...<exprN>); |\n\tselect <expr1>,...<exprN> [from <from_clause>] [where <qual>];"],
+  [ "listen",
+       "listen for notification on a relation",
+       "listen <class_name>"],
+  [ "load",
+      "dynamically load a module",
+      "load <filename>;"],
+  [ "notify",
+      "signal all frontends and backends listening on a relation",
+      "notify <class_name>"],
+  [ "purge",
+      "purge historical data",
+      "purge <class_name> [before <abstime>] [after <reltime>];"],
+  [ "revoke",
+      "revoke access control from a user or group",
+      "revoke <privilege[,privilege,...]> on <rel1>[,...<reln>] from \n[public | group <group> | <username>]\n\t privilege is {ALL | SELECT | INSERT | UPDATE | DELETE | RULE}"],
+  [ "rollback",
+      "abort a transaction",
+      "rollback [transaction|work]"],
+  [ "select",
+      "retrieve tuples",
+      "select [distinct on <attr>] <expr1> [as <attr1>], ... <exprN> [as <attrN>]\n\t[into table <class_name>] [from <from_list>]\n\t[where <qual>]\n\t[order by <attr1>\n\t\t[using <op1>],..<attrN> [[using <opN>] | ASC | DESC]];" ],
+  [ "update",
+      "update tuples",
+      "update <class_name> set <attr1>=<expr1>,...<attrN>=<exprN> [from <from_clause>] [where <qual>];"],
+  [ "vacuum",
+      "vacuum the database, i.e. cleans out deleted records, updates statistics",
+      "vacuum [table];"]
+]

data/sample/test1.rb

@@ -0,0 +1,63 @@
+#! /usr/bin/env ruby
+#
+# original file src/test/examples/testlibpq.c
+# 
+require 'pg'
+
+def main
+  pghost = nil
+  pgport = nil
+  pgoptions = nil
+  pgtty = nil
+  dbname = "template1"
+  begin
+    conn = PGconn.connect(pghost,pgport,pgoptions,pgtty,dbname)
+    if $DEBUG
+      fd = open("/tmp/trace.out","w")
+      conn.trace(fd)
+    end 
+    res = conn.exec("BEGIN")
+    res.clear
+    res = conn.exec("DECLARE myportal CURSOR FOR select * from pg_database")
+    res.clear
+
+    res = conn.exec("FETCH ALL in myportal")
+    if (res.status != PGresult::TUPLES_OK)
+      raise PGerror,"FETCH ALL command didn't return tuples properly\n"
+    end
+
+    for fld in res.fields
+      printf("%-15s",fld)
+    end
+    printf("\n\n")
+
+    res.result.each do |tupl|
+      tupl.each do |fld|
+	printf("%-15s",fld)
+      end
+      printf("\n")
+    end
+    res = conn.exec("CLOSE myportal")
+    res = conn.exec("END")
+    res.clear
+    conn.close
+
+    if $DEBUG
+      fl.close
+    end
+  rescue PGError
+    if (conn.status == PGconn::CONNECTION_BAD)
+      printf(STDERR, "We have lost the connection to the backend, so ")
+      printf(STDERR, "further processing is impossible.  ")
+      printf(STDERR, "Terminating.\n")
+    else
+      printf(STDERR, conn.error)
+    end
+    exit(1)
+  end
+end
+
+main
+
+
+

data/sample/test2.rb

@@ -0,0 +1,44 @@
+#! /usr/bin/env ruby
+#
+# original file src/test/examples/testlibpq2.c
+#                       Test of the asynchronous notification interface
+# CREATE TABLE TBL1 (i int4);
+# CREATE TABLE TBL2 (i int4);
+# CREATE RULE r1 AS ON INSERT TO TBL1 DO (INSERT INTO TBL2 values (new.i); \
+#                                         NOTIFY TBL2);
+# Then start up this program
+# After the program has begun, do
+# INSERT INTO TBL1 values (10);
+
+
+require 'pg'
+
+def main
+  pghost = nil
+  pgport = nil
+  pgoptions = nil
+  pgtty = nil
+  dbname = ENV['USER'] 
+  begin
+    conn = PGconn.connect(pghost,pgport,pgoptions,pgtty,dbname)
+  rescue PGError
+    printf(STDERR, "Connection to database '%s' failed.\n",dbname)
+    exit(2)
+  end
+  begin
+    res = conn.exec("LISTEN TBL2")
+  rescue PGError
+    printf(STDERR, "LISTEN command failed\n")
+    exit(2)
+  end
+  res.clear
+  while 1
+    notify = conn.get_notify
+    if (notify)
+      printf(STDERR,"ASYNC NOTIFY '%s' from backend pid '%d' received\n",notify[0],notify[1])
+      break
+    end
+  end
+end
+
+main

data/sample/test4.rb

@@ -0,0 +1,71 @@
+#! /usr/bin/env ruby
+#
+# original file src/test/examples/testlibpq4.c
+#     this test programs shows to use LIBPQ to make multiple backend
+#
+require 'pg'
+
+def main
+  if (ARGV.size != 4)
+    printf(STDERR,"usage: %s tableName dbName1 dbName2\n", ARGV[0])
+    printf(STDERR,"    compares two tables in two databases\n")
+    exit(1)
+  end
+  tblname = ARGV[1]
+  dbname1 = ARGV[2]
+  dbname2 = ARGV[3]
+  pghost = nil
+  pgport = nil
+  pgoptions = nil
+  pgtty = nil
+
+  begin
+    conn1 = PGconn.connect(pghost,pgport,pgoptions,pgtty,dbname1)
+    conn2 = PGconn.connect(pghost,pgport,pgoptions,pgtty,dbname2)
+  rescue PGError
+    printf(STDERR,"connection to database.\n")
+    exit(1)
+  end
+  begin
+    res1 = conn1.exec("BEGIN")
+    res1.clear
+    res1 = conn1.exec("DECLARE myportal CURSOR FOR select * from pg_database")
+    res1.clear
+
+    res1 = conn1.exec("FETCH ALL in myportal")
+    if (res1.status != PGresult::TUPLES_OK)
+      raise PGerror,"FETCH ALL command didn't return tuples properly\n"
+    end
+
+    for fld in res1.fields
+      printf("%-15s",fld)
+    end
+    printf("\n\n")
+
+    res1.result.each do |tupl|
+      tupl.each do |fld|
+	printf("%-15s",fld)
+      end
+      printf("\n")
+    end
+    res1 = conn1.exec("CLOSE myportal")
+    res1 = conn1.exec("END")
+    res1.clear
+    conn1.close
+
+  rescue PGError
+    if (conn1.status == PGconn::CONNECTION_BAD)
+      printf(STDERR, "We have lost the connection to the backend, so ")
+      printf(STDERR, "further processing is impossible.  ")
+      printf(STDERR, "Terminating.\n")
+    else
+      printf(STDERR, conn1.error)
+    end
+    exit(1)
+  end
+end
+
+main
+
+
+

data/spec/data/expected_trace.out

@@ -0,0 +1,26 @@
+To backend> Msg Q
+To backend> "SELECT 1 AS one"
+To backend> Msg complete, length 21
+From backend> T
+From backend (#4)> 28
+From backend (#2)> 1
+From backend> "one"
+From backend (#4)> 0
+From backend (#2)> 0
+From backend (#4)> 23
+From backend (#2)> 4
+From backend (#4)> -1
+From backend (#2)> 0
+From backend> D
+From backend (#4)> 11
+From backend (#2)> 1
+From backend (#4)> 1
+From backend (1)> 1
+From backend> C
+From backend (#4)> 11
+From backend> "SELECT"
+From backend> Z
+From backend (#4)> 5
+From backend> Z
+From backend (#4)> 5
+From backend> I

data/spec/pgconn_spec.rb

@@ -0,0 +1,127 @@
+require 'rubygems'
+require 'spec'
+
+$LOAD_PATH.unshift('ext')
+require 'pg'
+
+describe PGconn do
+
+	before( :all ) do
+		puts "======  TESTING PGconn  ======"
+		@test_directory = "#{Dir.getwd}/tmp_test_#{rand}"
+		@test_pgdata = @test_directory + '/data'
+		if File.exists?(@test_directory) then
+			raise "test directory exists!"
+		end
+		@conninfo = "host='#{@test_directory}' dbname=test"
+		Dir.mkdir(@test_directory)
+		Dir.mkdir(@test_pgdata)
+		cmds = []
+		cmds << "initdb -D '#{@test_pgdata}'"
+		cmds << "pg_ctl -D '#{@test_pgdata}' " + 
+			%!-o "--unix-socket-directory='#{@test_directory}' ! + 
+			%!--listen-addresses=''" ! + 
+			"start"
+		cmds << "sleep 2"
+		cmds << "createdb -h '#{@test_directory}' test"
+		cmds.each do |cmd|
+			if not system(cmd) then
+				raise "Error executing cmd: #{cmd}: #{$?}"
+			end
+		end
+		@conn = PGconn.connect(@conninfo)
+	end
+
+	it "should connect successfully with connection string" do
+		tmpconn = PGconn.connect(@conninfo)
+		tmpconn.status.should== PGconn::CONNECTION_OK
+		tmpconn.finish
+	end
+
+	it "should connect using 7 arguments converted to strings" do
+		tmpconn = PGconn.connect(@test_directory, 5432, nil, nil, :test, nil, nil)
+		tmpconn.status.should== PGconn::CONNECTION_OK
+		tmpconn.finish
+	end
+
+	it "should connect using hash" do
+		tmpconn = PGconn.connect(
+			:host => @test_directory,
+			:port => 5432,
+			:dbname => :test)
+		tmpconn.status.should== PGconn::CONNECTION_OK
+		tmpconn.finish
+	end
+
+	it "should connect asynchronously" do
+		tmpconn = PGconn.connect_start(@conninfo)
+		socket = IO.for_fd(tmpconn.socket)
+		status = tmpconn.connect_poll
+		while(status != PGconn::PGRES_POLLING_OK) do
+			if(status == PGconn::PGRES_POLLING_READING)
+				if(not select([socket],[],[],5.0))
+					raise "Asynchronous connection timed out!"
+				end
+			elsif(status == PGconn::PGRES_POLLING_WRITING)
+				if(not select([],[socket],[],5.0))
+					raise "Asynchronous connection timed out!"
+				end
+			end
+			status = tmpconn.connect_poll
+		end
+		tmpconn.status.should== PGconn::CONNECTION_OK
+		tmpconn.finish
+	end
+
+	it "should not leave stale server connections after finish" do
+		PGconn.connect(@conninfo).finish
+		res = @conn.exec(%[SELECT COUNT(*) AS n FROM pg_stat_activity
+							WHERE usename IS NOT NULL])
+		# there's still the global @conn, but should be no more
+		res[0]['n'].should == '1'
+	end
+
+	it "should trace and untrace client-server communication" do
+		# be careful to explicitly close files so that the 
+		# directory can be removed and we don't have to wait for
+		# the GC to run.
+		expected_trace_data = open('spec/data/expected_trace.out').read
+		trace_file = open("#{@test_directory}/test_trace.out", 'w')
+		@conn.trace(trace_file)
+		trace_file.close
+		res = @conn.exec("SELECT 1 AS one")
+		@conn.untrace
+		res = @conn.exec("SELECT 2 AS two")
+		trace_file = open("#{@test_directory}/test_trace.out")
+		trace_data = trace_file.read
+		trace_file.close
+		trace_data.should == expected_trace_data
+	end
+
+	it "should cancel a query" do
+		error = false
+		@conn.send_query("SELECT pg_sleep(1000)")
+		@conn.cancel
+		begin
+			tmpres = @conn.get_result
+		rescue PGError => e
+			error = true
+		end
+		error.should == true
+	end
+
+	after( :all ) do
+		puts ""
+		@conn.finish
+		cmds = []
+		cmds << "pg_ctl -D '#{@test_pgdata}' stop"
+		cmds << "rm -rf '#{@test_directory}'"
+		cmds.each do |cmd|
+			if not system(cmd) then
+				raise "Error executing cmd: #{cmd}: #{$?}"
+			end
+		end
+		puts "====== COMPLETED TESTING PGconn  ======"
+		puts ""
+	end
+end