← Back to branch summary

~vcs-imports/mammoth-replicator/trunk

« back to all changes in this revision

Viewing changes to doc/src/sgml/ref/drop_opclass.sgml

  • Committer: alvherre
  • Date: 2005-12-16 21:24:52 UTC
  • Revision ID: svn-v4:db760fc0-0f08-0410-9d63-cc6633f64896:trunk:1
Initial import of the REL8_0_3 sources from the Pgsql CVS repository.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/src/sgml/ref/drop_opclass.sgml
 
1
<!--
 
2
$PostgreSQL: pgsql/doc/src/sgml/ref/drop_opclass.sgml,v 1.8 2003-11-29 19:51:38 pgsql Exp $
 
3
PostgreSQL documentation
 
4
-->
 
5
 
 
6
<refentry id="SQL-DROPOPCLASS">
 
7
 <refmeta>
 
8
  <refentrytitle id="SQL-DROPOPCLASS-TITLE">DROP OPERATOR CLASS</refentrytitle>
 
9
  <refmiscinfo>SQL - Language Statements</refmiscinfo>
 
10
 </refmeta>
 
11
 
 
12
 <refnamediv>
 
13
  <refname>DROP OPERATOR CLASS</refname>
 
14
  <refpurpose>remove an operator class</refpurpose>
 
15
 </refnamediv>
 
16
  
 
17
 <indexterm zone="sql-dropopclass">
 
18
  <primary>DROP OPERATOR CLASS</primary>
 
19
 </indexterm>
 
20
 
 
21
 <refsynopsisdiv>
 
22
<synopsis>
 
23
DROP OPERATOR CLASS <replaceable class="PARAMETER">name</replaceable> USING <replaceable class="PARAMETER">index_method</replaceable> [ CASCADE | RESTRICT ]
 
24
</synopsis>
 
25
 </refsynopsisdiv>
 
26
 
 
27
 <refsect1>
 
28
  <title>Description</title>
 
29
 
 
30
  <para>
 
31
   <command>DROP OPERATOR CLASS</command> drops an existing operator class.
 
32
   To execute this command you must be the owner of the operator class.
 
33
  </para>
 
34
 </refsect1>
 
35
  
 
36
 <refsect1>
 
37
  <title>Parameters</title>
 
38
 
 
39
  <variablelist>
 
40
   <varlistentry>
 
41
    <term><replaceable class="parameter">name</replaceable></term>
 
42
    <listitem>
 
43
     <para>
 
44
      The name (optionally schema-qualified) of an existing operator class.
 
45
     </para>
 
46
    </listitem>
 
47
   </varlistentry>
 
48
 
 
49
   <varlistentry>
 
50
    <term><replaceable class="parameter">index_method</replaceable></term>
 
51
    <listitem>
 
52
     <para>
 
53
      The name of the index access method the operator class is for.
 
54
     </para>
 
55
    </listitem>
 
56
   </varlistentry>
 
57
 
 
58
   <varlistentry>
 
59
    <term><literal>CASCADE</literal></term>
 
60
    <listitem>
 
61
     <para>
 
62
      Automatically drop objects that depend on the operator class.
 
63
     </para>
 
64
    </listitem>
 
65
   </varlistentry>
 
66
 
 
67
   <varlistentry>
 
68
    <term><literal>RESTRICT</literal></term>
 
69
    <listitem>
 
70
     <para>
 
71
      Refuse to drop the operator class if any objects depend on it.
 
72
      This is the default.
 
73
     </para>
 
74
    </listitem>
 
75
   </varlistentry>
 
76
  </variablelist>
 
77
 </refsect1>
 
78
 
 
79
 <refsect1>
 
80
  <title>Examples</title>
 
81
 
 
82
  <para>
 
83
   Remove the B-tree operator class <literal>widget_ops</literal>:
 
84
 
 
85
<programlisting>
 
86
DROP OPERATOR CLASS widget_ops USING btree;
 
87
</programlisting>
 
88
 
 
89
   This command will not succeed if there are any existing indexes
 
90
   that use the operator class.  Add <literal>CASCADE</> to drop
 
91
   such indexes along with the operator class.
 
92
  </para>
 
93
 </refsect1>
 
94
 
 
95
 <refsect1>
 
96
  <title>Compatibility</title>
 
97
 
 
98
  <para>
 
99
   There is no <command>DROP OPERATOR CLASS</command> statement in the
 
100
   SQL standard.
 
101
  </para>
 
102
 </refsect1>
 
103
 
 
104
 <refsect1>
 
105
  <title>See Also</title>
 
106
 
 
107
  <simplelist type="inline">
 
108
   <member><xref linkend="sql-alteropclass" endterm="sql-alteropclass-title"></member>
 
109
   <member><xref linkend="sql-createopclass" endterm="sql-createopclass-title"></member>
 
110
  </simplelist>
 
111
 </refsect1>
 
112
 
 
113
</refentry>
 
114
 
 
115
<!-- Keep this comment at the end of the file
 
116
Local variables:
 
117
mode: sgml
 
118
sgml-omittag:nil
 
119
sgml-shorttag:t
 
120
sgml-minimize-attributes:nil
 
121
sgml-always-quote-attributes:t
 
122
sgml-indent-step:1
 
123
sgml-indent-data:t
 
124
sgml-parent-document:nil
 
125
sgml-default-dtd-file:"../reference.ced"
 
126
sgml-exposed-tags:nil
 
127
sgml-local-catalogs:"/usr/lib/sgml/catalog"
 
128
sgml-local-ecat-files:nil
 
129
End:
 
130
-->