granicus.if.org Git - postgresql/blob - doc/src/sgml/ref/drop_access_method.sgml

   1 <!--
   2 doc/src/sgml/ref/drop_access_method.sgml
   3 PostgreSQL documentation
   4 -->
   5
   6 <refentry id="sql-drop-access-method">
   7  <indexterm zone="sql-drop-access-method">
   8   <primary>DROP ACCESS METHOD</primary>
   9  </indexterm>
  10
  11  <refmeta>
  12   <refentrytitle>DROP ACCESS METHOD</refentrytitle>
  13   <manvolnum>7</manvolnum>
  14   <refmiscinfo>SQL - Language Statements</refmiscinfo>
  15  </refmeta>
  16
  17  <refnamediv>
  18   <refname>DROP ACCESS METHOD</refname>
  19   <refpurpose>remove an access method</refpurpose>
  20  </refnamediv>
  21
  22  <refsynopsisdiv>
  23 <synopsis>
  24 DROP ACCESS METHOD [ 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 ACCESS METHOD</command> removes an existing access method.
  33    Only superusers can drop access methods.
  34   </para>
  35  </refsect1>
  36
  37  <refsect1>
  38   <title>Parameters</title>
  39
  40   <variablelist>
  41    <varlistentry>
  42     <term><literal>IF EXISTS</literal></term>
  43     <listitem>
  44      <para>
  45       Do not throw an error if the access method does not exist.
  46       A notice is issued in this case.
  47      </para>
  48     </listitem>
  49    </varlistentry>
  50
  51    <varlistentry>
  52     <term><replaceable class="parameter">name</replaceable></term>
  53     <listitem>
  54      <para>
  55       The name of an existing access method.
  56      </para>
  57     </listitem>
  58    </varlistentry>
  59
  60    <varlistentry>
  61     <term><literal>CASCADE</literal></term>
  62     <listitem>
  63      <para>
  64       Automatically drop objects that depend on the access method
  65       (such as operator classes, operator families, and indexes),
  66       and in turn all objects that depend on those objects
  67       (see <xref linkend="ddl-depend">).
  68      </para>
  69     </listitem>
  70    </varlistentry>
  71
  72    <varlistentry>
  73     <term><literal>RESTRICT</literal></term>
  74     <listitem>
  75      <para>
  76       Refuse to drop the access method if any objects depend on it.
  77       This is the default.
  78      </para>
  79     </listitem>
  80    </varlistentry>
  81   </variablelist>
  82  </refsect1>
  83
  84  <refsect1>
  85   <title>Examples</title>
  86
  87   <para>
  88    Drop the access method <literal>heptree</>:
  89 <programlisting>
  90 DROP ACCESS METHOD heptree;
  91 </programlisting></para>
  92  </refsect1>
  93
  94  <refsect1>
  95   <title>Compatibility</title>
  96
  97   <para>
  98    <command>DROP ACCESS METHOD</command> is a
  99    <productname>PostgreSQL</> extension.
 100   </para>
 101  </refsect1>
 102
 103  <refsect1>
 104   <title>See Also</title>
 105
 106   <simplelist type="inline">
 107    <member><xref linkend="sql-create-access-method"></member>
 108   </simplelist>
 109  </refsect1>
 110
 111 </refentry>