Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 313cbdc

Browse files
Doc: Correct description of amcheck example query.
The amcheck documentation incorrectly claimed that its example query verifies every catalog index in the database. In fact, the query only verifies the 10 largest indexes (as determined by pg_class.relpages). Adjust the description accordingly. Backpatch: 10-, where contrib/amcheck was introduced.
1 parent 1eee8d4 commit 313cbdc

File tree

1 file changed

+9
-11
lines changed

1 file changed

+9
-11
lines changed

doc/src/sgml/amcheck.sgml

+9-11
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
functions.
3636
</para>
3737
<para>
38-
<filename>amcheck</filename> functions may be used only by superusers.
38+
<filename>amcheck</filename> functions may only be used by superusers.
3939
</para>
4040

4141
<sect2>
@@ -83,14 +83,13 @@ ORDER BY c.relpages DESC LIMIT 10;
8383
| pg_amop_fam_strat_index | 5
8484
(10 rows)
8585
</screen>
86-
This example shows a session that performs verification of every
87-
catalog index in the database <quote>test</quote>. Details of just
88-
the 10 largest indexes verified are displayed. Verification of
89-
the presence of heap tuples as index tuples is requested for
90-
unique indexes only. Since no error is raised, all indexes
91-
tested appear to be logically consistent. Naturally, this query
92-
could easily be changed to call
93-
<function>bt_index_check</function> for every index in the
86+
This example shows a session that performs verification of the
87+
10 largest catalog indexes in the database <quote>test</quote>.
88+
Verification of the presence of heap tuples as index tuples is
89+
requested for the subset that are unique indexes. Since no
90+
error is raised, all indexes tested appear to be logically
91+
consistent. Naturally, this query could easily be changed to
92+
call <function>bt_index_check</function> for every index in the
9493
database where verification is supported.
9594
</para>
9695
<para>
@@ -292,8 +291,7 @@ ORDER BY c.relpages DESC LIMIT 10;
292291
</listitem>
293292
<listitem>
294293
<para>
295-
Corruption caused by faulty RAM, and the broader memory subsystem
296-
and operating system.
294+
Corruption caused by faulty RAM, or the broader memory subsystem.
297295
</para>
298296
<para>
299297
<productname>PostgreSQL</productname> does not protect against correctable

0 commit comments

Comments
 (0)