https://github.com/erudika/para-search-lucene

Lucene plugin for Para
https://github.com/erudika/para-search-lucene

backend backend-services full-text-search lucene para plugin search

Last synced: 2 months ago
JSON representation

Lucene plugin for Para

• Host: GitHub
• URL: https://github.com/erudika/para-search-lucene
• Owner: Erudika
• License: apache-2.0
• Created: 2018-03-14T18:55:47.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2024-11-07T13:59:28.000Z (3 months ago)
• Last Synced: 2024-11-07T14:37:41.905Z (3 months ago)
• Topics: backend, backend-services, full-text-search, lucene, para, plugin, search
• Language: Java
• Homepage: https://paraio.org
• Size: 291 KB
• Stars: 5
• Watchers: 3
• Forks: 2
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Logo](https://s3-eu-west-1.amazonaws.com/org.paraio/para.png)

============================

> ### Lucene plugin for Para

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.erudika/para-search-lucene/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.erudika/para-search-lucene)

[![Join the chat at https://gitter.im/Erudika/para](https://badges.gitter.im/Erudika/para.svg)](https://gitter.im/Erudika/para?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

## 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](https://paraio.org/docs)

## Getting started

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

```xml

  com.erudika

  para-search-lucene

  {see_green_version_badge_above}

```

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`):

```ini

para.lucene.dir = "."

```

Finally, set the search config property:

```ini

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

- [Apache Lucene](https://lucene.apache.org/)

- [Para Core](https://github.com/Erudika/para)

## License

[Apache 2.0](LICENSE)