Skip site navigation (1)Skip section navigation (2)

  
 
  

home | help
CREATE T...CH PARSER(7)   PostgreSQL 18.6 Documentation  CREATE T...CH PARSER(7)

NAME
     CREATE_TEXT_SEARCH_PARSER - define a new text search parser

SYNOPSIS
     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 assign-
     ing 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 Chapter 12 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  re-
	 turns information about the set of token types it produces).

     headline_function
	 The  name of the headline function for the parser (a function that sum-
	 marizes 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  predeter-
     mined. 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
     ALTER  TEXT  SEARCH  PARSER (ALTER_TEXT_SEARCH_PARSER(7)), DROP TEXT SEARCH
     PARSER (DROP_TEXT_SEARCH_PARSER(7))

PostgreSQL 18.6 		      2026		 CREATE T...CH PARSER(7)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=CREATE_TEXT_SEARCH_PARSER&sektion=7&manpath=FreeBSD+Ports+15.1.quarterly>

home | help