Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Warning

Please note, that as of DSpace 4.0, the Solr-based Discovery search is on by the default in both JSPUI and XMLUI. This page describes the older Lucene-based search and DBMS browse indices. Neither the Lucene DBMS browse indices tables nor the Lucene search indices are used anymore (unless you explicitly disable SolrBrowseDAO and enable search artifacts).

Table of Contents
minLevel2
outlinetrue
stylenone

Overview

DSpace offers two options to index content for Browsing & Searching:

  1. Traditional Browse & Search Faceted/Filtered Search & Browse (via Lucene & Database indexesSolr & DSpace Discovery) - this is enabled by default since DSpace 4.0
  2. Traditional Faceted/Filtered Browse & Search (via Solr Lucene & DSpace DiscoveryDatabase tables) - this is disabled by default

This particular page only describes the "Traditional Browse & Search" indexing processes. For more information on Faceted/Filtered Browse & Search, please see DSpace Discovery, in particular Discovery Solr Index Maintenance .

Re-Enabling the legacy Lucene Search and/or DBMS Browse providers

Warning

TO BE COMPLETED

Creating the Browse & Search Indexes

To create (or recreate) all the various browse/search indexes that you define in the Configuration Section there are a variety of options available to you. You can see these options below in the command table.

...

Warning

If you are using the Solr Browse DAOs, that is the default since DSpace 4.0, it is not required to run this script as the data are stored in the Solr search core that need to be recreated using the Discovery maintenance script

 

Running the Indexing Programs

Complete Index Regeneration

Warning
titleRequires that you stop Tomcat first

Because this command actually deletes existing Browse Index tables, you must stop Tomcat (or your Servlet Container of choice) before executing index-init. After the indexing command completes, you can restart Tomcat.

...

Code Block
[dspace]/bin/dspace index-init

 

Updating the Indexes

By running [dspace]/bin/dspace index-update you will reindex your full browse & search indexes without modifying the DSpace table structure. (This should be your default approach if indexing, for example, via a cron job periodically). Because it does not "tear down" the existing tables, this command can be run while DSpace (and Tomcat or similar) is still running.

...

Warning

If you are using the Solr Browse DAOs, that is the default since DSpace 4.0, you don't need to run this script as the data are stored in the Solr search core. You need to recreate the indexes using the Discovery maintenance script

Destroy and Rebuild Browse Tables

Warning

This is really not recommended unless you know what you are doing.

...

Code Block
[dspace]/bin/dspace index -r -t -p -v -x -o myfile.sql

Indexing Customization

Browse Index Customization

DSpace provides robust browse indexing. It is possible to expand upon the default indexes delivered at the time of the installation. The System Administrator should review Browse Index Configuration to become familiar with the property keys and the definitions used therein before attempting heavy customizations.

...

Because Browse Indexes are stored in database tables, remember to run index-init after adding any new definitions in the dspace.cfg to have the indexes created and the data indexed.

Info

Since DSpace 34.0 a the Solr DAOs implementation of the browse engine is provided. If you are using the Solr DAOs used by default you don't need to run the script described in this page but instead at least if you have re-enabled the legacy DBMS provider. Instead use the Discovery maintenance script. Browse indexing in Solr is done within the Search Indexing process.

Search Index Customization

...

Warning

Please note, that as of DSpace 4.0, the Solr-based Discovery search is on by the default in both JSPUI and XMLUI. If you want customize the search behavior in a normal DSpace you should refer to the Discovery documentation.

You can find the documentation for configure the Search Indexes with the Legacy Lucene provider, at this page For information about configuring new Search Indexes, please refer to Configuring Lucene Search Indexes.