Search::Xapian::Enquire - Make queries against a database
This class provides an interface to the information retrieval system for the purpose of searching.
takes either a ready made Search::Xapian::Query or a scalar containing a query, which in that case will be passed to Search::Xapian::Query's constructor, together with any other passed arguments.
Takes the start element, and maximum number of elements (and optionally the minimum number of matches to check), and returns an array tied to Search::Xapian::MSet::Tied.
Returns a Search::Xapian::TermIterator, pointing to the start of the stream.
Returns a Search::Xapian::TermIterator, pointing to the end of the stream.
Set the direction in which documents are ordered by document id in the returned MSet.
This order only has an effect on documents which would otherwise have equal rank. For a weighted probabilistic match with no sort value, this means documents with equal weight. For a boolean match, with no sort value, this means all documents. And if a sort value is used, this means documents with equal sort value (and also equal weight if ordering on relevance after the sort).
order can be ENQ_ASCENDING (the default, docids sort in ascending order), ENQ_DESCENDING (docds sort in descending order), or ENQ_DONT_CARE (docids sort in whatever order is most efficient for the backend.)
Note: If you add documents in strict date order, then a boolean search - i.e. set_weighting_scheme(Search::Xapian::BoolWeight->new()) - with set_docid_order(ENQ_DESCENDING) is a very efficient way to perform "sort by date, newest first".
Set the sorting to be by relevance only. This is the default.
Set the sorting to be by value only.
sort_key - value number to reorder on. Sorting is with a string compare. If ascending is true (the default) higher is better; if ascending is false, lower is better.
ascending - If true, document values which sort higher by string compare are better. If false, the sort order is reversed. (default true)
Set the sorting to be by value, then by relevance for documents with the same value.
Set the sorting to be by relevance then value.
Note that with the default BM25 weighting scheme parameters, non-identical documents will rarely have the same weight, so this setting will give very similar results to set_sort_by_relevance(). It becomes more useful with particular BM25 parameter settings (e.g. BM25Weight(1,0,1,0,0)) or custom weighting schemes.
Set the sorting to be by key only.
sorter - the functor to use to build the key.
ascending - If true, keys which sort higher by string compare are better. If false, the sort order is reversed. (default true)
Set the sorting to be by key, then by relevance for documents with the same key.
Set the sorting to be by relevance then key.
Get match set.
Get set of query expansion terms.
Return a description of this object.
Add a matchspy.
This matchspy will be called with some of the documents which match the query, during the match process.
Remove all the matchspies.
Search::Xapian::Query, Search::Xapian::Database, Search::Xapian::MatchSpy
To install Search::Xapian, copy and paste the appropriate command in to your terminal.
perl -MCPAN -e shell
For more information on module installation, please visit the detailed CPAN module installation guide.