postgresql/doc/src/sgml/ref/drop_index.sgml

113 lines
2.3 KiB
Plaintext
Raw Normal View History

<!--
2010-09-20 22:08:53 +02:00
doc/src/sgml/ref/drop_index.sgml
PostgreSQL documentation
-->
<refentry id="SQL-DROPINDEX">
<refmeta>
<refentrytitle>DROP INDEX</refentrytitle>
<manvolnum>7</manvolnum>
<refmiscinfo>SQL - Language Statements</refmiscinfo>
</refmeta>
2003-05-04 04:23:16 +02:00
<refnamediv>
2003-05-04 04:23:16 +02:00
<refname>DROP INDEX</refname>
<refpurpose>remove an index</refpurpose>
</refnamediv>
2003-05-04 04:23:16 +02:00
2003-08-31 19:32:24 +02:00
<indexterm zone="sql-dropindex">
<primary>DROP INDEX</primary>
</indexterm>
<refsynopsisdiv>
2003-05-04 04:23:16 +02:00
<synopsis>
DROP INDEX [ IF EXISTS ] <replaceable class="PARAMETER">name</replaceable> [, ...] [ CASCADE | RESTRICT ]
2003-05-04 04:23:16 +02:00
</synopsis>
</refsynopsisdiv>
2003-05-04 04:23:16 +02:00
<refsect1>
<title>Description</title>
<para>
<command>DROP INDEX</command> drops an existing index from the database
system. To execute this command you must be the owner of
the index.
</para>
2003-05-04 04:23:16 +02:00
</refsect1>
<refsect1>
<title>Parameters</title>
2003-05-04 04:23:16 +02:00
<variablelist>
<varlistentry>
<term><literal>IF EXISTS</literal></term>
<listitem>
<para>
Do not throw an error if the index does not exist. A notice is issued
in this case.
</para>
</listitem>
</varlistentry>
2003-05-04 04:23:16 +02:00
<varlistentry>
<term><replaceable class="PARAMETER">name</replaceable></term>
2003-05-04 04:23:16 +02:00
<listitem>
<para>
The name (optionally schema-qualified) of an index to remove.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>CASCADE</literal></term>
<listitem>
<para>
Automatically drop objects that depend on the index.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>RESTRICT</literal></term>
<listitem>
<para>
Refuse to drop the index if any objects depend on it. This is
the default.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Examples</title>
<para>
2003-05-04 04:23:16 +02:00
This command will remove the index <literal>title_idx</literal>:
2003-05-04 04:23:16 +02:00
<programlisting>
DROP INDEX title_idx;
</programlisting>
</para>
</refsect1>
2003-05-04 04:23:16 +02:00
<refsect1>
<title>Compatibility</title>
<para>
<command>DROP INDEX</command> is a
<productname>PostgreSQL</productname> language extension. There
are no provisions for indexes in the SQL standard.
</para>
</refsect1>
2003-05-04 04:23:16 +02:00
<refsect1>
<title>See Also</title>
<simplelist type="inline">
<member><xref linkend="sql-createindex"></member>
2003-05-04 04:23:16 +02:00
</simplelist>
</refsect1>
</refentry>