summaryrefslogtreecommitdiff
path: root/doc/src
diff options
context:
space:
mode:
authorHeikki Linnakangas <heikki.linnakangas@iki.fi>2010-01-25 18:23:10 +0000
committerHeikki Linnakangas <heikki.linnakangas@iki.fi>2010-01-25 18:23:10 +0000
commit1d1f425f8d4331ecf09512386880af0827cd6091 (patch)
tree538d3a13f05b8aa2b1b87bc67180fffd21bca790 /doc/src
parente7dcfd05f3f0ac4c80d5bd26973a748230f9cbe1 (diff)
Add note that PREPARE TRANSACTION is for transaction managers, not
regular applications. Also add a comment pointing out that tab-complition for PREPARE TRANSACTION is missing on purpose.
Diffstat (limited to 'doc/src')
-rw-r--r--doc/src/sgml/ref/prepare_transaction.sgml11
1 files changed, 10 insertions, 1 deletions
diff --git a/doc/src/sgml/ref/prepare_transaction.sgml b/doc/src/sgml/ref/prepare_transaction.sgml
index b8b8d8aca83..da304c72550 100644
--- a/doc/src/sgml/ref/prepare_transaction.sgml
+++ b/doc/src/sgml/ref/prepare_transaction.sgml
@@ -1,5 +1,5 @@
<!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/prepare_transaction.sgml,v 1.9 2009/04/23 00:23:45 tgl Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/prepare_transaction.sgml,v 1.10 2010/01/25 18:23:10 heikki Exp $
PostgreSQL documentation
-->
@@ -83,6 +83,15 @@ PREPARE TRANSACTION <replaceable class="PARAMETER">transaction_id</replaceable>
<title>Notes</title>
<para>
+ <command>PREPARE TRANSACTION</> is not intended for use in applications
+ or interactive sessions. It's purpose is to allow an external
+ transaction manager to perform atomic global transactions across multiple
+ databases or other transactional resources. Unless you're writing a
+ transaction manager, you probably shouldn't be using <command>PREPARE
+ TRANSACTION</>.
+ </para>
+
+ <para>
This command must be used inside a transaction block. Use <xref
linkend="sql-begin" endterm="sql-begin-title"> to start one.
</para>