Provide some level of support for legacy install locations
[working/Evergreen.git] / docs / QueryParser_Changes.txt
1 QueryParser Changes
2
3 Quick notes for doc writers.
4
5 New columns:
6
7 config.metabib_class: Note: This gets a new config interface to expose this and other information. It intentionally has no buttons for adding or removing entries.
8   a_weight
9   b_weight
10   c_weight
11   d_weight
12
13 These are the FTS weights used for ranking for the four FTS weight classes. By default "A" is the exact match indexing and "C" is the stemmed version. They default to the PostgreSQL defaults that are used when otherwise unspecified.
14
15
16 New tables:
17
18 config.ts_config_list: Note: No editing interface exists for this, intentionally. It should be added to when DB-level FTS configs are added.
19   id - Actual DB level text search config name
20   name - Human readable description
21
22 This lists the valid FTS configs for use with the following two tables, with more human friendly names.
23
24 config.metabib_class_ts_map: Editable from the Server Admin menu
25   id - Primary key for editor benefit
26   field_class - Reference to config.metabib_class
27   ts_config - Which Text Search config to use
28   active - Is this config active. If false will not be used for searching or indexing.
29   index_weight - The FTS index weight to use for this FTS config. Should be A, B, C, or D, defaults to C.
30   index_lang - If set what language the record should be set to in order for this FTS config to be used for indexing
31   search_lang - If set what preferred language search should be using in order for this FTS config to be used for searching
32   always - If true use this config even when searching a specific field (author|personal, for example) even if that field has config as well
33
34 This maps broad search classes and text search configs. Multiple can exist for a given search class. Setting index_lang or search_lang to 'NONE' will effectively disable the config for that purpose as they check against a three character field like 'eng' or 'fre'.
35
36 config.metabib_field_ts_map: Editable from the Server Admin menu
37   id - Primary key for editor benefit
38   metabib_field - Reference to config.metabib_field
39   ts_config - Which Text Serach config to use
40   active - Is this config active. If false will not be used for searching or indexing.
41   index_weight - The FTS index weight to use for this FTS config. Should be A, B, C, or D, defaults to C.
42   index_lang - If set what language the record should be set to in order for this FTS config to be used for indexing
43   search_lang - If set what preferred language search should be using in order for this FTS config to be used for searching
44
45 This maps individual indexes and text search configs. Multiple can exist for a given index. Setting index_lang or search_lang to 'NONE' will effectively disable the config for that purpose as they check against a three character field like 'eng' or 'fre'. Note that anything from the broader configs will be used if none exist for the specified field and the "always" ones from the broader configs will be used even if field specific ones do exist.
46
47 New non-configuration tables exist for combined search indexes, but they are, IMO, more implementation details than things to be documented for end users.