Components

A reference guide for understanding and using the core components of Lucille.

Document

The basic unit of data that is sent through a Pipeline and eventually indexed into a search engine.

Events

As Lucille runs, it generates Events that inform on success, failure, etc.

Publisher

Provides a way to publish Documents for processing by the pipeline.

Runner

Component that manages a Lucille Run, end-to-end.

Worker

A thread that retrieves a published document and passes it through the pipeline, then sending completed documents to a destination queue.

Config

The Config is a HOCON file where you define the settings for running Lucille.

Indexer

An Indexer sends processed Documents to a specific destination.

Stages

A Stage performs a specific transformation on a Document.

File Handlers

File Handlers extract Lucille Documents from individual files, like CSV or JSON files, which themselves contain data which can be transformed into Lucille Documents.

Connectors

A component that retrieves data from a source system and packages the data into Documents in preparation for transformation.

Pipeline

The end-to-end sequence of stages that transform Documents.