1
0
mirror of https://github.com/postgres/postgres.git synced 2025-08-22 21:53:06 +03:00

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.
This commit is contained in:
Tom Lane
2007-08-21 21:08:47 +00:00
parent 5c681ab1cb
commit 3e3bb36ee9
18 changed files with 5224 additions and 10 deletions

View File

@@ -0,0 +1,115 @@
<!--
$PostgreSQL: pgsql/doc/src/sgml/ref/drop_tsparser.sgml,v 1.1 2007/08/21 21:08:47 tgl Exp $
PostgreSQL documentation
-->
<refentry id="SQL-DROPTSPARSER">
<refmeta>
<refentrytitle id="SQL-DROPTSPARSER-TITLE">DROP TEXT SEARCH PARSER</refentrytitle>
<refmiscinfo>SQL - Language Statements</refmiscinfo>
</refmeta>
<refnamediv>
<refname>DROP TEXT SEARCH PARSER</refname>
<refpurpose>remove a text search parser</refpurpose>
</refnamediv>
<indexterm zone="sql-droptsparser">
<primary>DROP TEXT SEARCH PARSER</primary>
</indexterm>
<refsynopsisdiv>
<synopsis>
DROP TEXT SEARCH PARSER [ IF EXISTS ] <replaceable class="PARAMETER">name</replaceable> [ CASCADE | RESTRICT ]
</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
<command>DROP TEXT SEARCH PARSER</command> drops an existing text search
parser. You must be a superuser to use this command.
</para>
</refsect1>
<refsect1>
<title>Parameters</title>
<variablelist>
<varlistentry>
<term><literal>IF EXISTS</literal></term>
<listitem>
<para>
Do not throw an error if the text search parser does not exist.
A notice is issued in this case.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable class="parameter">name</replaceable></term>
<listitem>
<para>
The name (optionally schema-qualified) of an existing text search parser.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>CASCADE</literal></term>
<listitem>
<para>
Automatically drop objects that depend on the text search parser.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>RESTRICT</literal></term>
<listitem>
<para>
Refuse to drop the text search parser if any objects depend on it.
This is the default.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Examples</title>
<para>
Remove the text search parser <literal>my_parser</literal>:
<programlisting>
DROP TEXT SEARCH PARSER my_parser;
</programlisting>
This command will not succeed if there are any existing text search
configurations that use the parser. Add <literal>CASCADE</> to
drop such configurations along with the parser.
</para>
</refsect1>
<refsect1>
<title>Compatibility</title>
<para>
There is no <command>DROP TEXT SEARCH PARSER</command> statement in the
SQL standard.
</para>
</refsect1>
<refsect1>
<title>See Also</title>
<simplelist type="inline">
<member><xref linkend="sql-altertsparser" endterm="sql-altertsparser-title"></member>
<member><xref linkend="sql-createtsparser" endterm="sql-createtsparser-title"></member>
</simplelist>
</refsect1>
</refentry>