Spelling and related minor fixes for the GIN docs.
authorNeil Conway
Thu, 23 Nov 2006 05:58:01 +0000 (05:58 +0000)
committerNeil Conway
Thu, 23 Nov 2006 05:58:01 +0000 (05:58 +0000)
doc/src/sgml/gin.sgml

index 6b382230fd01d4263550cee40478e744d0b74e14..0e4296872f3d8e1b08c7fa1ecae5125d11ad10e6 100644 (file)
@@ -1,4 +1,4 @@
-
+
 
 
 GIN Indexes
   This is much the same advantage as using GiST.
  
 
-  
-   The GIN
-    implementation in PostgreSQL is primarily
-    maintained by Teodor Sigaev and Oleg Bartunov, and there is more
-    information on their
-    website.
-  
-
+  The GIN
+  implementation in PostgreSQL is primarily
+  maintained by Teodor Sigaev and Oleg Bartunov. There is more
+  information about GIN on their
+  website.
 
 
 
@@ -78,7 +77,7 @@
 
  
     
-     int compare( Datum a, Datum b )
+     int compare(Datum a, Datum b)
      
       
       Compares keys (not indexed values!) and returns an integer less than 
        StrategyNumber n)
      
       
-      Returns an array of keys of the query to be executed. n contains
-      the strategy number of the operation 
-      (see ).
-      Depending on n, query may be different type.
+      Returns an array of keys of the query to be executed. n contains the
+      strategy number of the operation (see 
+      linkend="xindex-strategies">).  Depending on n, query may be
+      different type.
       
      
     
 
     
-     bool consistent( bool check[], StrategyNumber n, Datum query)
+     bool consistent(bool check[], StrategyNumber n, Datum query)
      
       
       Returns TRUE if the indexed value satisfies the query qualifier with 
       strategy n (or may satisfy in case of RECHECK mark in operator class). 
       Each element of the check array is TRUE if the indexed value has a 
-      corresponding key in the query: if (check[i] == TRUE ) the i-th key of 
+      corresponding key in the query: if (check[i] == TRUE) the i-th key of 
       the query is present in the indexed value.
       
      
 
 
 
-GIN tips and trics
+GIN tips and tric<span class="marked">k</span>s
 
  
   
    Create vs insert
    
    
-    In most cases, insertion into GIN index is slow
+    In most cases, insertion into GIN index is slow
     due to the likelihood of many keys being inserted for each value.
     So, for bulk insertions into a table it is advisable to to drop the GIN 
     index and recreate it after finishing bulk insertion.
     the whole result set, chosen at random.
    
    
-    "Soft" means that the actual number of returned results could slightly 
-    differ from the specified limit, depending on the query and the quality 
-    of the system's random number generator.
+    Soft means that the actual number of returned results
+    could slightly differ from the specified limit, depending on the query
+    and the quality of the system's random number generator.
    
    
   
 
  
   GIN doesn't support full index scans due to their
-  extremely inefficiency: because there are often many keys per value,
+  extreme inefficiency: because there are often many keys per value,
   each heap pointer will returned several times.
  
 
  
-  When extractQuery returns zero keys, GIN will emit a 
-  error: for different opclasses and strategies the semantic meaning of a void
-  query may be different (for example, any array contains the void array,
-  but they don't overlap the void array), and GIN can't
-  suggest reasonable answer.
+  When extractQuery returns zero keys,
+  GIN will emit an error: for different opclasses and
+  strategies the semantic meaning of a void query may be different (for
+  example, any array contains the void array, but they don't overlap the
+  void array), and GIN can't suggest a reasonable answer.