improve description of squery in README

wg · Jul 17, 2009 · 4acc379 · 4acc379
1 parent 57b963b
commit 4acc379
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/README b/README
@@ -23,11 +23,15 @@ Erlang PostgreSQL Database Client
 
 * Simple Query
 
-  {ok, Columns, Rows} = pgsql:squery(C, Sql).
+  {ok, Columns, Rows}        = pgsql:squery(C, "select ...").
-  {error, Error}      = pgsql:squery(C, InvalidSql).
+  {ok, Count}                = pgsql:squery(C, "update ...").
+  {ok, Count, Columns, Rows} = pgsql:squery(C, "insert ... returning ...").
+
+  {error, Error}             = pgsql:squery(C, "invalid SQL").
 
   Columns       - list of column records, see pgsql.hrl for definition.
   Rows          - list of tuples, one for each row.
+  Count         - integer count of rows inserted/updated/etc
 
   The simple query protocol returns all columns as text (Erlang binaries)
   and does not support binding parameters.