From 3e3bb36ee9122fdb211cb08575d6837f8ab522cc Mon Sep 17 00:00:00 2001 From: Tom Lane Date: Tue, 21 Aug 2007 21:08:47 +0000 Subject: 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. --- doc/src/sgml/ref/create_tsparser.sgml | 152 ++++++++++++++++++++++++++++++++++ 1 file changed, 152 insertions(+) create mode 100644 doc/src/sgml/ref/create_tsparser.sgml (limited to 'doc/src/sgml/ref/create_tsparser.sgml') diff --git a/doc/src/sgml/ref/create_tsparser.sgml b/doc/src/sgml/ref/create_tsparser.sgml new file mode 100644 index 00000000000..5f612cf0d96 --- /dev/null +++ b/doc/src/sgml/ref/create_tsparser.sgml @@ -0,0 +1,152 @@ + + + + + CREATE TEXT SEARCH PARSER + SQL - Language Statements + + + + CREATE TEXT SEARCH PARSER + define a new text search parser + + + + CREATE TEXT SEARCH PARSER + + + + +CREATE TEXT SEARCH PARSER name ( + START = start_function , + GETTOKEN = gettoken_function , + END = end_function , + LEXTYPES = lextypes_function + [, HEADLINE = headline_function ] +) + + + + + Description + + + CREATE TEXT SEARCH PARSER creates a new text search + parser. A text search parser defines a method for splitting a text + string into tokens and assigning types (categories) to the tokens. + A parser is not particularly useful by itself, but must be bound into a + text search configuration along with some text search dictionaries + to be used for searching. + + + + If a schema name is given then the text search parser is created in the + specified schema. Otherwise it is created in the current schema. + + + + You must be a superuser to use CREATE TEXT SEARCH PARSER. + (This restriction is made because an erroneous text search parser + definition could confuse or even crash the server.) + + + + Refer to for further information. + + + + + Parameters + + + + name + + + The name of the text search parser to be created. The name can be + schema-qualified. + + + + + + start_function + + + The name of the start function for the parser. + + + + + + gettoken_function + + + The name of the get-next-token function for the parser. + + + + + + end_function + + + The name of the end function for the parser. + + + + + + lextypes_function + + + The name of the lextypes function for the parser (a function that + returns information about the set of token types it produces). + + + + + + headline_function + + + The name of the headline function for the parser (a function that + summarizes a set of tokens). + + + + + + + The function names can be schema-qualified if necessary. Argument types + are not given, since the argument list for each type of function is + predetermined. All except the headline function are required. + + + + The arguments can appear in any order, not only the one shown above. + + + + + Compatibility + + + There is no + CREATE TEXT SEARCH PARSER statement in the SQL + standard. + + + + + See Also + + + + + + + -- cgit v1.2.3