Public Member Functions | Static Public Member Functions | List of all members
Xapian::Database Class Reference

This class is used to access a database, or a group of databases. More...

+ 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. More...
 
 Database ()
 Create a Database with no databases in.
 
 Database (const std::string &path, int flags=0)
 Open a Database, automatically determining the database backend to use. More...
 
 Database (int fd, int flags=0)
 Open a single-file Database. More...
 
virtual ~Database ()
 Destroy this handle on the database. More...
 
 Database (const Database &other)
 Copying is allowed. More...
 
void operator= (const Database &other)
 Assignment is allowed. More...
 
bool reopen ()
 Re-open the database. More...
 
virtual void close ()
 Close the database. More...
 
virtual std::string get_description () const
 Return a string describing this object.
 
PostingIterator postlist_begin (const std::string &tname) const
 An iterator pointing to the start of the postlist for a given term. More...
 
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. More...
 
TermIterator termlist_end (Xapian::docid) const
 Corresponding end iterator to termlist_begin().
 
bool has_positions () const
 Does this database have any positional information?
 
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 std::string &prefix=std::string()) const
 An iterator which runs across all terms with a given prefix. More...
 
TermIterator allterms_end (const std::string &=std::string()) const
 Corresponding end iterator to allterms_begin(prefix).
 
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::totallength get_total_length () const
 Get the total length of all the documents in the database. More...
 
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. More...
 
Xapian::termcount get_collection_freq (const std::string &tname) const
 Return the total number of occurrences of the given term. More...
 
Xapian::doccount get_value_freq (Xapian::valueno slot) const
 Return the frequency of a given value slot. More...
 
std::string get_value_lower_bound (Xapian::valueno slot) const
 Get a lower bound on the values stored in the given value slot. More...
 
std::string get_value_upper_bound (Xapian::valueno slot) const
 Get an upper bound on the values stored in the given value slot. More...
 
Xapian::termcount get_doclength_lower_bound () const
 Get a lower bound on the length of a document in this DB. More...
 
Xapian::termcount get_doclength_upper_bound () const
 Get an upper bound on the length of a document in this DB.
 
Xapian::termcount get_wdf_upper_bound (const std::string &term) const
 Get an upper bound on the wdf of term term.
 
ValueIterator valuestream_begin (Xapian::valueno slot) const
 Return an iterator over the value in slot slot for each document.
 
ValueIterator valuestream_end (Xapian::valueno) const
 Return end iterator corresponding to valuestream_begin().
 
Xapian::termcount get_doclength (Xapian::docid did) const
 Get the length of a document.
 
Xapian::termcount get_unique_terms (Xapian::docid did) const
 Get the number of unique terms in document.
 
void keep_alive ()
 Send a "keep-alive" to remote databases to stop them timing out. More...
 
Xapian::Document get_document (Xapian::docid did) const
 Get a document from the database, given its document id. More...
 
Xapian::Document get_document (Xapian::docid did, unsigned flags) const
 Get a document from the database, given its document id. More...
 
std::string get_spelling_suggestion (const std::string &word, unsigned max_edit_distance=2) const
 Suggest a spelling correction. More...
 
Xapian::TermIterator spellings_begin () const
 An iterator which returns all the spelling correction targets. More...
 
Xapian::TermIterator spellings_end () const
 Corresponding end iterator to spellings_begin().
 
Xapian::TermIterator synonyms_begin (const std::string &term) const
 An iterator which returns all the synonyms for a given term. More...
 
Xapian::TermIterator synonyms_end (const std::string &) const
 Corresponding end iterator to synonyms_begin(term).
 
Xapian::TermIterator synonym_keys_begin (const std::string &prefix=std::string()) const
 An iterator which returns all terms which have synonyms. More...
 
Xapian::TermIterator synonym_keys_end (const std::string &=std::string()) const
 Corresponding end iterator to synonym_keys_begin(prefix).
 
std::string get_metadata (const std::string &key) const
 Get the user-specified metadata associated with a given key. More...
 
Xapian::TermIterator metadata_keys_begin (const std::string &prefix=std::string()) const
 An iterator which returns all user-specified metadata keys. More...
 
Xapian::TermIterator metadata_keys_end (const std::string &=std::string()) const
 Corresponding end iterator to metadata_keys_begin().
 
std::string get_uuid () const
 Get a UUID for the database. More...
 
bool locked () const
 Test if this database is currently locked for writing. More...
 
Xapian::rev get_revision () const
 Get the revision of the database. More...
 
void compact (const std::string &output, unsigned flags=0, int block_size=0)
 Produce a compact version of this database. More...
 
void compact (int fd, unsigned flags=0, int block_size=0)
 Produce a compact version of this database. More...
 
void compact (const std::string &output, unsigned flags, int block_size, Xapian::Compactor &compactor)
 Produce a compact version of this database. More...
 
void compact (int fd, unsigned flags, int block_size, Xapian::Compactor &compactor)
 Produce a compact version of this database. More...
 

Static Public Member Functions

static size_t check (const std::string &path, int opts=0, std::ostream *out=NULL)
 Check the integrity of a database or database table. More...
 
static size_t check (int fd, int opts=0, std::ostream *out=NULL)
 Check the integrity of a single file database. More...
 

Detailed Description

This class is used to access a database, or a group of databases.

For searching, this class is used in conjunction with an Enquire object.

Exceptions
InvalidArgumentErrorwill be thrown if an invalid argument is supplied, for example, an unknown database type.
DatabaseOpeningErrormay be thrown if the database cannot be opened (for example, a required file cannot be found).
DatabaseVersionErrormay be thrown if the database is in an unsupported format (for example, created by a newer version of Xapian which uses an incompatible format).

Constructor & Destructor Documentation

◆ Database() [1/3]

Xapian::Database::Database ( const std::string &  path,
int  flags = 0 
)
explicit

Open a Database, automatically determining the database backend to use.

Parameters
pathdirectory that the database is stored in.
flagsBitwise-or of Xapian::DB_* constants.

◆ Database() [2/3]

Xapian::Database::Database ( int  fd,
int  flags = 0 
)
explicit

Open a single-file Database.

This method opens a single-file Database given a file descriptor open on it. Xapian looks starting at the current file offset, allowing a single file database to be easily embedded within another file.

Parameters
fdfile descriptor for the file. Xapian takes ownership of this and will close it when the database is closed.
flagsBitwise-or of Xapian::DB_* constants.

◆ ~Database()

virtual Xapian::Database::~Database ( )
virtual

Destroy this handle on the database.

If there are no copies of this object remaining, the database(s) will be closed.

◆ Database() [3/3]

Xapian::Database::Database ( const Database other)

Copying is allowed.

The internals are reference counted, so copying is cheap.

Parameters
otherThe object to copy.

Member Function Documentation

◆ add_database()

void Xapian::Database::add_database ( const Database database)

Add an existing database (or group of databases) to those accessed by this object.

Parameters
databasethe database(s) to add.

◆ allterms_begin()

TermIterator Xapian::Database::allterms_begin ( const std::string &  prefix = std::string()) const

An iterator which runs across all terms with a given prefix.

Parameters
prefixThe prefix to restrict the returned terms to (default: iterate all terms)

◆ check() [1/2]

static size_t Xapian::Database::check ( const std::string &  path,
int  opts = 0,
std::ostream *  out = NULL 
)
inlinestatic

Check the integrity of a database or database table.

Parameters
pathPath to database or table
optsOptions to use for check
outstd::ostream to write output to (NULL for no output)

◆ check() [2/2]

static size_t Xapian::Database::check ( int  fd,
int  opts = 0,
std::ostream *  out = NULL 
)
inlinestatic

Check the integrity of a single file database.

Parameters
fdfile descriptor for the database. The current file offset is used, allowing checking a single file database which is embedded within another file. Xapian takes ownership of the file descriptor and will close it before returning.
optsOptions to use for check
outstd::ostream to write output to (NULL for no output)

◆ close()

virtual void Xapian::Database::close ( )
virtual

Close the database.

This closes the database and closes all its file handles.

For a WritableDatabase, if a transaction is active it will be aborted, while if no transaction is active commit() will be implicitly called. Also the write lock is released.

Closing a database cannot be undone - in particular, calling reopen() after close() will not reopen it, but will instead throw a Xapian::DatabaseError exception.

Calling close() again on a database which has already been closed has no effect (and doesn't raise an exception).

After close() has been called, calls to other methods of the database, and to methods of other objects associated with the database, will either:

  • behave exactly as they would have done if the database had not been closed (this can only happen if all the required data is cached)
  • raise a Xapian::DatabaseError exception indicating that the database is closed.

The reason for this behaviour is that otherwise we'd have to check that the database is still open on every method call on every object associated with a Database, when in many cases they are working on data which has already been loaded and so they are able to just behave correctly.

This method was added in Xapian 1.1.0.

◆ compact() [1/4]

void Xapian::Database::compact ( const std::string &  output,
unsigned  flags = 0,
int  block_size = 0 
)
inline

Produce a compact version of this database.

New 1.3.4. Various methods of the Compactor class were deprecated in 1.3.4.

Parameters
outputPath to write the compact version to. This can be the same as an input if that input is a stub database (in which case the database(s) listed in the stub will be compacted to a new database and then the stub will be atomically updated to point to this new database).
flagsAny of the following combined using bitwise-or (| in C++):
  • Xapian::DBCOMPACT_NO_RENUMBER By default the document ids will be renumbered the output - currently by applying the same offset to all the document ids in a particular source database. If this flag is specified, then this renumbering doesn't happen, but all the document ids must be unique over all source databases. Currently the ranges of document ids in each source must not overlap either, though this restriction may be removed in the future.
  • Xapian::DBCOMPACT_MULTIPASS If merging more than 3 databases, merge the postlists in multiple passes, which is generally faster but requires more disk space for temporary files.
  • Xapian::DBCOMPACT_SINGLE_FILE Produce a single-file database (only supported for glass currently).
  • At most one of:
block_sizeThis specifies the block size (in bytes) for to use for the output. For glass, the block size must be a power of 2 between 2048 and 65536 (inclusive), and the default (also used if an invalid value is passed) is 8192 bytes.

◆ compact() [2/4]

void Xapian::Database::compact ( int  fd,
unsigned  flags = 0,
int  block_size = 0 
)
inline

Produce a compact version of this database.

New 1.3.4. Various methods of the Compactor class were deprecated in 1.3.4.

This variant writes a single-file database to the specified file descriptor. Only the glass backend supports such databases, so this form is only supported for this backend.

Parameters
fdFile descriptor to write the compact version to. The descriptor needs to be readable and writable (open with O_RDWR) and seekable. The current file offset is used, allowing compacting to a single file database embedded within another file. Xapian takes ownership of the file descriptor and will close it before returning.
flagsAny of the following combined using bitwise-or (| in C++):
  • Xapian::DBCOMPACT_NO_RENUMBER By default the document ids will be renumbered the output - currently by applying the same offset to all the document ids in a particular source database. If this flag is specified, then this renumbering doesn't happen, but all the document ids must be unique over all source databases. Currently the ranges of document ids in each source must not overlap either, though this restriction may be removed in the future.
  • Xapian::DBCOMPACT_MULTIPASS If merging more than 3 databases, merge the postlists in multiple passes, which is generally faster but requires more disk space for temporary files.
  • Xapian::DBCOMPACT_SINGLE_FILE Produce a single-file database (only supported for glass currently) - this flag is implied in this form and need not be specified explicitly.
block_sizeThis specifies the block size (in bytes) for to use for the output. For glass, the block size must be a power of 2 between 2048 and 65536 (inclusive), and the default (also used if an invalid value is passed) is 8192 bytes.

◆ compact() [3/4]

void Xapian::Database::compact ( const std::string &  output,
unsigned  flags,
int  block_size,
Xapian::Compactor compactor 
)
inline

Produce a compact version of this database.

New 1.3.4. Various methods of the Compactor class were deprecated in 1.3.4.

The compactor functor allows handling progress output and specifying how user metadata is merged.

Parameters
outputPath to write the compact version to. This can be the same as an input if that input is a stub database (in which case the database(s) listed in the stub will be compacted to a new database and then the stub will be atomically updated to point to this new database).
flagsAny of the following combined using bitwise-or (| in C++):
  • Xapian::DBCOMPACT_NO_RENUMBER By default the document ids will be renumbered the output - currently by applying the same offset to all the document ids in a particular source database. If this flag is specified, then this renumbering doesn't happen, but all the document ids must be unique over all source databases. Currently the ranges of document ids in each source must not overlap either, though this restriction may be removed in the future.
  • Xapian::DBCOMPACT_MULTIPASS If merging more than 3 databases, merge the postlists in multiple passes, which is generally faster but requires more disk space for temporary files.
  • Xapian::DBCOMPACT_SINGLE_FILE Produce a single-file database (only supported for glass currently).
block_sizeThis specifies the block size (in bytes) for to use for the output. For glass, the block size must be a power of 2 between 2048 and 65536 (inclusive), and the default (also used if an invalid value is passed) is 8192 bytes.
compactorFunctor

◆ compact() [4/4]

void Xapian::Database::compact ( int  fd,
unsigned  flags,
int  block_size,
Xapian::Compactor compactor 
)
inline

Produce a compact version of this database.

New 1.3.4. Various methods of the Compactor class were deprecated in 1.3.4.

The compactor functor allows handling progress output and specifying how user metadata is merged.

This variant writes a single-file database to the specified file descriptor. Only the glass backend supports such databases, so this form is only supported for this backend.

Parameters
fdFile descriptor to write the compact version to. The descriptor needs to be readable and writable (open with O_RDWR) and seekable. The current file offset is used, allowing compacting to a single file database embedded within another file. Xapian takes ownership of the file descriptor and will close it before returning.
flagsAny of the following combined using bitwise-or (| in C++):
  • Xapian::DBCOMPACT_NO_RENUMBER By default the document ids will be renumbered the output - currently by applying the same offset to all the document ids in a particular source database. If this flag is specified, then this renumbering doesn't happen, but all the document ids must be unique over all source databases. Currently the ranges of document ids in each source must not overlap either, though this restriction may be removed in the future.
  • Xapian::DBCOMPACT_MULTIPASS If merging more than 3 databases, merge the postlists in multiple passes, which is generally faster but requires more disk space for temporary files.
  • Xapian::DBCOMPACT_SINGLE_FILE Produce a single-file database (only supported for glass currently) - this flag is implied in this form and need not be specified explicitly.
block_sizeThis specifies the block size (in bytes) for to use for the output. For glass, the block size must be a power of 2 between 2048 and 65536 (inclusive), and the default (also used if an invalid value is passed) is 8192 bytes.
compactorFunctor

◆ get_collection_freq()

Xapian::termcount Xapian::Database::get_collection_freq ( const std::string &  tname) const

Return the total number of occurrences of the given term.

This is the sum of the number of occurrences of the term in each document it indexes: i.e., the sum of the within document frequencies of the term.

Parameters
tnameThe term whose collection frequency is being requested.

◆ get_doclength_lower_bound()

Xapian::termcount Xapian::Database::get_doclength_lower_bound ( ) const

Get a lower bound on the length of a document in this DB.

This bound does not include any zero-length documents.

◆ get_document() [1/2]

Xapian::Document Xapian::Database::get_document ( Xapian::docid  did) const

Get a document from the database, given its document id.

This method returns a Xapian::Document object which provides the information about a document.

Parameters
didThe document id of the document to retrieve.
Returns
A Xapian::Document object containing the document data
Exceptions
Xapian::DocNotFoundErrorThe document specified could not be found in the database.
Xapian::InvalidArgumentErrordid was 0, which is not a valid document id.

◆ get_document() [2/2]

Xapian::Document Xapian::Database::get_document ( Xapian::docid  did,
unsigned  flags 
) const

Get a document from the database, given its document id.

This method returns a Xapian::Document object which provides the information about a document.

Parameters
didThe document id of the document to retrieve.
flagsZero or more flags bitwise-or-ed together (currently only Xapian::DOC_ASSUME_VALID is supported).
Returns
A Xapian::Document object containing the document data
Exceptions
Xapian::DocNotFoundErrorThe document specified could not be found in the database.
Xapian::InvalidArgumentErrordid was 0, which is not a valid document id.

◆ get_metadata()

std::string Xapian::Database::get_metadata ( const std::string &  key) const

Get the user-specified metadata associated with a given key.

User-specified metadata allows you to store arbitrary information in the form of (key, value) pairs. See WritableDatabase::set_metadata() for more information.

When invoked on a Xapian::Database object representing multiple databases, currently only the metadata for the first is considered but this behaviour may change in the future.

If there is no piece of metadata associated with the specified key, an empty string is returned (this applies even for backends which don't support metadata).

Empty keys are not valid, and specifying one will cause an exception.

Parameters
keyThe key of the metadata item to access.
Returns
The retrieved metadata item's value.
Exceptions
Xapian::InvalidArgumentErrorwill be thrown if the key supplied is empty.

◆ get_revision()

Xapian::rev Xapian::Database::get_revision ( ) const

Get the revision of the database.

The revision is an unsigned integer which increases with each commit.

The database must have exactly one sub-database, which must be of type chert or glass. Otherwise an exception will be thrown.

Experimental - see https://xapian.org/docs/deprecation#experimental-features

◆ get_spelling_suggestion()

std::string Xapian::Database::get_spelling_suggestion ( const std::string &  word,
unsigned  max_edit_distance = 2 
) const

Suggest a spelling correction.

Parameters
wordThe potentially misspelled word.
max_edit_distanceOnly consider words which are at most max_edit_distance edits from word. An edit is a character insertion, deletion, or the transposition of two adjacent characters (default is 2).

◆ get_total_length()

Xapian::totallength Xapian::Database::get_total_length ( ) const

Get the total length of all the documents in the database.

Added in Xapian 1.4.5.

◆ get_uuid()

std::string Xapian::Database::get_uuid ( ) const

Get a UUID for the database.

The UUID will persist for the lifetime of the database.

Replicas (eg, made with the replication protocol, or by copying all the database files) will have the same UUID. However, copies (made with copydatabase, or xapian-compact) will have different UUIDs.

If the backend does not support UUIDs or this database has no subdatabases, the UUID will be empty.

If this database has multiple sub-databases, the UUID string will contain the UUIDs of all the sub-databases.

◆ get_value_freq()

Xapian::doccount Xapian::Database::get_value_freq ( Xapian::valueno  slot) const

Return the frequency of a given value slot.

This is the number of documents which have a (non-empty) value stored in the slot.

Parameters
slotThe value slot to examine.

◆ get_value_lower_bound()

std::string Xapian::Database::get_value_lower_bound ( Xapian::valueno  slot) const

Get a lower bound on the values stored in the given value slot.

If there are no values stored in the given value slot, this will return an empty string.

Parameters
slotThe value slot to examine.

◆ get_value_upper_bound()

std::string Xapian::Database::get_value_upper_bound ( Xapian::valueno  slot) const

Get an upper bound on the values stored in the given value slot.

If there are no values stored in the given value slot, this will return an empty string.

Parameters
slotThe value slot to examine.

◆ keep_alive()

void Xapian::Database::keep_alive ( )

Send a "keep-alive" to remote databases to stop them timing out.

Has no effect on non-remote databases.

◆ locked()

bool Xapian::Database::locked ( ) const

Test if this database is currently locked for writing.

If the underlying object is actually a WritableDatabase, always returns true.

Otherwise tests if there's a writer holding the lock (or if we can't test for a lock without taking it on the current platform, throw Xapian::UnimplementedError). If there's an error while trying to test the lock, throws Xapian::DatabaseLockError.

For multi-databases, this tests each sub-database and returns true if any of them are locked.

◆ metadata_keys_begin()

Xapian::TermIterator Xapian::Database::metadata_keys_begin ( const std::string &  prefix = std::string()) const

An iterator which returns all user-specified metadata keys.

When invoked on a Xapian::Database object representing multiple databases, currently only the metadata for the first is considered but this behaviour may change in the future.

If the backend doesn't support metadata, then this method returns an iterator which compares equal to that returned by metadata_keys_end().

Parameters
prefixIf non-empty, only keys with this prefix are returned.
Exceptions
Xapian::UnimplementedErrorwill be thrown if the backend implements user-specified metadata, but doesn't implement iterating its keys (currently this happens for the InMemory backend).

◆ operator=()

void Xapian::Database::operator= ( const Database other)

Assignment is allowed.

The internals are reference counted, so assignment is cheap.

Parameters
otherThe object to copy.

◆ postlist_begin()

PostingIterator Xapian::Database::postlist_begin ( const std::string &  tname) const

An iterator pointing to the start of the postlist for a given term.

Parameters
tnameThe termname to iterate postings for. If the term name is the empty string, the iterator returned will list all the documents in the database. Such an iterator will always return a WDF value of 1, since there is no obvious meaning for this quantity in this case.

◆ reopen()

bool Xapian::Database::reopen ( )

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.

Calling reopen() on a database which has been closed (with close()) will always raise a Xapian::DatabaseError.

Returns
true if the database might have been reopened (if false is returned, the database definitely hasn't been reopened, which applications may find useful when caching results, etc). In Xapian < 1.3.0, this method did not return a value.

◆ spellings_begin()

Xapian::TermIterator Xapian::Database::spellings_begin ( ) const

An iterator which returns all the spelling correction targets.

This returns all the words which are considered as targets for the spelling correction algorithm. The frequency of each word is available as the term frequency of each entry in the returned iterator.

◆ synonym_keys_begin()

Xapian::TermIterator Xapian::Database::synonym_keys_begin ( const std::string &  prefix = std::string()) const

An iterator which returns all terms which have synonyms.

Parameters
prefixIf non-empty, only terms with this prefix are returned.

◆ synonyms_begin()

Xapian::TermIterator Xapian::Database::synonyms_begin ( const std::string &  term) const

An iterator which returns all the synonyms for a given term.

Parameters
termThe term to return synonyms for.

◆ term_exists()

bool Xapian::Database::term_exists ( const std::string &  tname) const

Check if a given term exists in the database.

Parameters
tnameThe term to test the existence of.
Returns
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.

◆ termlist_begin()

TermIterator Xapian::Database::termlist_begin ( Xapian::docid  did) const

An iterator pointing to the start of the termlist for a given document.

Parameters
didThe document id of the document to iterate terms for.

The documentation for this class was generated from the following file:

Documentation for Xapian (version 1.4.9).
Generated on Sat Nov 3 2018 by Doxygen 1.8.13.