Lucene Search

Set this to true to enable highlighting of search results.

index.search.highlight.enabled=true

Set the fragment size returned from the search result highlighter

index.search.highlight.fragment.size=80

Set the number of lines for the snippet returned by a search engine.

index.search.highlight.snippet.size=3

Set the limit for results used when performing index searches.

index.search.limit=10000

Set this to true to enable scoring of results.

index.search.scoring.enabled=true

Set the limit for results used when performing index searches that are subsequently filtered by permissions.

index.filter.search.limit=5000

Set this to true if you want to avoid any writes to the index. This is useful in some clustering environments where there is a shared index and only one node of the cluster updates it.

index.read.only=false

Set this to true if you want to index your entire library of files on startup. This property is available so that automated test environments index on startup. Do not set this to true on production systems or else your index will be indexed on every startup.

index.on.startup=false

Set this to true to add a delay before indexing on startup. A delay may be necessary if a lot of plugins need to be loaded and reindexed. This property is only valid if index.on.startup is set to true.

index.on.startup.delay=60

Set this to true if you want to index your entire library of files after an upgrade. Only set this property to false if you are running a small upgrade and you do not need to reindex everything.

index.on.upgrade=true

Set this to true if you want the indexing on startup to be executed on a separate thread to speed up execution.

index.with.thread=true

Set the date format used for storing dates as text in the index.

index.date.format.pattern=yyyyMMddHHmmss

Set this to true if you want to compress index files before they are dumped.

index.dump.compression.enabled=true

Designate whether Lucene stores indexes in a database via JDBC, file system, or in RAM.

Examples:

lucene.store.type=jdbc
lucene.store.type=file
lucene.store.type=ram

When using file store, turning this flag on will tell Lucene to use MMapDirectory rather than using the default selection (SimpleFSDirectory for Windows and NIOFSDirectory for Linux). It only makes sense to use MMapDirectory for 64-bit JVM with a lot of memory. On a 32-bit JVM, if the index files are huge, this could easily lead to an out of memory for non-heap memory.

lucene.store.type.file.force.mmap=false

Lucene’s storage of indexes via JDBC has a bug where temp files are not removed. This can eat up disk space over time. Set this to true to automatically clean up the temporary files regularly. See http://issues.liferay.com/browse/LEP-2180.

Example:

lucene.store.jdbc.auto.clean.up.enabled=true

Set the interval on which the lucene automatic clean up is set to run. The value is set in one minute increments.

lucene.store.jdbc.auto.clean.up.interval=1440

Set the JDBC dialect that Lucene uses to store indexes in the database. This is only referenced if Lucene stores indexes in the database. Liferay will attempt to load the proper dialect based on the URL of the JDBC connection. For example, the property lucene.store.jdbc.dialect.mysql is read for the JDBC connection URL jdbc:mysql://localhost/lportal.

Example:

lucene.store.jdbc.dialect.db2=org.apache.lucene.store.jdbc.dialect.DB2Dialect
lucene.store.jdbc.dialect.derby=org.apache.lucene.store.jdbc.dialect.DerbyDialect
lucene.store.jdbc.dialect.hsqldb=org.apache.lucene.store.jdbc.dialect.HSQLDialect
lucene.store.jdbc.dialect.jtds=org.apache.lucene.store.jdbc.dialect.SQLServerDialect
lucene.store.jdbc.dialect.microsoft=org.apache.lucene.store.jdbc.dialect.SQLServerDialect
lucene.store.jdbc.dialect.mysql=org.apache.lucene.store.jdbc.dialect.MySQLDialect
lucene.store.jdbc.dialect.mysql=org.apache.lucene.store.jdbc.dialect.MySQLInnoDBDialect
lucene.store.jdbc.dialect.mysql=org.apache.lucene.store.jdbc.dialect.MySQLMyISAMDialect
lucene.store.jdbc.dialect.oracle=org.apache.lucene.store.jdbc.dialect.OracleDialect
lucene.store.jdbc.dialect.postgresql=org.apache.lucene.store.jdbc.dialect.PostgreSQLDialect

Set the directory where Lucene indexes are stored. This is only referenced if Lucene stores indexes in the file system.

lucene.dir=${liferay.home}/data/lucene/

Input a class name that extends com.liferay.portal.search.lucene.LuceneFileExtractor. This class is called by Lucene to extract text from complex files so that they can be properly indexed.

lucene.file.extractor=com.liferay.portal.search.lucene.LuceneFileExtractor

The file extractor can sometimes return text that is not valid for Lucene. This property expects a regular expression. Any character that does not match the regular expression will be replaced with a blank space. Set an empty regular expression to disable this feature.

Example:

lucene.file.extractor.regexp.strip=
lucene.file.extractor.regexp.strip=[\\d\\w]

Set how often index updates will be committed. Set the batch size to configure how many consecutive updates will trigger a commit. If the value is 0, then the index will be committed on every update. Set the time interval in milliseconds to configure how often to commit the index. The time interval is not read unless the batch size is greater than 0 because the time interval works in conjunction with the batch size to guarantee that the index is committed after a specified time interval. Set the time interval to 0 to disable committing the index by a time interval.

lucene.commit.batch.size=0
lucene.commit.time.interval=0

Set Lucene’s buffer size in megabytes. Higher numbers mean indexing goes faster but uses more memory.

lucene.buffer.size=16

Set Lucene’s merge factor. Higher numbers mean indexing goes faster but uses more memory. The default value from Lucene is 10. This should never be set to a number lower than 2.

lucene.merge.factor=10

Set how often to run Lucene’s optimize method. Optimization speeds up searching but slows down writing. Set this property to 0 to always optimize. Set this property to an integer greater than 0 to optimize every X writes.

lucene.optimize.interval=100

Set this to true if you want the portal to replicate an index write across all members of the cluster. This is useful in some clustered environments where you wish each server instance to have its own copy of the Lucene search index. This is only relevant when using the default Lucene indexing engine.

lucene.replicate.write=false