From: Heikki Linnakangas <heikki.linnakangas@iki.fi>
Date: Mon, 7 Mar 2011 08:42:49 +0000 (+0200)
Subject: Document the DEFERRABLE option in SET TRANSACTION command.
X-Git-Tag: REL9_1_ALPHA4~26
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=faba108fe4f2491ebc2b7faf4343f952125cc661;p=postgresql

Document the DEFERRABLE option in SET TRANSACTION command.

Kevin Grittner
---

diff --git a/doc/src/sgml/ref/set_transaction.sgml b/doc/src/sgml/ref/set_transaction.sgml
index 2c57f45511..f864bbf6a6 100644
--- a/doc/src/sgml/ref/set_transaction.sgml
+++ b/doc/src/sgml/ref/set_transaction.sgml
@@ -135,6 +135,17 @@ SET SESSION CHARACTERISTICS AS TRANSACTION <replaceable class="parameter">transa
    among those listed.  This is a high-level notion of read-only that
    does not prevent all writes to disk.
   </para>
+
+  <para>
+   The <literal>DEFERRABLE</literal> transaction property has no effect
+   unless the transaction is also <literal>SERIALIZABLE</literal> and
+   <literal>READ ONLY</literal>.  When all of these properties are set on a
+   transaction, the transaction may block when first acquiring its snapshot,
+   after which it is able to run without the normal overhead of a
+   <literal>SERIALIZABLE</literal> transaction and without any risk of
+   contributing to or being cancelled by a serialization failure.  This mode
+   is well suited for long-running reports or backups.
+  </para>
  </refsect1>
 
  <refsect1>