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

[postgis-commits at postgis.refractions.net]

Author: robe
Date: 2008-12-02 11:43:08 -0800 (Tue, 02 Dec 2008)
New Revision: 3354

Modified:
   trunk/doc/reference.xml
   trunk/doc/reference_new.xml
Log:
Move over CheckAuth

Modified: trunk/doc/reference.xml
===================================================================
--- trunk/doc/reference.xml	2008-12-01 23:34:03 UTC (rev 3353)
+++ trunk/doc/reference.xml	2008-12-02 19:43:08 UTC (rev 3354)
@@ -507,18 +507,6 @@
       </note>
 
       <variablelist>
-        <varlistentry id="CheckAuth">
-          <term>CheckAuth([&lt;schema&gt;], &lt;table&gt;,
-          &lt;rowid_col&gt;)</term>
-
-          <listitem>
-            <para>Check updates and deletes of rows in given table for being
-            authorized. Identify rows using &lt;rowid_col&gt; column.</para>
-
-            <para>Availability: 1.1.3</para>
-          </listitem>
-        </varlistentry>
-
         <varlistentry id="LockRow">
           <term>LockRow([&lt;schema&gt;], &lt;table&gt;, &lt;rowid&gt;,
           &lt;authid&gt;, [&lt;expires&gt;])</term>

Modified: trunk/doc/reference_new.xml
===================================================================
--- trunk/doc/reference_new.xml	2008-12-01 23:34:03 UTC (rev 3353)
+++ trunk/doc/reference_new.xml	2008-12-02 19:43:08 UTC (rev 3354)
@@ -11175,7 +11175,66 @@
         transaction level</ulink> otherwise locking mechanism would
         break.</para>
       </note>
+	 
+		<refentry id="CheckAuth">
+		  <refnamediv>
+			<refname>CheckAuth</refname>
+		
+			<refpurpose>Creates trigger that check updates and deletes of rows in given table for being
+            authorized.</refpurpose>
+		  </refnamediv>
+		
+		  <refsynopsisdiv>
+			<funcsynopsis>
+			  <funcprototype>
+				<funcdef>integer <function>CheckAuth</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_key_column_name</parameter></paramdef>
+			  </funcprototype>
+			  
+			  <funcprototype>
+				<funcdef>integer <function>CheckAuth</function></funcdef>
+				<paramdef><type>text </type> <parameter>a_table_name</parameter></paramdef>
+				<paramdef><type>text </type> <parameter>a_key_column_name</parameter></paramdef>
+			  </funcprototype>
+			</funcsynopsis>
+		  </refsynopsisdiv>
+		
+		  <refsection>
+			<title>Description</title>
+		
+			<para>Check updates and deletes of rows in given table for being
+            authorized. Identify rows using &lt;rowid_col&gt; column.</para>
+			
+			<para>If a_schema_name is not passed in, then searches for table in current schema.</para>
+			<note><para>If an authorization trigger already exists on this table function errors.</para>
+				<para>If Transaction support is not enabled, function throws and exception.</para>
+			</note>
 
+            <para>Availability: 1.1.3</para>
+		
+		  </refsection>
+		  
+		
+		  <refsection>
+			<title>Examples</title>
+		
+			<programlisting>SELECT CheckAuth('public', 'towns', 'gid');
+			result
+			------
+			0
+			</programlisting>
+		  </refsection>
+		
+		  <!-- Optionally add a "See Also" section -->
+		  <refsection>
+			<title>See Also</title>
+		
+			<para><xref linkend="EnableLongTransactions" /></para>
+		  </refsection>
+		</refentry>
+
 	  <refentry id="DisableLongTransactions">
         <refnamediv>
           <refname>DisableLongTransactions</refname>