Note the deprecation of the 2PC features.

James William Pye · James William Pye · commit 2029ddaa2c22 · 2009-12-12T01:29:38.000-07:00
diff --git a/postgresql/api.py b/postgresql/api.py
@@ -652,6 +652,8 @@ class Transaction(Element):
 		...  with db.xact():
 		...   ...
 
+	[DEPRECATED]
+
 	Or, in cases where two-phase commit is desired:
 
 		>>> with db.xact(gid = 'gid') as gxact:
@@ -696,6 +698,8 @@ def isolation(self) -> (None, str):
 	@abstractproperty
 	def gid(self) -> (None, str):
 		"""
+		[DEPRECATED]
+
 		The global identifier of the transaction block:
 
 			PREPARE TRANSACTION <gid>;
@@ -750,20 +754,23 @@ def rollback(self) -> None:
 		"""
 		Abort the transaction.
 
-		If the transaction is configured with a `gid` *and* has been prepared, issue
-		a ROLLBACK PREPARE statement with the configured `gid`.
-
 		If the transaction is a savepoint, ROLLBACK TO the savepoint identifier.
 
 		If the transaction is a transaction block, issue an ABORT.
 
 		If the transaction has already been aborted, do nothing.
+
+		[DEPRECATED]
+		If the transaction is configured with a `gid` *and* has been prepared, issue
+		a ROLLBACK PREPARE statement with the configured `gid`.
 		"""
 	abort = rollback
 
 	@abstractmethod
 	def recover(self) -> None:
 		"""
+		[DEPRECATED]
+
 		If the transaction is assigned a `gid`, recover may be used to identify
 		the transaction as prepared and ready for committing or aborting.
 
@@ -783,6 +790,8 @@ def recover(self) -> None:
 	@abstractmethod
 	def prepare(self) -> None:
 		"""
+		[DEPRECATED]
+
 		Explicitly prepare the transaction with the configured `gid` by issuing a
 		PREPARE TRANSACTION statement with the configured `gid`.
 		This *must* be called for the first phase of the commit.
diff --git a/postgresql/documentation/driver.txt b/postgresql/documentation/driver.txt
@@ -337,11 +337,11 @@ The methods and properties on the connection object are ready for use:
   occurs. If errors occur, the processing of the statements will stop and the
   error will be raised.
 
- ``db.xact(gid = None, isolation = None, mode = None)``
+ ``db.xact(isolation = None, mode = None)``
   The `postgresql.api.Transaction` constructor for creating transactions.
   This method creates a transaction reference. The transaction will not be
   started until it's instructed to do so. See `Transactions`_ for more
-  information.
+  information. (**gid keyword is deprecated**)
 
  ``db.settings``
   A property providing a `collections.MutableMapping` interface to the
@@ -1267,17 +1267,13 @@ instruction methods provided by `postgresql.api.Transaction` objects.
 Transaction Configuration
 -------------------------
 
-.. warning::
-   **All transaction configuration arguments are being deprecated over the**
-   **next few versions of py-postgresql. Use should be discontinued**.
-
 Keyword arguments given to ``xact()`` provide the means for configuring the
 properties of the transaction. Only three points of configuration are available:
 
  ``gid``
   The global identifier to use. Identifies the transaction as using two-phase
   commit. The ``prepare()`` method *must* be called prior to ``commit()`` or
-  ``__exit__()``.
+  ``__exit__()``. (**Deprecated**)
 
  ``isolation``
   The isolation level of the transaction. This must be a string. It will be
@@ -1314,8 +1310,8 @@ that change of state.
   Commit the transaction.
 
  ``x.rollback()``
-  Abort the transaction. For prepared transactions, this can be called at any
-  phase.
+  Abort the transaction.
+  (Deprecated: For prepared transactions, this can be called at any phase.)
 
  ``x.recover()``
   Identify the existence of the prepared transaction. (**Deprecated**)
diff --git a/postgresql/driver/pq3.py b/postgresql/driver/pq3.py
@@ -1422,7 +1422,7 @@ class Transaction(pg_api.Transaction):
 	def _e_metas(self):
 		yield (None, self.state)
 
-	def __init__(self, database, gid = None, isolation = None, mode = None):
+	def __init__(self, database, isolation = None, mode = None, gid = None):
 		self.database = database
 		self.gid = gid
 		self.isolation = isolation
