Debian Codegraph @

doc/src/sgml/ref/alter_tstemplate.sgml

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