All Versions
- DSpace 7.x (Current Release)
- DSpace 8.x (Unreleased)
- DSpace 6.x (EOL)
- DSpace 5.x (EOL)
- More Versions...
Old Release
This documentation relates to an old version of DSpace, version 4.x. Looking for another version? See all documentation.
This DSpace release is end-of-life and is no longer supported.
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 DBMS browse tables nor the Lucene search indices are used anymore (unless you explicitly disable SolrBrowseDAO and enable search artifacts).
DSpace offers two options to index content for Browsing & Searching:
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 .
TO BE COMPLETED
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.
Command used: |
|
Java class: | org.dspace.browse.IndexBrowse |
Arguments short and long forms): | Description |
| Should we rebuild all the indexes, which removes old tables and creates new ones. For use with |
|
|
| Execute all the remove and create SQL against the database. For use with |
| Actually do the indexing. Mutually exclusive with |
|
|
| Write the remove and create SQL to the stdout. For use with |
| Create the tables only, do no attempt to index. Mutually exclusive with |
| Make the tables, and do the indexing. This forces |
| Print extra information to the stdout. If used in conjunction with |
| Delete all the indexes, but do not create new ones. For use with |
| Show this help documentation. Overrides all other arguments. |
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
Requires 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.
Known Oracle Issues
In many Oracle based DSpace installations, index-init often malfunctions because of Oracle specific permissions. It is therefore advised to stick to index-update instead
By running [dspace]/bin/dspace index-init
you will completely regenerate your indexes, tearing down all existing tables and reconstructing with the new configuration.
[dspace]/bin/dspace index-init
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.
[dspace]/bin/dspace index-update
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
This is really not recommended unless you know what you are doing.
You can destroy and rebuild the database, but do not do the indexing. Output the SQL to do this to the screen and a file, as well as executing it against the database, while being verbose.
At the CLI screen:
[dspace]/bin/dspace index -r -t -p -v -x -o myfile.sql
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.
Through customization is is possible to:
Examples of new browse indexes that are possible. (The system administrator is reminded to read the section on Browse Index Configuration )
webui.browse.index.6 = series:metadata:dc.relation.ispartofseries:text:single
webui.browse.index.3 = title:metadata:dc.title,dc:title.uniform,dc:relation.ispartofseries:title:full
webui.browse.index.7 = lcsubject.metdata:dc.subject.lcsh.text:single
As one can see, the choices are limited only by your metadata schema, the metadata, and your imagination.
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.
Since DSpace 4.0 the Solr DAOs implementation of the browse engine is used by default you don't need to run the script described in this page 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.
You can find the documentation for configure the Search Indexes with the Legacy Lucene provider, at this page Configuring Lucene Search Indexes.