postgresql/doc/src/sgml/ref/alter_tstemplate.sgml
Tom Lane 3e3bb36ee9 First rough cut at text search documentation: bare bones reference
pages for the new SQL commands.  I also committed Bruce's text search
introductory chapter, as-is except for fixing some markup errors,
so that there would be a place for the reference pages to link to.
2007-08-21 21:08:47 +00:00

83 lines
2.1 KiB
Plaintext

<!--
$PostgreSQL: pgsql/doc/src/sgml/ref/alter_tstemplate.sgml,v 1.1 2007/08/21 21:08:47 tgl Exp $
PostgreSQL documentation
-->
<refentry id="SQL-ALTERTSTEMPLATE">
<refmeta>
<refentrytitle id="SQL-ALTERTSTEMPLATE-TITLE">ALTER TEXT SEARCH TEMPLATE</refentrytitle>
<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>newname</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">newname</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" endterm="sql-createtstemplate-title"></member>
<member><xref linkend="sql-droptstemplate" endterm="sql-droptstemplate-title"></member>
</simplelist>
</refsect1>
</refentry>