Received: from malur.postgresql.org ([217.196.149.56]) by arkaria.postgresql.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_CBC_SHA384:256) (Exim 4.89) (envelope-from ) id 1f6AzX-0000ZG-1n for pgsql-hackers@arkaria.postgresql.org; Wed, 11 Apr 2018 08:20:31 +0000 Received: from localhost ([127.0.0.1] helo=malur.postgresql.org) by malur.postgresql.org with esmtp (Exim 4.89) (envelope-from ) id 1f6AzW-0001yl-27 for pgsql-hackers@arkaria.postgresql.org; Wed, 11 Apr 2018 08:20:30 +0000 Received: from magus.postgresql.org ([2a02:c0:301:0:ffff::29]) by malur.postgresql.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_CBC_SHA384:256) (Exim 4.89) (envelope-from ) id 1f6AzV-0001yV-6g for pgsql-hackers@lists.postgresql.org; Wed, 11 Apr 2018 08:20:29 +0000 Received: from out5-smtp.messagingengine.com ([66.111.4.29]) by magus.postgresql.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_CBC_SHA384:256) (Exim 4.89) (envelope-from ) id 1f6AzS-0000er-GD for pgsql-hackers@postgresql.org; Wed, 11 Apr 2018 08:20:28 +0000 Received: from compute4.internal (compute4.nyi.internal [10.202.2.44]) by mailout.nyi.internal (Postfix) with ESMTP id 45D5921500 for ; Wed, 11 Apr 2018 04:20:24 -0400 (EDT) Received: from mailfrontend2 ([10.202.2.163]) by compute4.internal (MEProxy); Wed, 11 Apr 2018 04:20:24 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=paquier.xyz; h= content-type:date:from:message-id:mime-version:subject:to :x-me-sender:x-me-sender:x-sasl-enc; s=fm1; bh=UwjNfh0JSpZpb9z+m zqC9xxiHzFI1h+mn3xPNiMG0W0=; b=NTXVj18H6cMKJKSMJaHTtx1f/vhPg2qpl z8qG4Ob2Gd2UNg06yaEcvjF2UOBwMY9riyal5l2zj856mmBsuXbyNlWa0kxjzGr5 kSmqlqiXXkhFWRoXl1jobp2ukltmOhhJqt30h2a9Yo9zETdCdUd2yhvfmovo90Zw fSsaDY+MCyVGP6bpEt+y/wJt5zpAiHcYHvlLRrMEMtBMoASee3R9siS5TmvAo2B2 0nyELc97ATbEUBLUsLrxZpnrlepTbQMSjM5Y4Kghe+rvPBGx5ssNjyvaqNSENnWy xEgETOyMp6ErC99Wki5ZVuo38FOpGbvjVY3j4SsbnkX1jXW60d1qQ== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=content-type:date:from:message-id :mime-version:subject:to:x-me-sender:x-me-sender:x-sasl-enc; s= fm2; bh=UwjNfh0JSpZpb9z+mzqC9xxiHzFI1h+mn3xPNiMG0W0=; b=dY9qWQav HwJGDjN5ThSiIKiMsQg2S+kYsUU3qsVuIg/P7Q/aZpmQLmEvnHtKInN3/W4zc4Lm M/F1jq2vH2Jjnkv7ynvpOxnatR11ugdyr1rTdXpT76cerxW9FKZWRfgJmVzRDScx u2ecniiiZpdLbXvq/c4RDtl48pV4RzhRkNsZLFLD4Ye6/OZf2765ICtj2GLbvMG2 YhGe+aAzKsZZGJ3NhvvZ6kx9jdMhaAwInNUhiBelfZvglA8w6vPlHI3+lwn5vEy7 +dDlm0Zm2dtx6E4tLFzGZ7cIYoMo0YRUmD6xiVRcIoKNT7DVLP3nSUVbz2EgeV28 36/ABrE4A6fqXw== X-ME-Sender: Received: from paquier.xyz (c137162.net61215.cablenet.ne.jp [61.215.137.162]) by mail.messagingengine.com (Postfix) with ESMTPA id 1952B102B7 for ; Wed, 11 Apr 2018 04:20:22 -0400 (EDT) Date: Wed, 11 Apr 2018 17:20:20 +0900 From: Michael Paquier To: Postgres hackers Subject: Fix for documentation of Covering Indexes Message-ID: <20180411082020.GD19732@paquier.xyz> MIME-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha512; protocol="application/pgp-signature"; boundary="27ZtN5FSuKKSZcBU" Content-Disposition: inline List-Id: List-Help: List-Subscribe: List-Post: List-Owner: List-Archive: Precedence: bulk --27ZtN5FSuKKSZcBU Content-Type: multipart/mixed; boundary="zjcmjzIkjQU2rmur" Content-Disposition: inline --zjcmjzIkjQU2rmur Content-Type: text/plain; charset=us-ascii Content-Disposition: inline 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 --zjcmjzIkjQU2rmur Content-Type: text/x-diff; charset=us-ascii Content-Disposition: attachment; filename="covering-index-docs.patch" Content-Transfer-Encoding: quoted-printable diff --git a/doc/src/sgml/ref/alter_table.sgml b/doc/src/sgml/ref/alter_tab= le.sgml index bd2262761e..8c7b9619b8 100644 --- a/doc/src/sgml/ref/alter_table.sgml +++ b/doc/src/sgml/ref/alter_table.sgml @@ -125,6 +125,7 @@ WITH ( MODULUS numeric= _literal, REM =20 index_parameters in= UNIQUE, PRIMARY KEY, and EX= CLUDE constraints are: =20 +[ INCLUDE ( column_name [, = =2E.. ] ) ] [ WITH ( storage_parameter = [=3D value] [, ... ] ) ] [ USING INDEX TABLESPACE tablespace_name<= /replaceable> ] =20 diff --git a/doc/src/sgml/ref/create_table.sgml b/doc/src/sgml/ref/create_t= able.sgml index cb3867dbd5..f2bd562d55 100644 --- a/doc/src/sgml/ref/create_table.sgml +++ b/doc/src/sgml/ref/create_table.sgml @@ -73,8 +73,8 @@ CREATE [ [ GLOBAL | LOCAL ] { TEMPORARY | TEMP } | UNLOGG= ED ] TABLE [ IF NOT EXI =20 [ CONSTRAINT constraint_name ] { CHECK ( expression ) [ NO= INHERIT ] | - UNIQUE ( column_name [, .= =2E. ] ) index_parameters INCLUDE (column_name [, ...]) | - PRIMARY KEY ( column_name= [, ... ] ) index_parameters= INCLUDE (column_name [, ...]) | + UNIQUE ( column_name [, .= =2E. ] ) index_parameters | + PRIMARY KEY ( column_name= [, ... ] ) index_parameters= | EXCLUDE [ USING index_method ] ( exclude_element WITH= operator [, ... ] ) index_parameters [ WHERE ( predicate ) ] | FOREIGN KEY ( column_name= [, ... ] ) REFERENCES reftable [ ( refcolumn [, ... ] )= ] [ MATCH FULL | MATCH PARTIAL | MATCH SIMPLE ] [ ON DELETE action ] [ ON UPDATE action ] } @@ -93,6 +93,7 @@ WITH ( MODULUS numeric_l= iteral, REM =20 index_parameters in= UNIQUE, PRIMARY KEY, and EX= CLUDE constraints are: =20 +[ INCLUDE ( column_name [, = =2E.. ] ) ] [ WITH ( storage_parameter = [=3D value] [, ... ] ) ] [ USING INDEX TABLESPACE tablespace_name<= /replaceable> ] =20 --zjcmjzIkjQU2rmur-- --27ZtN5FSuKKSZcBU Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iQIzBAABCgAdFiEEG72nH6vTowiyblFKnvQgOdbyQH0FAlrNxUQACgkQnvQgOdby QH2WHQ/+KNwL0/sQHzrDhH7mTGzkNh3yJaHqQbhobE1AUZefOKcPCjT7/xtFxXye frlK3CdGL2gqKNWxjwVrmWv3EiDYBbr8LW9oPwFH1MfppjCLtdahGAHTgxBMks5K rWl3iON7mXJ0kmMt1ez4DkzTesnXvLHUj+pswgUb2p7zfvG+rSgqEKilIScktDYe +oAPLVL+hHNv/2mnXxuDpdESuHnKWuJ5uxT6UyAMJcFtA37jWwqmD0xt4KuU6fe9 QMrrVzSEONxPpJB6rgm+ESaKm48R5iFqSEeVhjacsPlVAdhuagWnkOtHtkidMZR5 slkYOURlcD4Zpcv5786BcFD8f5bk/w1dgNrDzMZHKfcOCpTpjB7sytWmPGJreU4P wdYa30mRT7BOmq231+aZ5xDa4OYzhEVSBpU0x3yHUpUA/GV8J/VzvddEp2+MJ/Qn OF4DA4bKkzgw59VN8VvyUnw9P137eiZWfZS3Oq6cNGfPtsUP/wPfy6ykoQUwUqNo Tk5mcN0WWPK8p2+cgcb1rajpdZWPps/9jYLXWq1RH0NBFpjGRhai8Ae92IlKDIca DilnNtlQLpDqSxbk8JvtCNJwJ89xgafzFODOiR9CAFkmIHfuYlpcNUDATAzHcsgO rA4JuUiOVdBdLkBwjNQAxZvI8TLAWd1uRHx4oj5JTjLDfI17ojQ= =fEYy -----END PGP SIGNATURE----- --27ZtN5FSuKKSZcBU--