Difference between revisions of "Lucene indexes creation"

From BioUML platform
Jump to: navigation, search
(Created page with "'''Lucene indexes''' are necessary for Lucene search to work. Indexes are created for each database separately in <code>databases</code> collection and stored inside <code...")
 
(Indexes in BioUML server)
 
(5 intermediate revisions by one user not shown)
Line 2: Line 2:
  
 
__TOC__
 
__TOC__
 
 
=== Indexes in BioUML workbench ===
 
=== Indexes in BioUML workbench ===
 
In [[BioUML workbench]] indexes are created automatically when you try to search the corresponding database:
 
In [[BioUML workbench]] indexes are created automatically when you try to search the corresponding database:
Line 15: Line 14:
  
 
=== Indexes in BioUML server ===
 
=== Indexes in BioUML server ===
To create indexes in [[BioUML server]] you have to use separate helper application which can be launched using <code>rebuild_indexes.sh</code> (on Unix) or <code>rebuild_indexes.bat</code> (on Windows) script. Place this script into <code>$SERVER_PATH</code> folder (see [[BioUML server installation]]).
+
Indexes on BioUML server can be created using administrative analysis [[Rebuild search indexes (analysis)|Rebuild search indexes]].
 
+
This application reads the configuration from <code>rebuild_indexes.properties</code> file, so you have to create one. It contains several rows in <code>key=value</code> manner. The following keys are defined:
+
 
+
;user
+
:user name (e-mail of the user to log in to BioUML server during indexes creation). This user must be a [[server administrator]] for the current server.
+
;pass
+
:password for the specified user
+
;database
+
:semicolon-separated list of databases to reindex
+
;folder
+
:name of indexes folder. Must be <code>luceneIndex</code>
+
 
+
An example of <code>rebuild_indexes.properties</code> file is shown below.
+
 
+
user=administrator@myserver.example.com
+
pass=secretAdministratorPassword
+
database=Ensembl;GO;Reactome
+
folder=luceneIndex
+
 
+
After this file is created, launch rebuild_indexes script and it will try to create the missing indexes. It's desired to shutdown the BioUML server for the indexes creation procedure.
+
  
 
=== Recreating indexes after the database update ===
 
=== Recreating indexes after the database update ===
 
When you update the database indexes will become obsolete. The easiest way to update them is to terminate BioUML, remove <code>luceneIndexes</code> subfolder and recreate the indexes using the procedure above.
 
When you update the database indexes will become obsolete. The easiest way to update them is to terminate BioUML, remove <code>luceneIndexes</code> subfolder and recreate the indexes using the procedure above.
 +
 +
=== See also ===
 +
* [[Databases installation]]
  
 
[[Category:Installation]]
 
[[Category:Installation]]

Latest revision as of 16:47, 11 December 2014

Lucene indexes are necessary for Lucene search to work. Indexes are created for each database separately in databases collection and stored inside luceneIndexes subfolder of database folder on the disk.

Contents

[edit] Indexes in BioUML workbench

In BioUML workbench indexes are created automatically when you try to search the corresponding database:

Lucene indexes creation workbench.png

An indexes creation window will appear prompting you on which indexes you want to create. Upon pressing Ok button indexes recreation procedure will start. It may time a lot of time depending on the database:

Lucene indexes creation workbench process.png

After it finishes you may use the search.

[edit] Indexes in BioUML server

Indexes on BioUML server can be created using administrative analysis Rebuild search indexes.

[edit] Recreating indexes after the database update

When you update the database indexes will become obsolete. The easiest way to update them is to terminate BioUML, remove luceneIndexes subfolder and recreate the indexes using the procedure above.

[edit] See also

Personal tools
Namespaces

Variants
Actions
BioUML platform
Community
Modelling
Analysis & Workflows
Collaborative research
Development
Virtual biology
Wiki
Toolbox