From eb9f280ca78e9b8b28c88911ed45e8e59a04b997 Mon Sep 17 00:00:00 2001 From: Tom Lane Date: Mon, 1 Oct 2007 21:10:40 +0000 Subject: [PATCH] Add catalogs.sgml documentation for text search catalogs. --- doc/src/sgml/catalogs.sgml | 406 ++++++++++++++++++++++++++++++++++++- 1 file changed, 404 insertions(+), 2 deletions(-) diff --git a/doc/src/sgml/catalogs.sgml b/doc/src/sgml/catalogs.sgml index 98cd438618..d0c7673a8e 100644 --- a/doc/src/sgml/catalogs.sgml +++ b/doc/src/sgml/catalogs.sgml @@ -1,4 +1,4 @@ - + @@ -218,6 +218,31 @@ triggers + + pg_ts_config + text search configurations + + + + pg_ts_config_map + text search configurations' token mappings + + + + pg_ts_dict + text search dictionaries + + + + pg_ts_parser + text search parsers + + + + pg_ts_template + text search templates + + pg_type data types @@ -2481,6 +2506,7 @@ + <structname>pg_index</structname> @@ -3269,7 +3295,7 @@ Each operator family is a collection of operators and associated support routines that implement the semantics specified for a particular index access method. Furthermore, the operators in a family are all - compatible, in a way that depends on the access method. + compatible, in a way that is specified by the access method. The operator family concept allows cross-data-type operators to be used with indexes and to be reasoned about using knowledge of access method semantics. @@ -4404,6 +4430,382 @@ + + <structname>pg_ts_config</structname> + + + pg_ts_config + + + + The pg_ts_config catalog contains entries + representing text search configurations. A configuration specifies + a particular text search parser and a list of dictionaries to use + for each of the parser's output token types. The parser is shown + in the pg_ts_config entry, but the + token-to-dictionary mapping is defined by subsidiary entries in pg_ts_config_map. + + + + PostgreSQL's text search features are + described at length in . + + + + <structname>pg_ts_config</> Columns + + + + + Name + Type + References + Description + + + + + + cfgname + name + + Text search configuration name + + + + cfgnamespace + oid + pg_namespace.oid + + The OID of the namespace that contains this configuration + + + + + cfgowner + oid + pg_authid.oid + Owner of the configuration + + + + cfgparser + oid + pg_ts_parser.oid + The OID of the text search parser for this configuration + + + +
+ + + + + <structname>pg_ts_config_map</structname> + + + pg_ts_config_map + + + + The pg_ts_config_map catalog contains entries + showing which text search dictionaries should be consulted, and in + what order, for each output token type of each text search configuration's + parser. + + + + PostgreSQL's text search features are + described at length in . + + + + <structname>pg_ts_config_map</> Columns + + + + + Name + Type + References + Description + + + + + + mapcfg + oid + pg_ts_config.oid + The OID of the pg_ts_config entry owning this map entry + + + + maptokentype + integer + + A token type emitted by the configuration's parser + + + + mapseqno + integer + + Order in which to consult this entry (lower + mapseqnos first) + + + + mapdict + oid + pg_ts_dict.oid + The OID of the text search dictionary to consult + + + +
+ + + + + <structname>pg_ts_dict</structname> + + + pg_ts_dict + + + + The pg_ts_dict catalog contains entries + defining text search dictionaries. A dictionary depends on a text + search template, which specifies all the implementation functions + needed; the dictionary itself provides values for the user-settable + parameters supported by the template. This division of labor allows + dictionaries to be created by unprivileged users. The parameters + are specified by a text string dictinitoption, + whose format and meaning vary depending on the template. + + + + PostgreSQL's text search features are + described at length in . + + + + <structname>pg_ts_dict</> Columns + + + + + Name + Type + References + Description + + + + + + dictname + name + + Text search dictionary name + + + + dictnamespace + oid + pg_namespace.oid + + The OID of the namespace that contains this dictionary + + + + + dictowner + oid + pg_authid.oid + Owner of the dictionary + + + + dicttemplate + oid + pg_ts_template.oid + The OID of the text search template for this dictionary + + + + dictinitoption + text + + Initialization option string for the template + + + +
+ + + + + <structname>pg_ts_parser</structname> + + + pg_ts_parser + + + + The pg_ts_parser catalog contains entries + defining text search parsers. A parser is responsible for splitting + input text into lexemes and assigning a token type to each lexeme. + Since a parser must be implemented by C-language-level functions, + creation of new parsers is restricted to database superusers. + + + + PostgreSQL's text search features are + described at length in . + + + + <structname>pg_ts_parser</> Columns + + + + + Name + Type + References + Description + + + + + + prsname + name + + Text search parser name + + + + prsnamespace + oid + pg_namespace.oid + + The OID of the namespace that contains this parser + + + + + prsstart + regproc + pg_proc.oid + OID of the parser's startup function + + + + prstoken + regproc + pg_proc.oid + OID of the parser's next-token function + + + + prsend + regproc + pg_proc.oid + OID of the parser's shutdown function + + + + prsheadline + regproc + pg_proc.oid + OID of the parser's headline function + + + + prslextype + regproc + pg_proc.oid + OID of the parser's lextype function + + + +
+ + + + + <structname>pg_ts_template</structname> + + + pg_ts_template + + + + The pg_ts_template catalog contains entries + defining text search templates. A template is the implementation + skeleton for a class of text search dictionaries. + Since a template must be implemented by C-language-level functions, + creation of new templates is restricted to database superusers. + + + + PostgreSQL's text search features are + described at length in . + + + + <structname>pg_ts_template</> Columns + + + + + Name + Type + References + Description + + + + + + tmplname + name + + Text search template name + + + + tmplnamespace + oid + pg_namespace.oid + + The OID of the namespace that contains this template + + + + + tmplinit + regproc + pg_proc.oid + OID of the template's initialization function + + + + tmpllexize + regproc + pg_proc.oid + OID of the template's lexize function + + + +
+ + + <structname>pg_type</structname> -- 2.40.0