.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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 turned on, 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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Xapian::Database 3pm"
.TH Xapian::Database 3pm "2014-10-21" "perl v5.20.1" "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 \fIcommit()\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 \*(L"keep-alive\*(R" 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