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 "Running 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 simplified, more '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.
Open a database, fail if database doesn't exist.
Create a new database, fail if database exists.
open the existing database, without destorying data, or create new.
overwrite database if it exists
Match if both subqueries are satisfied
Match if either subquery is satisfied.
Match if left but not right subquery is satisfied.
Match if left or right, but not both queries are satisfied.
Match if left is satisfied, but use weights from both.
Like OP_AND, but only weight using the left query.
Match if the words are near eachother. The window should be specified, as a parameter to Search::Xapian::Query::Query. but it defaults to the number of terms in the list.
Match as a phrase (All words in order).
Select an elite set from the subqueries, and perform a query with these combined as an OR query.
Standard is db + ops
Error handling for all methods liable to generate them.
Brief descriptions of classes, possibly just adapted from Xapian docs.
The following Xapian classes are not yet wrapped: Error (and subclasses), ErrorHandler, ExpandDecider (and subclasses), MatchDecider, Weight (and subclasses).
The following methods are not yet wrapped: Enquire::get_eset(...) with more than two arguments, Enquire::get_mset(...) with more than two arguments, Enquire::register_match_decider(...) with one argument, Enquire::set_weighting_scheme(const Weight &weight); Query::Query(tname, ...); with more than one argument, Query itor ctor optional "parameter" parameter, Remote::open(...), static Stem::get_available_languages().
We wrap ESet::back(), MSet::swap() and MSet::operator[](), but not MSet::back(), ESet::swap(), ESet::operator[]().
Tie MSet and ESet to allow them to just be used as lists?
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, Tim Brody for patches wrapping ::QueryParser and ::Stopper and especially Olly Betts <olly@survex.com> for contributing advice, bugfixes, and wrapper code for the more obscure classes.
Alex Bowley <kilinrax@cpan.org>
