| 1 |
======== |
|---|
| 2 |
NXLucene |
|---|
| 3 |
======== |
|---|
| 4 |
|
|---|
| 5 |
:Author: Julien Anguenot |
|---|
| 6 |
:Revision: $Id$ |
|---|
| 7 |
|
|---|
| 8 |
.. sectnum:: :depth: 6 |
|---|
| 9 |
.. contents:: :depth: 1 |
|---|
| 10 |
|
|---|
| 11 |
What is it ? |
|---|
| 12 |
============ |
|---|
| 13 |
|
|---|
| 14 |
NXLucened_ is a standalone multi threads remote server handling a |
|---|
| 15 |
Lucene_ index store. It is based on the PyLucene_ Python_ bindings and |
|---|
| 16 |
uses Twisted_ and ZopeInterface_ for its implementation. |
|---|
| 17 |
|
|---|
| 18 |
Currently, it supports the XML-RPC protocol but might be easily |
|---|
| 19 |
extended to other protocols, such as SOAP, thanks to its modular |
|---|
| 20 |
design. |
|---|
| 21 |
|
|---|
| 22 |
Note the FSDirectory backend is the only supported backend by |
|---|
| 23 |
NXLucened_ for now. |
|---|
| 24 |
|
|---|
| 25 |
The search results are returned as RSS streams. |
|---|
| 26 |
|
|---|
| 27 |
NXLucened_ exposes an XML query language for indexing and searching |
|---|
| 28 |
operations. Note the Lucene_ native search query is of course still |
|---|
| 29 |
supported. Check the interfaces.py module. |
|---|
| 30 |
|
|---|
| 31 |
While installing NXLucened_, you will install as well the core libs, |
|---|
| 32 |
nxlucene namespace, that might be used by third party Python |
|---|
| 33 |
programs. For instance, the query lib might be useful to help you |
|---|
| 34 |
format your nxlucene queries. |
|---|
| 35 |
|
|---|
| 36 |
|
|---|
| 37 |
.. _PyLucene: http://pylucene.osafoundation.org/ |
|---|
| 38 |
.. _Python: http://www.python.org/ |
|---|
| 39 |
.. _Lucene: http://lucene.apache.org/ |
|---|
| 40 |
.. _ZopeInterface: http://zope.org/Products/ZopeInterface |
|---|
| 41 |
.. _Twisted: http://twistedmatrix.com/projects/core/ |
|---|
| 42 |
|
|---|
| 43 |
Motivation |
|---|
| 44 |
========== |
|---|
| 45 |
|
|---|
| 46 |
This product has been implemented in the CPS project scope. CPS_ is |
|---|
| 47 |
based on Zope_ and the standard cataloging solution of Zope_ is the |
|---|
| 48 |
ZCatalog_ nowadays. The ZCatalog_ works well until a certain amount |
|---|
| 49 |
of data but the main problem is that Zope_ is dealing with a task it |
|---|
| 50 |
shouldn't have to deal with and thus decrease the overall |
|---|
| 51 |
performances of the overall Zope_ platform. You may see, anyway, the |
|---|
| 52 |
ZCatalog_ as an hack on top of the ZODB_ because the ZODB_ doesn't |
|---|
| 53 |
have any native query language nor full index suppport. |
|---|
| 54 |
|
|---|
| 55 |
That's why we needed such as solution for CPS_. |
|---|
| 56 |
|
|---|
| 57 |
This product has been designed to deal with millions of documents |
|---|
| 58 |
within the Lucene_ store. |
|---|
| 59 |
|
|---|
| 60 |
For NXLucened_ use examples : |
|---|
| 61 |
|
|---|
| 62 |
- Zope3_ integration |
|---|
| 63 |
|
|---|
| 64 |
nuxeo.lucene_ |
|---|
| 65 |
|
|---|
| 66 |
- CPS_ integration |
|---|
| 67 |
|
|---|
| 68 |
CPSLuceneCatalog_ |
|---|
| 69 |
|
|---|
| 70 |
.. _CPS: http://www.cps-project.org/ |
|---|
| 71 |
.. _Zope: http://www.zope.org/ |
|---|
| 72 |
.. _ZCatalog: http://www.faqs.org/docs/ZopeBook/SearchingZCatalog.html |
|---|
| 73 |
.. _ZODB: http://www.zope.org/Wikis/ZODB/ |
|---|
| 74 |
.. _Zope3: http://dev.zope.org/Zope3/ |
|---|
| 75 |
.. _nuxeo.lucene: http://svn.nuxeo.org/pub/Zope3/nuxeo.lucene |
|---|
| 76 |
.. _CPSLuceneCatalog: http://svn.nuxeo.org/pub/CPS3/products/CPSLuceneCatalog/ |
|---|
| 77 |
.. _NXLucened: http://www.cps-project.org/workspaces/development/projects/nxlucene/ |
|---|
| 78 |
|
|---|
| 79 |
Documentation |
|---|
| 80 |
============= |
|---|
| 81 |
|
|---|
| 82 |
See the doc sub-folder of this archive and check the NXLucened_ website_ |
|---|
| 83 |
|
|---|
| 84 |
.. _website: http://www.cps-project.org/sections/nxlucene/ |
|---|
| 85 |
|
|---|
| 86 |
Installation |
|---|
| 87 |
============ |
|---|
| 88 |
|
|---|
| 89 |
See INSTALL.txt or here_ |
|---|
| 90 |
|
|---|
| 91 |
.. _here : http://www.cps-project.org/workspaces/development/projects/nxlucene/readme |
|---|
| 92 |
|
|---|
| 93 |
Need support ? |
|---|
| 94 |
============== |
|---|
| 95 |
|
|---|
| 96 |
- http://lists.nuxeo.com/mailman/listinfo/cps-devel |
|---|
| 97 |
|
|---|
| 98 |
|
|---|
| 99 |
Looking for commercial support ? |
|---|
| 100 |
================================ |
|---|
| 101 |
|
|---|
| 102 |
You can contact Nuxeo_ |
|---|
| 103 |
|
|---|
| 104 |
- http://www.nuxeo.com/en/ |
|---|
| 105 |
|
|---|
| 106 |
.. _Nuxeo: http://www.nuxeo.com/en/ |
|---|
| 107 |
|
|---|
| 108 |
License |
|---|
| 109 |
======= |
|---|
| 110 |
|
|---|
| 111 |
This Software is governed by the LGPL License. See LICENSE.txt or |
|---|
| 112 |
http://www.gnu.org/copyleft/lesser.html |
|---|
| 113 |
|
|---|
| 114 |
This software includes as well softwares under the MIT and the ZPL. |
|---|
| 115 |
|
|---|
| 116 |
|
|---|
| 117 |
.. Emacs |
|---|
| 118 |
.. Local Variables: |
|---|
| 119 |
.. mode: rst |
|---|
| 120 |
.. End: |
|---|
| 121 |
.. Vim |
|---|
| 122 |
.. vim: set filetype=rst: |
|---|
