LeanCorpus 3.1.0

LeanCorpus Monorepo

LeanCorpus is an embeddable, segment-centric full-text search engine for modern .NET. It provides indexing, search, vector retrieval, typed mapping, optional compression and observability without requiring a separate search service.

Build your first search

Install the core package:

dotnet add package LeanCorpus

Create an index, add a document and search it:

using Rowles.LeanCorpus.Document;
using Rowles.LeanCorpus.Document.Fields;
using Rowles.LeanCorpus.Index.Indexer;
using Rowles.LeanCorpus.Search.Queries;
using Rowles.LeanCorpus.Search.Searcher;
using Rowles.LeanCorpus.Store;

using var directory = new MMapDirectory("./my-index");
using var writer = new IndexWriter(directory, new IndexWriterConfig());

var document = new LeanDocument();
document.Add(new StringField("id", "1"));
document.Add(new TextField("title", "The quick brown fox"));
writer.AddDocument(document);
writer.Commit();

using var searcher = new IndexSearcher(directory);
var results = searcher.Search(new TermQuery("title", "fox"), topN: 10);

Console.WriteLine($"Found {results.TotalHits} document(s).");

The program creates ./my-index and prints:

Found 1 document(s).

Choose the package that matches your job

The core package already includes Deflate and Brotli. Add a compression package only when its speed or size trade-off fits your workload.

Choose your next path

• Build a typed model with the source generator.
• Run a complete application from the examples guide.
• Understand documents, commits, segments and readers in the architecture guide.
• Add metrics, tracing and slow-query logging through observability.
• Compare features and trade-offs in Why LeanCorpus?.
• Work on the repository using CONTRIBUTING.md.

Native AOT

Validate Native AOT paths in the repository with:

./devops aot

Optional compression packages normally register themselves through module initialisers. Native AOT applications should call the package's Register() method explicitly at startup.

Monorepo map

Plans and discussion

The public roadmap is developed in GitHub Discussions:

• LeanCorpus 3.x and 4.x roadmap
• LeanCorpus .NET 11 plan

Quality

LeanCorpus is licensed under the repository LICENCE.