| F.60. shared_ispell — a shared ispell dictionary | ||||
|---|---|---|---|---|
| Prev | Up | Appendix F. Additional Supplied Modules and Extensions Shipped inpostgrespro-std-17-contrib | Home | Next |
F.60. shared_ispell — a shared ispell dictionary#
Theshared_ispell module provides a shared ispell dictionary, i.e. a dictionary that's stored in shared segment. The traditional ispell implementation means that each session initializes and stores the dictionary on it's own, which means a lot of CPU/RAM is wasted.
This extension allocates an area in shared segment (you have to choose the size in advance) and then loads the dictionary into it when it's used for the first time.
F.60.1. Functions#
The functions provided by theshared_ispell module are shown inTable F.40.
Table F.40. shared_ispell Functions
F.60.2. GUC Parameters#
shared_ispell.max_size(int)#Defines the maximum size of the shared segment. This is a hard limit, the shared segment is not extensible and you need to set it so that all the dictionaries fit into it and not much memory is wasted.
F.60.3. Using the dictionary#
The module needs to allocate space in the shared memory segment. So add this to the config file (or update the current values):
# libraries to loadshared_preload_libraries = 'shared_ispell'# config of the shared memoryshared_ispell.max_size = 32MB
To find out how much memory you actually need, use a large value (e.g. 200MB) and load all the dictionaries you want to use. Then use theshared_ispell_mem_used() function to find out how much memory was actually used (and set theshared_ispell.max_size GUC variable accordingly).
Don't set it exactly to that value, leave there some free space, so that you can reload the dictionaries without changing the GUC max_size limit (which requires a restart of the DB). Something like 512kB should be just fine.
The extension defines ashared_ispell template that you may use to define custom dictionaries. E.g. you may do this:
CREATE TEXT SEARCH DICTIONARY english_shared ( TEMPLATE = shared_ispell, DictFile = en_us, AffFile = en_us, StopWords = english);CREATE TEXT SEARCH CONFIGURATION public.english_shared ( COPY = pg_catalog.simple );ALTER TEXT SEARCH CONFIGURATION english_shared ALTER MAPPING FOR asciiword, asciihword, hword_asciipart, word, hword, hword_part WITH english_shared, english_stem;
We can test created configuration:
SELECT * FROM ts_debug('english_shared', 'abilities'); alias | description | token | dictionaries | dictionary | lexemes -----------+-----------------+-----------+-------------------------------+----------------+----------- asciiword | Word, all ASCII | abilities | {english_shared,english_stem} | english_shared | {ability}(1 row) Or you can update your own text search configuration. For example, you have thepublic.english dictionary. You can update it to use theshared_ispell template:
ALTER TEXT SEARCH CONFIGURATION public.english ALTER MAPPING FOR asciiword, asciihword, hword_asciipart, word, hword, hword_part WITH english_shared, english_stem;
F.60.4. Author#
Tomas Vondra<tomas.vondra@2ndquadrant.com>, Prague, Czech Republic