Skip to content

Commit bcbb402

Browse files
feodorfeodor
committed
Improve wordings by David Fuhry <dfuhry@cs.kent.edu>
1 parent 18a9637 commit bcbb402

File tree

5 files changed

+34
-31
lines changed

5 files changed

+34
-31
lines changed

‎doc/src/sgml/config.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- $PostgreSQL: pgsql/doc/src/sgml/config.sgml,v 1.87 2006/09/16 00:30:12 momjian Exp $ -->
1+
<!-- $PostgreSQL: pgsql/doc/src/sgml/config.sgml,v 1.88 2006/09/18 12:11:36 teodor Exp $ -->
22

33
<chapter Id="runtime-config">
44
<title>Server Configuration</title>
@@ -2180,7 +2180,7 @@ SELECT * FROM parent WHERE key = 2400;
21802180
</indexterm>
21812181
<listitem>
21822182
<para>
2183-
Soft upper limit of the size of the returned set by GIN index. For more
2183+
Soft upper limit of the size of the set returned by GIN index. For more
21842184
information see <xref linkend="gin-tips">.
21852185
</para>
21862186
</listitem>

‎doc/src/sgml/gin.sgml

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- $PostgreSQL: pgsql/doc/src/sgml/gin.sgml,v 2.3 2006/09/14 21:15:07 tgl Exp $ -->
1+
<!-- $PostgreSQL: pgsql/doc/src/sgml/gin.sgml,v 2.4 2006/09/18 12:11:36 teodor Exp $ -->
22

33
<chapter id="GIN">
44
<title>GIN Indexes</title>
@@ -14,7 +14,7 @@
1414
<para>
1515
<acronym>GIN</acronym> stands for Generalized Inverted Index. It is
1616
an index structure storing a set of (key, posting list) pairs, where
17-
'posting list' is a set of rows in which the key occurs. The
17+
'posting list' is a set of rows in which the key occurs. Each
1818
row may contain many keys.
1919
</para>
2020

@@ -104,7 +104,8 @@
104104
<listitem>
105105
<para>
106106
Returns an array of keys of the query to be executed. n contains
107-
strategy number of operation (see <xref linkend="xindex-strategies">).
107+
the strategy number of the operation
108+
(see <xref linkend="xindex-strategies">).
108109
Depending on n, query may be different type.
109110
</para>
110111
</listitem>
@@ -114,9 +115,9 @@
114115
<term>bool consistent( bool check[], StrategyNumber n, Datum query)</term>
115116
<listitem>
116117
<para>
117-
Returns TRUE if indexed value satisfies query qualifier with strategy n
118-
(or may satisfy in case of RECHECK mark in operator class).
119-
Each element of the check array is TRUE if indexed value has a
118+
Returns TRUE if the indexed value satisfies the query qualifier with
119+
strategy n (or may satisfy in case of RECHECK mark in operator class).
120+
Each element of the check array is TRUE if the indexed value has a
120121
corresponding key in the query: if (check[i] == TRUE ) the i-th key of
121122
the query is present in the indexed value.
122123
</para>
@@ -135,10 +136,10 @@
135136
<term>Create vs insert</term>
136137
<listitem>
137138
<para>
138-
In most cases, insertion into <acronym>GIN</acronym> index is slow because
139-
many GIN keys may be inserted for each table row. So, when loading data
140-
in bulk it may be useful to drop index and recreate it
141-
after the data is loaded in the table.
139+
In most cases, insertion into <acronym>GIN</acronym> index is slow
140+
due to the likelihood of many keys being inserted for each value.
141+
So, for bulk insertions into a table it is advisable to to drop the GIN
142+
index and recreate it after finishing bulk insertion.
142143
</para>
143144
</listitem>
144145
</varlistentry>
@@ -147,7 +148,7 @@
147148
<term>gin_fuzzy_search_limit</term>
148149
<listitem>
149150
<para>
150-
The primary goal of development <acronym>GIN</acronym> indices was
151+
The primary goal of developing <acronym>GIN</acronym> indices was
151152
support for highly scalable, full-text search in
152153
<productname>PostgreSQL</productname> and there are often situations when
153154
a full-text search returns a very large set of results. Since reading
@@ -158,7 +159,7 @@
158159
<para>
159160
Such queries usually contain very frequent words, so the results are not
160161
very helpful. To facilitate execution of such queries
161-
<acronym>GIN</acronym> has a configurable soft upper limit of the size
162+
<acronym>GIN</acronym> has a configurable soft upper limit of the size
162163
of the returned set, determined by the
163164
<varname>gin_fuzzy_search_limit</varname> GUC variable. It is set to 0 by
164165
default (no limit).
@@ -182,16 +183,16 @@
182183
<title>Limitations</title>
183184

184185
<para>
185-
<acronym>GIN</acronym> doesn't support full scan of index due to it's
186-
extremely inefficiency: because of a lot of keys per value,
186+
<acronym>GIN</acronym> doesn't support full index scans due to their
187+
extremely inefficiency: because there are often many keys per value,
187188
each heap pointer will returned several times.
188189
</para>
189190

190191
<para>
191-
When extractQuery returns zero number of keys, <acronym>GIN</acronym> will
192-
emit a error: for different opclass and strategy semantic meaning of void
193-
query may be different (for example, any array contains void array,
194-
but they aren't overlapped with void one), and <acronym>GIN</acronym> can't
192+
When extractQuery returns zero keys, <acronym>GIN</acronym> will emit a
193+
error: for different opclasses and strategies the semantic meaning of a void
194+
query may be different (for example, any array contains the void array,
195+
but they don't overlap the void array), and <acronym>GIN</acronym> can't
195196
suggest reasonable answer.
196197
</para>
197198

‎doc/src/sgml/indices.sgml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- $PostgreSQL: pgsql/doc/src/sgml/indices.sgml,v 1.63 2006/09/16 00:30:14 momjian Exp $ -->
1+
<!-- $PostgreSQL: pgsql/doc/src/sgml/indices.sgml,v 1.64 2006/09/18 12:11:36 teodor Exp $ -->
22

33
<chapter id="indexes">
44
<title id="indexes-title">Indexes</title>
@@ -248,7 +248,7 @@ CREATE INDEX <replaceable>name</replaceable> ON <replaceable>table</replaceable>
248248
<see>index</see>
249249
</indexterm>
250250
GIN is a inverted index and it's usable for values which have more
251-
than one key, arrays for example. Like to GiST, GIN may support
251+
than one key, arrays for example. Like GiST, GIN may support
252252
many different user-defined indexing strategies and the particular
253253
operators with which a GIN index can be used vary depending on the
254254
indexing strategy.
@@ -266,7 +266,7 @@ CREATE INDEX <replaceable>name</replaceable> ON <replaceable>table</replaceable>
266266

267267
(See <xref linkend="functions-array"> for the meaning of
268268
these operators.)
269-
Another GIN operator classes are available in the <literal>contrib</>
269+
Other GIN operator classes are available in the <literal>contrib</>
270270
tsearch2 and intarray modules. For more information see <xref linkend="GIN">.
271271
</para>
272272
</sect1>

‎doc/src/sgml/mvcc.sgml

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- $PostgreSQL: pgsql/doc/src/sgml/mvcc.sgml,v 2.61 2006/09/17 22:50:31 tgl Exp $ -->
1+
<!-- $PostgreSQL: pgsql/doc/src/sgml/mvcc.sgml,v 2.62 2006/09/18 12:11:36 teodor Exp $ -->
22

33
<chapter id="mvcc">
44
<title>Concurrency Control</title>
@@ -993,10 +993,12 @@ UPDATE accounts SET balance = balance - 100.00 WHERE acctnum = 22222;
993993
</term>
994994
<listitem>
995995
<para>
996-
Short-term share/exclusive page-level locks are used for
997-
read/write access. Locks are released immediately after each
998-
index row is fetched or inserted. However, note that a GIN index
999-
usually requires several inserts for each table row.
996+
Short-term share/exclusive page-level locks are used for
997+
read/write access. Locks are released immediately after each
998+
index row is fetched or inserted. But note that a GIN-indexed
999+
value insertion usually produces several index key insertions
1000+
per row, so GIN may do substantial work for a single value's
1001+
insertion.
10001002
</para>
10011003
</listitem>
10021004
</varlistentry>

‎doc/src/sgml/xindex.sgml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- $PostgreSQL: pgsql/doc/src/sgml/xindex.sgml,v 1.48 2006/09/16 00:30:16 momjian Exp $ -->
1+
<!-- $PostgreSQL: pgsql/doc/src/sgml/xindex.sgml,v 1.49 2006/09/18 12:11:36 teodor Exp $ -->
22

33
<sect1 id="xindex">
44
<title>Interfacing Extensions To Indexes</title>
@@ -243,8 +243,8 @@
243243
</table>
244244

245245
<para>
246-
GIN indexes are similar to GiST in flexibility: it hasn't a fixed set
247-
of strategies. Instead, the <quote>consistency</> support routine
246+
GIN indexes are similar to GiST's in flexibility: they don't have a fixed
247+
et of strategies. Instead, the <quote>consistency</> support routine
248248
interprets the strategy numbers accordingly with operator class
249249
definition. As an example, strategies of operator class over arrays
250250
is shown in <xref linkend="xindex-gin-array-strat-table">.

0 commit comments

Comments
 (0)