Akonadi::Search::XapianDatabase
#include <xapiandatabase.h>
Public Member Functions | |
XapianDatabase (const QString &path, bool writeOnly=false) | |
void | commit () |
Xapian::Database * | db () |
void | deleteDocument (uint id) |
XapianDocument | document (uint id) |
bool | haveChanges () const |
void | replaceDocument (uint id, const Xapian::Document &doc) |
void | replaceDocument (uint id, const XapianDocument &doc) |
Detailed Description
Xapian database.
Definition at line 24 of file xapiandatabase.h.
Constructor & Destructor Documentation
◆ XapianDatabase()
|
explicit |
Create the Xapian db at path path
.
The parameter writeOnly
locks the database as long as this object is valid
Definition at line 23 of file xapiandatabase.cpp.
◆ ~XapianDatabase()
XapianDatabase::~XapianDatabase | ( | ) |
Definition at line 45 of file xapiandatabase.cpp.
Member Function Documentation
◆ commit()
void XapianDatabase::commit | ( | ) |
Commit all the pending changes.
This may not commit at this instance as the db might be locked by another process It emits the committed signal on completion
Definition at line 88 of file xapiandatabase.cpp.
◆ db()
|
inline |
A pointer to the actual db.
Only use this when doing queries
Definition at line 51 of file xapiandatabase.h.
◆ deleteDocument()
void XapianDatabase::deleteDocument | ( | uint | id | ) |
Definition at line 67 of file xapiandatabase.cpp.
◆ document()
|
nodiscard |
Definition at line 137 of file xapiandatabase.cpp.
◆ haveChanges()
|
nodiscard |
Returns true if the XapianDatabase has changes which need to be committed.
Definition at line 83 of file xapiandatabase.cpp.
◆ replaceDocument() [1/2]
void XapianDatabase::replaceDocument | ( | uint | id, |
const Xapian::Document & | doc ) |
Definition at line 55 of file xapiandatabase.cpp.
◆ replaceDocument() [2/2]
void XapianDatabase::replaceDocument | ( | uint | id, |
const XapianDocument & | doc ) |
Definition at line 50 of file xapiandatabase.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Mon Nov 4 2024 16:37:50 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.