doc/src/sgml/ref/alter_tsparser.sgml

   1 <!--
   2 $PostgreSQL$
   3 PostgreSQL documentation
   4 -->
   5
   6 <refentry id="SQL-ALTERTSPARSER">
   7  <refmeta>
   8   <refentrytitle id="SQL-ALTERTSPARSER-TITLE">ALTER TEXT SEARCH PARSER</refentrytitle>
   9   <manvolnum>7</manvolnum>
  10   <refmiscinfo>SQL - Language Statements</refmiscinfo>
  11  </refmeta>
  12
  13  <refnamediv>
  14   <refname>ALTER TEXT SEARCH PARSER</refname>
  15   <refpurpose>change the definition of a text search parser</refpurpose>
  16  </refnamediv>
  17
  18  <indexterm zone="sql-altertsparser">
  19   <primary>ALTER TEXT SEARCH PARSER</primary>
  20  </indexterm>
  21
  22  <refsynopsisdiv>
  23 <synopsis>
  24 ALTER TEXT SEARCH PARSER <replaceable>name</replaceable> RENAME TO <replaceable>newname</replaceable>
  25 </synopsis>
  26  </refsynopsisdiv>
  27
  28  <refsect1>
  29   <title>Description</title>
  30
  31   <para>
  32    <command>ALTER TEXT SEARCH PARSER</command> changes the definition of
  33    a text search parser.  Currently, the only supported functionality
  34    is to change the parser's name.
  35   </para>
  36
  37   <para>
  38    You must be a superuser to use <command>ALTER TEXT SEARCH PARSER</>.
  39   </para>
  40  </refsect1>
  41
  42  <refsect1>
  43   <title>Parameters</title>
  44
  45   <variablelist>
  46    <varlistentry>
  47     <term><replaceable class="parameter">name</replaceable></term>
  48     <listitem>
  49      <para>
  50       The name (optionally schema-qualified) of an existing text search parser.
  51      </para>
  52     </listitem>
  53    </varlistentry>
  54
  55    <varlistentry>
  56     <term><replaceable class="parameter">newname</replaceable></term>
  57     <listitem>
  58      <para>
  59       The new name of the text search parser.
  60      </para>
  61     </listitem>
  62    </varlistentry>
  63  </variablelist>
  64  </refsect1>
  65
  66  <refsect1>
  67   <title>Compatibility</title>
  68
  69   <para>
  70    There is no <command>ALTER TEXT SEARCH PARSER</command> statement in
  71    the SQL standard.
  72   </para>
  73  </refsect1>
  74
  75  <refsect1>
  76   <title>See Also</title>
  77
  78   <simplelist type="inline">
  79    <member><xref linkend="sql-createtsparser" endterm="sql-createtsparser-title"></member>
  80    <member><xref linkend="sql-droptsparser" endterm="sql-droptsparser-title"></member>
  81   </simplelist>
  82  </refsect1>
  83 </refentry>