All Versions
- DSpace 7.x (Current Release)
- DSpace 8.x (Unreleased)
- DSpace 6.x (EOL)
- DSpace 5.x (EOL)
- More Versions...
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 DBMS browse tables nor the Lucene search indices are used anymore (unless you explicitly disable SolrBrowseDAO and enable search artifacts). This page was previously called ReIndexing Content with the old legacy providers (DBMS for Browse or Lucene for Search) |
Table of Contents | ||||||
---|---|---|---|---|---|---|
|
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 .
Warning |
---|
TO BE COMPLETED TODO: also add the DB-backed itemcounter here (?) |
...
Code Block |
---|
browseDAO.class = org.dspace.browse.BrowseDAOPostgres browseCreateDAO.class = org.dspace.browse.BrowseCreateDAOPostgres |
This option enables the browse engine to store its indexes in Oracle database tables. All browsing is then performed via queries to those database tables. This is the traditional browsing option for users of Oracle. The configuration is as follows:
Code Block |
---|
browseDAO.class = org.dspace.browse.BrowseDAOOracle browseCreateDAO.class = org.dspace.browse.BrowseCreateDAOOracle |
To create (or recreate) all the various browse/search indexes that you define as described in this page 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. |
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 |
Warning | ||
---|---|---|
| ||
Because this command actually deletes existing Browse Index tables, you must stop Tomcat (or your Servlet Container of choice) before executing |
Warning | ||
---|---|---|
| ||
In many Oracle based DSpace installations, index-lucene-init often malfunctions because of Oracle specific permissions. It is therefore advised to stick to index-lucene-update instead |
By running [dspace]/bin/dspace index-lucene-init
you will completely regenerate your indexes, tearing down all existing tables and reconstructing with the new configuration.
Code Block |
---|
[dspace]/bin/dspace index-lucene-init |
By running [dspace]/bin/dspace index-lucene-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.
Code Block |
---|
[dspace]/bin/dspace index-lucene-update |
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 |
Warning |
---|
This is really not recommended unless you know what you are doing. |
...
Code Block |
---|
[dspace]/bin/dspace index-db-browse -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.
...
Because Browse Indexes are stored in database tables, remember to run index-lucene-init
after adding any new definitions in the dspace.cfg
to have the indexes created and the data indexed.
Info |
---|
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. |
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. |
Search indexes can be configured and customized easily in the dspace.cfg file. This allows institutions to choose which DSpace metadata fields are indexed by Lucene.
Property: |
|
Example Value: |
|
Informational Note: | Where to put the search index files |
Property: |
|
Example Value: |
|
Informational Note: | By setting higher values of search.max-clauses will enable prefix searches to work on larger repositories. |
Property: |
|
Example Value: |
|
Informational Note: | It is possible to create a 'delayed index flusher'. If a web application pushes multiple search requests (i.e. a barrage or sword deposits, or multiple quick edits in the user interface), then this will combine them into a single index update. You set the property key to the number of milliseconds to wait for an update. The example value will hold a Lucene update in a queue for up to 5 seconds. After 5 seconds all waiting updates will be written to the Lucene index. |
Property: |
|
Example Value: |
|
Informational Note: | Which Lucene Analyzer implementation to use. If this is omitted or commented out, the standard DSpace analyzer (designed for English) is used by default. This standard DSpace analyzer removes common stopwords, lowercases all words and performs stemming (removing common word endings, like "ing", "s", etc). |
Property: |
|
Example Value: |
|
Informational Note: | Instead of the standard DSpace Analyzer (DSAnalyzer), use an analyzer which doesn't "stem" words/terms. When using this analyzer, a search for "wellness" will always return items matching "wellness" and not "well". However, similarly a search for "experiments" will only return objects matching "experiments" and not "experiment" or "experimenting". When using this analyzer, you may still use WildCard searches like "experiment*" to match the beginning of words. |
Property: |
|
Example Value: |
|
Informational Note: | Instead of the standard English analyzer, the Chinese analyzer is used. |
Property: |
|
Example Value: |
|
Informational Note | Boolean search operator to use. The currently supported values are OR and AND. If this configuration item is missing or commented out, OR is used. AND requires all the search terms to be present. OR requires one or more search terms to be present. |
Property: |
|
Example Value: |
|
Informational Note: | This is the maximum number of terms indexed for a single field in Lucene. The default is 10,000 words‚ often not enough for full-text indexing. If you change this, you will need to re-index for the change to take effect on previously added items. -1 = unlimited (Integer.MAG_VALUE) |
Property: |
|
Example Value: |
|
Informational Note | This property determines which of the metadata fields are being indexed for search. As an example, if you do not include the title field here, searching for a word in the title will not be matched with the titles of your items.. |
...
After changing the configuration run /[dspace]/bin/dspace index-lucene-init
to regenerate the indexes.
...
Although DSIndexer automatically builds a separate index for the authority keys of any index that contains authority-controlled metadata fields, the "Advanced Search" UIs does do not allow direct access to it. Perhaps it will be added in the future. Fortunately, the OpenSearch API lets you submit a query directly to the Lucene search engine, and this may include the authority-controlled indexes.
As the previous configuration apply only to the indexing and querying phase one will need to customize the user interface to reflect the changes, for example, to add the a new search category to the Advanced Search.
XML UI requires manual coding of the involved templates instead the JSP UI provides specific configuration to set the index to show in the advanced search dropdown. Below are listed the configuration parameters
Property: |
|
Example Value | jspui.search.index.display.1 = ANY |
Informational Note: | Set the N-value of the index dropdown in the advanced search form. The value must match one of the defined index |