Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: including details about the use of SOLR for the browse system

Table of Contents
minLevel2
outlinetrue
stylenone

Overview

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

  1. Traditional Browse & Search (via Lucene & Database indexes) - this is enabled by default
  2. Faceted/Filtered Browse & Search (via Solr & DSpace Discovery) - available for XMLUI only and 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 .

Creating the Browse & Search Indexes

...

Command used:

[dspace]/bin/dspace index-init

Java class:

org.dspace.browse.IndexBrowse

Arguments short and long forms):

Description

-r or -rebuild

Should we rebuild all the indexes, which removes old tables and creates new ones. For use with -f. Mutually exclusive with -d

-s or -start

-s <int> start from this index number and work upwards (mostly only useful for debugging). For use with -t and -f

-x or -execute

Execute all the remove and create SQL against the database. For use with -t and -f

-i or -index

Actually do the indexing. Mutually exclusive with -t and -f.

-o or -out

-o <filename> write the remove and create SQL to the given file. For use with -t and -f

-p or -print

Write the remove and create SQL to the stdout. For use with -t and -f.

-t or -tables

Create the tables only, do no attempt to index. Mutually exclusive with -f and -i

-f or -full

Make the tables, and do the indexing. This forces -x. Mutually exclusive with -f and -i.

-v or -verbose

Print extra information to the stdout. If used in conjunction with -p, you cannot use the stdout to generate your database structure.

-d or -delete

Delete all the indexes, but do not create new ones. For use with -f. This is mutually exclusive with -r.

-h or -help

Show this help documentation. Overrides all other arguments.

Warning

If you are using the SOLR Browse DAOs 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

...

Code Block
[dspace]/bin/dspace index-update
Warning

If you are using the SOLR Browse DAOs you don't need to run this script as the data are stored in the SOLR search core. You need to recreate the indexes usign the Discovery maintenance script

Destroy and Rebuild Browse Tables

...

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 3.0 a SOLR DAOs implementation of the browse system is provided. If you are using the SOLR DAOs you don't need to run the script described in this page but instead use the Discovery maintenance script. Browse indexing in SOLR is done withing the Search Indexing process.

 

Search Index Customization

...