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

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