doc/src/sgml/ref/drop_index.sgml

   1 <!--
   2 $PostgreSQL$
   3 PostgreSQL documentation
   4 -->
   5
   6 <refentry id="SQL-DROPINDEX">
   7  <refmeta>
   8   <refentrytitle id="SQL-DROPINDEX-TITLE">DROP INDEX</refentrytitle>
   9   <manvolnum>7</manvolnum>
  10   <refmiscinfo>SQL - Language Statements</refmiscinfo>
  11  </refmeta>
  12
  13  <refnamediv>
  14   <refname>DROP INDEX</refname>
  15   <refpurpose>remove an index</refpurpose>
  16  </refnamediv>
  17
  18  <indexterm zone="sql-dropindex">
  19   <primary>DROP INDEX</primary>
  20  </indexterm>
  21
  22  <refsynopsisdiv>
  23 <synopsis>
  24 DROP INDEX [ IF EXISTS ] <replaceable class="PARAMETER">name</replaceable> [, ...] [ CASCADE | RESTRICT ]
  25 </synopsis>
  26  </refsynopsisdiv>
  27
  28  <refsect1>
  29   <title>Description</title>
  30
  31   <para>
  32    <command>DROP INDEX</command> drops an existing index from the database
  33    system. To execute this command you must be the owner of
  34    the index.
  35   </para>
  36  </refsect1>
  37
  38  <refsect1>
  39   <title>Parameters</title>
  40
  41   <variablelist>
  42    <varlistentry>
  43     <term><literal>IF EXISTS</literal></term>
  44     <listitem>
  45      <para>
  46       Do not throw an error if the index does not exist. A notice is issued
  47       in this case.
  48      </para>
  49     </listitem>
  50    </varlistentry>
  51
  52    <varlistentry>
  53     <term><replaceable class="PARAMETER">name</replaceable></term>
  54     <listitem>
  55      <para>
  56       The name (optionally schema-qualified) of an index to remove.
  57      </para>
  58     </listitem>
  59    </varlistentry>
  60
  61    <varlistentry>
  62     <term><literal>CASCADE</literal></term>
  63     <listitem>
  64      <para>
  65       Automatically drop objects that depend on the index.
  66      </para>
  67     </listitem>
  68    </varlistentry>
  69
  70    <varlistentry>
  71     <term><literal>RESTRICT</literal></term>
  72     <listitem>
  73      <para>
  74       Refuse to drop the index if any objects depend on it.  This is
  75       the default.
  76      </para>
  77     </listitem>
  78    </varlistentry>
  79   </variablelist>
  80  </refsect1>
  81
  82  <refsect1>
  83   <title>Examples</title>
  84
  85   <para>
  86    This command will remove the index <literal>title_idx</literal>:
  87
  88 <programlisting>
  89 DROP INDEX title_idx;
  90 </programlisting>
  91   </para>
  92  </refsect1>
  93
  94  <refsect1>
  95   <title>Compatibility</title>
  96
  97   <para>
  98    <command>DROP INDEX</command> is a
  99    <productname>PostgreSQL</productname> language extension.  There
 100    are no provisions for indexes in the SQL standard.
 101   </para>
 102  </refsect1>
 103
 104  <refsect1>
 105   <title>See Also</title>
 106
 107   <simplelist type="inline">
 108    <member><xref linkend="sql-createindex" endterm="sql-createindex-title"></member>
 109   </simplelist>
 110  </refsect1>
 111
 112 </refentry>