xapiandatabase.h

/*
 * SPDX-FileCopyrightText: 2014 Vishesh Handa <me@vhanda.in>
 *
 * SPDX-License-Identifier: LGPL-2.1-or-later
 *
 */
 
#pragma once
 
#include "search_xapian_export.h"
#include <xapian.h>
 
#include <QList>
#include <QPair>
#include <QString>
 
namespace Akonadi
{
namespace Search
{
class XapianDocument;
 
/** Xapian database. */
class AKONADI_SEARCH_XAPIAN_EXPORT XapianDatabase
{
public:
    /**
     * Create the Xapian db at path \p path. The parameter \p
     * writeOnly locks the database as long as this object is
     * valid
     */
    explicit XapianDatabase(const QString &path, bool writeOnly = false);
    ~XapianDatabase();
 
    void replaceDocument(uint id, const Xapian::Document &doc);
    void replaceDocument(uint id, const XapianDocument &doc);
    void deleteDocument(uint id);
 
    /**
     * 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
     */
    void commit();
 
    [[nodiscard]] XapianDocument document(uint id);
 
    /**
     * A pointer to the actual db. Only use this when doing queries
     */
    Xapian::Database *db()
    {
        if (m_db) {
            m_db->reopen();
            return m_db;
        }
        return &m_wDb;
    }
 
    /**
     * Returns true if the XapianDatabase has changes which need to
     * be committed
     */
    [[nodiscard]] bool haveChanges() const;
 
private:
    Xapian::Database *m_db = nullptr;
    Xapian::WritableDatabase m_wDb;
 
    using DocIdPair = QPair<Xapian::docid, Xapian::Document>;
    QList<DocIdPair> m_docsToAdd;
    QList<uint> m_docsToRemove;
 
    std::string m_path;
    const bool m_writeOnly = false;
 
    AKONADI_SEARCH_XAPIAN_NO_EXPORT Xapian::WritableDatabase createWritableDb();
};
}
}