NAME

Search::Xapian - Perl XS frontend to the Xapian C++ search library.

SYNOPSIS

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();
}

DESCRIPTION

This module provides access to most of the classes in the xapian library, as well as 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 with this module, or reading through the xapian documentation on http://www.xapian.org/.

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).

EXPORT

None by default.

TODO

Error Handling

Error handling for all method liable to generate them.

Documentation

Brief descriptions of classes, possibly just adapted for xapian docs.

AUTHOR

Alex Bowley <kilinrax@cpan.org>

SEE ALSO

perl. xapian.