From: Regina Obe <lr@pcorp.us>
Date: Thu, 14 Jul 2011 11:13:10 +0000 (+0000)
Subject: document the install_missing_indexes function that is used as part of the upgrade... 
X-Git-Tag: 2.0.0alpha1~1207
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=9fad5c7c968ff0d60982de993aae60585f16463a;p=postgis

document the install_missing_indexes function that is used as part of the upgrade process

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

diff --git a/doc/extras_tigergeocoder.xml b/doc/extras_tigergeocoder.xml
index 1e434cc2e..38b7c21f0 100644
--- a/doc/extras_tigergeocoder.xml
+++ b/doc/extras_tigergeocoder.xml
@@ -230,6 +230,54 @@ SELECT * FROM addresses_to_geocode WHERE rating is not null;
 	  </refsection>
 	</refentry>
 	
+	<refentry id="Install_Missing_Indexes">
+	  <refnamediv>
+		<refname>Install_Missing_Indexes</refname>
+
+		<refpurpose>Finds all tables with key columns used in geocoder joins and fitler conditions that are missing used indexes on those columns and will add them.</refpurpose>
+	  </refnamediv>
+
+	  <refsynopsisdiv>
+		<funcsynopsis>
+		  <funcprototype>
+			<funcdef>boolean <function>Install_Missing_Indexes</function></funcdef>
+			<paramdef />
+		  </funcprototype>
+		</funcsynopsis>
+	  </refsynopsisdiv>
+
+	  <refsection>
+		<title>Description</title>
+
+		<para>Finds all tables in <varname>tiger</varname> and <varname>tiger_data</varname> schemas with key columns used in geocoder joins that are missing indexes on those columns and will output the SQL DDL to
+		    define the index for those tables. This is a helper function that adds new indexes needed to make queries faster that may have been missing during the load process.
+		   This function is a companion to <xref linkend="Missing_Indexes_Generate_Script" /> that in addition to generating the create index script, also executes it.
+		   It is called as part of the <filename>update_geocode.sql</filename> upgrade script.</para>
+	
+		
+		<para>Availability: 2.0.0</para>
+
+
+	  </refsection>
+
+
+	  <refsection>
+		<title>Examples</title>
+		<programlisting>SELECT install_missing_indexes();
+		 install_missing_indexes
+-------------------------
+ t
+		</programlisting>
+	
+	  </refsection>
+
+	  <!-- Optionally add a "See Also" section -->
+	  <refsection>
+		<title>See Also</title>
+		<para><xref linkend="Loader_Generate_Script"/>, <xref linkend="Missing_Indexes_Generate_Script"/></para>
+	  </refsection>
+	</refentry>
+	
 	<refentry id="Loader_Generate_Script">
 	  <refnamediv>
 		<refname>Loader_Generate_Script</refname>
@@ -372,7 +420,7 @@ CREATE INDEX idx_tiger_data_ma_faces_countyfp ON tiger_data.ma_faces USING btree
 	  <!-- Optionally add a "See Also" section -->
 	  <refsection>
 		<title>See Also</title>
-		<para><xref linkend="Loader_Generate_Script"/></para>
+		<para><xref linkend="Loader_Generate_Script"/>, <xref linkend="Install_Missing_Indexes" /></para>
 	  </refsection>
 	</refentry>