Lucene plugin for Para
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src
.gitignore
.travis.yml
Dockerfile
LICENSE
README.md
deploy.sh
pom.xml

README.md

Logo

Lucene plugin for Para

Build Status Maven Central Join the chat at https://gitter.im/Erudika/para

What is this?

Para was designed as a simple and modular back-end framework for object persistence and retrieval. It enables your application to store objects directly to a data store (NoSQL) or any relational database (RDBMS) and it also automatically indexes those objects and makes them searchable.

This plugin allows you to use pure Lucene as the search engine for Para.

Documentation

Read the Docs

Getting started

The plugin is on Maven Central. Here's the Maven snippet to include in your pom.xml:

<dependency>
  <groupId>com.erudika</groupId>
  <artifactId>para-search-lucene</artifactId>
  <version>{see_green_version_badge_above}</version>
</dependency>

Alternatively you can download the JAR from the "Releases" tab above put it in a lib folder alongside the server WAR file para-x.y.z.war. Para will look for plugins inside lib and pick up the plugin.

Configuration

Here are all the configuration properties for this plugin (these go inside your application.conf):

para.lucene.dir = "."

Finally, set the search config property:

para.search = "LuceneSearch"

This could be a Java system property or part of a application.conf file on the classpath. This tells Para to use the LuceneSearch as the Search implementation.

Dependencies

License

Apache 2.0