2002-07-30 00:14:11 +02:00
<!--
2003-05-04 04:23:16 +02:00
$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_opclass.sgml,v 1.3 2003/05/04 02:23:16 petere Exp $
2002-07-30 00:14:11 +02:00
PostgreSQL documentation
-->
<refentry id="SQL-DROPOPCLASS">
<refmeta>
<refentrytitle id="SQL-DROPOPCLASS-TITLE">DROP OPERATOR CLASS</refentrytitle>
<refmiscinfo>SQL - Language Statements</refmiscinfo>
</refmeta>
2003-05-04 04:23:16 +02:00
2002-07-30 00:14:11 +02:00
<refnamediv>
2003-05-04 04:23:16 +02:00
<refname>DROP OPERATOR CLASS</refname>
<refpurpose>remove a user-defined operator class</refpurpose>
2002-07-30 00:14:11 +02:00
</refnamediv>
<refsynopsisdiv>
2003-05-04 04:23:16 +02:00
<synopsis>
DROP OPERATOR CLASS <replaceable class="PARAMETER">name</replaceable> USING <replaceable class="PARAMETER">index_method</replaceable> [ CASCADE | RESTRICT ]
</synopsis>
2002-07-30 00:14:11 +02:00
</refsynopsisdiv>
2003-05-04 04:23:16 +02:00
<refsect1>
<title>Description</title>
2002-07-30 00:14:11 +02:00
<para>
2003-05-04 04:23:16 +02:00
<command>DROP OPERATOR CLASS</command> drops an existing operator class.
2002-07-30 00:14:11 +02:00
To execute this command you must be the owner of the operator class.
</para>
2003-05-04 04:23:16 +02:00
</refsect1>
<refsect1>
<title>Parameters</title>
2002-07-30 00:14:11 +02:00
2003-05-04 04:23:16 +02:00
<variablelist>
<varlistentry>
<term><replaceable class="parameter">name</replaceable></term>
<listitem>
<para>
The name (optionally schema-qualified) of an existing operator class.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable class="parameter">index_method</replaceable></term>
<listitem>
<para>
The name of the index access method the operator class is for.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>CASCADE</literal></term>
<listitem>
<para>
Automatically drop objects that depend on the operator class.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>RESTRICT</literal></term>
<listitem>
<para>
Refuse to drop the operator class if any objects depend on it.
This is the default.
</para>
</listitem>
</varlistentry>
</variablelist>
2002-07-30 00:14:11 +02:00
</refsect1>
2003-05-04 04:23:16 +02:00
<refsect1>
<title>Diagnostics</title>
<variablelist>
<varlistentry>
<term><computeroutput>DROP OPERATOR CLASS</computeroutput></term>
<listitem>
<para>
Message returned if the command was successful.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Examples</title>
2002-07-30 00:14:11 +02:00
<para>
2003-05-04 04:23:16 +02:00
Remove the B-tree operator class <literal>widget_ops</literal>:
2002-07-30 00:14:11 +02:00
2003-05-04 04:23:16 +02:00
<programlisting>
2002-07-30 00:14:11 +02:00
DROP OPERATOR CLASS widget_ops USING btree;
2003-05-04 04:23:16 +02:00
</programlisting>
2002-07-30 00:14:11 +02:00
2003-05-04 04:23:16 +02:00
This command will not succeed if there are any existing indexes
2002-07-30 00:14:11 +02:00
that use the operator class. Add <literal>CASCADE</> to drop
such indexes along with the operator class.
</para>
</refsect1>
2003-05-04 04:23:16 +02:00
<refsect1>
<title>Compatibility</title>
<para>
There is no <command>DROP OPERATOR CLASS</command> statement in the
SQL standard.
</para>
2002-07-30 00:14:11 +02:00
</refsect1>
2003-05-04 04:23:16 +02:00
<refsect1>
<title>See Also</title>
<simplelist type="inline">
<member><xref linkend="sql-createopclass" endterm="sql-createopclass-title"></member>
</simplelist>
</refsect1>
2002-07-30 00:14:11 +02:00
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:nil
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"../reference.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:"/usr/lib/sgml/catalog"
sgml-local-ecat-files:nil
End:
-->