isomorfeus-ferret

Convenient and well performing indexing and search.

Community and Support

At the Isomorfeus Framework Project

About this project

Isomorfeus-Ferret is a revived version of the original ferret gem created by Dave Balmain. During revival many things havbe been fixed, now all tests pass, no crashes and it successfully compiles and runs with rubys >3. Its no loger a goal to have a c library available, but instead the usage is meant as ruby gem with a c extension only.

It should work on *nixes and *nuxes and also works on Windows.

However, the revival is still fresh and although it appears to be working, issues have to be expected.

Documentation

The documentations is currently scattered throughout the repo.

For a quick start its best to read: https://github.com/isomorfeus/isomorfeus-ferret/blob/master/TUTORIAL.md

Further: https://github.com/isomorfeus/isomorfeus-ferret/blob/master/lib/isomorfeus/ferret/index/index.rb https://github.com/isomorfeus/isomorfeus-ferret/blob/master/lib/isomorfeus/ferret/document.rb

The query language and parser are documented here: https://github.com/isomorfeus/isomorfeus-ferret/blob/master/ext/isomorfeus_ferret_ext/frb_qparser.c

Examples can be found in the 'test' directory or in 'misc/ferret_vs_lucene'.

Future

Lots of things to do:

• Bring documentation in order in a docs directory
• Review code (especially for memory/stack issues, typical c issues)
• Take care of ruby GVL and threading
• Check locking (thread and filesystem)
• See todo directory: https://github.com/isomorfeus/isomorfeus-ferret/tree/master/misc/todo

Any help, support much appreciated!