pgadmin4/docs/en_US/fts_parser_dialog.rst

43 lines
2.4 KiB
ReStructuredText
Raw Normal View History

2016-05-20 20:39:21 +00:00
*****************
FTS Parser Dialog
*****************
2016-05-13 13:43:57 +00:00
2016-05-20 20:39:21 +00:00
Use the *FTS Parser* dialog to create 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. The *FTS Parser* dialog allows you to implement options of the CREATE TEXT SEARCH PARSER command. For more information about the CREATE TEXT SEARCH PARSER command, see PostgreSQL core documentation available at:
2016-05-13 13:43:57 +00:00
http://www.postgresql.org/docs/9.5/static/sql-createtsparser.html
2016-05-20 20:39:21 +00:00
The *FTS Parser* dialog organizes the development of a text search parser through the following dialog tabs: *General*, and *Definition*. The *SQL* tab displays the SQL code generated by dialog selections.
2016-05-13 13:43:57 +00:00
Click the *General* tab to begin.
2016-05-20 20:39:21 +00:00
.. image:: images/fts_parser_general.png
2016-05-13 13:43:57 +00:00
Use the fields in the *General* tab to identify a text search parser:
* Use the *Name* field to add a descriptive name for the parser. The name will be displayed in the *pgAdmin* tree control.
* Select the name of the schema in which the parser will reside from the drop-down listbox in the *Schema* field.
* Store notes about the domain in the *Comments* field.
Click the *Definition* tab to continue.
2016-05-20 20:39:21 +00:00
.. image:: images/fts_parser_definition.png
2016-05-13 13:43:57 +00:00
Use the fields in the *Definition* tab to define parameters:
* Use the drop-down listbox next to *Start function* to select the name of the start function for the parser.
* Use the drop-down listbox next to *Get next token function* to select the name of the get-next-token function for the parser.
* Use the drop-down listbox next to *End function* to select the name of the end function for the parser.
* Use the drop-down listbox next to *Lextypes function* to select the name of the lextypes function for the parser (a function that returns information about the set of token types it produces).
* Use the drop-down listbox next to *Headline function* to select the name of the headline function for the parser (a function that summarizes a set of tokens).
Click the *SQL* tab to continue.
2016-05-20 20:39:21 +00:00
.. image:: images/fts_parser_sql.png
2016-05-13 13:43:57 +00:00
2016-05-20 20:39:21 +00:00
Your entries in the *Extension* dialog generate a generate a SQL command; you can review the command on the *SQL* pane.
2016-05-13 13:43:57 +00:00
* Click the *Info* button (i) to access online help.
* Click the *Save* button to save work.
* Click the *Cancel* button to exit without saving work.
* Click the *Reset* button to restore configuration parameters.