.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Xapian::Database 3pm"
.TH Xapian::Database 3pm 2024-03-08 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Search::Xapian::Database \- Search database object
.SH DESCRIPTION
.IX Header "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.
.SH METHODS
.IX Header "METHODS"
.IP "new <database>" 4
.IX Item "new <database>"
Class constructor. Can either take a path to an existing database
or another database class as the first parameter
.IP clone 4
.IX Item "clone"
Return a clone of this class.
.IP add_database 4
.IX Item "add_database"
Add an existing database (or group of databases) to those accessed by this
object.
.IP reopen 4
.IX Item "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.
.IP close 4
.IX Item "close"
Close the database. This also implies a \fBcommit()\fR unless a transaction is in
progress.
.IP "enquire [<query>]" 4
.IX Item "enquire [<query>]"
Returns a new Search::Xapian::Enquire object. Any extra
parameters are passed to set_query.
.IP get_doccount 4
.IX Item "get_doccount"
Returns the number of document indexed in this database.
.IP get_lastdocid 4
.IX Item "get_lastdocid"
Returns the id of the last used document.
.IP "get_doclength <doc_id>" 4
.IX Item "get_doclength <doc_id>"
Returns the length of a given document.
.IP "get_document <doc_id>" 4
.IX Item "get_document <doc_id>"
Returns a Search::Xapian::Document object for the given document.
.IP get_avlength 4
.IX Item "get_avlength"
Get the average length of the documents in the database.
.IP "get_termfreq <term>" 4
.IX Item "get_termfreq <term>"
Get the number of documents in the database indexed by a given term.
.IP "term_exists <term>" 4
.IX Item "term_exists <term>"
returns true if this term exists in the database, or false otherwise.
.IP get_description 4
.IX Item "get_description"
return a description of this object.
.IP get_spelling_suggestion 4
.IX Item "get_spelling_suggestion"
returns a suggested spelling correction.
.IP "allterms_begin [<prefix>]" 4
.IX Item "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.
.IP "allterms_end [<prefix>]" 4
.IX Item "allterms_end [<prefix>]"
Returns a Search::Xapian::TermIterator pointing to the end of the
termlist corresponding to allterms_begin.
.IP "termlist_begin <docid>" 4
.IX Item "termlist_begin <docid>"
Returns a Search::Xapian::TermIterator pointing to the start of the
termlist for a given document.
.IP "termlist_end <docid>" 4
.IX Item "termlist_end <docid>"
Returns a Search::Xapian::TermIterator pointing to the end of the
termlist for a given document.
.IP "positionlist_begin <docid> <term>" 4
.IX Item "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.
.IP "positionlist_end <docid> <term>" 4
.IX Item "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.
.IP "postlist_begin <term>" 4
.IX Item "postlist_begin <term>"
Returns a Search::Xapian::PostingIterator pointing to the
start of the posting list for a given term.
.IP "postlist_end <term>" 4
.IX Item "postlist_end <term>"
Returns a Search::Xapian::PostingIterator pointing to the
end of the posting list for a given term.
.IP keep_alive 4
.IX Item "keep_alive"
Send a "keep-alive" to remote databases to stop them timing out.
.IP "get_collection_freq <term>" 4
.IX Item "get_collection_freq <term>"
Get the number of elements indexed by a certain term.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Search::Xapian,
Search::Xapian::Enquire,
Search::Xapian::WritableDatabase