[postgis-commits] svn - r3099 - trunk/doc
postgis-commits at postgis.refractions.net
postgis-commits at postgis.refractions.net
Tue Oct 14 04:40:34 PDT 2008
Author: robe
Date: 2008-10-14 04:40:27 -0700 (Tue, 14 Oct 2008)
New Revision: 3099
Modified:
trunk/doc/reference.xml
trunk/doc/reference_new.xml
Log:
completely move over rest of management functions to new section. Add probe_geometry_columns - never been documented, but useful. Get rid of update_geometry_stats - just returns a dumb message that its obsolete.
Modified: trunk/doc/reference.xml
===================================================================
--- trunk/doc/reference.xml 2008-10-14 03:56:39 UTC (rev 3098)
+++ trunk/doc/reference.xml 2008-10-14 11:40:27 UTC (rev 3099)
@@ -649,72 +649,6 @@
<title>PostGIS Extensions</title>
<sect2>
- <title>Management Functions</title>
-
- <variablelist>
- <varlistentry>
- <term>update_geometry_stats([<table_name>,
- <column_name>])</term>
-
- <listitem>
- <para>Update statistics about spatial tables for use by the query
- planner. You will also need to run "VACUUM ANALYZE [table_name]
- [column_name]" for the statistics gathering process to be
- complete. NOTE: starting with PostgreSQL 8.0 statistics gathering
- is automatically performed running "VACUUM ANALYZE".</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>postgis_script_build_date()</term>
-
- <listitem>
- <para>Returns build date of the PostGIS scripts.</para>
-
- <para>Availability: 1.0.0RC1</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>postgis_scripts_installed()</term>
-
- <listitem>
- <para>Returns version of the postgis scripts installed in this
- database.</para>
-
- <note>
- <para>If the output of this function doesn't match the output of
- <link
- linkend="postgis_scripts_released">postgis_scripts_released()</link>
- you probably missed to properly upgrade an existing database.
- See the <link linkend="upgrading">Upgrading</link> section for
- more info.</para>
- </note>
-
- <para>Availability: 0.9.0</para>
- </listitem>
- </varlistentry>
-
- <varlistentry id="postgis_scripts_released">
- <term>postgis_scripts_released()</term>
-
- <listitem>
- <para>Returns the version number of the lwpostgis.sql script
- released with the installed postgis lib.</para>
-
- <note>
- <para>Starting with version 1.1.0 this function returns the same
- value of <xref linkend="PostGIS_Lib_Version" />. Kept
- for backward compatibility.</para>
- </note>
-
- <para>Availability: 0.9.0</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </sect2>
-
- <sect2>
<title>Operators</title>
<variablelist>
Modified: trunk/doc/reference_new.xml
===================================================================
--- trunk/doc/reference_new.xml 2008-10-14 03:56:39 UTC (rev 3098)
+++ trunk/doc/reference_new.xml 2008-10-14 11:40:27 UTC (rev 3099)
@@ -441,7 +441,7 @@
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
- <funcdef>text <function>Postgis_Lib_Build_Date</function></funcdef>
+ <funcdef>text <function>PostGIS_Lib_Build_Date</function></funcdef>
<paramdef></paramdef>
</funcprototype>
@@ -556,6 +556,155 @@
</refsection>
</refentry>
+ <refentry id="PostGIS_Scripts_Build_Date">
+ <refnamediv>
+ <refname>PostGIS_Scripts_Build_Date</refname>
+
+ <refpurpose>Returns build date of the PostGIS scripts.</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>text <function>PostGIS_Scripts_Build_Date</function></funcdef>
+
+ <paramdef></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </refsynopsisdiv>
+
+ <refsection>
+ <title>Description</title>
+
+ <para>Returns build date of the PostGIS scripts.</para>
+
+ <para>Availability: 1.0.0RC1</para>
+ </refsection>
+
+ <refsection>
+ <title>Examples</title>
+
+ <programlisting>SELECT PostGIS_Scripts_Build_Date();
+ postgis_scripts_build_date
+-------------------------
+ 2007-08-18 09:09:26
+(1 row)</programlisting>
+ </refsection>
+
+ <refsection>
+ <title>See Also</title>
+
+ <para><xref linkend="PostGIS_Full_Version" />, <xref
+ linkend="PostGIS_GEOS_Version" />, <xref
+ linkend="PostGIS_JTS_Version" />, <xref
+ linkend="PostGIS_Lib_Version" />, <xref
+ linkend="PostGIS_Version" /></para>
+ </refsection>
+ </refentry>
+
+ <refentry id="PostGIS_Scripts_Installed">
+ <refnamediv>
+ <refname>PostGIS_Scripts_Installed</refname>
+
+ <refpurpose>Returns version of the postgis scripts installed in this
+ database.</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>text <function>PostGIS_Scripts_Installed</function></funcdef>
+
+ <paramdef></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </refsynopsisdiv>
+
+ <refsection>
+ <title>Description</title>
+
+ <para>Returns version of the postgis scripts installed in this
+ database.</para>
+
+ <note>
+ <para>If the output of this function doesn't match the output of
+ <link
+ linkend="postgis_scripts_released">postgis_scripts_released()</link>
+ you probably missed to properly upgrade an existing database.
+ See the <link linkend="upgrading">Upgrading</link> section for
+ more info.</para>
+ </note>
+
+ <para>Availability: 0.9.0</para>
+ </refsection>
+
+ <refsection>
+ <title>Examples</title>
+
+ <programlisting>SELECT PostGIS_Scripts_Installed();
+ postgis_scripts_installed
+-------------------------
+ 1.3.4SVN
+(1 row)</programlisting>
+ </refsection>
+
+ <refsection>
+ <title>See Also</title>
+
+ <para><xref linkend="PostGIS_Full_Version" />, <xref linkend="PostGIS_Scripts_Released" />, <xref linkend="PostGIS_Version" /></para>
+ </refsection>
+ </refentry>
+
+ <refentry id="PostGIS_Scripts_Released">
+ <refnamediv>
+ <refname>PostGIS_Scripts_Released</refname>
+
+ <refpurpose>Returns the version number of the lwpostgis.sql script
+ released with the installed postgis lib.</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>text <function>PostGIS_Scripts_Released</function></funcdef>
+
+ <paramdef></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </refsynopsisdiv>
+
+ <refsection>
+ <title>Description</title>
+
+ <para>Returns the version number of the lwpostgis.sql script
+ released with the installed postgis lib.</para>
+
+ <note>
+ <para>Starting with version 1.1.0 this function returns the same
+ value of <xref linkend="PostGIS_Lib_Version" />. Kept
+ for backward compatibility.</para>
+ </note>
+
+ <para>Availability: 0.9.0</para>
+ </refsection>
+
+ <refsection>
+ <title>Examples</title>
+
+ <programlisting>SELECT PostGIS_Scripts_Released();
+ postgis_scripts_released
+-------------------------
+ 1.3.4SVN
+(1 row)</programlisting>
+ </refsection>
+
+ <refsection>
+ <title>See Also</title>
+
+ <para><xref linkend="PostGIS_Full_Version" />, <xref linkend="PostGIS_Scripts_Installed" />, <xref linkend="PostGIS_Lib_Version" /></para>
+ </refsection>
+ </refentry>
+
<refentry id="PostGIS_Uses_Stats">
<refnamediv>
<refname>PostGIS_Uses_Stats</refname>
@@ -642,7 +791,51 @@
linkend="PostGIS_PROJ_Version" /></para>
</refsection>
</refentry>
+
+ <refentry id="Probe_Geometry_Columns">
+ <refnamediv>
+ <refname>Probe_Geometry_Columns</refname>
+ <refpurpose>Scans all tables with PostGIS geometry constraints and adds them to the <varname>geometry_columns</varname>
+ table if they are not there. Also give stats on number of inserts and already present or possibly obsolete columns.</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>text <function>Probe_Geometry_Columns</function></funcdef>
+ <paramdef></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </refsynopsisdiv>
+
+ <refsection>
+ <title>Description</title>
+
+ <para>Scans all tables with PostGIS geometry constraints and adds them to the <varname>geometry_columns</varname>
+ table if they are not there. Also give stats on number of inserts and already present or possibly obsolete.</para>
+ <note><para>This will usually only pick up records added by AddGeometryColumn() function. It will not scan views so views
+ will need to be manually added to geometry_columns table.</para></note>
+ </refsection>
+
+ <refsection>
+ <title>Examples</title>
+
+ <programlisting>SELECT Probe_Geometry_Columns();
+ probe_geometry_columns
+---------------------------------------
+probed:6 inserted:0 conflicts:6 stale:0
+(1 row)</programlisting>
+ </refsection>
+
+ <refsection>
+ <title>See Also</title>
+
+ <para><xref linkend="AddGeometryColumn" /></para>
+ </refsection>
+ </refentry>
+
+
<refentry id="UpdateGeometrySRID">
<refnamediv>
<refname>UpdateGeometrySRID</refname>
More information about the postgis-commits
mailing list