aboutsummaryrefslogtreecommitdiff
path: root/doc/src/sgml/ref/drop_opclass.sgml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/src/sgml/ref/drop_opclass.sgml')
-rw-r--r--doc/src/sgml/ref/drop_opclass.sgml184
1 files changed, 184 insertions, 0 deletions
diff --git a/doc/src/sgml/ref/drop_opclass.sgml b/doc/src/sgml/ref/drop_opclass.sgml
new file mode 100644
index 00000000000..631a45aaeba
--- /dev/null
+++ b/doc/src/sgml/ref/drop_opclass.sgml
@@ -0,0 +1,184 @@
+<!--
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_opclass.sgml,v 1.1 2002/07/29 22:14:10 tgl Exp $
+PostgreSQL documentation
+-->
+
+<refentry id="SQL-DROPOPCLASS">
+ <refmeta>
+ <refentrytitle id="SQL-DROPOPCLASS-TITLE">DROP OPERATOR CLASS</refentrytitle>
+ <refmiscinfo>SQL - Language Statements</refmiscinfo>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ DROP OPERATOR CLASS
+ </refname>
+ <refpurpose>
+ remove a user-defined operator class
+ </refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <refsynopsisdivinfo>
+ <date>2002-07-28</date>
+ </refsynopsisdivinfo>
+ <synopsis>
+DROP OPERATOR CLASS <replaceable class="PARAMETER">name</replaceable> USING <replaceable class="PARAMETER">access_method</replaceable> [ CASCADE | RESTRICT ]
+ </synopsis>
+
+ <refsect2 id="R2-SQL-DROPOPCLASS-1">
+ <refsect2info>
+ <date>2002-07-28</date>
+ </refsect2info>
+ <title>
+ Inputs
+ </title>
+ <para>
+ <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">access_method</replaceable></term>
+ <listitem>
+ <para>
+ The name of the index access method the operator class is for.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>CASCADE</term>
+ <listitem>
+ <para>
+ Automatically drop objects that depend on the operator class.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>RESTRICT</term>
+ <listitem>
+ <para>
+ Refuse to drop the operator class if there are any dependent objects.
+ This is the default.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect2>
+
+ <refsect2 id="R2-SQL-DROPOPCLASS-2">
+ <refsect2info>
+ <date>2002-07-28</date>
+ </refsect2info>
+ <title>
+ Outputs
+ </title>
+ <para>
+
+ <variablelist>
+ <varlistentry>
+ <term><computeroutput>
+DROP OPERATOR CLASS
+ </computeroutput></term>
+ <listitem>
+ <para>
+ The message returned if the command is successful.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect2>
+ </refsynopsisdiv>
+
+ <refsect1 id="R1-SQL-DROPOPCLASS-1">
+ <refsect1info>
+ <date>2002-07-28</date>
+ </refsect1info>
+ <title>
+ Description
+ </title>
+ <para>
+ <command>DROP OPERATOR CLASS</command> drops an existing operator class
+ from the database.
+ To execute this command you must be the owner of the operator class.
+ </para>
+
+ <refsect2 id="R2-SQL-DROPOPCLASS-3">
+ <refsect2info>
+ <date>2002-07-28</date>
+ </refsect2info>
+ <title>
+ Notes
+ </title>
+ <para>
+ The <command>DROP OPERATOR CLASS</command> statement is a
+ <productname>PostgreSQL</productname>
+ language extension.
+ </para>
+ <para>
+ Refer to
+ <xref linkend="sql-createopclass" endterm="sql-createopclass-title">
+ for information on how to create operator classes.
+ </para>
+ </refsect2>
+ </refsect1>
+
+ <refsect1 id="R1-SQL-DROPOPCLASS-2">
+ <title>
+ Usage
+ </title>
+ <para>
+ Remove btree operator class <literal>widget_ops</literal>:
+
+ <programlisting>
+DROP OPERATOR CLASS widget_ops USING btree;
+ </programlisting>
+
+ This command will not execute if there are any existing indexes
+ that use the operator class. Add <literal>CASCADE</> to drop
+ such indexes along with the operator class.
+ </para>
+ </refsect1>
+
+ <refsect1 id="R1-SQL-DROPOPCLASS-3">
+ <title>
+ Compatibility
+ </title>
+
+ <refsect2 id="R2-SQL-DROPOPCLASS-4">
+ <refsect2info>
+ <date>2002-07-28</date>
+ </refsect2info>
+ <title>
+ SQL92
+ </title>
+ <para>
+ There is no <command>DROP OPERATOR CLASS</command> in
+ <acronym>SQL92</acronym>.
+ </para>
+ </refsect2>
+ </refsect1>
+</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:
+-->