Move over LockRow

git-svn-id: http://svn.osgeo.org/postgis/trunk@3355 b70326c6-7e19-0410-871a-916f4a2858ee

diff --git a/doc/reference.xml b/doc/reference.xml
index d7160762f6c280ee7ba43918eacf67f5142f1a22..8e7b33794d194b83afbaafa7ae9666e0f05c222c 100644 (file)
--- a/doc/reference.xml
+++ b/doc/reference.xml
@@ -507,20 +507,6 @@
       </note>
 
       <variablelist>
-        <varlistentry id="LockRow">
-          <term>LockRow([&lt;schema&gt;], &lt;table&gt;, &lt;rowid&gt;,
-          &lt;authid&gt;, [&lt;expires&gt;])</term>
-
-          <listitem>
-            <para>Set lock/authorization for specific row in table
-            &lt;authid&gt; is a text value, &lt;expires&gt; is a timestamp
-            defaulting to now()+1hour. Returns 1 if lock has been assigned, 0
-            otherwise (already locked by other auth)</para>
-
-            <para>Availability: 1.1.3</para>
-          </listitem>
-        </varlistentry>
-
         <varlistentry id="UnlockRows">
           <term>UnlockRows(&lt;authid&gt;)</term>
 

diff --git a/doc/reference_new.xml b/doc/reference_new.xml
index a9252f46f6ea52ade4b3d8d5301a28b565e51e42..fe1c47b641506aba6ffd39e902a551a3b59a3c0f 100644 (file)
--- a/doc/reference_new.xml
+++ b/doc/reference_new.xml
@@ -11331,6 +11331,93 @@ Long transactions support enabled
           <para><xref linkend="DisableLongTransactions" /></para>
         </refsection>
       </refentry>
+         
+       <varlistentry id="LockRow">
+         <term>LockRow([&lt;schema&gt;], &lt;table&gt;, &lt;rowid&gt;,
+         &lt;authid&gt;, [&lt;expires&gt;])</term>
+
+         <listitem>
+               <para>Set lock/authorization for specific row in table
+               &lt;authid&gt; is a text value, &lt;expires&gt; is a timestamp
+               defaulting to now()+1hour. Returns 1 if lock has been assigned, 0
+               otherwise (already locked by other auth).</para>
+
+               <para>Availability: 1.1.3</para>
+         </listitem>
+       </varlistentry>
+       
+       <refentry id="LockRow">
+         <refnamediv>
+           <refname>LockRow</refname>
+       
+           <refpurpose>Set lock/authorization for specific row in table</refpurpose>
+         </refnamediv>
+       
+         <refsynopsisdiv>
+           <funcsynopsis>
+             <funcprototype>
+               <funcdef>integer <function>LockRow</function></funcdef>
+               <paramdef><type>text </type> <parameter>a_schema_name</parameter></paramdef>
+               <paramdef><type>text </type> <parameter>a_table_name</parameter></paramdef>
+                       <paramdef><type>text </type> <parameter>a_row_key</parameter></paramdef>
+                       <paramdef><type>text</type> <parameter>an_auth_token</parameter></paramdef>
+                       <paramdef><type>timestamp</type> <parameter>expire_dt</parameter></paramdef>
+             </funcprototype>
+       
+             <funcprototype>
+               <funcdef>integer <function>LockRow</function></funcdef>
+               <paramdef><type>text </type> <parameter>a_table_name</parameter></paramdef>
+                       <paramdef><type>text </type> <parameter>a_row_key</parameter></paramdef>
+                       <paramdef><type>text</type> <parameter>an_auth_token</parameter></paramdef>
+                       <paramdef><type>timestamp</type> <parameter>expire_dt</parameter></paramdef>
+             </funcprototype>
+                 
+                 <funcprototype>
+               <funcdef>integer <function>LockRow</function></funcdef>
+               <paramdef><type>text </type> <parameter>a_table_name</parameter></paramdef>
+                       <paramdef><type>text </type> <parameter>a_row_key</parameter></paramdef>
+                       <paramdef><type>text</type> <parameter>an_auth_token</parameter></paramdef>
+             </funcprototype>
+                 
+           </funcsynopsis>
+         </refsynopsisdiv>
+       
+         <refsection>
+           <title>Description</title>
+       
+           <para>Set lock/authorization for specific row in table
+               &lt;authid&gt; is a text value, &lt;expires&gt; is a timestamp
+               defaulting to now()+1hour. Returns 1 if lock has been assigned, 0
+               otherwise (already locked by other auth)</para>
+
+               <para>Availability: 1.1.3</para>
+         </refsection>
+         
+       
+         <refsection>
+           <title>Examples</title>
+       
+           <programlisting>SELECT LockRow('public', 'towns', '2', 'joey');
+LockRow
+-------
+1
+
+--Joey has already locked the record and Priscilla is out of luck
+SELECT LockRow('public', 'towns', '2', 'priscilla');
+LockRow
+-------
+0
+
+               </programlisting>
+         </refsection>
+       
+         <!-- Optionally add a "See Also" section -->
+         <refsection>
+           <title>See Also</title>
+       
+           <para><xref linkend="UnlockRows" /></para>
+         </refsection>
+       </refentry>
   </sect1>
   
   <sect1 id="Miscellaneous_Functions">