coredbaccess.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2007-03-18
 * Description : Core database access wrapper.
 *
 * Copyright (C) 2007-2008 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 * Copyright (C) 2010-2022 by Gilles Caulier <caulier dot gilles at gmail dot com>
 *
 * This program is free software; you can redistribute it
 * and/or modify it under the terms of the GNU General
 * Public License as published by the Free Software Foundation;
 * either version 2, or (at your option)
 * any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * ============================================================ */
 
#ifndef DIGIKAM_CORE_DB_ACCESS_H
#define DIGIKAM_CORE_DB_ACCESS_H
 
// Local includes
 
#include "digikam_export.h"
#include "dbengineparameters.h"
 
namespace Digikam
{
 
class CoreDbBackend;
class CoreDB;
class CoreDbWatch;
class InitializationObserver;
class DbEngineErrorHandler;
class CoreDbAccessStaticPriv;
 
class DIGIKAM_DATABASE_EXPORT CoreDbAccess
{
public:
 
    enum ApplicationStatus
    {
        MainApplication,
        DatabaseSlave
    };
 
public:
 
    explicit CoreDbAccess();
    ~CoreDbAccess();
 
    CoreDB* db()             const;
 
    CoreDbBackend* backend() const;
 
    QString lastError();
 
    void setLastError(const QString& error);
 
public:
 
    static DbEngineParameters parameters();
 
    static void setParameters(const DbEngineParameters& parameters);
    static void setParameters(const DbEngineParameters& parameters, ApplicationStatus status);
 
    static bool checkReadyForUse(InitializationObserver* const observer = nullptr);
 
    static void cleanUpDatabase();
 
    static CoreDbWatch* databaseWatch();
 
    static void initDbEngineErrorHandler(DbEngineErrorHandler* const errorhandler);
 
private:
 
    // Disable
    explicit CoreDbAccess(bool);
 
    friend class CoreDbAccessUnlock;
    static CoreDbAccessStaticPriv* d;
};
 
// -----------------------------------------------------------------------------
 
class CoreDbAccessUnlock
{
public:
 
    CoreDbAccessUnlock();
    explicit CoreDbAccessUnlock(CoreDbAccess* const access);
    ~CoreDbAccessUnlock();
 
private:
 
    int count;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_CORE_DB_ACCESS_H