Logo

What is NXLucene ?

Last modified: 05/30/2006 08:29 AM

logosmall.jpg

NXLucene

Author: Julien Anguenot
Revision: README.txt 45945 2006-05-26 13:49:56Z atchertchian

1   What is it ?

NXLucened is a standalone multi threads remote server handling a Lucene index store. It is based on the PyLucene Python bindings and uses Twisted and ZopeInterface for its implementation.

Currently, it supports the XML-RPC protocol but might be easily extended to other protocols, such as SOAP, thanks to its modular design.

Note the FSDirectory backend is the only supported backend by NXLucened for now.

The search results are returned as RSS streams.

NXLucened exposes an XML query language for indexing and searching operations. Note the Lucene native search query is of course still supported. Check the interfaces.py module.

While installing NXLucened, you will install as well the core libs, nxlucene namespace, that might be used by third party Python programs. For instance, the query lib might be useful to help you format your nxlucene queries.

2   Motivation

This product has been implemented in the CPS project scope. CPS is based on Zope and the standard cataloging solution of Zope is the ZCatalog nowadays. The ZCatalog works well until a certain amount of data but the main problem is that Zope is dealing with a task it shouldn't have to deal with and thus decrease the overall performances of the overall Zope platform. You may see, anyway, the ZCatalog as an hack on top of the ZODB because the ZODB doesn't have any native query language nor full index suppport.

That's why we needed such as solution for CPS.

This product has been designed to deal with millions of documents within the Lucene store.

For NXLucened use examples :

3   Documentation

See the doc sub-folder of this archive and check the NXLucened website

4   Installation

See INSTALL.txt or here

7   License

This Software is governed by the LGPL License. See LICENSE.txt or http://www.gnu.org/copyleft/lesser.html

This software includes as well softwares under the MIT and the ZPL.

This site is powered by CPS, which includes CPSSkins. CPS and its design are Copyright © 2002-2006 Nuxeo SAS.
CPSSkins is Copyright © 2003-2006 Jean-Marc Orliaguet.
powered_by_nuxeo.png