Search::Xapian - Perl XS frontend to the Xapian C++ search library.
use Search::Xapian;
my $db = Search::Xapian::Database->new( '[DATABASE DIR]' );
my $enq = $db->enquire( '[QUERY TERM]' );
printf "Parsing query '%s'\n", $enq->get_query()->get_description();
my @matches = $enq->matches(0, 10);
print scalar(@matches) . " results found\n";
foreach my $match ( @matches ) {
my $doc = $match->get_document();
printf "ID %d %d%% [ %s ]\n", $match->get_docid(), $match->get_percent(), $doc->get_data();
}
This module wraps most methods of most Xapian classes. The missing classes and methods should be added in the future. It also provides a more simplified, 'perlish' interface - as demonstrated above.
The Xapian library is evolving very quickly at the time of writing, hence any documentation placed here would be likely to become out of date quite rapidly, and I do not have the patience to write some which could rapidly become redundant.
Apologies to those of you considering using this module. For the time being, I would suggest garnering what you can from the tests and examples provided, or reading through the Xapian documentation on http://www.xapian.org/, notably the API documentation at http://www.xapian.org/docs/apidoc/html/annotated.html
If you encounter problems, email either me or preferably the Xapian-discuss mailing list (which I am on - subscription details can be found on the Xapian web site).
None by default.
Error handling for all method liable to generate them.
Brief descriptions of classes, possibly just adapted for Xapian docs.
Thanks to Tye McQueen <tye@metronet.com> for explaining the finer points of how best to write XS frontends to C++ libraries, James Aylett <james@tartarus.org> for clarifying the less obvious aspects of the Xapian API, and especially Olly Betts <olly@survex.com> for contributing advice, bugfixes, and wrapper code for the more obsure classes.
Alex Bowley <kilinrax@cpan.org>
