doc/src/sgml/ref/drop_tsdictionary.sgml

   1 <!--
   2 $PostgreSQL$
   3 PostgreSQL documentation
   4 -->
   5
   6 <refentry id="SQL-DROPTSDICTIONARY">
   7  <refmeta>
   8   <refentrytitle id="SQL-DROPTSDICTIONARY-TITLE">DROP TEXT SEARCH DICTIONARY</refentrytitle>
   9   <manvolnum>7</manvolnum>
  10   <refmiscinfo>SQL - Language Statements</refmiscinfo>
  11  </refmeta>
  12
  13  <refnamediv>
  14   <refname>DROP TEXT SEARCH DICTIONARY</refname>
  15   <refpurpose>remove a text search dictionary</refpurpose>
  16  </refnamediv>
  17
  18  <indexterm zone="sql-droptsdictionary">
  19   <primary>DROP TEXT SEARCH DICTIONARY</primary>
  20  </indexterm>
  21
  22  <refsynopsisdiv>
  23 <synopsis>
  24 DROP TEXT SEARCH DICTIONARY [ 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 TEXT SEARCH DICTIONARY</command> drops an existing text
  33    search dictionary.  To execute this command you must be the owner of the
  34    dictionary.
  35   </para>
  36  </refsect1>
  37
  38  <refsect1>
  39   <title>Parameters</title>
  40
  41   <variablelist>
  42
  43    <varlistentry>
  44     <term><literal>IF EXISTS</literal></term>
  45     <listitem>
  46      <para>
  47       Do not throw an error if the text search dictionary does not exist.
  48       A notice is issued in this case.
  49      </para>
  50     </listitem>
  51    </varlistentry>
  52
  53    <varlistentry>
  54     <term><replaceable class="parameter">name</replaceable></term>
  55     <listitem>
  56      <para>
  57       The name (optionally schema-qualified) of an existing text search
  58       dictionary.
  59      </para>
  60     </listitem>
  61    </varlistentry>
  62
  63    <varlistentry>
  64     <term><literal>CASCADE</literal></term>
  65     <listitem>
  66      <para>
  67       Automatically drop objects that depend on the text search dictionary.
  68      </para>
  69     </listitem>
  70    </varlistentry>
  71
  72    <varlistentry>
  73     <term><literal>RESTRICT</literal></term>
  74     <listitem>
  75      <para>
  76       Refuse to drop the text search dictionary 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    Remove the text search dictionary <literal>english</literal>:
  89
  90 <programlisting>
  91 DROP TEXT SEARCH DICTIONARY english;
  92 </programlisting>
  93
  94    This command will not succeed if there are any existing text search
  95    configurations that use the dictionary.  Add <literal>CASCADE</> to
  96    drop such configurations along with the dictionary.
  97   </para>
  98  </refsect1>
  99
 100  <refsect1>
 101   <title>Compatibility</title>
 102
 103   <para>
 104    There is no <command>DROP TEXT SEARCH DICTIONARY</command> statement in the
 105    SQL standard.
 106   </para>
 107  </refsect1>
 108
 109  <refsect1>
 110   <title>See Also</title>
 111
 112   <simplelist type="inline">
 113    <member><xref linkend="sql-altertsdictionary" endterm="sql-altertsdictionary-title"></member>
 114    <member><xref linkend="sql-createtsdictionary" endterm="sql-createtsdictionary-title"></member>
 115   </simplelist>
 116  </refsect1>
 117
 118 </refentry>