doc/src/sgml/ref/drop_tsparser.sgml

<!--
doc/src/sgml/ref/drop_tsparser.sgml
PostgreSQL documentation
-->

<refentry id="sql-droptsparser">
 <indexterm zone="sql-droptsparser">
  <primary>DROP TEXT SEARCH PARSER</primary>
 </indexterm>

 <refmeta>
  <refentrytitle>DROP TEXT SEARCH PARSER</refentrytitle>
  <manvolnum>7</manvolnum>
  <refmiscinfo>SQL - Language Statements</refmiscinfo>
 </refmeta>

 <refnamediv>
  <refname>DROP TEXT SEARCH PARSER</refname>
  <refpurpose>remove a text search parser</refpurpose>
 </refnamediv>

 <refsynopsisdiv>
<synopsis>
DROP TEXT SEARCH PARSER [ IF EXISTS ] <replaceable class="parameter">name</replaceable> [ CASCADE | RESTRICT ]
</synopsis>
 </refsynopsisdiv>

 <refsect1>
  <title>Description</title>

  <para>
   <command>DROP TEXT SEARCH PARSER</command> drops an existing text search
   parser.  You must be a superuser to use this command.
  </para>
 </refsect1>

 <refsect1>
  <title>Parameters</title>

  <variablelist>

   <varlistentry>
    <term><literal>IF EXISTS</literal></term>
    <listitem>
     <para>
      Do not throw an error if the text search parser does not exist.
      A notice is issued in this case.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term><replaceable class="parameter">name</replaceable></term>
    <listitem>
     <para>
      The name (optionally schema-qualified) of an existing text search parser.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term><literal>CASCADE</literal></term>
    <listitem>
     <para>
      Automatically drop objects that depend on the text search parser,
      and in turn all objects that depend on those objects
      (see <xref linkend="ddl-depend"/>).
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term><literal>RESTRICT</literal></term>
    <listitem>
     <para>
      Refuse to drop the text search parser if any objects depend on it.
      This is the default.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1>
  <title>Examples</title>

  <para>
   Remove the text search parser <literal>my_parser</literal>:

<programlisting>
DROP TEXT SEARCH PARSER my_parser;
</programlisting>

   This command will not succeed if there are any existing text search
   configurations that use the parser.  Add <literal>CASCADE</literal> to
   drop such configurations along with the parser.
  </para>
 </refsect1>

 <refsect1>
  <title>Compatibility</title>

  <para>
   There is no <command>DROP TEXT SEARCH PARSER</command> statement in the
   SQL standard.
  </para>
 </refsect1>

 <refsect1>
  <title>See Also</title>

  <simplelist type="inline">
   <member><xref linkend="sql-altertsparser"/></member>
   <member><xref linkend="sql-createtsparser"/></member>
  </simplelist>
 </refsect1>

</refentry>