Warning: This page has not been updated in over over a year and may be outdated or deprecated.
development:architecture:solr_index_schema
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
development:architecture:solr_index_schema [2022/02/10 13:04] – [VuFind 8.1] demiankatz | development:architecture:solr_index_schema [2023/10/26 11:50] – demiankatz | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== Solr Index Schema ====== | ====== Solr Index Schema ====== | ||
- | This is a list of Solr fields defined by VuFind. | + | This is a list of Solr fields defined by VuFind®. |
===== Static Fields ===== | ===== Static Fields ===== | ||
Line 9: | Line 9: | ||
|allfields |text |contains all searchable text from the record, useful as a catch-all in searching | | |allfields |text |contains all searchable text from the record, useful as a catch-all in searching | | ||
|allfields_unstemmed |textProper |copyFielded from allfields; used for relevance ranking | | |allfields_unstemmed |textProper |copyFielded from allfields; used for relevance ranking | | ||
- | |author |textProper |the primary authors of the work (single-valued until VuFind | + | |author |textProper |the primary authors of the work (single-valued until VuFind® |
|author_additional |textProper |authors from the table of contents; used for searching but not displayed | | |author_additional |textProper |authors from the table of contents; used for searching but not displayed | | ||
|author_browse |string |copyFielded from author, author2 and author_corporate; | |author_browse |string |copyFielded from author, author2 and author_corporate; | ||
- | |author_corporate |textProper |corporate authors of the work (introduced in VuFind | + | |author_corporate |textProper |corporate authors of the work (introduced in VuFind® |
- | |author_corporate_role |string |same as author_role, | + | |author_corporate_role |string |same as author_role, |
- | |author_facet |textFacet |author names for use in faceting; copyfielded from author, author2 and author_corporate (introduced in VuFind | + | |author_facet |textFacet |author names for use in faceting; copyfielded from author, author2 and author_corporate (introduced in VuFind® |
- | |author_fuller |textProper |fuller form of primary authors name(s); used for searching and relevance but not displayed. This became multi-valued in VuFind | + | |author_fuller |textProper |fuller form of primary authors name(s); used for searching and relevance but not displayed. This became multi-valued in VuFind® |
- | |author_role |string |the roles of the primary authors of the work, generally indexed as relator codes which are translated at display time. Optional, but if populated, values should share the same order as the author element. (introduced in VuFind | + | |author_role |string |the roles of the primary authors of the work, generally indexed as relator codes which are translated at display time. Optional, but if populated, values should share the same order as the author element. (introduced in VuFind® |
- | |author_sort |string |the author name to use for sorting (introduced in VuFind | + | |author_sort |string |the author name to use for sorting (introduced in VuFind® |
- | |author_variant |text |contains variant forms of the name(s) found in author (introduced in VuFind | + | |author_variant |text |contains variant forms of the name(s) found in author (introduced in VuFind® |
|author2 |textProper |secondary authors of the work | | |author2 |textProper |secondary authors of the work | | ||
- | |author2_fuller |textProper |same as author_fuller, | + | |author2_fuller |textProper |same as author_fuller, |
- | |author2_role |string |same as author_role, | + | |author2_role |string |same as author_role, |
- | |author2_variant |text |same as author_variant, | + | |author2_variant |text |same as author_variant, |
|building |string |the building containing the item represented by the record (used for faceting) | | |building |string |the building containing the item represented by the record (used for faceting) | | ||
|callnumber-first |string |a human-readable form of the broad LC call number' | |callnumber-first |string |a human-readable form of the broad LC call number' | ||
Line 40: | Line 40: | ||
|dateSpan |string |date coverage for a record which spans a period of time (i.e. a journal -- see MARC 362a); used for display | | |dateSpan |string |date coverage for a record which spans a period of time (i.e. a journal -- see MARC 362a); used for display | | ||
|description |text |descriptive summary of the item (used for display) | | |description |text |descriptive summary of the item (used for display) | | ||
- | |dewey-full |string |Dewey call numbers normalized for compatibility with VuFind's call number search | | + | |dewey-full |string |Dewey call numbers normalized for compatibility with VuFind®'s call number search | |
|dewey-hundreds |string |The Dewey number at hundreds-level precision (used for faceting) | | |dewey-hundreds |string |The Dewey number at hundreds-level precision (used for faceting) | | ||
|dewey-ones |string |The Dewey number at ones-level precision (used for faceting) | | |dewey-ones |string |The Dewey number at ones-level precision (used for faceting) | | ||
Line 52: | Line 52: | ||
|first_indexed |date |see [[indexing: | |first_indexed |date |see [[indexing: | ||
|format |string |describes the format (book, DVD, etc.) of the record for display and faceting; copyFielded to allfields and allfields_unstemmed for searching | | |format |string |describes the format (book, DVD, etc.) of the record for display and faceting; copyFielded to allfields and allfields_unstemmed for searching | | ||
- | |fullrecord |string |contains raw metadata (usually MARC) for use within | + | |fullrecord |string |contains raw metadata (usually MARC) for use within |
|fulltext |text |contains full text associated with the record; used for searching | | |fulltext |text |contains full text associated with the record; used for searching | | ||
|fulltext_unstemmed |textProper |copyFielded from fulltext; used for relevance ranking | | |fulltext_unstemmed |textProper |copyFielded from fulltext; used for relevance ranking | | ||
Line 86: | Line 86: | ||
|publisher |textProper |name of publisher(s) | | |publisher |textProper |name of publisher(s) | | ||
|publisherStr |string |copyFielded from publisher; unused by default but could be used for faceting | | |publisherStr |string |copyFielded from publisher; unused by default but could be used for faceting | | ||
- | |record_format |string |used to control which [[development: | + | |record_format |string |used to control which [[development: |
|series |text |series title(s); used for search and display | | |series |text |series title(s); used for search and display | | ||
|series2 |text |secondary series title(s); used for search, but only displayed when series is empty (possible candidate for future deprecation) | | |series2 |text |secondary series title(s); used for search, but only displayed when series is empty (possible candidate for future deprecation) | | ||
Line 112: | Line 112: | ||
===== Recommended Dynamic Fields ===== | ===== Recommended Dynamic Fields ===== | ||
- | VuFind | + | VuFind® |
* doi_str_mv - [[https:// | * doi_str_mv - [[https:// | ||
- | * previous_id_str_mv - the Solr [[development: | + | |
+ | | ||
* upc_str_mv - UPC code(s) for the record | * upc_str_mv - UPC code(s) for the record | ||
* uuid_str_mv - UUIDs (Universally unique identifiers) for the record. These are commonly used in, for example, digital library or repository systems and can be a useful match point with third party systems. | * uuid_str_mv - UUIDs (Universally unique identifiers) for the record. These are commonly used in, for example, digital library or repository systems and can be a useful match point with third party systems. | ||
Line 121: | Line 122: | ||
===== Dynamic Field Suffixes ===== | ===== Dynamic Field Suffixes ===== | ||
- | All of VuFind's dynamic fields are configured to be both stored and indexed (to avoid proliferation of confusing suffixes). Each suffix represents a particular field type (detailed below) and may be multiValued if given the _mv suffix. | + | All of VuFind®'s dynamic fields are configured to be both stored and indexed (to avoid proliferation of confusing suffixes). Each suffix represents a particular field type (detailed below) and may be multiValued if given the _mv suffix. |
^ Field ^ Type ^ | ^ Field ^ Type ^ | ||
- | |*_autocomplete |single-valued field for use by SolrPrefix autocomplete handler (added in VuFind | + | |*_autocomplete |single-valued field for use by SolrPrefix autocomplete handler (added in VuFind® |
|*_date |single date | | |*_date |single date | | ||
|*_date_mv |multiValued date | | |*_date_mv |multiValued date | | ||
Line 146: | Line 147: | ||
===== Changelog ===== | ===== Changelog ===== | ||
- | ==== VuFind | + | ==== VuFind® 10.0 ==== |
+ | |||
+ | Support was added for the optional hierarchy_all_parents_str_mv dynamic field. | ||
+ | |||
+ | ==== VuFind® 9.0 ==== | ||
+ | |||
+ | The author_fuller and author2_fuller fields were removed. | ||
+ | |||
+ | The author and author_variant fields have had storeOffsetsWithPositions=" | ||
+ | |||
+ | ==== VuFind® | ||
Support was added for the previous_id_str_mv and uuid_str_mv dynamic fields. | Support was added for the previous_id_str_mv and uuid_str_mv dynamic fields. | ||
- | ==== VuFind | + | ==== VuFind® |
The author_fuller and author2_fuller fields were deprecated, and MARC indexing for author and author2 was adjusted to include subfield q (see [[https:// | The author_fuller and author2_fuller fields were deprecated, and MARC indexing for author and author2 was adjusted to include subfield q (see [[https:// | ||
Line 155: | Line 166: | ||
The *_autocomplete dynamic field suffix was added to support the new SolrPrefix autocomplete handler. | The *_autocomplete dynamic field suffix was added to support the new SolrPrefix autocomplete handler. | ||
- | ==== VuFind | + | ==== VuFind® |
The deprecated recordtype field was completely removed; record_format MUST be used instead starting with this release. | The deprecated recordtype field was completely removed; record_format MUST be used instead starting with this release. | ||
- | ==== VuFind | + | ==== VuFind® |
The recordtype field was renamed to record_format (and is now indexed as well as stored, to facilitate format-based filtering). | The recordtype field was renamed to record_format (and is now indexed as well as stored, to facilitate format-based filtering). | ||
- | ==== VuFind | + | ==== VuFind® |
The author_facet field is now stored as well as indexed for consistency with other facet fields. | The author_facet field is now stored as well as indexed for consistency with other facet fields. | ||
Line 174: | Line 185: | ||
* Added *_geo_mv | * Added *_geo_mv | ||
- | ==== VuFind | + | ==== VuFind® |
Added the geo field type, the *_geo dynamic field suffix, and the long_lat_display / long_lat_label fields. Made long_lat multi-valued. | Added the geo field type, the *_geo dynamic field suffix, and the long_lat_display / long_lat_label fields. Made long_lat multi-valued. | ||
- | ==== VuFind | + | ==== VuFind® |
These fields were removed: | These fields were removed: | ||
Line 209: | Line 220: | ||
* hierarchy_browse was changed from type TextFacetRaw to type string (the TextFacetRaw field type was unnecessary and has been removed). | * hierarchy_browse was changed from type TextFacetRaw to type string (the TextFacetRaw field type was unnecessary and has been removed). | ||
- | ==== VuFind | + | ==== VuFind® |
This release simplified and improved call number handling. | This release simplified and improved call number handling. | ||
Line 216: | Line 227: | ||
^ Field ^ Type ^ Description ^ | ^ Field ^ Type ^ Description ^ | ||
- | |callnumber |string |LC call numbers normalized for compatibility with VuFind's call number search | | + | |callnumber |string |LC call numbers normalized for compatibility with VuFind®'s call number search | |
|callnumber-a |string |the first portion of the LC call number; used for display and browse | | |callnumber-a |string |the first portion of the LC call number; used for display and browse | | ||
|callnumber-first-code |string |never used | | |callnumber-first-code |string |never used | | ||
Line 227: | Line 238: | ||
* callnumber-sort | * callnumber-sort | ||
* dewey-search | * dewey-search | ||
- | |||
---- struct data ---- | ---- struct data ---- | ||
+ | properties.Page Owner : | ||
---- | ---- | ||
development/architecture/solr_index_schema.txt · Last modified: 2023/11/10 20:30 by demiankatz