Thread: Fix for documentation of Covering Indexes
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. Thanks, -- Michael
Attachment
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
On Wed, Apr 18, 2018 at 05:52:01AM -0400, Heikki Linnakangas wrote: > Committed, thanks! Thanks for the commit. -- Michael
Attachment
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
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