[postgis-commits] svn - r3360 - trunk/doc

[postgis-commits at postgis.refractions.net]

Author: robe
Date: 2008-12-04 09:01:35 -0800 (Thu, 04 Dec 2008)
New Revision: 3360

Modified:
   trunk/doc/reference.xml
   trunk/doc/reference_new.xml
Log:
Move over rest of Long Transactions

Modified: trunk/doc/reference.xml
===================================================================
--- trunk/doc/reference.xml	2008-12-03 17:12:54 UTC (rev 3359)
+++ trunk/doc/reference.xml	2008-12-04 17:01:35 UTC (rev 3360)
@@ -490,46 +490,6 @@
         </varlistentry>
       </variablelist>
     </sect2>
-
-    <sect2>
-      <title>Long Transactions support</title>
-
-      <para>This module and associated pl/pgsql functions have been
-      implemented to provide long locking support required by <ulink
-      url="http://portal.opengeospatial.org/files/index.php?artifact_id=7176">Web
-      Feature Service</ulink> specification.</para>
-
-      <note>
-        <para>Users must use <ulink
-        url="http://www.postgresql.org/docs/8.3/static/transaction-iso.html">serializable
-        transaction level</ulink> otherwise locking mechanism would
-        break.</para>
-      </note>
-
-      <variablelist>
-        <varlistentry id="UnlockRows">
-          <term>UnlockRows(&lt;authid&gt;)</term>
-
-          <listitem>
-            <para>Remove all locks held by specified authorization id. Returns
-            the number of locks released.</para>
-
-            <para>Availability: 1.1.3</para>
-          </listitem>
-        </varlistentry>
-
-        <varlistentry id="AddAuth">
-          <term>AddAuth(&lt;authid&gt;)</term>
-
-          <listitem>
-            <para>Add an authorization token to be used in current
-            transaction.</para>
-
-            <para>Availability: 1.1.3</para>
-          </listitem>
-        </varlistentry>
-      </variablelist>
-    </sect2>
   </sect1>
 
   <sect1>

Modified: trunk/doc/reference_new.xml
===================================================================
--- trunk/doc/reference_new.xml	2008-12-03 17:12:54 UTC (rev 3359)
+++ trunk/doc/reference_new.xml	2008-12-04 17:01:35 UTC (rev 3360)
@@ -11175,8 +11175,60 @@
         transaction level</ulink> otherwise locking mechanism would
         break.</para>
       </note>
+	  		
+	<refentry id="AddAuth">
+	  <refnamediv>
+		<refname>AddAuth</refname>
+	
+		<refpurpose>Add an authorization token to be used in current transaction.</refpurpose>
+	  </refnamediv>
+	
+	  <refsynopsisdiv>
+		<funcsynopsis>
+		  <funcprototype>
+			<funcdef>boolean <function>AddAuth</function></funcdef>
+			<paramdef><type>text </type> <parameter>auth_token</parameter></paramdef>
+		  </funcprototype>
+		</funcsynopsis>
+	  </refsynopsisdiv>
+	
+	  <refsection>
+		<title>Description</title>
+	
+		<para>Add an authorization token to be used in current transaction.</para>
+	
+		<para>Creates/adds to a temp table called temp_lock_have_table the current transaction identifier
+			and authorization token key.</para>
+			
+		<para>Availability: 1.1.3</para>
+	  </refsection>
+	  
+	
+	  <refsection>
+		<title>Examples</title>
+	
+		<programlisting>
+		SELECT LockRow('towns', '353', 'priscilla');
+		BEGIN TRANSACTION;
+			SELECT AddAuth('joey');
+			UPDATE towns SET the_geom = ST_Translate(the_geom,2,2) WHERE gid = 353;
+		COMMIT;
+		
+		
+		---Error--
+		ERROR:  UPDATE where "gid" = '353' requires authorization 'priscilla'
+		</programlisting>
+	  </refsection>
+	
+	  <!-- Optionally add a "See Also" section -->
+	  <refsection>
+		<title>See Also</title>
+	
+		<para><xref linkend="LockRow" /></para>
+	  </refsection>
+	</refentry>
 	 
-		<refentry id="CheckAuth">
+	  <refentry id="CheckAuth">
 		  <refnamediv>
 			<refname>CheckAuth</refname>
 		
@@ -11218,7 +11270,8 @@
 		  <refsection>
 			<title>Examples</title>
 		
-			<programlisting>SELECT CheckAuth('public', 'towns', 'gid');
+			<programlisting>
+			SELECT CheckAuth('public', 'towns', 'gid');
 			result
 			------
 			0
@@ -11402,6 +11455,54 @@
 	    <para><xref linkend="UnlockRows" /></para>
 	  </refsection>
 	</refentry>
+
+	<refentry id="UnlockRows">
+	  <refnamediv>
+	    <refname>UnlockRows</refname>
+	
+	    <refpurpose>Remove all locks held by specified authorization id. Returns
+            the number of locks released.</refpurpose>
+	  </refnamediv>
+	
+	  <refsynopsisdiv>
+	    <funcsynopsis>
+	      <funcprototype>
+	        <funcdef>integer <function>UnlockRows</function></funcdef>
+	        <paramdef><type>text </type> <parameter>auth_token</parameter></paramdef>
+	      </funcprototype>
+	    </funcsynopsis>
+	  </refsynopsisdiv>
+	
+	  <refsection>
+	    <title>Description</title>
+	
+	    <para>Remove all locks held by specified authorization id. Returns
+            the number of locks released.</para>
+	
+		<para>Availability: 1.1.3</para>
+	  </refsection>
+	  
+	
+	  <refsection>
+	    <title>Examples</title>
+	
+	    <programlisting>
+		SELECT LockRow('towns', '353', 'priscilla');
+		SELECT LockRow('towns', '2', 'priscilla');
+		SELECT UnLockRows('priscilla');
+		UnLockRows
+		------------
+		2
+		</programlisting>
+	  </refsection>
+	
+	  <!-- Optionally add a "See Also" section -->
+	  <refsection>
+	    <title>See Also</title>
+	
+	    <para><xref linkend="LockRow" /></para>
+	  </refsection>
+	</refentry>
   </sect1>
   
   <sect1 id="Miscellaneous_Functions">