search::xapian::postingiterator(3pm) [debian man page]
Xapian::PostingIterator(3pm) User Contributed Perl Documentation Xapian::PostingIterator(3pm) NAME
Search::Xapian::PostingIterator - Iterate over the list of documents indexed by a term. DESCRIPTION
This iterator represents a stream of documents indexed by a term. It overloads "++" for advancing the iterator, or you can explicitly call the "inc" method. This class also overloads "eq", "ne", "==", "!=", and "" (stringification). METHODS
new Constructor. Defaults to an uninitialized iterator. clone inc Advance the iterator by one. (Called implictly by "++" overloading). skip_to <tname> Skip the iterator to term tname, or the first term after tname if tname isn't in the list of terms being iterated. get_docid Get the unique id of this document. get_wdf Return the wdf of the current term (if meaningful). positionlist_begin Return Search::Xapian::PositionIterator pointing to start of positionlist for current term. positionlist_end Return Search::Xapian::PositionIterator pointing to end of positionlist for current term. get_doclength Get the length of the document at the current position in the postlist. This information may be stored in the postlist, in which case this lookup should be extremely fast (indeed, not require further disk access). If the information is not present in the postlist, it will be retrieved from the database, at a greater performance cost. equal <term> Checks if a term is the same as this term. Also overloaded to the "eq" and "==" operators. nequal <term> Checks if a term is different from this term. Also overloaded to the "ne" and "!=" operators. get_description Return a description of this object. SEE ALSO
Search::Xapian,Search::Xapian::Database perl v5.14.2 2012-05-09 Xapian::PostingIterator(3pm)
Check Out this Related Man Page
Xapian::Database(3pm) User Contributed Perl Documentation Xapian::Database(3pm) NAME
Search::Xapian::Database - Search database object DESCRIPTION
This class represents a Xapian database for searching. See Search::Xapian::WritableDatabase for an object suitable for indexing. To perform searches, this class works with the Search::Xapian::Query object. METHODS
new <database> Class constructor. Can either take a path to an existing database or another database class as the first parameter clone Return a clone of this class. add_database Add an existing database (or group of databases) to those accessed by this object. reopen This re-opens the database(s) to the latest available version(s). It can be used either to make sure the latest results are returned, or to recover from a Xapian::DatabaseModifiedError. close Close the database. This also implies a commit() unless a transaction is in progress. enquire [<query>] Returns a new Search::Xapian::Enquire object. Any extra parameters are passed to set_query. get_doccount Returns the number of document indexed in this database. get_lastdocid Returns the id of the last used document. get_doclength <doc_id> Returns the length of a given document. get_document <doc_id> Returns a Search::Xapian::Document object for the given document. get_avlength Get the average length of the documents in the database. get_termfreq <term> Get the number of documents in the database indexed by a given term. term_exists <term> returns true if this term exists in the database, or false otherwise. get_description return a description of this object. get_spelling_suggestion returns a suggested spelling correction. allterms_begin [<prefix>] Returns a Search::Xapian::TermIterator iterating over the termlist for the the entire database. If the optional prefix argument is non-empty, only terms starting with that string are returned. allterms_end [<prefix>] Returns a Search::Xapian::TermIterator pointing to the end of the termlist corresponding to allterms_begin. termlist_begin <docid> Returns a Search::Xapian::TermIterator pointing to the start of the termlist for a given document. termlist_end <docid> Returns a Search::Xapian::TermIterator pointing to the end of the termlist for a given document. positionlist_begin <docid> <term> Returns a Search::Xapian::PositionIterator pointing to the start of the position list for a given term in the given document. positionlist_end <docid> <term> Returns a Search::Xapian::PositionIterator pointing to the end of the position list for a given term in the given document. postlist_begin <term> Returns a Search::Xapian::PostingIterator pointing to the start of the posting list for a given term. postlist_end <term> Returns a Search::Xapian::PostingIterator pointing to the end of the posting list for a given term. keep_alive Send a "keep-alive" to remote databases to stop them timing out. get_collection_freq <term> Get the number of elements indexed by a certain term. SEE ALSO
Search::Xapian,Search::Xapian::Enquire,Search::Xapian::WritableDatabase perl v5.14.2 2012-05-09 Xapian::Database(3pm)