Versions Compared

Old Version 2

changes.mady.by.user Ivan Masár

Saved on

compared with

New Version Current

changes.mady.by.user Bram Luyten (Atmire)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

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 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

...

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.

Warning
titleKnown 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.

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.

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 using the Discovery maintenance script

Destroy and Rebuild Browse Tables

Warning

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. WARNING: This is not really recommended unless you know what you are doing.

At the CLI screen:

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

Indexing Customization

...

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 engine 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 within the Search Indexing process.

Search Index Customization

...