dbobject.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 DBOBJECT_H
#define DBOBJECT_H
#include <QSqlRecord>
#include <QVariantMap>
#include "abstractdata.h"
#include "heart_global.h"
#include "dbaddress.h"
 
class QSqlQuery;
 
namespace QH {
namespace PKG {

enum class PrepareResult {
    Fail,
    Success,
    Disabled,
};

enum class MemberType {
    None = 0x0,

    Insert = 0x1,

    Update = 0x2,

    Unique = 0x4,

    Autoincement = 0x8,

    InsertUpdate = Insert | Update,

    PrimaryKey = Insert | Unique,

    PrimaryKeyAutoIncrement = PrimaryKey | Autoincement
};
 
constexpr inline uint qHash(MemberType type) {
    return static_cast<uint>(type);
}

struct HEARTSHARED_EXPORT DBVariant {
    DBVariant();
 
    DBVariant(const QVariant& value, MemberType type);
    QVariant value;
    MemberType type = MemberType::None;
};

typedef QMap<QString, DBVariant> DBVariantMap;

class HEARTSHARED_EXPORT DBObject : public AbstractData
{
    QH_PACKAGE("DBObject")
 
public:
 
    DBObject();
 
    ~DBObject() override;
 
    bool isValid() const override;

    bool isHaveAPrimaryKey() const;

    virtual void clear();

    virtual DBObject* createDBObject() const = 0;

    virtual PrepareResult prepareSelectQuery(QSqlQuery& q) const;

    virtual bool fromSqlRecord(const QSqlRecord& q) = 0;

    virtual PrepareResult prepareInsertQuery(QSqlQuery& q, bool replace) const;

    virtual PrepareResult prepareUpdateQuery(QSqlQuery& q) const;

    virtual PrepareResult prepareRemoveQuery(QSqlQuery& q) const;

    virtual bool isCached() const;

    virtual bool isBundle() const;

    DbAddress dbAddress() const;
 
    QString toString() const override;

    virtual DBVariantMap variantMap() const;

    virtual QString table() const = 0;
 
protected:
 
    QDataStream &fromStream(QDataStream &stream) override;
    QDataStream &toStream(QDataStream &stream) const override;

 
    virtual std::pair<QString, QMap<QString, QVariant>> condition() const;

    virtual QString primaryKey() const;

    virtual QVariant primaryValue() const;

    bool isInsertPrimaryKey() const;
 
};
}
}
 
Q_DECLARE_METATYPE(const QH::PKG::DBObject*)
Q_DECLARE_METATYPE(QH::PKG::DBObject*)
Q_DECLARE_METATYPE(QList<QH::PKG::DBObject *>*);
Q_DECLARE_METATYPE(QList<const QH::PKG::DBObject *>*);
 
#endif // DBOBJECT_H