existing_index_doc_patch.diff

text/x-patch

Filename: existing_index_doc_patch.diff

Type: text/x-patch

Part: 0

Message: Re: Patch to add a primary key using an existing index

Patch

Same data as JSON: GET /api/v1/attachments/:id/patch the parsed metadata as JSON — format, series position, per-file stats; never the diff bytes. API reference →

Format: unified

File	+	−
doc/src/sgml/ref/alter_table.sgml	0	0

diff --git a/doc/src/sgml/ref/alter_table.sgml b/doc/src/sgml/ref/alter_table.sgml
index 83d2fbb..0b486ab 100644
*** a/doc/src/sgml/ref/alter_table.sgml
--- b/doc/src/sgml/ref/alter_table.sgml
*************** ALTER TABLE <replaceable class="PARAMETE
*** 242,268 ****
      <term><literal>ADD <replaceable class="PARAMETER">table_constraint_using_index</replaceable></literal></term>
      <listitem>
       <para>
!       This form adds a new <literal>PRIMARY KEY</> or <literal>UNIQUE</>
        constraint to the table using an existing index. All the columns of the
        index will be included in the constraint.
       </para>
  
       <para>
!       The index should be UNIQUE, and should not be a <firstterm>partial index</>
!       or an <firstterm>expressional index</>.
       </para>
  
       <para>
!       This can be helpful in situations where one wishes to recreate or
!       <literal>REINDEX</> the index of a <literal>PRIMARY KEY</> or a
!       <literal>UNIQUE</> constraint, but dropping and recreating the constraint
!       to acheive the effect is not desirable. See the illustrative example below.
       </para>
  
       <note>
       <para>
        If a constraint name is provided then the index will be renamed to that
!       name, else the constraint will be named to match the index name.
       </para>
      </note>
  
--- 242,270 ----
      <term><literal>ADD <replaceable class="PARAMETER">table_constraint_using_index</replaceable></literal></term>
      <listitem>
       <para>
!       This form adds a new <literal>PRIMARY KEY</> or <literal>UNIQUE</literal>
        constraint to the table using an existing index. All the columns of the
        index will be included in the constraint.
       </para>
  
       <para>
!       The index should be a UNIQUE index. A <firstterm>partial index</firstterm>
! 	  or an <firstterm>expressional index</firstterm> is not allowed.
       </para>
  
       <para>
!       Adding a constraint using an existing index can be helpful in situations 
! 	  where you wishes to rebuild an index used for a  
! 	  <literal>PRIMARY KEY</literal> or a <literal>UNIQUE</literal> constraint,
! 	  but dropping and recreating the constraint
!       is not desirable. See the illustrative example below.
       </para>
  
       <note>
       <para>
        If a constraint name is provided then the index will be renamed to that
!       name of the constraint. Otherwise the constraint will be named to match 
! 	  the index name.
       </para>
      </note>