Re: Fix for documentation of Covering Indexes

From: Liudmila Mantrova <l(dot)mantrova(at)postgrespro(dot)ru>
To: Heikki Linnakangas <hlinnaka(at)iki(dot)fi>, Michael Paquier <michael(at)paquier(dot)xyz>, Postgres hackers <pgsql-hackers(at)postgresql(dot)org>
Cc: pgsql-docs(at)lists(dot)postgresql(dot)org
Subject: Re: Fix for documentation of Covering Indexes
Date: 2018-07-30 10:38:10
Message-ID: a58527f8-dbfc-3ba9-0a0c-05c5849d97aa@postgrespro.ru
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs pgsql-hackers

On 04/18/2018 12:52 PM, Heikki Linnakangas wrote:
> On 11/04/18 04:20, Michael Paquier wrote:
>> Hi all,
>>
>> The documentation of covering indexes is incorrect for CREATE and ALTER
>> TABLE:
>> - ALTER TABLE's page is missing the call.
>> - Exclusion constraints can use INCLUDE clauses.
>>
>> In order to simplify the documentation, please let me suggest the
>> attached which moves the definition of the INCLUDE clause into the
>> section index_parameters, which is compatible with what I read from the
>> parser.
>
> Committed, thanks!
>
> - Heikki
>
Following this change, I believe we need to modify UNIQUE and PRIMARY
KEY descriptions in CREATE TABLE as they still mention INCLUDE but not
the other index_parameters. The attached patch fixes this inconsistency,
as well as adds a separate paragraph for INCLUDE in CREATE TABLE to
clarify its purpose and avoid repetition in constraint descriptions. It
also reorders the paragraphs in CREATE INDEX to follow the syntax.

--
Liudmila Mantrova
Technical writer at Postgres Professional: http://www.postgrespro.com
The Russian Postgres Company

Attachment Content-Type Size
include-clause-reference.patch text/x-patch 10.1 KB

In response to

Browse pgsql-docs by date

  From Date Subject
Next Message PG Doc comments form 2018-08-01 10:10:52 regarding dblink_fdw
Previous Message Nikolay Samokhvalov 2018-07-29 18:53:46 Re: Documents in PDF format

Browse pgsql-hackers by date

  From Date Subject
Next Message Tomas Vondra 2018-07-30 10:42:51 Re: [PATCH] Improve geometric types
Previous Message Michael Paquier 2018-07-30 10:21:31 Re: BUG #15182: Canceling authentication due to timeout aka Denial of Service Attack