Home » Download » Modules

Search Lucene API

·
cpliakas - January 8, 2009 - 23:30
CommonPlaces logo

Overview

#D7CX: I pledge that Search Lucene API 2.0 will have a full Drupal 7 release on the day that Drupal 7 is released.

Search Lucene API is an easy-to-install module that integrates Lucene searching into Drupal. Lucene is an open source search engine library that is the back-end indexer for Nutch, Apache Solr, and a multitude of other applications and websites. This module comes bundled with the Search Lucene Content project to provide a full-featured alternative to the core content search. Search Lucene API is built on top of the Zend Framework's PHP port of Lucene, so neither Java nor any application outside of Drupal are required to use this module. Out of the box, Search Lucene API adds the following functionality to your site search:

  • Ranked search results
  • Wildcard searching
  • Boolean operators AND, OR, AND NOT, +, - are supported.
  • Term grouping
  • Fuzzy searching
  • Proximity searching
  • Range searching
  • Term boosting
  • Fielded searching
  • Word stemming (2.x only)

For detailed information on the features listed above, please visit the Lucene query syntax page.

Search Lucene API exposes a series of hooks that allow developers to interact with every stage of the search process and easily create Search Lucene API modules. This module also integrates with Drush for management of Lucene indexes via command line interface. The indexes created by Search Lucene API are binary compatible with Java Lucene, so you can use your favorite Java based diagnostic tools such as Luke for debugging and analysis.

Related Projects

  • Search Lucene MoreLikeThis - Adds a block that displays content recommendations based on the text in the node being viewed.
  • Search Lucene Views - Adds a views filter to refine results by Lucene query. Exposing the filter provides "search within these results" functionality to the view.
  • Search Lucene Multisite - Allows for a consolidated search of all content across a multi-site installation.

Maintainer

Search Lucene API is developed and maintained by Chris Pliakas and sponsored by CommonPlaces e-Solutions, LLC. A special thanks to sethcohn and ebeyrent for their guidance and support on this project. Also, thank you to Kenneth Katzgrau for creating the StandardAnalyzer project which has brought English word stemming to the 2.0 branch.

Follow Chris on Twitter: @cpliakas

Requirements

The Zend Framework makes use of advanced object oriented constructs, so PHP 5.1.6 or later is required to run Search Lucene API. Neither java nor any external services are required to use this module.

Installation

Due to Drupal's license policy regarding contributed modules, the Zend Framework components required by Search Lucene API cannot be bundled with it's releases. However, a project page has been set up at SourceForge.net to make downloading the required components as easy as possible. To install Search Lucene API, take the following actions:

  • Review the standard module installation guide, then download and extract Search Lucene API to the appropriate modules directory.
  • Download the officially supported release of the ZF components corresponding to the version of the module you are using from the Search Lucene API Library project at SourceForge.net. If no release matches the version of the module you are using, download the latest version matching the major release of the module. For example, if the module version is at 6.x-1.5 but the latest ZF version is at 6.x-1.0, you may use the 6.x-1.0 version. You will be notified via the status report page when a ZF component upgrade is available for the version of the module you are using.
  • Extract the archive downloaded from SourceForge.net, and move the "lib" directory to the Search Lucene API module's root directory.
  • Install both Search Lucene API and Search Lucene Content in "Administer" -> "Modules".

NOTE: If you receive a "Class 'LuceneAPI_Analyzer' not found" error message, you have downloaded a development version of the ZF components. Stay away from the 6.x-1.x and 5.x-1.x files and use the 6.x-1.0 and 5.x-1.0 files instead.

News

CommonPlaces sites using Search Lucene API:

  • TheDERM.org
  • Physicians Professional Network
  • 2.0 makes its debut!!! Site will be disclosed when ready ...

Version 1.2 Released for D5, D6

This release fixes some minor bugs present in the 1.1 and earlier releases. You do NOT need to upgrade your ZF components or rebuild your indexes after upgrading to this release.

Version 2.0

To play around with the 2.0 dev version, download the 2.x branch of the ZF components via subversion from https://luceneapi.svn.sourceforge.net/svnroot/luceneapi/branches/2.x.

Releases

Official releasesDateSizeLinksStatus
6.x-1.22009-Jun-2440.61 KBDownload · Release notesRecommended for 6.xThis is currently the recommended release for 6.x.
5.x-1.22009-Jun-2441.41 KBDownload · Release notesRecommended for 5.xThis is currently the recommended release for 5.x.
Development snapshotsDateSizeLinksStatus
6.x-2.x-dev2009-Jul-1035.44 KBDownload · Release notesDevelopment snapshotDevelopment snapshots are automatically regenerated and their contents can frequently change, so they are not recommended for production use.


 
 

Drupal is a registered trademark of Dries Buytaert.