Apache Lucene.net

Clone this repo:
  1. ecf6212 Lucene.Net.TestFramework: Moved StackTraceHelper from Util to Support folder by Shad Storhaug · 3 weeks ago master
  2. f630a54 Lucene.Net.Util.OpenBitSet: Added comments to indicate these changes differ from Lucene (closes #154) by Shad Storhaug · 4 weeks ago
  3. 51491e4 Fix OpenBitSet.Union and .Xor methods. by uppi · 4 years, 1 month ago
  4. 4c74b6e Lucene.Net.ICU: Removed inapplicable release notes about icu.net by Shad Storhaug · 4 weeks ago
  5. 15ba09d SWEEP: Avoid static constructors (see https://github.com/apache/lucenenet/pull/224#issuecomment-469284006) by Shad Storhaug · 7 weeks ago

Apache Lucene.Net

Full-text search for .NET

Apache Lucene.Net is a .NET full-text search engine framework, a C# port of the popular Apache Lucene project. Apache Lucene.Net is not a complete application, but rather a code library and API that can easily be used to add search capabilities to applications.

The Apache Lucene.Net web site is at: http://lucenenet.apache.org

Supported Frameworks

Lucene.Net 3.0.3

  • .NET Framework 4.0
  • .NET Framework 3.5

Lucene.Net 4.8.0

Status

Latest Stable Version: Lucene.Net 3.0.3

Working toward Lucene.Net 4.8.0 (currently in BETA)

Download

Lucene.Net 3.0.3

Core Library

NuGet version

PM> Install-Package Lucene.Net
All Packages

Lucene.Net 4.8.0

Core Library

NuGet version

PM> Install-Package Lucene.Net -Pre
All Packages

Documentation

We now have some preliminary documentation for Lucene.Net 4.8.0 on the Lucene.Net Website.

The API is similar to Java Lucene 4.8.0, which you may also find helpful to review.

NOTE: We are working on fixing issues with the documentation, but could use more help since it is a massive project. See #206.

Legacy Versions

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!

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

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

lucene-cli Documentation

How to Contribute

Lucene.Net is a very large project (over 400,000 executable lines of code and nearly 1,000,000 lines of text total) and we welcome any and all help to maintain such an effort. Read our Contribution Guide or read on for ways that you can help.

Join Mailing Lists

How to Join Mailing Lists

Ask a Question

If you have a general how-to question or need help from the Lucene.Net community, please email the Apache Lucene.Net-User mailing list by sending a message to:

user@lucenenet.apache.org

We recommend you join the user mailing list to stay looped into all user discussions.

Alternatively, you can get help via StackOverflow.

Please do not submit general how-to questions to JIRA, use JIRA for bug reports/tasks only.

Report a Bug

To report a bug, please use the JIRA issue tracker. You can signup for a JIRA account here (it just takes a minute).

Start a Discussion

To start a development discussion regarding technical features of Lucene.Net, please email the Apache Lucene.Net-Developer mailing list by sending a message to:

dev@lucenenet.apache.org

We recommend you join both the user and dev mailing lists to stay looped in to all user and developer discussions.

Submit a Pull Request

Before you start working on a pull request, please read our Contributing guide.

If you plan to submit multiple pull requests, please submit an Individual Contributor License, or for individual pull requests, just submit the request and in the description state that the code is your original work and you license it under the Apache License v2.

Building and Testing

Command Line

Building on the Command Line is currently only supported on Windows.

Prerequisites
  1. Powershell 3.0 or higher (see this question to check your Powershell version)
  2. .NET Core SDK 2.0 or higher
Execution

To build the source, clone or download and unzip the repository. From the repository root, execute:

> build [options]
Build Options

NuGet packages are output by the build to the /release/NuGetPackages/ directory. Test results (if applicable) are output to the /release/TestResults/ directory.

You can setup Visual Studio to read the NuGet packages like any NuGet feed by following these steps:

  1. In Visual Studio, right-click the solution in Solution Explorer, and choose “Manage NuGet Packages for Solution”
  2. Click the gear icon next to the Package sources dropdown.
  3. Click the + icon (for add)
  4. Give the source a name such as Lucene.Net Local Packages
  5. Click the ... button next to the Source field, and choose the /src/release/NuGetPackages folder on your local system.
  6. Click Ok

Then all you need to do is choose the Lucene.Net Local Packages feed from the dropdown (in the NuGet Package Manager) and you can search for, install, and update the NuGet packages just as you can with any Internet-based feed.

Visual Studio

Prerequisites

  1. Visual Studio 2017 version 15.3 or higher
  2. .NET Core SDK 2.0 or higher
  3. NUnit3 Test Adapter

Execution

  1. Open Lucene.Net.sln in Visual Studio.
  2. Choose the target framework to test by opening build/TestTargetFramework.proj and uncommenting the corresponding <TargetFramework>.
  3. Build a project or the entire solution, and wait for Visual Studio to discover the tests - this may take several minutes.
  4. Run or debug the tests in Test Explorer, optionally using the desired filters.

NOTE: When running tests in Visual Studio, be sure to set the default processor architecture to 64 bit to avoid running out of virtual memory on some tests.