kpumuk / sphinx

An easy interface to Sphinx standalone full-text search engine. It is implemented as plugin for Ruby on Rails, but can be easily used as standalone library.

This URL has Read+Write access

commit  58ec62857c5331f13e24ad652dc07e737bf9e4c5
tree    e9e5ba027164ab536e673c8d2c7ecaaf1a7206bd
parent  51f79762d2004002775aa87c4063704dd26ac0c2
sphinx /
README.rdoc

Sphinx Client API 0.9.10

This document gives an overview of what is Sphinx itself and how to use in within Ruby on Rails. For more information or documentation, please go to www.sphinxsearch.com

Sphinx

Sphinx is a standalone full-text search engine, meant to provide fast, size-efficient and relevant fulltext search functions to other applications. Sphinx was specially designed to integrate well with SQL databases and scripting languages. Currently built-in data sources support fetching data either via direct connection to MySQL, or from an XML pipe.

Simplest way to communicate with Sphinx is to use searchd - a daemon to search through fulltext indices from external software.

Compatibility

This version supports all API features of Sphinx 0.9.10-r2043. Full compatibility list:

  • 0.9.10 — Sphinx 0.9.10-r2043
  • 0.9.9 — Sphinx 0.9.9-r1299

Documentation

You can create the documentation by running:

        rake rdoc

Latest version

You can always get latest version from kpumuk.info/projects/ror-plugins/sphinx

Credits

Dmytro Shteflyuk <kpumuk@kpumuk.info> kpumuk.info

Andrew Aksyonoff sphinxsearch.com/

Special thanks to Alexey Kovyrin <alexey@kovyrin.net> blog.kovyrin.net

License

This library is distributed under the terms of the Ruby license. You can freely distribute/modify this library.