doc/src/sgml/ref/drop_tsconfig.sgml

   1 <!--
   2 doc/src/sgml/ref/drop_tsconfig.sgml
   3 PostgreSQL documentation
   4 -->
   5
   6 <refentry id="sql-droptsconfig">
   7  <indexterm zone="sql-droptsconfig">
   8   <primary>DROP TEXT SEARCH CONFIGURATION</primary>
   9  </indexterm>
  10
  11  <refmeta>
  12   <refentrytitle>DROP TEXT SEARCH CONFIGURATION</refentrytitle>
  13   <manvolnum>7</manvolnum>
  14   <refmiscinfo>SQL - Language Statements</refmiscinfo>
  15  </refmeta>
  16
  17  <refnamediv>
  18   <refname>DROP TEXT SEARCH CONFIGURATION</refname>
  19   <refpurpose>remove a text search configuration</refpurpose>
  20  </refnamediv>
  21
  22  <refsynopsisdiv>
  23 <synopsis>
  24 DROP TEXT SEARCH CONFIGURATION [ 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 CONFIGURATION</command> drops an existing text
  33    search configuration.  To execute this command you must be the owner of the
  34    configuration.
  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 configuration 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       configuration.
  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 configuration,
  68       and in turn all objects that depend on those objects
  69       (see <xref linkend="ddl-depend"/>).
  70      </para>
  71     </listitem>
  72    </varlistentry>
  73
  74    <varlistentry>
  75     <term><literal>RESTRICT</literal></term>
  76     <listitem>
  77      <para>
  78       Refuse to drop the text search configuration if any objects depend on it.
  79       This is the default.
  80      </para>
  81     </listitem>
  82    </varlistentry>
  83   </variablelist>
  84  </refsect1>
  85
  86  <refsect1>
  87   <title>Examples</title>
  88
  89   <para>
  90    Remove the text search configuration <literal>my_english</literal>:
  91
  92 <programlisting>
  93 DROP TEXT SEARCH CONFIGURATION my_english;
  94 </programlisting>
  95
  96    This command will not succeed if there are any existing indexes
  97    that reference the configuration in <function>to_tsvector</function> calls.
  98    Add <literal>CASCADE</literal> to
  99    drop such indexes along with the text search configuration.
 100   </para>
 101  </refsect1>
 102
 103  <refsect1>
 104   <title>Compatibility</title>
 105
 106   <para>
 107    There is no <command>DROP TEXT SEARCH CONFIGURATION</command> statement in
 108    the SQL standard.
 109   </para>
 110  </refsect1>
 111
 112  <refsect1>
 113   <title>See Also</title>
 114
 115   <simplelist type="inline">
 116    <member><xref linkend="sql-altertsconfig"/></member>
 117    <member><xref linkend="sql-createtsconfig"/></member>
 118   </simplelist>
 119  </refsect1>
 120
 121 </refentry>