About Features Downloads Getting Started Documentation Events Support GitHub

Love VuFind®? Consider becoming a financial supporter. Your support helps build a better VuFind®!

Site Tools


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.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
Next revisionBoth sides next revision
development:architecture:solr_index_schema [2020/05/28 19:25] – [VuFind 7.0] demiankatzdevelopment:architecture:solr_index_schema [2023/10/26 11:48] demiankatz
Line 15: Line 15:
 |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 |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) |
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:plugins:record_drivers|record driver]] is loaded to render this record (:!: This field was named recordtype prior to VuFind 6.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 | |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 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   * 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   * 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 ===== ===== Dynamic Field Suffixes =====
Line 122: Line 125:
  
 ^ Field ^ Type ^ ^ Field ^ Type ^
 +|*_autocomplete |single-valued field for use by SolrPrefix autocomplete handler (added in VuFind 8.0) |
 |*_date |single date | |*_date |single date |
 |*_date_mv |multiValued date | |*_date_mv |multiValued date |
Line 142: Line 146:
  
 ===== Changelog ===== ===== Changelog =====
 +
 +==== 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="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 ==== ==== VuFind 7.0 ====
Line 218: Line 241:
  
 ---- struct data ---- ---- struct data ----
 +properties.Page Owner : 
 ---- ----
  
development/architecture/solr_index_schema.txt · Last modified: 2023/11/10 20:30 by demiankatz