quarkiverse / quarkus-lucene

Quarkus Lucene Extension

Lucene extension for Quarkus

Apache Lucene is a Java library providing powerful indexing and search features, as well as spellchecking, hit highlighting and advanced analysis/tokenization capabilities.

This extension adds support for building native executables when using Apache Lucene.

Usage

Configuration

After configuring the Quarkus BOM:

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>io.quarkus</groupId>
            <artifactId>quarkus-bom</artifactId>
            <version>${insert.quarkus.version.here}</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

You can configure the lucene extension by adding the following dependency:

<dependency>
    <groupId>io.quarkiverse.lucene</groupId>
    <artifactId>quarkus-lucene</artifactId>
    <version>${insert.release.version}</version>
</dependency>

Limitations

• The extension disables the workaround for bug JDK-4724038 in the MMapDirectory. This means that files from the index will not be deleted immediately when Lucene issues a deletion operation, but only upon garbage collection, causing a temporary larger disk usage.

• Test Coverage is currently limited to lucene-core ,lucene-analyzers-common and lucene-queryparser artifacts from Lucene.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Gustavo 💻 🚧

Dainius Jocas 💻 🚧

Guillaume Smet 💻

Melloware 📖 💻

This project follows the all-contributors specification. Contributions of any kind welcome!