dbintrospector.h

/*
    SPDX-FileCopyrightText: 2006 Tobias Koenig <[email protected]>
    SPDX-FileCopyrightText: 2012 Volker Krause <[email protected]>

    SPDX-License-Identifier: LGPL-2.0-or-later
*/
#ifndef DBINTROSPECTOR_H
#define DBINTROSPECTOR_H

#include <QHash>
#include <QSharedPointer>
#include <QSqlDatabase>
#include <QStringList>

class DbIntrospectorTest;

namespace Akonadi
{
namespace Server
{

class DbIntrospector
{
public:
    typedef QSharedPointer<DbIntrospector> Ptr;

    class ForeignKey
    {
    public:
        QString name;
        QString column;
        QString refTable;
        QString refColumn;
        QString onUpdate; // TODO use same enum as DbInitializer
        QString onDelete; // dito
    };

    static DbIntrospector::Ptr createInstance(const QSqlDatabase &database);

    virtual ~DbIntrospector();

    virtual bool hasTable(const QString &tableName);

    virtual bool hasIndex(const QString &tableName, const QString &indexName);

    virtual bool hasColumn(const QString &tableName, const QString &columnName);

    virtual bool isTableEmpty(const QString &tableName);

    virtual QVector<ForeignKey> foreignKeyConstraints(const QString &tableName);

protected:
    DbIntrospector(const QSqlDatabase &database);

    virtual QString hasIndexQuery(const QString &tableName, const QString &indexName);

    QSqlDatabase m_database;

private:
    Q_DISABLE_COPY_MOVE(DbIntrospector)

    friend class ::DbIntrospectorTest;
    QHash<QString, QStringList> m_columnCache; // avoids extra db roundtrips
};

} // namespace Server
} // namespace Akonadi

#endif // DBINTROSPECTOR_H