[Pypgsql-checkins] CVS: pypgsql README,1.15,1.16

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

Update of /cvsroot/pypgsql/pypgsql
In directory usw-pr-cvs1:/tmp/cvs-serv10643

Modified Files:
	README 
Log Message:
13OCT2001 bga	Update documentation to reflect recent changes.

Index: README
===================================================================
RCS file: /cvsroot/pypgsql/pypgsql/README,v
retrieving revision 1.15
retrieving revision 1.16
diff -C2 -d -r1.15 -r1.16
*** README	2001/10/05 23:00:55	1.15
--- README	2001/10/13 20:46:40	1.16
***************
*** 1,4 ****
  #ident "@(#) $Id$"
! pyPgSQL - v1.6: Python DB-API 2.0 Compliant Interface Module for PostgreSQL.
  ===========================================================================

--- 1,4 ----
  #ident "@(#) $Id$"
! pyPgSQL - v1.7: Python DB-API 2.0 Compliant Interface Module for PostgreSQL.
  ===========================================================================

***************
*** 180,185 ****

      PQconnectdb		- preferred method to connect to a database.
-     PQsetdbLogin	- alternative method to connect to a database.
-     PQconnectStart	- Connect to a database in a non-blocking manner.
      PQconndefaults	- returns a list containing the connection defaults.
      PQresStatus		- returns a string representation of the result status.
--- 180,183 ----
***************
*** 192,195 ****
--- 190,194 ----
      PgInt8              - creates a PgInt8 object from a string or number.
      PgLargeObject	- creates a PgLargeObject from a connection and OID.
+     PgVersion		- creates a PgVerion object from a string.
      PgQuoteString	- Quotes a string, escaping any characters as needed,
  			  for use as input to a character/text field.
***************
*** 275,308 ****

  Note:		See the PostgreSQL C API documentation for details.
- 
- 2.1.2 PQsetdbLogin
- ------------------
- 
- Syntax:		c = PQsetdbLogin(host, port, options, tty, db, login, pwd)
- 
- Returns:	A PgConnection object.
- 
- Description:	Implements the PostgreSQL C API's PQsetdbLogin function.
- 
- Exceptions:	DatabaseError
- 
- Note:		See the PostgreSQL C API documentation for details.
- 
- 2.1.3 PQconnectStart (PostgreSQL 7.x and above)
- --------------------
- 
- Syntax:		c = PQconnectStart(conninfo)

! 		Where conninfo is a string containing connection information.
! 
! Returns:	A PgConnection object.
! 
! Description:	Implements the PostgreSQL C API's PQconnectStart function.
! 
! Exceptions:	DatabaseError
! 
! Note:		See the PostgreSQL C API documentation for details.
! 
! 2.1.4 PQconndefaults
  --------------------

--- 274,279 ----

  Note:		See the PostgreSQL C API documentation for details.

! 2.1.2 PQconndefaults
  --------------------

***************
*** 317,321 ****
  Note:		See the PostgreSQL C API documentation for details.

! 2.1.5 PQresStatus
  -----------------

--- 288,292 ----
  Note:		See the PostgreSQL C API documentation for details.

! 2.1.3 PQresStatus
  -----------------

***************
*** 328,332 ****
  Note:		See the PostgreSQL C API documentation for details.

! 2.1.6 PQresType
  ---------------

--- 299,303 ----
  Note:		See the PostgreSQL C API documentation for details.

! 2.1.4 PQresType
  ---------------

***************
*** 343,347 ****
  Returns:	A string representation of the result type code, 'type'.

! 2.1.7 PQftypeName
  -----------------

--- 314,318 ----
  Returns:	A string representation of the result type code, 'type'.

! 2.1.5 PQftypeName
  -----------------

***************
*** 355,359 ****
  		function.

! 2.1.8 PgBoolean
  ---------------

--- 326,330 ----
  		function.

! 2.1.6 PgBoolean
  ---------------

***************
*** 370,374 ****
  Returns:	PgTrue or PgFalse based on the value of 'object'

! 2.1.9 PgInt2
  ------------

--- 341,345 ----
  Returns:	PgTrue or PgFalse based on the value of 'object'

! 2.1.7 PgInt2
  ------------

***************
*** 381,386 ****
  Returns:	A PgInt2 object initialized with the value of 'object'.

! 2.1.10 PgInt8
! -------------

  Syntax:		n = PgInt8(object)
--- 352,357 ----
  Returns:	A PgInt2 object initialized with the value of 'object'.

! 2.1.8 PgInt8
! ------------

  Syntax:		n = PgInt8(object)
***************
*** 392,397 ****
  Returns:	A PgInt8 object initialized with the value of 'object'.

! 2.1.11 PgLargeObject
! --------------------

  Syntax:		o = PgLargeObject(PgConnection, OID)
--- 363,368 ----
  Returns:	A PgInt8 object initialized with the value of 'object'.

! 2.1.9 PgLargeObject
! -------------------

  Syntax:		o = PgLargeObject(PgConnection, OID)
***************
*** 403,407 ****
  Returns:	A closed PgLargeObject object.

! 2.1.12 PgQuoteString
  --------------------

--- 374,386 ----
  Returns:	A closed PgLargeObject object.

! Note:		A PgLargeObject can not be opened outside the context of a
! 		transaction.  Because of this, large objects created with this
! 		method (and by inference, un-pickled large objects) will begin
! 		a transaction (if needed) in it's associated PgConnection
! 		object when the the large object is opened.  When the large
! 		object is closed, the transaction will be committed.  If a
! 		rollback is desired, pass close() an argument of 1.
! 
! 2.1.10 PgQuoteString
  --------------------

***************
*** 432,436 ****
  Returns:	A quoted, escaped copy of the input string.

! 2.1.13 PgQuoteBytea
  -------------------

--- 411,415 ----
  Returns:	A quoted, escaped copy of the input string.

! 2.1.11 PgQuoteBytea
  -------------------

***************
*** 457,461 ****
  Returns:	A quoted, escaped copy of the input string.

! 2.1.14 PgUnQuoteBytea
  ---------------------

--- 436,440 ----
  Returns:	A quoted, escaped copy of the input string.

! 2.1.12 PgUnQuoteBytea
  ---------------------

***************
*** 1095,1101 ****

  Note:		Open is a built-in function of Python, not a method of the File
! 		Object.

! 2.4.2 export
  ------------

--- 1074,1098 ----

  Note:		Open is a built-in function of Python, not a method of the File
! 		Object.  If there is not transaction started on the associated
! 		PgConnection object when open is called, one is started.  This
! 		will only occur for un-pickled large objects and large objects
! 		created with the PgLargeObject method of libpq (and PgSQL).

! 2.4.3 close
! -----------
! 
! Syntax:		lo.close()
! 
! Description:	This method will close an open large object.
! 
! Note:		If the large object was the result of un-pickling a large
! 		object or it was created with the PgLargeObject method of
! 		libpq (or PgSQL), close() will commit the transaction started
! 		by open().  If a rollback is desired, then pass close a single
! 		argument of the integer 1.  This argument is only valid if the
! 		large object was the result of un-pickling a large object or
! 		created with the PgLargeObject method.
! 
! 2.4.3 export
  ------------