postgres 0.7.9.2007.12.22 → 0.7.9.2008.01.03

data/README

@@ -21,8 +21,6 @@ Thanks to:
 Maintainer:
   Jeff Davis <ruby-pg@j-davis.com>
 
-Portions copyright Laika, Inc.
-
 Copying:
   You may redistribute this software under the terms of the GPL,
   included in the file named GPL; or under the same terms as Ruby,
@@ -31,13 +29,15 @@ Copying:
 - Summary
 
 This is the extension library to access a PostgreSQL database from Ruby.
-This library works with PostgreSQL 6.5/7.0/7.1/7.2; it probably works 
-with 6.3 or earlier with slight modification, but not tested at all.
+This library works with PostgreSQL 7.4 and later.
 
 - Requirements
 
-  Ruby 1.3.4 or later.
-  PostgreSQL 6.4/6.5/7.0/7.1/7.2 installed.
+  Ruby 1.8 or later.
+  PostgreSQL 7.4 or later installed.
+
+  It may work with earlier versions as well, but those are
+  not regularly tested.
 
 - How to install ?
 
@@ -51,113 +51,35 @@ Follow the instructions below to compile and install:
 You may need to specify the directory name for the include files and the
 -lpq library by using
 
-    --with-pgsql-include-dir=<include file directory>
-    --with-pgsql-lib-dir=<library directory>
- or 
-    --with-pgsql-dir=<dir>
-      Same as --with-pgsql-include-dir=<dir>/include,
-      --with-pgsql-lib-dir=<dir>/lib
-
+    --with-pgsql-include=<include file directory>
+    --with-pgsql-lib=<library directory>
 
 For example:
 
-  ruby extconf.rb --with-pgsql-include-dir=/usr/local/pgsql/include \
-                  --with-pgsql-lib-dir=/usr/local/pgsql/lib
-or
-  ruby extconf.rb --with-pgsql-dir=/usr/local/pgsql/
+  ruby extconf.rb --with-pgsql-include=/usr/local/pgsql/include \
+                  --with-pgsql-lib=/usr/local/pgsql/lib
 
 - How to use ?
 
 You need to specify:
 
-  require "postgres"
-
-at the top of your script.
-
-- What functions can I use ?
-
-The list of supported functions are below.  See postgres.html for detail.
-
-class PGconn:
-
- class methods:
-    new
-    connect
-    setdb
-    setdblogin
-
-    escape
-    quote
-    escape_bytea
-
- methods:
-    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
-
-class PGresult:
-
- methods:
-    each
-    []
-    status
-    result
-    fields
-    num_tuples
-    num_fields
-    fieldname
-    fieldnum
-    type
-    size
-    getvalue
-    getlength
-    cmdstatus
-    print
-    clear
-
-class PGlarge:
-
- methods:
-    open
-    close
-    read
-    write
-    lseek
-    tell
-    unlink
-    oid
-    size
-    export
+  require 'pg' or
+  require 'postgres'
+
+These are two different modules, with important differences.
+
+The 'postgres' module is the 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).
+
+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 the RDoc documentation for detailed usage instructions.
 
 - Acknowledgments
 
@@ -169,3 +91,7 @@ And to the people who developed PostgreSQL.
 This library is copyrighted by its authors; Yukihiro Matsumoto, and Eiji
 Matsumoto.
 
+Portions copyright Laika, Inc.
+
+
+

data/compat-ruby-postgres/postgres.c

@@ -14,8 +14,16 @@
 
 #include "ruby.h"
 #include "rubyio.h"
+
+#if RUBY_VM == 1
+  /* ruby 1.9 */
+#include "ruby/st.h"
+#include "ruby/intern.h"
+#else
+  /* ruby 1.8 */
 #include "st.h"
 #include "intern.h"
+#endif
 
 /* grep '^#define' $(pg_config --includedir)/server/catalog/pg_type.h | grep OID */
 #include "type-oids.h"
@@ -33,6 +41,10 @@ PQserverVersion(const PGconn *conn)
 }
 #endif /* HAVE_PQSERVERVERSION */
 
+#ifndef RHASH_SIZE
+#define RHASH_SIZE(x) RHASH((x))->tbl->num_entries
+#endif /* RHASH_SIZE */
+
 #ifndef RSTRING_LEN
 #define RSTRING_LEN(x) RSTRING((x))->len
 #endif /* RSTRING_LEN */
@@ -41,6 +53,14 @@ PQserverVersion(const PGconn *conn)
 #define RSTRING_PTR(x) RSTRING((x))->ptr
 #endif /* RSTRING_PTR */
 
+#if RUBY_VM == 1
+  /* ruby 1.9 */
+#define RB_REG_NEW(s, len, opt) rb_reg_new(rb_str_new((s),(len)), opt)
+#else
+  /* ruby 1.8 */
+#define RB_REG_NEW(s, len, opt) rb_reg_new((s), (len), (opt))
+#endif
+
 #ifndef HAVE_PG_ENCODING_TO_CHAR
 #define pg_encoding_to_char(x) "SQL_ASCII"
 #endif
@@ -133,7 +153,7 @@ try_connectdb(arg)
         /* do nothing */
     }
     else if (!NIL_P(conninfo = rb_check_hash_type(arg))) {
-        VALUE key_values = rb_ary_new2(RHASH(conninfo)->tbl->num_entries);
+        VALUE key_values = rb_ary_new2(RHASH_SIZE(conninfo));
         rb_hash_foreach(conninfo, build_key_value_string_i, key_values);
         conninfo = rb_ary_join(key_values, rb_str_new2(" "));
     }
@@ -465,21 +485,19 @@ pgconn_s_escape_bytea(self, obj)
     VALUE self;
     VALUE obj;
 {
-    char *from, *to;
+    unsigned char *from, *to;
     size_t from_len, to_len;
     VALUE ret;
     
     Check_Type(obj, T_STRING);
-    from      = RSTRING_PTR(obj);
+    from      = (unsigned char*)RSTRING_PTR(obj);
     from_len  = RSTRING_LEN(obj);
     
-    to = (char *)PQescapeBytea(from, from_len, &to_len);
+    to = PQescapeBytea(from, from_len, &to_len);
     
-    ret = rb_str_new(to, to_len - 1);
+    ret = rb_str_new((char*)to, to_len - 1);
     OBJ_INFECT(ret, obj);
-    
     PQfreemem(to);
-    
     return ret;
 }
 
@@ -503,21 +521,19 @@ pgconn_escape_bytea(self, obj)
     VALUE self;
     VALUE obj;
 {
-    char *from, *to;
+    unsigned char *from, *to;
     size_t from_len, to_len;
     VALUE ret;
     
     Check_Type(obj, T_STRING);
-    from      = RSTRING_PTR(obj);
+    from      = (unsigned char*)RSTRING_PTR(obj);
     from_len  = RSTRING_LEN(obj);
     
-    to = (char *)PQescapeByteaConn(get_pgconn(self),from, from_len, &to_len);
+    to = PQescapeByteaConn(get_pgconn(self),from, from_len, &to_len);
     
-    ret = rb_str_new(to, to_len - 1);
+    ret = rb_str_new((char*)to, to_len - 1);
     OBJ_INFECT(ret, obj);
-    
     PQfreemem(to);
-    
     return ret;
 }
 
@@ -535,16 +551,16 @@ static VALUE
 pgconn_s_unescape_bytea(self, obj)
     VALUE self, obj;
 {
-    char *from, *to;
+    unsigned char *from, *to;
     size_t to_len;
     VALUE ret;
 
     Check_Type(obj, T_STRING);
-    from = StringValuePtr(obj);
+    from = (unsigned char*)StringValuePtr(obj);
 
-    to = (char *) PQunescapeBytea(from, &to_len);
+    to = PQunescapeBytea(from, &to_len);
 
-    ret = rb_str_new(to, to_len);
+    ret = rb_str_new((char*)to, to_len);
     OBJ_INFECT(ret, obj);
     PQfreemem(to);
 
@@ -1351,7 +1367,7 @@ pgconn_set_client_encoding(obj, str)
 {
     Check_Type(str, T_STRING);
     if ((PQsetClientEncoding(get_pgconn(obj), StringValuePtr(str))) == -1){
-        rb_raise(rb_ePGError, "invalid encoding name %s",str);
+        rb_raise(rb_ePGError, "invalid encoding name: %s",StringValuePtr(str));
     }
     return Qnil;
 }
@@ -1880,76 +1896,6 @@ pgresult_getisnull(obj, tup_num, field_num)
     return PQgetisnull(result, i, j) ? Qtrue : Qfalse;
 }
 
-/*
- * call-seq:
- *    res.print( file, opt )
- *
- * MISSING: Documentation
- */
-static VALUE
-pgresult_print(obj, file, opt)
-    VALUE obj, file, opt;
-{
-    VALUE value;
-    ID mem;
-    OpenFile* fp;
-    PQprintOpt po;
-
-    Check_Type(file, T_FILE);
-    Check_Type(opt,  T_STRUCT);
-    GetOpenFile(file, fp);
-
-    memset(&po, 0, sizeof(po));
-
-    mem = rb_intern("header");
-    value = rb_struct_getmember(opt, mem);
-    po.header = value == Qtrue ? 1 : 0;
-
-    mem = rb_intern("align");
-    value = rb_struct_getmember(opt, mem);
-    po.align = value == Qtrue ? 1 : 0;
-
-    mem = rb_intern("standard");
-    value = rb_struct_getmember(opt, mem);
-    po.standard = value == Qtrue ? 1 : 0;
-
-    mem = rb_intern("html3");
-    value = rb_struct_getmember(opt, mem);
-    po.html3 = value == Qtrue ? 1 : 0;
-
-    mem = rb_intern("expanded");
-    value = rb_struct_getmember(opt, mem);
-    po.expanded = value == Qtrue ? 1 : 0;
-
-    mem = rb_intern("pager");
-    value = rb_struct_getmember(opt, mem);
-    po.pager = value == Qtrue ? 1 : 0;
-
-    mem = rb_intern("fieldSep");
-    value = rb_struct_getmember(opt, mem);
-    if (!NIL_P(value)) {
-        Check_Type(value, T_STRING);
-        po.fieldSep = StringValuePtr(value);
-    }
-
-    mem = rb_intern("tableOpt");
-    value = rb_struct_getmember(opt, mem);
-    if (!NIL_P(value)) {
-        Check_Type(value, T_STRING);
-        po.tableOpt = StringValuePtr(value);
-    }
-
-    mem = rb_intern("caption");
-    value = rb_struct_getmember(opt, mem);
-    if (!NIL_P(value)) {
-        Check_Type(value, T_STRING);
-        po.caption = StringValuePtr(value);
-    }
-
-    PQprint(fp->f2?fp->f2:fp->f, get_pgresult(obj), &po);
-    return obj;
-}
-
 /*
  * call-seq:
  *    res.cmdtuples()
@@ -2332,28 +2278,27 @@ pglarge_read(argc, argv, obj)
     VALUE *argv;
     VALUE obj;
 {
-    int len;
-    PGlarge *pglarge = get_pglarge(obj);
-    VALUE str;
-    VALUE length;
-    
-    rb_scan_args(argc, argv, "01", &length);
-    if (NIL_P(length)) {
-        return loread_all(obj);
-    }
-    
-    len = NUM2INT(length);
-    if (len < 0){
-        rb_raise(rb_ePGError,"nagative length %d given", len);
-    }
-    str = rb_tainted_str_new(0,len);
+	int len;
+	PGlarge *pglarge = get_pglarge(obj);
+	VALUE length;
+	char *buffer;
 
-    if((len = lo_read(pglarge->pgconn, pglarge->lo_fd, StringValuePtr(str), len)) < 0) {
-        rb_raise(rb_ePGError, "error while reading");
-    }
-    if (len == 0) return Qnil;
-    RSTRING_LEN(str) = len;
-    return str;
+	rb_scan_args(argc, argv, "01", &length);
+	if (NIL_P(length)) {
+		return loread_all(obj);
+	}
+
+	len = NUM2INT(length);
+	if (len < 0){
+		rb_raise(rb_ePGError,"nagative length %d given", len);
+	}
+	buffer = ALLOCA_N(char, len);
+
+	if((len = lo_read(pglarge->pgconn, pglarge->lo_fd, buffer, len)) < 0) {
+		rb_raise(rb_ePGError, "error while reading");
+	}
+	if (len == 0) return Qnil;
+	return rb_str_new(buffer,len);
 }
 
 /*
@@ -2672,7 +2617,7 @@ void
 Init_postgres()
 {
     pg_gsub_bang_id = rb_intern("gsub!");
-    pg_escape_regex = rb_reg_new("([\\t\\n\\\\])", 10, 0);
+    pg_escape_regex = RB_REG_NEW("([\\t\\n\\\\])", 10, 0);
     rb_global_variable(&pg_escape_regex);
     pg_escape_str = rb_str_new("\\\\\\1", 4);
     rb_global_variable(&pg_escape_str);
@@ -2815,7 +2760,6 @@ Init_postgres()
     rb_define_method(rb_cPGresult, "cmdtuples", pgresult_cmdtuples, 0);
     rb_define_method(rb_cPGresult, "cmdstatus", pgresult_cmdstatus, 0);
     rb_define_method(rb_cPGresult, "oid", pgresult_oid, 0);
-    rb_define_method(rb_cPGresult, "print", pgresult_print, 2);
     rb_define_method(rb_cPGresult, "clear", pgresult_clear, 0);
     rb_define_alias(rb_cPGresult, "close", "clear");
 

data/ext/compat.c

@@ -128,6 +128,15 @@ PQsendDescribePortal(PGconn *conn, const char *portalName)
 }
 #endif /* HAVE_PQSENDDESCRIBEPORTAL */
 
+#ifndef HAVE_PQSENDPREPARE
+int
+PQsendPrepare(PGconn *conn, const char *stmtName, const char *query,
+	int nParams, const Oid *paramTypes)
+{
+	rb_raise(rb_eStandardError, "PQsendPrepare not supported by this client version.");
+}
+#endif /* HAVE_PQSENDPREPARE */
+
 #ifndef HAVE_PQENCRYPTPASSWORD
 char *
 PQencryptPassword(const char *passwd, const char *user)