isqldb.h

Go to the documentation of this file.

/*
 * Copyright (C) 2018-2025 QuasarApp.
 * Distributed under the lgplv3 software license, see the accompanying
 * Everyone is permitted to copy and distribute verbatim copies
 * of this license document, but changing it is not allowed.
*/
 
#ifndef ISQLDB_H
#define ISQLDB_H
 
#include "iobjectprovider.h"
 
#include <QMap>
#include <QHash>
#include <QSet>
#include <QVariantMap>
#include <QMutex>
#include "config.h"
#include "softdelete.h"
 
namespace QH {
 
class SqlDBWriter;
class DbAddress;

enum class SqlDBCasheWriteMode: int {
    Default = 0x0,
    On_New_Thread = 0x1,
    Force = 0x2,
} ;

enum class CacheAction: int {
    None,
    Insert,
    Update,
    Delete
};

class HEARTSHARED_EXPORT ISqlDB: public QObject, public iObjectProvider, public SoftDelete
{
    Q_OBJECT
 
public:
    ISqlDB(qint64 updateInterval = DEFAULT_UPDATE_INTERVAL,
           SqlDBCasheWriteMode mode = SqlDBCasheWriteMode::Default);
    ~ISqlDB() override;

    SqlDBWriter* writer() const;

    void setWriter(SqlDBWriter* writer);
 
    bool getAllObjects(const PKG::DBObject &templateObject,
                       QList<QSharedPointer<QH::PKG::DBObject>> &result) override;
 
    bool updateObject(const QSharedPointer<QH::PKG::DBObject>& saveObject,
                      bool wait = false) override;
    bool deleteObject(const QSharedPointer<QH::PKG::DBObject>& delObj,
                      bool wait = false) override;
    bool insertObject(const QSharedPointer<QH::PKG::DBObject>& saveObject,
                      bool wait = false,
                      const QWeakPointer<unsigned int>& autoincrementIdResult = {}) override;
 
    bool replaceObject(const QSharedPointer<QH::PKG::DBObject>& saveObject,
                       bool wait = false) override;
 
    bool doQuery(const QString &query, const QVariantMap& bindValues,
                 bool wait = false, QSqlQuery* result = nullptr) const override;
 
    bool doSql(const QString &sqlFile, bool wait) const override;

    bool changeObjects(const PKG::DBObject &templateObject,
                       const std::function<bool (const QSharedPointer<PKG::DBObject> &)> &changeAction);
    qint64 getUpdateInterval() const;

    void setUpdateInterval(const qint64 &value);

    virtual bool init(const QString &initDbParams = "");

    virtual bool init(const QVariantMap &params);
 
    void setSQLSources(const QStringList &list) override;
 
protected:
    void prepareForDelete() override;

    qint64 getLastUpdateTime() const;

    void setLastUpdateTime(const qint64 &value);

    virtual void deleteFromCache(const QSharedPointer<QH::PKG::DBObject> &delObj) = 0;

    virtual bool insertToCache(const QSharedPointer<QH::PKG::DBObject> &obj)  = 0;

    virtual bool updateCache(const QSharedPointer<QH::PKG::DBObject> &obj) = 0;

    virtual QList<QSharedPointer<QH::PKG::DBObject>>
    getFromCache(const PKG::DBObject *obj) = 0;

    virtual void pushToQueue(const QSharedPointer<QH::PKG::DBObject> &obj,
                             CacheAction type);

    SqlDBCasheWriteMode getMode() const;

    void setMode(const SqlDBCasheWriteMode &mode);

    virtual void globalUpdateDataBasePrivate(qint64 currentTime);

    virtual void globalUpdateDataBase(SqlDBCasheWriteMode mode = SqlDBCasheWriteMode::Default);
 
private:
 
    bool updateObjectP(const QSharedPointer<QH::PKG::DBObject>& saveObject,
                       bool wait = false);
    bool deleteObjectP(const QSharedPointer<QH::PKG::DBObject>& delObj,
                       bool wait = false);
    bool insertObjectP(const QSharedPointer<QH::PKG::DBObject>& saveObject,
                       bool wait,
                       const QWeakPointer<unsigned int>& autoincrementIdResult);
    bool replaceObjectP(const QSharedPointer<QH::PKG::DBObject>& saveObject,
                        bool wait = false);
 
    qint64 lastUpdateTime = 0;
    qint64 updateInterval = DEFAULT_UPDATE_INTERVAL;
 
    SqlDBCasheWriteMode _mode;
 
    SqlDBWriter* _writer = nullptr;
 
    QHash<CacheAction, QSharedPointer<QH::PKG::DBObject>> _changes;
    QMutex _saveLaterMutex;
 
signals:
    void sigItemChanged(const QSharedPointer<QH::PKG::DBObject> &obj);

    void sigItemDeleted(const QH::DbAddress& obj);
 
};

constexpr inline uint qHash(CacheAction action) {
    return static_cast<uint>(action);
}
 
}
 
#endif // ISQLDB_H