#include <database.h>
Inheritance diagram for Xapian::Database:
Public Member Functions | |
void | add_database (const Database &database) |
Add an existing database (or group of databases) to those accessed by this object. | |
Database () | |
Create a Database with no databases in. | |
Database (const std::string &path) | |
Open a Database, automatically determining the database backend to use. | |
Database (Internal *internal) | |
virtual | ~Database () |
Destroy this handle on the database. | |
Database (const Database &other) | |
Copying is allowed. | |
void | operator= (const Database &other) |
Assignment is allowed. | |
void | reopen () |
Re-open the database. | |
virtual std::string | get_description () const |
Introspection method. | |
PostingIterator | postlist_begin (const std::string &tname) const |
An iterator pointing to the start of the postlist for a given term. | |
PostingIterator | postlist_end (const std::string &) const |
Corresponding end iterator to postlist_begin(). | |
TermIterator | termlist_begin (Xapian::docid did) const |
An iterator pointing to the start of the termlist for a given document. | |
TermIterator | termlist_end (Xapian::docid) const |
Corresponding end iterator to termlist_begin(). | |
PositionIterator | positionlist_begin (Xapian::docid did, const std::string &tname) const |
An iterator pointing to the start of the position list for a given term in a given document. | |
PositionIterator | positionlist_end (Xapian::docid, const std::string &) const |
Corresponding end iterator to positionlist_begin(). | |
TermIterator | allterms_begin () const |
An iterator which runs across all terms in the database. | |
TermIterator | allterms_end () const |
Corresponding end iterator to allterms_begin(). | |
Xapian::doccount | get_doccount () const |
Get the number of documents in the database. | |
Xapian::docid | get_lastdocid () const |
Get the highest document id which has been used in the database. | |
Xapian::doclength | get_avlength () const |
Get the average length of the documents in the database. | |
Xapian::doccount | get_termfreq (const std::string &tname) const |
Get the number of documents in the database indexed by a given term. | |
bool | term_exists (const std::string &tname) const |
Check if a given term exists in the database. | |
Xapian::termcount | get_collection_freq (const std::string &tname) const |
Return the total number of occurrences of the given term. | |
Xapian::doclength | get_doclength (Xapian::docid did) const |
Get the length of a document. | |
void | keep_alive () |
Send a "keep-alive" to remote databases to stop them timing out. | |
Xapian::Document | get_document (Xapian::docid did) const |
Get a document from the database, given its document id. | |
Public Attributes | |
std::vector< Xapian::Internal::RefCntPtr< Internal > > | internal |
For searching, this class is used in conjunction with an Enquire object.
InvalidArgumentError | will be thrown if an invalid argument is supplied, for example, an unknown database type. | |
DatabaseOpeningError | may be thrown if the database cannot be opened (for example, a required file cannot be found). |
|
Create a Database with no databases in.
|
|
Open a Database, automatically determining the database backend to use.
|
|
Destroy this handle on the database. If there are no copies of this object remaining, the database(s) will be closed. |
|
Copying is allowed. The internals are reference counted, so copying is cheap. |
|
Add an existing database (or group of databases) to those accessed by this object.
|
|
An iterator which runs across all terms in the database.
|
|
Corresponding end iterator to allterms_begin().
|
|
Get the average length of the documents in the database.
|
|
Return the total number of occurrences of the given term. This is the sum of the number of ocurrences of the term in each document it indexes: ie, the sum of the within document frequencies of the term.
|
|
Introspection method.
Reimplemented in Xapian::WritableDatabase. |
|
Get the number of documents in the database.
|
|
Get the length of a document.
|
|
Get a document from the database, given its document id. This method returns a Xapian::Document object which provides the information about a document.
|
|
Get the highest document id which has been used in the database.
|
|
Get the number of documents in the database indexed by a given term.
|
|
Send a "keep-alive" to remote databases to stop them timing out.
|
|
Assignment is allowed. The internals are reference counted, so assignment is cheap. |
|
An iterator pointing to the start of the position list for a given term in a given document.
|
|
Corresponding end iterator to positionlist_begin().
|
|
An iterator pointing to the start of the postlist for a given term.
|
|
Corresponding end iterator to postlist_begin().
|
|
Re-open the database. 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. |
|
Check if a given term exists in the database. Return true if and only if the term exists in the database. This is the same as (get_termfreq(tname) != 0), but will often be more efficient. |
|
An iterator pointing to the start of the termlist for a given document.
|
|
Corresponding end iterator to termlist_begin().
|