ZsqlDatabase.h

Go to the documentation of this file.

/*
 * Zuble - A run-time system for QML/Javascript applications
 * Copyright (C) 2013, 2014  Bob Dinitto
 *
 * ZsqlDatabase.h
 *
 *  Created on: 06-Aug, 2014
 *  Author: Bob Dinitto   bob@ninzo.com
 *
 * Zuble is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 */

#ifndef ZSQLDATABASE_H
#define ZSQLDATABASE_H

#include "zblcore_global.h"
#include "zglobal.h"
#include "ZblException.h"
#include <QObject>
#include <QSqlDatabase>
#include <QReadWriteLock>
#include <QObjectCleanupHandler>
#include <QStringList>
#include <QVariant>

namespace Zbl
{

class ZsqlQuery;

class ZBLCORESHARED_EXPORT ZsqlDatabase : public QObject
{
    friend class Zbl::ZsqlQuery;

    //typedef QSharedPointer<ZsqlDatabase> ZsqlDatabasePtr;
    typedef QPointer<ZsqlQuery> ZsqlQueryPtr;

    Q_OBJECT

    typedef QMap<QString, ZsqlDatabase*> ZsqlDbMap;
    typedef QList<ZsqlQuery*> ZsqlQueryList;

public:

    // to participate in automatic enum propagation
    // for QML programs we redeclare these enums;
    // note background Javascript programs can't use QML
    // type engine, those programs must use tags property instead

    Q_ENUMS(TableType)

    enum TableType {
        Tables = QSql::Tables,
        SystemTables = QSql::SystemTables,
        Views = QSql::Views,
        AllTables = QSql::AllTables,

    };
    Q_DECLARE_FLAGS(TableTypes, TableType)


    Q_ENUMS(NumericalPrecisionPolicy)

    enum NumericalPrecisionPolicy
    {
        LowPrecisionInt32    = QSql::LowPrecisionInt32,
        LowPrecisionInt64    = QSql::LowPrecisionInt64,
        LowPrecisionDouble   = QSql::LowPrecisionDouble,
        HighPrecision        = QSql::HighPrecision
    };

    explicit ZsqlDatabase(QObject *parent = 0);

    virtual ~ZsqlDatabase();

    Q_PROPERTY(QString hostName READ getHostname WRITE setHostname)

    
    Q_PROPERTY(QString databaseName READ getDbName WRITE setDbName)

    Q_PROPERTY(int portNumber READ getPortNumber WRITE setPortNumber)

    Q_PROPERTY(QString connectOptions READ getConnectOptions
               WRITE setConnectOptions)

    Q_PROPERTY(bool isValid READ isValid)

    Q_PROPERTY(bool isOpen READ isOpen)

    Q_PROPERTY(bool isOpenError READ isOpenError)

    Q_PROPERTY(QObject* lastError READ getLastError)

    Q_PROPERTY(QVariant tags READ getTags)



    bool isValid() const;

    bool isOpen() const;

    bool isOpenError() const;

    QString getHostname() const;

    void setHostname(const QString& hostname);

    QString getDbName() const;

    void setDbName(const QString& hostname);

    int getPortNumber() const;

    void setPortNumber(int);

    void setConnectOptions(const QString& options);

    QString getConnectOptions();

    QObject* getLastError();

    QVariant getTags();


    Q_INVOKABLE bool open(const QString & user, const QString & password);


    Q_INVOKABLE void close();

    Q_INVOKABLE QStringList getTableNames(int tableType) const;

    Q_INVOKABLE bool transaction();

    Q_INVOKABLE bool commit();

    Q_INVOKABLE bool rollback();

    Q_INVOKABLE QObject* newQuery();

    Q_INVOKABLE QObject* record(const QString& tablename);

    Q_INVOKABLE void release();

    static QObject* addDatabase(const QString& driverType,
                                const QString& connectionName );

    static void removeDatabase(const QString& connectionName );

    static void removeThreadDatabases();


    static  QObject* database(const QString& connectionName);

signals:

public slots:


protected:

    void createTags();

    inline void validateDb() const;

    inline void validateThread();

    QSqlDatabase* m_db;

    static ZsqlDbMap m_databaseObjects;

    static QReadWriteLock m_lock;

    static QVariant m_tags;

};

inline void ZsqlDatabase::validateThread()
{
    if(!inObjectThread(this))
        throw ZblException("ZsqlDatabase objects should only be called from the "
                           "thread in which they were created.");
}

inline void ZsqlDatabase::validateDb() const
{
    if(!m_db)
        throw ZblException(
         "Error: ZsqlDatabase's embedded QSqlDatabase object has already "
                "been released.");
}

} // Zbl

#endif // ZSQLDATABASE_H