Versions Compared

Old Version 5

changes.mady.by.user Tim Donohue

Saved on

compared with

New Version 6

changes.mady.by.user Tim Donohue

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Cleanup & more details on indexing

...

Table of Contents
minLevel2
outlinetrue
stylenone

Browse Index Creation

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

Creating the Browse & Search Indexes

To create (or recreate) To create 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.

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="25ea68c181f67463-fda0cd96-4d274b92-add7b0f5-063e10a69b0262da21d4e204"><ac:plain-text-body><![CDATA[

Command used:

[dspace]/bin/dspace index-init

]]></ac:plain-text-body></ac:structured-macro>

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.

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.

Wiki Markup
*Complete Index Regeneration*. By running {{\[dspace\]/bin/dspace index-init}} you will completely regenerate your indexes, tearing down all oldexisting tables and reconstructing with the new configuration.

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

Updating the Indexes

Wiki Markup
*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

Destroy and Rebuild Browse Tables

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

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.

...

As one can see, the choices are limited only by your metadata schema, the metadata, and your imagination.

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

Search Index Customization

For information about configuring new Search Indexes, please refer to Configuring Lucene Search Indexes.