On Fri, Dec 13, 2019 at 10:28:33AM +0100, Josef Šimánek wrote: > I have prepared patch to improve documentation for REINDEX. It > should be more inline with another documentation pages. > > You can see the change applied in attached file. Patch can be found at > https://github.com/simi/postgres/pull/3 (diff - > https://github.com/simi/postgres/pull/3.diff, patch - > https://github.com/simi/postgres/pull/3.patch).
Please, always attach your patches to emails sent on this mailing
list. If for a reason or another, the data located to with external
link is lost (imagine for example that your github account is gone or
that github is reduced to ashes), then such patches would be lost, and
anybody looking at this email 10 years from now would not know what
you have been writing about here. I am attaching it here for the
archive's sake.
+<phrase>where <replaceable class="parameter">option</replaceable> can
be:</phrase>
+
+ VERBOSE
Why not... We did that in the docs of ANALYZE for v11 when
introducing the parenthesized grammar flavor for the options
available.
- Rebuild all the indexes on the table <literal>my_table</literal>:
+ Rebuild all the indexes on the table <literal>my_table</literal>
with progress report per index:
<programlisting>
-REINDEX TABLE my_table;
+REINDEX (VERBOSE) TABLE my_table;
Not sure if this part brings much to the reader though. It is not
like the command description of REINDEX is complicated with dozens
of option choices.
--
Michael
From 992fbb946daf0e5483319665c74a1a75dfea503b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Josef=20=C5=A0im=C3=A1nek?= <josef.sima...@gmail.com>
Date: Fri, 13 Dec 2019 01:59:07 +0100
Subject: [PATCH] Unify REINDEX options documentation and extend examples.
---
doc/src/sgml/ref/reindex.sgml | 10 +++++++---
1 file changed, 7 insertions(+), 3 deletions(-)
diff --git a/doc/src/sgml/ref/reindex.sgml b/doc/src/sgml/ref/reindex.sgml
index 10881ab03a85..007cceb320ee 100644
--- a/doc/src/sgml/ref/reindex.sgml
+++ b/doc/src/sgml/ref/reindex.sgml
@@ -21,7 +21,11 @@ PostgreSQL documentation
<refsynopsisdiv>
<synopsis>
-REINDEX [ ( VERBOSE ) ] { INDEX | TABLE | SCHEMA | DATABASE | SYSTEM } [ CONCURRENTLY ] <replaceable class="parameter">name</replaceable>
+REINDEX [ ( <replaceable class="parameter">option</replaceable> [, ...] ) ] { INDEX | TABLE | SCHEMA | DATABASE | SYSTEM } [ CONCURRENTLY ] <replaceable class="parameter">name</replaceable>
+
+<phrase>where <replaceable class="parameter">option</replaceable> can be:</phrase>
+
+ VERBOSE
</synopsis>
</refsynopsisdiv>
@@ -422,10 +426,10 @@ REINDEX INDEX my_index;
</para>
<para>
- Rebuild all the indexes on the table <literal>my_table</literal>:
+ Rebuild all the indexes on the table <literal>my_table</literal> with progress report per index:
<programlisting>
-REINDEX TABLE my_table;
+REINDEX (VERBOSE) TABLE my_table;
</programlisting>
</para>
signature.asc
Description: PGP signature
