codekingpro/portable-devtools

1<?xml version="1.0" encoding="UTF-8" standalone="no"?>2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>CREATE TEXT SEARCH PARSER</title><link rel="stylesheet" type="text/css" href="stylesheet.css" /><link rev="made" href="pgsql-docs@lists.postgresql.org" /><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot" /><link rel="prev" href="sql-createtsdictionary.html" title="CREATE TEXT SEARCH DICTIONARY" /><link rel="next" href="sql-createtstemplate.html" title="CREATE TEXT SEARCH TEMPLATE" /></head><body id="docContent" class="container-fluid col-10"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="5" align="center">CREATE TEXT SEARCH PARSER</th></tr><tr><td width="10%" align="left"><a accesskey="p" href="sql-createtsdictionary.html" title="CREATE TEXT SEARCH DICTIONARY">Prev</a> </td><td width="10%" align="left"><a accesskey="u" href="sql-commands.html" title="SQL Commands">Up</a></td><th width="60%" align="center">SQL Commands</th><td width="10%" align="right"><a accesskey="h" href="index.html" title="PostgreSQL 16.3 Documentation">Home</a></td><td width="10%" align="right"> <a accesskey="n" href="sql-createtstemplate.html" title="CREATE TEXT SEARCH TEMPLATE">Next</a></td></tr></table><hr /></div><div class="refentry" id="SQL-CREATETSPARSER"><div class="titlepage"></div><a id="id-1.9.3.90.1" class="indexterm"></a><div class="refnamediv"><h2><span class="refentrytitle">CREATE TEXT SEARCH PARSER</span></h2><p>CREATE TEXT SEARCH PARSER — define a new text search parser</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">3CREATE TEXT SEARCH PARSER <em class="replaceable"><code>name</code></em> (4    START = <em class="replaceable"><code>start_function</code></em> ,5    GETTOKEN = <em class="replaceable"><code>gettoken_function</code></em> ,6    END = <em class="replaceable"><code>end_function</code></em> ,7    LEXTYPES = <em class="replaceable"><code>lextypes_function</code></em>8    [, HEADLINE = <em class="replaceable"><code>headline_function</code></em> ]9)10</pre></div><div class="refsect1" id="id-1.9.3.90.5"><h2>Description</h2><p>11   <code class="command">CREATE TEXT SEARCH PARSER</code> creates a new text search12   parser.  A text search parser defines a method for splitting a text13   string into tokens and assigning types (categories) to the tokens.14   A parser is not particularly useful by itself, but must be bound into a15   text search configuration along with some text search dictionaries16   to be used for searching.17  </p><p>18   If a schema name is given then the text search parser is created in the19   specified schema.  Otherwise it is created in the current schema.20  </p><p>21   You must be a superuser to use <code class="command">CREATE TEXT SEARCH PARSER</code>.22   (This restriction is made because an erroneous text search parser23   definition could confuse or even crash the server.)24  </p><p>25   Refer to <a class="xref" href="textsearch.html" title="Chapter 12. Full Text Search">Chapter 12</a> for further information.26  </p></div><div class="refsect1" id="id-1.9.3.90.6"><h2>Parameters</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="replaceable"><code>name</code></em></span></dt><dd><p>27      The name of the text search parser to be created.  The name can be28      schema-qualified.29     </p></dd><dt><span class="term"><em class="replaceable"><code>start_function</code></em></span></dt><dd><p>30      The name of the start function for the parser.31     </p></dd><dt><span class="term"><em class="replaceable"><code>gettoken_function</code></em></span></dt><dd><p>32      The name of the get-next-token function for the parser.33     </p></dd><dt><span class="term"><em class="replaceable"><code>end_function</code></em></span></dt><dd><p>34      The name of the end function for the parser.35     </p></dd><dt><span class="term"><em class="replaceable"><code>lextypes_function</code></em></span></dt><dd><p>36      The name of the lextypes function for the parser (a function that37      returns information about the set of token types it produces).38     </p></dd><dt><span class="term"><em class="replaceable"><code>headline_function</code></em></span></dt><dd><p>39      The name of the headline function for the parser (a function that40      summarizes a set of tokens).41     </p></dd></dl></div><p>42   The function names can be schema-qualified if necessary.  Argument types43   are not given, since the argument list for each type of function is44   predetermined.  All except the headline function are required.45  </p><p>46   The arguments can appear in any order, not only the one shown above.47  </p></div><div class="refsect1" id="id-1.9.3.90.7"><h2>Compatibility</h2><p>48   There is no49   <code class="command">CREATE TEXT SEARCH PARSER</code> statement in the SQL50   standard.51  </p></div><div class="refsect1" id="id-1.9.3.90.8"><h2>See Also</h2><span class="simplelist"><a class="xref" href="sql-altertsparser.html" title="ALTER TEXT SEARCH PARSER"><span class="refentrytitle">ALTER TEXT SEARCH PARSER</span></a>, <a class="xref" href="sql-droptsparser.html" title="DROP TEXT SEARCH PARSER"><span class="refentrytitle">DROP TEXT SEARCH PARSER</span></a></span></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="sql-createtsdictionary.html" title="CREATE TEXT SEARCH DICTIONARY">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="sql-commands.html" title="SQL Commands">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="sql-createtstemplate.html" title="CREATE TEXT SEARCH TEMPLATE">Next</a></td></tr><tr><td width="40%" align="left" valign="top">CREATE TEXT SEARCH DICTIONARY </td><td width="20%" align="center"><a accesskey="h" href="index.html" title="PostgreSQL 16.3 Documentation">Home</a></td><td width="40%" align="right" valign="top"> CREATE TEXT SEARCH TEMPLATE</td></tr></table></div></body></html>