Welcome to the Lucene wiki! We use the wiki for brainstorming, maintainance of a FAQ, a free-for-all link database, and lots of miscellaneous snippets. Feel free to contribute. See HowToContribute for more details.

Overview

Lucene is a text search engine API. Specifically, Lucene is the guts of a search engine - the hard stuff. You write the easy stuff, the UI and the process of selecting and parsing your data files to pump them into the search engine, yourself.

You can find the Lucene project at:http://lucene.apache.org/

Lucene is high-performance, scalable, full-featured, open-source, and written in Java.

Informational

1. BasicsOfPerformance -- Page bringing various other pages on performance under one roof.

2. ConceptsAndDefinitions -- Concepts and Definitions related to Lucene.

3. lucene status -- CHANGES.txt svn head

4. LuceneFAQ -- The Lucene FAQ. Check here before asking on the list

5. GdataServer -- Gdata implementation using Lucene

6. HowTo -- Tips, tricks, and gotchas

7. InformationRetrieval -- Articles and Tutorials on Information Retrieval. Learn more about the theory behind Lucene

8. SearchQualityReports -- Reports on search quality experiments with Lucene.

9. LuceneImplementations -- Implementations of the Lucene index and search model in languages other than Java. Note that not all implementations are compatible with the Lucene Java File Format

10. Resources -- Books, Articles, Corpora... also see LuceneResources for projects that extend Lucene

11. SourceRepository -- How to get the sources

12. commits tracker -- Lucene commits tracker, has RSS feed

13. SunJavaBugs -- known bugs in Sun's Java implementation that affect Lucene

14. NearRealtimeSearch -- How to perform updates and search on them immediately using Lucene

15. Payloads - Information on payloads

16. ParallelIncrementalIndexing -- Using Lucene to build parallel indexes that support partial document updates

17. StaticIndexPruning - removing some term and posting data from existing indexes while retaining retrieval quality of top-N results

18. AvailableLockFactories - brief guide to different LockFactory implementations

19. QueryParsers - query parser implementations

Community

1. CommunityContributions -- Code, modules, etc. available outside of Apache

2. HowToContribute -- We love patches, documentation, etc. Here's how to submit it.

3. LatestNews -- What's happening in the Lucene community

4. OnTheRoad -- Who's talking about Lucene and where?

5. PoweredBy -- Links to projects using Lucene

6. Support -- People and companies for hire.

7. Training -- Training courses

8. UseCases -- Want to share how you solved a particularly thorny issue in Lucene? Create a subpage under this one and write away

9. BestPractices -- Tips and techniques that can be regarded as best practices for Lucene.

10. MailingListArchives -- A list of archives of the Lucene Java (and probably others) mailing lists

Committers

1. CommittersResources

2. TestPlans

3. Validation

4. LucenePlanning -- Whiteboard for future Lucene design

5. TopLevelProject -- Wiki stuff for the Lucene TLP, since the TLP doesn't have a wiki

Lucene Proposals

A spot for keeping track of new ideas related to Lucene (both TLP and Java specific)

1. OpenRelevance

Miscellaneous

1. Archives -- Older Wiki documents

2. LuceneAtApacheConUs2009 -- Proposed search technology track at the ApacheCon US

3. LuceneMeetupMarch2009 -- Lucene community gathering event in Amsterdam during the ApacheCon Europe

4. LuceneRevolution2010 -- Lucene Conference in Boston

5. SummerOfCode2011 -- Google Summer of Code 2011

How to use this site

You may want to click on the Login link above and login if you haven't already.

During the editing of the Lucene wiki, please use the markup :TODO: to denote items you know need cleaned up later. This will stand out visually on the page like so: :TODO: ... and :TODO: is easy to search for.

A Wiki is a collaborative site, anyone can contribute and share:

• Edit any page by pressing Edit at the top or the bottom of the page

• Create a link to another page with joined capitalized words (like WikiSandBox) or with quoted words in brackets

• Search for page titles or text within pages using the search box at the top of any page

• See HelpForBeginners to get you going, HelpContents for all help pages.

• SyntaxReference: quick access to wiki syntax