summaryrefslogtreecommitdiff
path: root/doc/src/sgml/ref/alter_tstemplate.sgml
blob: cb4b97b030181827cd952beb49b7f289c0a09d15 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
<!--
$PostgreSQL: pgsql/doc/src/sgml/ref/alter_tstemplate.sgml,v 1.4 2010/04/03 07:22:57 petere Exp $
PostgreSQL documentation
-->

<refentry id="SQL-ALTERTSTEMPLATE">
 <refmeta>
  <refentrytitle>ALTER TEXT SEARCH TEMPLATE</refentrytitle>
  <manvolnum>7</manvolnum>
  <refmiscinfo>SQL - Language Statements</refmiscinfo>
 </refmeta>

 <refnamediv>
  <refname>ALTER TEXT SEARCH TEMPLATE</refname>
  <refpurpose>change the definition of a text search template</refpurpose>
 </refnamediv>  
  
 <indexterm zone="sql-altertstemplate">
  <primary>ALTER TEXT SEARCH TEMPLATE</primary>
 </indexterm>

 <refsynopsisdiv>
<synopsis>
ALTER TEXT SEARCH TEMPLATE <replaceable>name</replaceable> RENAME TO <replaceable>new_name</replaceable>
</synopsis>
 </refsynopsisdiv>
  
 <refsect1>
  <title>Description</title>

  <para>
   <command>ALTER TEXT SEARCH TEMPLATE</command> changes the definition of
   a text search template.  Currently, the only supported functionality
   is to change the template's name.
  </para>

  <para>
   You must be a superuser to use <command>ALTER TEXT SEARCH TEMPLATE</>.
  </para>
 </refsect1>
  
 <refsect1>
  <title>Parameters</title>

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

   <varlistentry>
    <term><replaceable class="parameter">new_name</replaceable></term>
    <listitem>
     <para>
      The new name of the text search template.
     </para>
    </listitem>
   </varlistentry>
 </variablelist>
 </refsect1>

 <refsect1>
  <title>Compatibility</title>

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

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

  <simplelist type="inline">
   <member><xref linkend="sql-createtstemplate"></member>
   <member><xref linkend="sql-droptstemplate"></member>
  </simplelist>
 </refsect1>
</refentry>