CREATE TEXT SEARCH TEMPLATE
define a new text search template
English manual coverage begins with PostgreSQL 6.4. Source history and runtime observations have their own recorded version boundaries.
Reading PG 18·Select a recorded version
- anchor
- SQL-CREATETSTEMPLATE
- file
- sql-createtstemplate.html
- lang
- en
- name
- CREATE TEXT SEARCH TEMPLATE
- purpose
- define a new text search template
- purpose zh
- 定义一个新的文本检索模板
- sections same as
- Unknown
- slug
- 18
- synopsis html
- CREATE TEXT SEARCH TEMPLATE <em class="replaceable"><code>name</code></em> ( [ INIT = <em class="replaceable"><code>init_function</code></em> , ] LEXIZE = <em class="replaceable"><code>lexize_function</code></em> )
- synopsis text
- CREATE TEXT SEARCH TEMPLATE name ( [ INIT = init_function , ] LEXIZE = lexize_function )
Syntax
CREATE TEXT SEARCH TEMPLATE name (
[ INIT = init_function , ]
LEXIZE = lexize_function
)Syntax diagrams
Read left to right. Branches are choices, bypasses are optional, loops repeat. Select an underlined parameter to open its rule.
Definition PG 18
CREATE TEXT SEARCH TEMPLATE name ( [ INIT = init_function , ] LEXIZE = lexize_function )
Description
CREATE TEXT SEARCH TEMPLATE creates a new text search template. Text search templates define the functions that implement text search dictionaries. A template is not useful by itself, but must be instantiated as a dictionary to be used. The dictionary typically specifies parameters to be given to the template functions.
If a schema name is given then the text search template is created in the specified schema. Otherwise it is created in the current schema.
You must be a superuser to use CREATE TEXT SEARCH TEMPLATE. This restriction is made because an erroneous text search template definition could confuse or even crash the server. The reason for separating templates from dictionaries is that a template encapsulates the “unsafe” aspects of defining a dictionary. The parameters that can be set when defining a dictionary are safe for unprivileged users to set, and so creating a dictionary need not be a privileged operation.
Refer to Chapter 12 for further information.
Parameters
nameThe name of the text search template to be created. The name can be schema-qualified.
init_functionThe name of the init function for the template.
lexize_functionThe name of the lexize function for the template.
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. The lexize function is required, but the init function is optional.
The arguments can appear in any order, not only the one shown above.
Compatibility
There is no CREATE TEXT SEARCH TEMPLATE statement in the SQL standard.
See Also
ALTER TEXT SEARCH TEMPLATE, DROP TEXT SEARCH TEMPLATECompare versions
Source references
Full definition and evidence JSON
Definition sources
center · PostgreSQL 18 · wiki-repair-20261023:094b44b944ef531e5e7ab3b52c39ca2f073405fe348647bf08d33f01101f7f22
Text language: en · wiki-repair-20261023:094b44b944ef531e5e7ab3b52c39ca2f073405fe348647bf08d33f01101f7f22