pgsql: Doc: rework introductory documentation about covering indexes.

From: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
To: pgsql-committers(at)lists(dot)postgresql(dot)org
Subject: pgsql: Doc: rework introductory documentation about covering indexes.
Date: 2018-11-22 18:25:23
Message-ID: E1gPtfH-0003nY-5a@gemulon.postgresql.org
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-committers

Doc: rework introductory documentation about covering indexes.

Documenting INCLUDE in the section about unique indexes is confusing,
as complained of by Emilio Platzer. Furthermore, it entirely failed
to explain why you might want to use the feature. The section about
index-only scans is really the right place; it already talked about
making such things the hard way. Rewrite that text to describe INCLUDE
as the normal way to make a covering index.

Also, move that section up a couple of places, as it now seems more
important than some of the stuff we had before it. It still has to
be after expression and partial indexes, since otherwise some of it
would involve forward references.

Discussion: https://postgr.es/m/154031939560.30897.14677735588262722042@wrigleys.postgresql.org

Branch
------
master

Details
-------
https://git.postgresql.org/pg/commitdiff/fe375d33a184b98510d08f45f55da1338cde974a

Modified Files
--------------
doc/src/sgml/indices.sgml | 435 +++++++++++++++++++++++++++-------------------
1 file changed, 252 insertions(+), 183 deletions(-)

Browse pgsql-committers by date

  From Date Subject
Next Message Tom Lane 2018-11-22 20:14:11 pgsql: Fix another crash in json{b}_populate_recordset and json{b}_to_r
Previous Message Michael Paquier 2018-11-22 04:26:22 pgsql: Fix typo in description of ExecFindPartition