Cleanup of readme. Adding license to readme.

Aurynn Shaw · Aurynn Shaw · commit 13fe013a26de · 2010-08-30T21:46:13.000-07:00
Modification of the execute stage of prepared statements to allow multiple bound portals on the same prepared query.
diff --git a/README.md b/README.md
@@ -3,18 +3,18 @@
 This library is a implementation of the PostgreSQL backend/frontend protocol in javascript.
 It uses the node.js tcp and event libraries.  A javascript md5 library is included for servers that require md5 password hashing (this is default).
 
-This library allows for the handling of prepared queries.
-
-Parameterized queries are (currently) no longer supported.
+This library allows for the correct handling of prepared queries.
 
 If you wish to nest DB calls, db.close must be in the deepest callback, or all statements that occur inside of callbacks deeper than the callback which handles db.close will not be executed.
 
+All code is available under the terms of the MIT license, unless otherwise noted (md5.js)
+
 ## Example use
 
 	var sys = require("sys");
-	var Postgres = require("postgres");
+	var pg = require("postgres");
 
-	var db = new Postgres.Connection("database", "username", "password");
+    var db = new pg.connect("pgsql://test:12345@localhost:5432/template1");
 	db.query("SELECT * FROM sometable", function (data) {
 		sys.p(data);
 	});
@@ -25,9 +25,8 @@ If you wish to nest DB calls, db.close must be in the deepest callback, or all s
     var sys = require("sys");
     var pg = require("postgres");
     
-    var db = new pg.Connection("database", "username", "password");
+    var db = new pg.connect("pgsql://test:12345@localhost:5432/template1");
     db.query("SELECT * FROM yourtable WHERE id = ?", [1], function (data) {
-        
         sys.p(data);
     });
     db.close();
@@ -37,14 +36,11 @@ If you wish to nest DB calls, db.close must be in the deepest callback, or all s
     var sys = require("sys");
     var pg = require("postgres");
     
-    var db = new pg.Connection("database", "username", "password");
+    var db = new pg.connect("pgsql://test:12345@localhost:5432/template1");
     
     var stmt = db.prepare("SELECT * FROM yourtable WHERE id = ?");
     
-    stmt.execute([1]).addCallback(function (d) {
-        
+    stmt.execute([1], function (d) {
         sys.p(d);
         db.close();
-    });
-    
-
+    });
diff --git a/demo.js b/demo.js
@@ -14,4 +14,7 @@ db.prepare("SELECT ?::int", function (sth) {
         }
         db.end();
     });
+    sth.execute([2], function (rs) {
+        sys.puts(sys.inspect(rs));
+    })
 });
diff --git a/lib/postgres-pure.js b/lib/postgres-pure.js
@@ -49,7 +49,7 @@ function encoder(header) {
   return w;
 }
 
-// http://www.postgresql.org/docs/8.3/static/protocol-message-formats.html
+// http://www.postgresql.org/docs/8.4/static/protocol-message-formats.html
 var formatter = {
   Bind: function (portal, prepared_name, params, args) {
       var builder =  (encoder('B'))
@@ -331,7 +331,6 @@ function Prepared(sql, conn, callback) {
     
     var prepared_name = md5(sql); // Use the md5 hash. This is easily selectable later.
     var q = this;
-    var portal = 'meh';
     q.row_description = null;
     q.param_description = null;
     q.noData = false;
@@ -434,11 +433,11 @@ function Prepared(sql, conn, callback) {
                 if (typeof(arguments[1]) == 'function') {
                     callback = arguments[1];
                 }
-                eP = new execPrepared(portal, prepared_name, q.param_description, arguments[0], q.row_description, conn, arguments[1]);
+                eP = new execPrepared(prepared_name, q.param_description, arguments[0], q.row_description, conn, arguments[1]);
             }
         }
         else if (typeof(arguments[0]) == 'function' ) {
-            eP = new execPrepared(portal, prepared_name, q.param_description, [], q.row_description, conn, arguments[0]);
+            eP = new execPrepared(prepared_name, q.param_description, [], q.row_description, conn, arguments[0]);
             // Announcing that my slot is released in favour of this new query.
             // The connection doesn't advance the buffer, but *does* replace 
             // the current query with this one.
@@ -462,8 +461,9 @@ function Prepared(sql, conn, callback) {
 }
 Prepared.prototype = new process.EventEmitter;
 
-function execPrepared (portal, prepared, params, args, row_desc, conn,  callback) {
+function execPrepared (prepared, params, args, row_desc, conn,  callback) {
     var q = this;
+    var portal = md5(prepared + args.join("|")); // Clearly need a generated portal name here.
     q.row_description = row_desc;
     var results = [];
     var arr = [
@@ -741,6 +741,7 @@ function Connection(args) {
             if (value !== null) {
                 // TODO: investigate to see if these numbers are stable across databases or
                 // if we need to dynamically pull them from the pg_types table
+                // TODO: Investigate javascript Date objects.
                 switch (description.type_id) {
                     case 16: // bool
                         value = value === 't';
@@ -919,24 +920,4 @@ function Connection(args) {
 }
 Connection.prototype = new process.EventEmitter();
 
-
-/*
-Connection.prototype.get_store = function (name, columns) {
-  return new sqllib.Store(this, name, columns, {
-    do_insert: function (data, keys, values, callback) {
-      this.conn.query("INSERT INTO " +
-        this.name + "(" + keys.join(", ") + ")" +
-        " VALUES (" + values.join(", ") + ")" +
-        " RETURNING _id",
-        function (result) {
-          data._id = parseInt(result[0]._id, 10);
-          callback(data._id);
-        }
-      );
-    },
-    index_col: '_id',
-    types: ["_id SERIAL"]
-  });
-};
-*/
 exports.connect = Connection;

Original file line number	Diff line number	Diff line change
`@@ -14,4 +14,7 @@ db.prepare("SELECT ?::int", function (sth) {`
`14`	`14`	`}`
`15`	`15`	`db.end();`
`16`	`16`	`});`
	`17`	`+ sth.execute([2], function (rs) {`
	`18`	`+ sys.puts(sys.inspect(rs));`
	`19`	`+ })`
`17`	`20`	`});`