doc/src/sgml/ref/drop_tsconfig.sgml

   1 <!--
   2 $PostgreSQL$
   3 PostgreSQL documentation
   4 -->
   5
   6 <refentry id="SQL-DROPTSCONFIG">
   7  <refmeta>
   8   <refentrytitle id="SQL-DROPTSCONFIG-TITLE">DROP TEXT SEARCH CONFIGURATION</refentrytitle>
   9   <manvolnum>7</manvolnum>
  10   <refmiscinfo>SQL - Language Statements</refmiscinfo>
  11  </refmeta>
  12
  13  <refnamediv>
  14   <refname>DROP TEXT SEARCH CONFIGURATION</refname>
  15   <refpurpose>remove a text search configuration</refpurpose>
  16  </refnamediv>
  17
  18  <indexterm zone="sql-droptsconfig">
  19   <primary>DROP TEXT SEARCH CONFIGURATION</primary>
  20  </indexterm>
  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      </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 configuration 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 configuration <literal>my_english</literal>:
  89
  90 <programlisting>
  91 DROP TEXT SEARCH CONFIGURATION my_english;
  92 </programlisting>
  93
  94    This command will not succeed if there are any existing indexes
  95    that reference the configuration in <function>to_tsvector</> calls.
  96    Add <literal>CASCADE</> to
  97    drop such indexes along with the text search configuration.
  98   </para>
  99  </refsect1>
 100
 101  <refsect1>
 102   <title>Compatibility</title>
 103
 104   <para>
 105    There is no <command>DROP TEXT SEARCH CONFIGURATION</command> statement in
 106    the SQL standard.
 107   </para>
 108  </refsect1>
 109
 110  <refsect1>
 111   <title>See Also</title>
 112
 113   <simplelist type="inline">
 114    <member><xref linkend="sql-altertsconfig" endterm="sql-altertsconfig-title"></member>
 115    <member><xref linkend="sql-createtsconfig" endterm="sql-createtsconfig-title"></member>
 116   </simplelist>
 117  </refsect1>
 118
 119 </refentry>