pg 0.8.0 → 0.9.0.pre156

data/Contributors

@@ -26,3 +26,5 @@ Yuta TSUBOI <yuuta-t@is.aist-nara.ac.jp>
 Lugovoi Nikolai <meadow.nnick@gmail.com>
 Jeff Davis <ruby@j-davis.com>
 Bertram Scharpf <software@bertram-scharpf.de>
+Michael Granger <ged@FaerieMUD.org>
+Mahlon E. Smith <mahlon@martini.nu>

data/README

@@ -1,125 +1,68 @@
-================================================================================
-ruby-pg: Ruby interface to PostgreSQL RDBMS
-================================================================================
+= ruby-pg: Ruby interface to PostgreSQL RDBMS
 
-This library is copyrighted by the authors.
-
-Authors:
-  * Yukihiro Matsumoto <matz@ruby-lang.org>
-      Author of Ruby.
-  * Eiji Matsumoto <usagi@ruby.club.or.jp>
-      One of users who loves Ruby.
-  * Jeff Davis <ruby-pg@j-davis.com>
-
-Thanks to:
-  * Noboru Saitou <noborus@netlab.jp>
-      Past maintainer.
-  * Dave Lee
-      Past maintainer.
-  * Guy Decoux   ts <decoux@moulon.inra.fr> 
-  
-Maintainer:
-  Jeff Davis <ruby-pg@j-davis.com>
-
-Copying:
-  You may redistribute this software under the terms of the Ruby license,
-  included in the file "LICENSE". The Ruby license also allows distribution
-  under the terms of the GPL, included in the file "COPYING.txt" and the
-  file "GPL".
-
-  Portions of the code are from the PostgreSQL project, and are distributed
-  under the terms of the BSD license, included in the file "BSD".
-
-- Summary
+This is the extension library to access a PostgreSQL database from Ruby. This
+library works with PostgreSQL 7.4 and later.
 
-This is the extension library to access a PostgreSQL database from Ruby.
-This library works with PostgreSQL 7.4 and later.
+== Requirements
 
-- Requirements
+* Ruby 1.8.6 or later.
+* PostgreSQL 7.3 or later installed.
 
-  Ruby 1.8 or later.
-  PostgreSQL 7.3 or later installed.
+It may work with earlier versions as well, but those are not regularly tested.
 
-  It may work with earlier versions as well, but those are
-  not regularly tested.
+== How To Install
 
-- How to install ?
+Install via RubyGems:
 
-Follow the instructions below to compile and install:
+  gem install pg
 
-  ruby extconf.rb
-  make
-  su              (if necessary)
-  make install
+Or install from source:
 
-You may need to specify the directory name for the include files and the
--lpq library by using
+  rake install
 
-    --with-pgsql-include=<include file directory>
-    --with-pgsql-lib=<library directory>
+You may need to specify the path to the 'pg_config' program installed with
+Postgres:
 
-For example:
+  rake -- --with-pg-config=<path to pg_config>
 
-  ruby extconf.rb --with-pgsql-include=/usr/local/pgsql/include \
-                  --with-pgsql-lib=/usr/local/pgsql/lib
+For example, on a Mac with PostgreSQL installed via MacPorts 
+(<tt>port install postgresql84</tt>):
 
-- Modules
+  rake install -- --with-pg-config=/opt/local/lib/postgresql84/bin/pg_config
 
-'pg': The 'pg' module is the newer module, that has been greatly improved, and
-  is almost a complete rewrite. It is not backwards compatible. Use this module
-  for newly written code. It should be more stable, less buggy, and has more
-  features.
+See README.OS_X for more information about installing under MacOS X, and 
+README.windows for Windows build/installation instructions.
 
-'postgres': Older module, maintained for backwards compatibility. It 
-  has known flaws that aren't reasonably fixable without breaking backwards
-  compatibility. Use this module if you have code that already works, and 
-  you just want the fixes that I've committed to this module (for instance,
-  this module is compatible with PostgreSQL 8.3).
+== Copying
 
-- How to use ?
-
-This gem builds and installs two PostgreSQL database adapters, 'postgres'
-and 'pg'. 
+This library is copyrighted by the authors.
 
-The standard way to download and install the most current stable  
-version of the postgres gem (from http://gems.rubyforge.org) is to use  
-the RubyGem package manager. You may need to supply RubyGem with the 
-location of the libpq library and the libpq.h and libpq/libpq-fs.h 
-files, and may need to run as root.
-If you installed from source on a Unix system you can locate these  
-libpq files with:
-find <path to install directory> -name "libpq-fe.h" -print
-With binary distributions, you may need to install additional  
-PostgreSQL development libraries to get these files.
+Authors:
+* Yukihiro Matsumoto <matz@ruby-lang.org> - Author of Ruby.
+* Eiji Matsumoto <usagi@ruby.club.or.jp> - One of users who loves Ruby.
+* Jeff Davis <ruby-pg@j-davis.com>
 
-Then run:
-sudo gem install postgres -- --with-pgsql-include-dir=<location of  
-Postgresql>/include --with-pgsql-lib-dir=<location of Postgresql/lib
+Thanks to:
+* Noboru Saitou <noborus@netlab.jp> - Past maintainer.
+* Dave Lee - Past maintainer.
+* Guy Decoux (ts) <decoux@moulon.inra.fr> 
+  
+Maintainers:
+* Jeff Davis <ruby-pg@j-davis.com>
+* Michael Granger <ged@FaerieMUD.org>
 
-Example:
-on Mac OS X with PostgreSQL in /Library/PostgreSQL8 use
---with-pgsql-include-dir=/Library/PostgreSQL8/include --with-pgsql-lib- 
-dir=/Library/PostgreSQL8/lib
+You may redistribute this software under the terms of the Ruby license,
+included in the file "LICENSE". The Ruby license also allows distribution
+under the terms of the GPL, included in the file "GPL".
 
-To use the module with Rails:
-refer to it as
-adapter: postgresql
-in your database:yaml file
+Portions of the code are from the PostgreSQL project, and are distributed
+under the terms of the BSD license, included in the file "BSD".
 
-To use these modules in Ruby directly (not Rails), refer to the RDoc
-documentation.
+Portions copyright LAIKA, Inc.
 
-- Acknowledgments
+== Acknowledgments
 
 We are thankful to the people at the ruby-list and ruby-dev mailing lists.
 And to the people who developed PostgreSQL.
 
-- Copying
-
-This library is copyrighted by its authors; Yukihiro Matsumoto, and Eiji
-Matsumoto.
-
-Portions copyright Laika, Inc.
-
-
 

data/README.OS_X

@@ -0,0 +1,19 @@
+= Compiling on MacOS X
+
+If you are building/installing ruby-pg on MacOS X, and the installation doesn't work at first, here are a few things you can try.
+
+== Compiling With the Correct Architecture
+
+OS X supports both architecture-specific binaries (e.g. i386), as well as universal binaries (i.e. i386 & ppc). If ruby is built as a universal binary and postgresql is not, you need to specify the path to the appropriate pg_config binary or set the environment variable ARCHFLAGS appropriately.
+
+For example, if you're using the stock Ruby binary, and PostgreSQL 8.4.x installed from MacPorts (without specifying the {{{+universal}}} variant), do:
+
+  gem install -- --with-pg-config=/opt/local/lib/postgresql84/bin/pg_config
+
+Alternatively, if the build system can't figure out which architectures it should include, you may need to set the 'ARCHFLAGS' environment variable explicitly:
+
+  sudo env ARCHFLAGS='-arch i386' gem install pg
+
+or, if you're building from source:
+
+  rake compile ARCHFLAGS="-arch i386"

data/README.ja

@@ -0,0 +1,183 @@
+                  PostgreSQL$BMQ3HD%%i%$%V%i%j(B  version 0.7.1
+
+                                                             $B$^$D$b$H(B $B$f$-$R$m(B
+                                                             $B$^$D$b$H(B $B$($$$8(B
+
+                                                  $B@$OC?M(B:    $B@FF#(B $BEP(B
+	
+- What's this ?
+
+$BK\%i%$%V%i%j$O!"(BRuby$B$+$i(BPostgreSQL$B$X%"%/%;%9$9$k$?$a$N3HD%%i%$%V%i%j$G$9!#(B
+$B%5%]!<%H$7$F$$$k(BPostgreSQL$B$N%P!<%8%g%s$O!"(B6.5/7.0/7.1/7.2 $B$G$9!#(B6.3$B0JA0$N(B
+$B%P!<%8%g%s$G$b(B($B$A$g$C$H$7$?JQ99$G(B)$BF0:n$9$k$H;W$$$^$9$,!"%F%9%H$7$F$$$^$;$s!#(B
+
+- How to install ?
+ *** requirement ***
+ PostgreSQL module$B$r;H$&$s$G$9$+$i!$EvA3(BPostgreSQL$B$OI,MW$G$9$M!%:#$N$H$3$m(B
+ $B%m!<%+%k$K(BPostgreSQL$B$,%$%s%9%H!<%k$5$l$F$$$k$3$H$rA0Ds$K$7$F$$$^$9$,!$(B
+ $BI,MW$J%X%C%@$H(Blibpq$B$5$($"$l$P!$%5!<%P$OI,$:$7$b%m!<%+%k$GF0:n$7$F$$$kI,MW(B
+ $B$O$"$j$^$;$s!%(B
+
+ $B%G%U%)%k%H$G$O!$(BPostgreSQL$B$,(B/usr/local/pgsql$BG[2<$K%$%s%9%H!<%k$5$l$F$$$k(B
+ $B$H$7$F$$$^$9!%JL$N>l=j$K%$%s%9%H!<%k$7$F$$$k>l9g$K$O!$4D6-JQ?t(BPGLIB$B$K(Blibpq
+ $B%i%$%V%i%j$,CV$$$F$"$k(Bdirectory$B$K@_Dj$7$F2<$5$$!#(B
+
+ $BG$0U$N>l=j$G!$$3$N%"!<%+%$%V$rE83+$7$F$/$@$5$$!%8e$O(B
+
+  ruby extconf.rb
+  make
+  su               ($B$b$7I,MW$J$i(B)
+  make install
+ 
+ $B$H$9$k$@$1$G$9!%(BPostgreSQL$B$N%$%s%/%k!<%I%U%!%$%k!"%i%$%V%i%j%U%!%$%k$N(B
+ $B%$%s%9%H!<%k>l=j$,I8=`$N0LCV$G$O$J$/%3%s%Q%$%i$,8+IU$1$k$3$H$,$G$-$J$$(B
+ $B>l9g$K$O(B
+
+    --with-pgsql-include-dir=<$B%$%s%/%k!<%I%U%!%$%k%G%#%l%/%H%j(B>
+    --with-pgsql-lib-dir=<$B%i%$%V%i%j%G%#%l%/%H%j(B>
+$B$^$?$O(B
+    --with-pgsql-dir=<$B%G%#%l%/%H%j(B>
+          $B$3$l$O0J2<$N$h$&$K;XDj$7$?$H$-$H$*$J$8$G$9!#(B
+           --with-pgsql-include-dir=<$B%G%#%l%/%H%j(B>/include
+           --with-pgsql-lib-dir=<$B%G%#%l%/%H%j(B>/lib
+
+
+ $BNc$($P(B
+
+  ruby extconf.rb --with-pgsql-include-dir=/usr/local/pgsql/include \
+                  --with-pgsql-lib-dir=/usr/local/pgsql/lib
+$B$^$?$O(B
+  ruby extconf.rb --with-pgsql-dir=/usr/local/pgsql
+
+ $B$N$h$&$K;XDj$7$F$/$@$5$$!#(B
+
+- How to use ?
+
+  require "postgres"
+
+$B$H$7$F$+$i8f;HMQ2<$5$$!#(B
+
+- What function can I use ?
+
+$B4pK\E*$K!"(BC$B$N(Blibpq$B%$%s%?%U%'!<%9$GDj5A$5$l$F$$$k4X?t$O%5%]!<%H$7$F$$$^$9!#(B
+ver 0.6.0 $B$+$i?7$7$/(B Large Object $B%$%s%?!<%U%'%$%9$,DI2C$5$l$^$7$?!#(B
+
+$B%5%]!<%H$7$F$$$k%a%=%C%I$N0lMw$O0J2<$NDL$j$G$9!#(B
+
+PGconn$B%/%i%9(B:
+
+ $B%/%i%9%a%=%C%I(B
+    new
+    connect
+    setdb
+    setdblogin
+    escape
+    quote
+    escape_bytea
+
+ $B%a%=%C%I(B
+    db
+    host
+    options
+    port
+    tty
+    status
+    error
+    finish
+    close
+    reset
+    user
+    trace
+    untrace
+
+    exec
+    query
+    async_exec
+    async_query
+    get_notify
+    insert_table
+    putline
+    getline
+    endcopy
+    notifies
+
+    lo_import
+    lo_export
+    lo_create
+    lo_open  
+    lo_unlink
+
+    client_encoding
+    set_client_encoding
+
+PGresult$B%/%i%9(B:
+
+$B%a%=%C%I(B
+    each
+    []
+    status
+    result
+    fields
+    num_tuples
+    num_fields
+    fieldname
+    fieldnum
+    type
+    size
+    getvalue
+    getlength
+    cmdstatus
+    print
+    clear
+
+PGlarge$B%/%i%9(B:
+
+$B%a%=%C%I(B
+    open
+    close
+    read
+    write
+    lseek
+    tell
+    unlink
+    oid
+    size
+    export
+    
+- Acknowledgement
+
+$BK\3HD%%i%$%V%i%j$r:n@.$9$k$K$"$?$C$F!"(Bruby-list, ruby-dev,
+ruby-talk,$B5Z$S(B pgsql-jp$B%a!<%j%s%0%j%9%H$N%a%s%P!<$K!"B?$/$NM-1W$J(B
+$B%"%I%P%$%9$rD:$-$^$7$?!#$3$3$K46<U$N0U$rI=$7$^$9!#(B
+
+- Copying
+
+$BK\3HD%%i%$%V%i%j$NCx:n8"$O!"$^$D$b$H(B $B$f$-$R$m$H$^$D$b$H(B $B$($$$8$,(B
+$BJ];}$7$^$9!#(B
+
+$BK\3HD%%i%$%V%i%j$O!"(BRuby$BK\BN$HF1$8G[I[>r7o$K=>$C$F:FG[I[$9$k$3$H(B
+$B$,$G$-$^$9!#(BRuby$BK\BN$NG[I[>r7o$K$D$$$F$O!"(BRuby$BG[I[J*Cf$N(BREADME.jp
+$B$K=q$+$l$F$$$^$9!#(B
+
+$B8=:_$O@FF#(B $BEP$,(B maintainer $B$r>5$C$F$$$k$N$G!"Ld$$9g$o$;$O$3$A$i$NJ}$K(B
+$B$*4j$$$7$^$9!#(B
+
+- Author
+
+ $B$^$D$b$H(B $B$f$-$R$m(B <matz@ruby-lang.org>
+  Author of Ruby
+
+ $B$^$D$b$H(B $B$($$$8(B <usagi@ruby.club.or.jp>
+  One of users who loves Ruby
+
+$B$3$N$U$?$j$O7;Do$G$O$"$j$^$;$s!#(B :-)
+
+- Special Thanks
+
+ Guy Decoux   ts <decoux@moulon.inra.fr>
+
+- maintainer
+
+  $B@FF#(B $BEP(B <noborus@netlab.jp>
+  $B$^$D$b$H$G$J$/$F$9$$$^$;$s(B :-)
+

data/README.windows

@@ -0,0 +1,72 @@
+
+= Compiling on MS Windows
+
+In order to build this extension on MS Windows you will need a couple things.
+
+First, a compiler. For the one click installer this means you should either
+use VC++ 6.0 or the compiler that comes with cygwin or mingw if you're
+building on that platform.
+
+If you've built Ruby yourself, you should use the same compiler to build
+this library that you used to build Ruby.
+
+Second, PostgreSQL. Be sure you installed it with the development header
+files if you installed it using the standard PostgreSQL installer for
+Windows. If you didn't, you can run the installer again, select "modify",
+and then select the 'development headers' option to install them.
+
+I recommend making sure that 'pg_config.exe' is in your PATH. The PostgreSQL
+installer for Windows does not necessarily update your PATH when it installs
+itself, so you may need to do this manually. This isn't strictly necessary,
+however.
+
+In order to build ruby-pg, just run 'rake'. If the pg_config.exe executable
+is not in your PATH, you'll need to explicitly point ruby-pg to where your
+PostgreSQL headers and libraries are with something like this:
+
+   rake --with-pg-dir=c:/progra~1/postgr~1/8.3
+
+Adjust your path accordingly. BE SURE TO USE THE SHORT PATH NAMES! If you
+try to use a path with spaces in it, the nmake.exe program will choke.
+
+
+== Cross compiling for mswin32
+
+Using rake-compiler a cross compiled pg-gem can be build on a linux host for
+the win32 platform. The generated gem is statically linked against libpq and
+libssl. OpenSSL and PostgreSQL are downloaded and compiled from the sources.
+There are no runtime dependencies to any but the standard Windows DLLs.
+
+Install mingw32. On a debian based system this should work:
+
+   apt-get install mingw32
+
+On MacOS X, if you have MacPorts installed:
+
+  port install i386-mingw32-gcc
+
+Install the rake-compiler:
+
+  gem install rake-compiler
+
+Download and cross compile ruby for win32:
+
+  rake-compiler cross-ruby VERSION=1.8.6-p287
+
+Download and cross compile pg for win32:
+
+  rake cross native gem RUBY_CC_VERSION=1.8.6 OPENSSL_VERSION=0.9.8l POSTGRESQL_VERSION=8.4.2
+
+If everything works, there should be pg-VERSION-x86-mswin32.gem in the pkg
+directory.
+
+
+If you have any problems you can submit them via the project's issue-tracker:
+
+  http://bitbucket.org/ged/ruby-pg/issues/new/
+
+Or you can join the mailing list:
+
+  ruby-pg-general@rubyforge.org
+
+And submit questions, problems, or solutions, so that it can be improved.