doc/README.EN

   1 * Senna: An Embeddable Fulltext Search Engine
   2
   3 Senna is an embeddable fulltext search engine, which you can use in conjunction with various scripting languages and databases. Senna is an inverted index based engine, and combines the best of n-gram indexing and word indexing to achieve fast, precise searches. While senna codebase is rather compact it is scalable enough to handle large amounts of data and queries.
   4
   5 *Major features
   6
   7 **Embeddable
   8
   9 Senna can easily be embbeded into a database, or can be used directly from within programs written in C, ruby, perl, etc.
  10
  11 Whereas a majority of search engines are comprised of a data file (the actual text that is being searched) and an inverted index file, senna uses only an inverted index file and delegates the responsibility to store and manage data to the system that Senna is being embedded into (such as a database). This allows Senna to avoid having to duplicate efforts to manage the actual data.
  12
  13 Senna is also designed such that no locking is required when performing concurrent read/writes. This greatly reduces the impact on the embedding system's performance
  14
  15 **High Accuracy
  16
  17 Senna uses the best breed of word-based index and n-gram index. This means that Senna's indices are relatively small and has a high precision, while at the same time keeping a high recall on the search results.
  18
  19 By default Senna stores terms into an inverted index file (word-based index) after performing morphological analysis on the sentences. But by combining a fast, partial match search using a dictionary, Senna is also able to match entries that are usually missed by ordinary word-based index searches.
  20
  21 **Incremental Updates
  22
  23 Senna allows incremental updates to an already existing index. This allows users to dynamically add/edit/delete index entries without having to rebuild the entire index
  24
  25 *License
  26
  27 This program is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation.
  28
  29 This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
  30
  31 *Requirements
  32
  33 - OS
  34 -- Linux, FreeBSD, MacOS X
  35 - Requirements
  36 -- MeCab-0.80 or later (for japanese-word indexing. normally not required.)[[http://mecab.sourceforge.jp/]]
  37 -- Ruby 1.8.1 or later (for Ruby binding.)[[http://www.ruby-lang.org/]]
  38 -- MySQL 4.0 series(4.0.22 or later) (for MySQL binding.)[[http://www.mysql.com/]]
  39
  40 *Contact
  41
  42 <senna-at-razil.jp>
  43
  44 [[Brazil ltd.|http://razil.jp]]