Lucene.Net 4.8.0-beta00004

Lucene.NET is a full-text search engine library capable of advanced text analysis, indexing, and searching. It can be used to easily add search capabilities to applications. Lucene.Net is a C# port of the popular Java Lucene search engine framework from The Apache Software Foundation, targeting the .NET platform.

Quick Start

Prerequisites

• Lucene.Net
• Lucene.Net.Analysis.Common

Imports

using Lucene.Net.Analysis.Standard;
using Lucene.Net.Documents;
using Lucene.Net.Index;
using Lucene.Net.Search;
using Lucene.Net.Store;
using Lucene.Net.Util;

Create an Index and Define a Text Analyzer

// Ensures index backward compatibility
const LuceneVersion AppLuceneVersion = LuceneVersion.LUCENE_48;

// Construct a machine-independent path for the index
var basePath = Environment.GetFolderPath(
    Environment.SpecialFolder.CommonApplicationData);
var indexPath = Path.Combine(basePath, "index");

using var dir = FSDirectory.Open(indexPath);

// Create an analyzer to process the text
var analyzer = new StandardAnalyzer(AppLuceneVersion);

// Create an index writer
var indexConfig = new IndexWriterConfig(AppLuceneVersion, analyzer);
using var writer = new IndexWriter(dir, indexConfig);

Add to the Index

var source = new
{
    Name = "Kermit the Frog",
    FavoritePhrase = "The quick brown fox jumps over the lazy dog"
};
var doc = new Document
{
    // StringField indexes but doesn't tokenize
    new StringField("name",
        source.Name,
        Field.Store.YES),
    new TextField("favoritePhrase",
        source.FavoritePhrase,
        Field.Store.YES)
};

writer.AddDocument(doc);
writer.Flush(triggerMerge: false, applyAllDeletes: false);

Construct a Query

// Search with a phrase
var phrase = new MultiPhraseQuery
{
    new Term("favoritePhrase", "brown"),
    new Term("favoritePhrase", "fox")
};

Fetch the Results

// Re-use the writer to get real-time updates
using var reader = writer.GetReader(applyAllDeletes: true);
var searcher = new IndexSearcher(reader);
var hits = searcher.Search(phrase, 20 /* top 20 */).ScoreDocs;

// Display the output in a table
Console.WriteLine($"{"Score",10}" +
    $" {"Name",-15}" +
    $" {"Favorite Phrase",-40}");
foreach (var hit in hits)
{
    var foundDoc = searcher.Doc(hit.Doc);
    Console.WriteLine($"{hit.Score:f8}" +
        $" {foundDoc.Get("name"),-15}" +
        $" {foundDoc.Get("favoritePhrase"),-40}");
}

Documentation

See the API documentation for Lucene.NET 4.8.0.

All Packages

• Lucene.Net - Core library
• Lucene.Net.Analysis.Common - Analyzers for indexing content in different languages and domains
• Lucene.Net.Analysis.Kuromoji - Japanese Morphological Analyzer
• Lucene.Net.Analysis.Morfologik - Analyzer for dictionary stemming, built-in Polish dictionary
• Lucene.Net.Analysis.OpenNLP - OpenNLP Library Integration
• Lucene.Net.Analysis.Phonetic - Analyzer for indexing phonetic signatures (for sounds-alike search)
• Lucene.Net.Analysis.SmartCn - Analyzer for indexing Chinese
• Lucene.Net.Analysis.Stempel - Analyzer for indexing Polish
• Lucene.Net.Benchmark - System for benchmarking Lucene
• Lucene.Net.Classification - Classification module for Lucene
• Lucene.Net.Codecs - Lucene codecs and postings formats
• Lucene.Net.Expressions - Dynamically computed values to sort/facet/search on based on a pluggable grammar
• Lucene.Net.Facet - Faceted indexing and search capabilities
• Lucene.Net.Grouping - Collectors for grouping search results
• Lucene.Net.Highlighter - Highlights search keywords in results
• Lucene.Net.ICU - Specialized ICU (International Components for Unicode) Analyzers and Highlighters
• Lucene.Net.Join - Index-time and Query-time joins for normalized content
• Lucene.Net.Memory - Single-document in-memory index implementation
• Lucene.Net.Misc - Index tools and other miscellaneous code
• Lucene.Net.Queries - Filters and Queries that add to core Lucene
• Lucene.Net.QueryParser - Text to Query parsers and parsing framework
• Lucene.Net.Replicator Files replication utility
• Lucene.Net.Sandbox - Various third party contributions and new ideas
• Lucene.Net.Spatial - Geospatial search
• Lucene.Net.Suggest - Auto-suggest and Spell-checking support
• Lucene.Net.TestFramework - Framework for testing Lucene-based applications

Demos & Tools

There are several demos implemented as simple console applications that can be copied and pasted into Visual Studio or compiled on the command line in the Lucene.Net.Demo project.

There is also a dotnet command line tool available on NuGet. It contains all of the demos as well as tools maintaining your Lucene.NET index, featuring operations such as splitting, merging, listing segment info, fixing, deleting segments, upgrading, etc. Always be sure to back up your index before running any commands against it!

• Prerequisite: .NET Core 3.1.0 Runtime

dotnet tool install lucene-cli -g --version 4.8.0-beta00015

NOTE: The version of the CLI you install should match the version of Lucene.NET you use.

Once installed, you can explore the commands and options that are available by entering the command lucene.

lucene-cli Documentation

Lucene.NET Needs Your Help

Lucene.NET 4.8.0 is a large project that has been under development since 2014, and a few volunteers have contributed more than 5000 hours of their time to help. All of the Lucene.NET modules are ported from Java, but we are still missing a few key features and have much work to do on our biggest dependency, ICU4N, to get it production ready.

If you wish to contribute your time, please see the Contributing page to get started. Specifically, the types of people we need to get Lucene.NET 4.8.0 out of beta are:

• An engineer with advanced concurrency debugging and design skills
• Someone with experience fund raising for open source
• Some developers to experiment with and blog about Lucene.NET and to help us make the user experience better by creating more documentation

Sponsor Lucene.NET

We understand some people and companies don't have the time to contribute code or write documentation, but still wish to participate. While Apache provides much of the infrastructure we need through Apache sponsorship programs, these funds generally are not applied toward development work of Lucene.NET.

Being that Lucene.NET has over 450,000 lines of code and depends on several other projects that we also maintain, development on Lucene.NET is no small endeavor. It can be difficult for a small team of developers to put in the kind of time that a project of this magnitude requires, which is why we need your help. Lucene.NET needs more regular developers devoting periodic blocks of development time and it needs sponsorships so some of those developers can allocate substantial amounts of time to the project.

	Please Sponsor Our Development Team!
Shad Storhaug
Shannon Deminick
Ron Clabo

* (additional regular contributors will be featured here)

Disclaimer

These sponsorships are not officially affiliated with the Apache Software Foundation, but aim to support endeavors related to Apache Lucene.NET. The ASF values community integrity and vendor independence very highly. As a general principle, it doesn't accept "cash for code" so that individual cash payments can't force contributions into a project which aren't aligned with community consensus.

Plans

Some of the developments we may be able to accelerate through this initiative include:

• Performance optimization.
• Fixing tests that are still failing intermittently.
• Finish ICU4N packaging, and provide a way to make smaller custom distributions of ICU data using the ICU Data Build Tool.
• Automation of website and API documentation build and deployment.
• Online API documentation for J2N.
• Production release of Lucene.NET 4.8.0.
• Upgrade of Lucene.NET from 4.8.0 to the latest stable version of Lucene (approximately 1800 hours of work).

Funding may also be applied toward:

• Ongoing support of Lucene.NET 4.8.0 and higher.
• Development hardware and virtualization of debugging environments.
• Reporting bugs found in .NET platform and development tools.
• Documenting policies and procedures for use by the Lucene.NET development team.