begriffs open source - ai-pg/blob - full-docs/txt/sql-createtsparser.txt

   1
   2 CREATE TEXT SEARCH PARSER
   3
   4    CREATE TEXT SEARCH PARSER — define a new text search parser
   5
   6 Synopsis
   7
   8 CREATE TEXT SEARCH PARSER name (
   9     START = start_function ,
  10     GETTOKEN = gettoken_function ,
  11     END = end_function ,
  12     LEXTYPES = lextypes_function
  13     [, HEADLINE = headline_function ]
  14 )
  15
  16 Description
  17
  18    CREATE TEXT SEARCH PARSER creates a new text search parser. A text
  19    search parser defines a method for splitting a text string into tokens
  20    and assigning types (categories) to the tokens. A parser is not
  21    particularly useful by itself, but must be bound into a text search
  22    configuration along with some text search dictionaries to be used for
  23    searching.
  24
  25    If a schema name is given then the text search parser is created in the
  26    specified schema. Otherwise it is created in the current schema.
  27
  28    You must be a superuser to use CREATE TEXT SEARCH PARSER. (This
  29    restriction is made because an erroneous text search parser definition
  30    could confuse or even crash the server.)
  31
  32    Refer to Chapter 12 for further information.
  33
  34 Parameters
  35
  36    name
  37           The name of the text search parser to be created. The name can
  38           be schema-qualified.
  39
  40    start_function
  41           The name of the start function for the parser.
  42
  43    gettoken_function
  44           The name of the get-next-token function for the parser.
  45
  46    end_function
  47           The name of the end function for the parser.
  48
  49    lextypes_function
  50           The name of the lextypes function for the parser (a function
  51           that returns information about the set of token types it
  52           produces).
  53
  54    headline_function
  55           The name of the headline function for the parser (a function
  56           that summarizes a set of tokens).
  57
  58    The function names can be schema-qualified if necessary. Argument types
  59    are not given, since the argument list for each type of function is
  60    predetermined. All except the headline function are required.
  61
  62    The arguments can appear in any order, not only the one shown above.
  63
  64 Compatibility
  65
  66    There is no CREATE TEXT SEARCH PARSER statement in the SQL standard.
  67
  68 See Also
  69
  70    ALTER TEXT SEARCH PARSER, DROP TEXT SEARCH PARSER