Differences

This shows you the differences between two versions of the page.

--- development:architecture:solr_index_schema [2020/05/28 19:27] – [Static Fields] demiankatz
+++ development:architecture:solr_index_schema [2023/11/10 20:30] (current) – [VuFind® 10.0] demiankatz
@@ Line 1: / Line 1: @@
 ====== 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 =====
@@ Line 9: / Line 9: @@
 |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 |
-|author |textProper |the primary authors of the work (single-valued until VuFind 3.0, when it was made multi-valued) |
+|author |textProper |the primary authors of the work (single-valued until VuFind® 3.0, when it was made multi-valued) |
 |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; used for [[indexing:alphabetical_heading_browse|Alphabetical Heading Browse]] |
-|author_corporate |textProper |corporate authors of the work (introduced in VuFind 3.0) |
+|author_corporate |textProper |corporate authors of the work (introduced in VuFind® 3.0) |
-|author_corporate_role |string |same as author_role, but for author_corporate (introduced in VuFind 3.0) |
+|author_corporate_role |string |same as author_role, but for author_corporate (introduced in VuFind® 3.0) |
-|author_facet |textFacet |author names for use in faceting; copyfielded from author, author2 and author_corporate (introduced in VuFind 3.0 to replace authorStr) |
+|author_facet |textFacet |author names for use in faceting; copyfielded from author, author2 and author_corporate (introduced in VuFind® 3.0 to replace authorStr) |
-|author_fuller |textProper |fuller form of primary authors name(s); used for searching and relevance but not displayed. This became multi-valued in VuFind 3.0; it was single-valued prior to that. |
+|author_fuller |textProper |fuller form of primary authors name(s); used for searching and relevance but not displayed. This became multi-valued in VuFind® 3.0; it was single-valued prior to that. :!: Deprecated as of VuFind® 8.0 and removed in VuFind® 9.0 |
-|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 3.0) |
+|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® 3.0) |
-|author_sort |string |the author name to use for sorting (introduced in VuFind 3.0 to replace authorStr) |
+|author_sort |string |the author name to use for sorting (introduced in VuFind® 3.0 to replace authorStr) |
-|author_variant |text |contains variant forms of the name(s) found in author (introduced in VuFind 3.0) |
+|author_variant |text |contains variant forms of the name(s) found in author (introduced in VuFind® 3.0) |
 |author2 |textProper |secondary authors of the work |
-|author2_fuller |textProper |same as author_fuller, but for author2 field (introduced in VuFind 3.0) |
+|author2_fuller |textProper |same as author_fuller, but for author2 field (introduced in VuFind® 3.0) :!: Deprecated as of VuFind® 8.0 and removed in VuFind® 9.0 |
-|author2_role |string |same as author_role, but for the author2 field (introduced in VuFind 3.0; replaces the previously-unused author2-role) |
+|author2_role |string |same as author_role, but for the author2 field (introduced in VuFind® 3.0; replaces the previously-unused author2-role) |
-|author2_variant |text |same as author_variant, but for the author2 field (introduced in VuFind 3.0) |
+|author2_variant |text |same as author_variant, but for the author2 field (introduced in VuFind® 3.0) |
 |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's meaning (broader than callnumber-subject); used for browse and facet functionality |
@@ 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 |
 |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-ones |string |The Dewey number at ones-level precision (used for faceting) |
@@ Line 52: / Line 52: @@
 |first_indexed |date |see [[indexing:tracking_record_changes|Tracking Record Changes]] |
 |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 VuFind; not intended to be searchable |
+|fullrecord |string |contains raw metadata (usually MARC) for use within VuFind®; not intended to be searchable |
 |fulltext |text |contains full text associated with the record; used for searching |
 |fulltext_unstemmed |textProper |copyFielded from fulltext; used for relevance ranking |
@@ Line 86: / Line 86: @@
 |publisher |textProper |name of publisher(s) |
 |publisherStr |string |copyFielded from publisher; unused by default but could be used for faceting |
-|record_format |string |used to control which [[development:plugins:record_drivers|record driver]] is loaded to render this record (:!: This field was named recordtype prior to VuFind 6.0; in VuFind 6.x, you can use the recordtype and record_format fields interchangeably, but the deprecated recordtype field was completely removed in VuFind 7.0) |
+|record_format |string |used to control which [[development:plugins:record_drivers|record driver]] is loaded to render this record (:!: This field was named recordtype prior to VuFind® 6.0; in VuFind® 6.x, you can use the recordtype and record_format fields interchangeably, but the deprecated recordtype field was completely removed in VuFind® 7.0) |
 |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) |
@@ Line 112: / Line 112: @@
 ===== Recommended Dynamic Fields =====
-VuFind looks for values in one dynamic field that is not explicitly specified in the schema; more may be adopted in the future.
+VuFind® looks for values in some dynamic fields that are not explicitly specified in the schema; more may be adopted in the future.
   * doi_str_mv - [[https://en.wikipedia.org/wiki/Digital_object_identifier|DOI]](s) for the record
+  * hierarchy_all_parents_str_mv - can be populated to allow "deep searching" of collections; see [[indexing:hierarchies_and_collections|Hierarchies and Collections]] for details.
+  * previous_id_str_mv - the Solr [[development:plugins:fallback_record_loaders|fallback record loader]] can be configured to use this field (or any other field) as a backup source of record IDs; this functionality is disabled by default and was introduced in VuFind® 8.1.
   * 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.
 ===== 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 ^
+|*_autocomplete |single-valued field for use by SolrPrefix autocomplete handler (added in VuFind® 8.0) |
 |*_date |single date |
 |*_date_mv |multiValued date |
@@ Line 143: / Line 147: @@
 ===== Changelog =====
-==== VuFind 7.0 ====
+==== VuFind® 10.0 ====
+Support was added for the optional hierarchy_all_parents_str_mv dynamic field.
+The url field was changed to be ''indexed="true"'' so that its contents can be searched.
+==== VuFind® 9.0 ====
+The author_fuller and author2_fuller fields were removed.
+The author and author_variant fields have had storeOffsetsWithPositions="true" added, to fix a highlighting problem introduced by Solr 9 (highlighting fails if termVectors is true and storeOffsetsWithPositions is not true).
+==== VuFind® 8.1 ====
+Support was added for the previous_id_str_mv and uuid_str_mv dynamic fields.
+==== VuFind® 8.0 ====
+The author_fuller and author2_fuller fields were deprecated, and MARC indexing for author and author2 was adjusted to include subfield q (see [[https://github.com/vufind-org/vufind/pull/1782|pull request #1782]]).
+The *_autocomplete dynamic field suffix was added to support the new SolrPrefix autocomplete handler.
+==== VuFind® 7.0 ====
 The deprecated recordtype field was completely removed; record_format MUST be used instead starting with this release.
-==== VuFind 6.0 ====
+==== VuFind® 6.0 ====
 The recordtype field was renamed to record_format (and is now indexed as well as stored, to facilitate format-based filtering).
-==== VuFind 4.0 ====
+==== VuFind® 4.0 ====
 The author_facet field is now stored as well as indexed for consistency with other facet fields.
@@ Line 162: / Line 186: @@
   * Added *_geo_mv
-==== VuFind 3.1 ====
+==== VuFind® 3.1 ====
 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 3.0 ====
+==== VuFind® 3.0 ====
 These fields were removed:
@@ Line 197: / Line 221: @@
   * hierarchy_browse was changed from type TextFacetRaw to type string (the TextFacetRaw field type was unnecessary and has been removed).
-==== VuFind 2.4 ====
+==== VuFind® 2.4 ====
 This release simplified and improved call number handling.
@@ Line 204: / Line 228: @@
 ^ 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-first-code |string |never used |
@@ Line 215: / Line 239: @@
   * callnumber-sort
   * dewey-search
 ---- struct data ----
+properties.Page Owner :
 ----