Re: [HACKERS] GIN documentation

2006-09-16 Thread David Fuhry

Teodor,

   Attached is a diff -c against your original gindocs patch.  I did my 
best not to change any of the semantics.  My changes no doubt overlap  
conflict with those Jeff Davis sent you earlier, so consider both of our 
diffs.


Thanks,

Dave Fuhry

Teodor Sigaev wrote:

Patch adds GIN documentation and slightly improves GiST docs.

Somebody of native English speakers, pls, check the text... Thank you.





---(end of broadcast)---
TIP 4: Have you searched our list archives?

   http://archives.postgresql.org
*** gindocs.orig	2006-09-17 00:21:38.0 -0400
--- gindocs	2006-09-17 00:57:12.0 -0400
***
*** 22,28 
  ! 	  /indexterm
  ! 	  listitem
  ! 	   para
! ! 		Soft upper limit of the size of the returned set by GIN index. For more
  ! 		information see xref linkend=gin-tips.
  ! 	   /para
  ! 	  /listitem
--- 22,28 
  ! 	  /indexterm
  ! 	  listitem
  ! 	   para
! ! 		Soft upper limit of the size of the set returned by the GIN index. For more
  ! 		information see xref linkend=gin-tips.
  ! 	   /para
  ! 	  /listitem
***
*** 88,95 
  +  para
  +acronymGIN/acronym stands for Generalized Inverted Index.  It is
  +an index structure storing a set of (key, posting list) pairs, where
! +'posting list' is a set of rows in which the key occurs. The
! +row may contains a lot of keys.
  +  /para
  + 
  +  para
--- 88,95 
  +  para
  +acronymGIN/acronym stands for Generalized Inverted Index.  It is
  +an index structure storing a set of (key, posting list) pairs, where
! +'posting list' is a set of rows in which the key occurs. Each
! +row may contain many keys.
  +  /para
  + 
  +  para
***
*** 178,184 
  +  listitem
  +   para
  + 	   Returns an array of keys of the query to be executed. n contains
! + 	   strategy number of operation (see xref linkend=xindex-strategies).
  + 	   Depending on n, query may be different type.
  +   /para
  +  /listitem
--- 178,184 
  +  listitem
  +   para
  + 	   Returns an array of keys of the query to be executed. n contains
! + 	   the strategy number of the operation (see xref linkend=xindex-strategies).
  + 	   Depending on n, query may be different type.
  +   /para
  +  /listitem
***
*** 188,196 
  +  termbool consistent( bool check[], StrategyNumber n, Datum query)/term
  +  listitem
  +   para
! + 	   Returns TRUE if indexed value satisfies 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 indexed value has a 
  + 	   corresponding key in the query: if (check[i] == TRUE ) the i-th key of 
  + 	   the query is present in the indexed value.
  +   /para
--- 188,196 
  +  termbool consistent( bool check[], StrategyNumber n, Datum query)/term
  +  listitem
  +   para
! + 	   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 
  + 	   the query is present in the indexed value.
  +   /para
***
*** 209,218 
  +termCreate vs insert/term
  +listitem
  + 	para
! + 	 In most cases, insertion into acronymGIN/acronym index is slow enough
! + 	 due to a lot keys should be inserted per one value. So, for bulk upload
! + 	 data in table it will be useful to drop index and create it
! + 	 after finishing upload.
  + 	/para
  +/listitem
  +   /varlistentry
--- 209,218 
  +termCreate vs insert/term
  +listitem
  + 	para
! + 	 In most cases, insertion into a acronymGIN/acronym 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.
  + 	/para
  +/listitem
  +   /varlistentry
***
*** 221,227 
  +termgin_fuzzy_search_limit/term
  +listitem
  + 	para
! + 	 The primary goal of development acronymGIN/acronym indices was 
  + 	 support for highly scalable, full-text search in 
  + 	 productnamePostgreSQL/productname and there are often situations when 
  + 	 a full-text search returns a very large set of results.  Since reading 
--- 221,227 
  +termgin_fuzzy_search_limit/term
  +listitem
  + 	para
! + 	 The primary goal of developing acronymGIN/acronym indices was 
  + 	 support for highly scalable, full-text search in 
  + 	 productnamePostgreSQL/productname and there are often situations when 
  + 	 a full-text search returns a very large set of results.  Since reading 

[HACKERS] GIN documentation

2006-09-13 Thread Teodor Sigaev

Patch adds GIN documentation and slightly improves GiST docs.

Somebody of native English speakers, pls, check the text... Thank you.


gindocs.gz
Description: application/gzip

---(end of broadcast)---
TIP 4: Have you searched our list archives?

   http://archives.postgresql.org


Re: [HACKERS] GIN documentation

2006-09-13 Thread Jeff Davis
On Wed, 2006-09-13 at 14:24 +0400, Teodor Sigaev wrote:
 Patch adds GIN documentation and slightly improves GiST docs.
 
 Somebody of native English speakers, pls, check the text... Thank you.

I have some minor changes that reworded some parts that were confusing
to me.

I don't fully understand GIN, but I hope this is helpful.

Regards,
Jeff Davis 
--- gindocs.orig	2006-09-13 10:07:57.0 -0700
+++ gindocs	2006-09-13 10:43:25.0 -0700
@@ -89,7 +89,7 @@
 +acronymGIN/acronym stands for Generalized Inverted Index.  It is
 +an index structure storing a set of (key, posting list) pairs, where
 +'posting list' is a set of rows in which the key occurs. The
-+row may contains a lot of keys.
++row may contain many keys.
 +  /para
 + 
 +  para
@@ -209,10 +209,10 @@
 +termCreate vs insert/term
 +listitem
 + 	para
-+ 	 In most cases, insertion into acronymGIN/acronym index is slow enough
-+ 	 due to a lot keys should be inserted per one value. So, for bulk upload
-+ 	 data in table it will be useful to drop index and create it
-+ 	 after finishing upload.
++ 	 In most cases, insertion into acronymGIN/acronym index is slow because 
++ 	 many GIN keys may be inserted for each table row. So, when loading data
++ 	 in bulk it may be useful to drop index and recreate it
++ 	 after the data is loaded in the table.
 + 	/para
 +/listitem
 +   /varlistentry
@@ -381,9 +381,8 @@
 +para
 + 		Short-term share/exclusive page-level locks are used for 
 + 		read/write access. Locks are released immediately after each
-+ 		index row is fetched or inserted. But note, that GIN index
-+ 		usually requires produce several inserts per one row, so,
-+ 		GIN makes more work per one value's insertion.
++ 		index row is fetched or inserted. However, note that GIN index
++ 		usually requires several inserts per one table row.
 +/para
 +   /listitem
 +  /varlistentry

---(end of broadcast)---
TIP 4: Have you searched our list archives?

   http://archives.postgresql.org