Apache Lucene.Net 4.8.0-beta00008 Documentation
Lucene is a .NET full-text search engine. 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.
This is the official API documentation for Apache Lucene.NET 4.8.0-beta00008.
Getting Started
The following section is intended as a "getting started" guide. It has three audiences: first-time users looking to install Apache Lucene in their application; developers looking to modify or base the applications they develop on Lucene; and developers looking to become involved in and contribute to the development of Lucene. The goal is to help you "get started". It does not go into great depth on some of the conceptual or inner details of Lucene:
- Lucene demo, its usage, and sources: Tutorial and walk-through of the command-line Lucene demo.
- Introduction to Lucene's APIs: High-level summary of the different Lucene packages.
- Analysis overview: Introduction to Lucene's analysis API. See also the Token
Stream consumer workflow .
Reference Documents
- Changes: List of changes in this release.
- System Requirements: Minimum and supported .NET versions. TODO: Add link
- Migration Guide: What changed in Lucene 4; how to migrate code from Lucene 3.x. TODO: Add link
- File Formats : Guide to the supported index format used by Lucene. This can be customized by using an alternate codec.
- Search and Scoring in Lucene: Introduction to how Lucene scores documents.
- Classic Scoring Formula: Formula of Lucene's classic Vector Space implementation. (look here for other models)
- Classic Query
Parser Syntax : Overview of the Classic QueryParser's syntax and features.
Libraries
- Lucene.
Net - Core library - Lucene.
Net. - Analyzers for indexing content in different languages and domainsAnalysis. Common - Lucene.
Net. - Japanese Morphological AnalyzerAnalysis. Kuromoji - Lucene.
Net. - Analyzer for dictionary stemming, built-in Polish dictionaryAnalysis. Morfologik - Lucene.
Net. - OpenNLP Library IntegrationAnalysis. Open NLP - Lucene.
Net. - Analyzer for indexing phonetic signatures (for sounds-alike search)Analysis. Phonetic - Lucene.
Net. - Analyzer for indexing ChineseAnalysis. Smart Cn - Lucene.
Net. - Analyzer for indexing PolishAnalysis. Stempel - Lucene.
Net. - System for benchmarking LuceneBenchmark - Lucene.
Net. - Classification module for LuceneClassification - Lucene.
Net. - Lucene codecs and postings formatsCodecs - Lucene.
Net. - Dynamically computed values to sort/facet/search on based on a pluggable grammarExpressions - Lucene.
Net. - Faceted indexing and search capabilitiesFacet - Lucene.
Net. - Collectors for grouping search resultsGrouping - Lucene.
Net. - Highlights search keywords in resultsHighlighter - Lucene.
Net. - Specialized ICU (International Components for Unicode) Analyzers and HighlightersICU - Lucene.
Net. - Index-time and Query-time joins for normalized contentJoin - Lucene.
Net. - Single-document in-memory index implementationMemory - Lucene.
Net. - Index tools and other miscellaneous codeMisc - Lucene.
Net. - Filters and Queries that add to core LuceneQueries - Lucene.
Net. - Text to Query parsers and parsing frameworkQuery Parser - Lucene.
Net. Files replication utilityReplicator - Lucene.
Net. - Various third party contributions and new ideasSandbox - Lucene.
Net. - Geospatial searchSpatial - Lucene.
Net. - Auto-suggest and Spell-checking supportSuggest - Lucene.
Net. - Framework for testing Lucene-based applicationsTest Framework
Tools
- Lucene CLI: Dotnet tool to work with Lucene indexes from the command line
- Demo: Simple example code