bpsdatastore.h

Go to the documentation of this file.

#ifndef BPSDATASTORE_H
#define BPSDATASTORE_H

#include "bpssettings.h"
#include <QObject>
#include <QStringList>

class QSqlDatabase;
class QSqlRecord;
class QSqlIndex;
class BpsQuery;

class BPSCORE_EXPORT BpsDatastore : public QObject
{
    Q_OBJECT
    BPS_PRIVATE(BpsDatastore)

public:

    BpsDatastore(QObject* aParent = 0);

    virtual ~BpsDatastore();

    QString connection() const;

    void setConnection(const QString& aConnection);

    QString driver() const;

    void setDriver(const QString& aDriver);

    QString host() const;

    void setHost(const QString& aHost);

    int port() const;

    void setPort(int aPort);

    QString database() const;

    void setDatabase(const QString& aDatabase);

    QString schema() const;

    void setSchema(const QString& aSchema);

    QString username() const;

    void setUsername(const QString& aUsername);

    QString password() const;

    QString terminal() const;

    QString application() const;

    void setPassword(const QString& aPassword);

    void connect();

    void disconnect();

    void transaction();

    bool inTransaction() const;

    bool lockTable(const QString& aTable, int aTimeout);

    void commit();

    void rollback();

    QVariant nextIdent(const QString& aSeqenceName);

    QVariant nextKey(const QString& aName);

    void purgeActors();

    void touchActor();

    void checkin(const QString& aTerminalName = QString(), const QString& aApplicationName = QString());

    void checkout();

    QSqlDatabase& link();

    bool isConnected() const;

    bool isOracle() const;

    bool isPostgres() const;

    bool isOwner() const;

    bool sequenceExists(const QString& aName, const QString& aSchema = QString());

    bool tableExists(const QString& aName, const QString& aSchema = QString());

    bool indexExists(const QString& aName, const QString& aSchema = QString());

    bool viewExists(const QString& aName, const QString& aSchema = QString());

    QSqlRecord* record(const QString& aTableName);

    QSqlIndex* primaryIndex(const QString& aTableName);

    /*
     * Check whether the current user is authorized for a table or column.
     * The connection must be established. 
     * \param[in] aFlags The permission flags required. All flags passed as argument must be present in column 
     *                   t_functionauths.c_flags. Flag comparison is done case sensitive.
     * \param[in] aTable Name of the table. Table names compare is done case insensitive.
     * \param[in] aColumn Name of the column. The default is an empty string, meaning the authorization is for the whole table.
     * \return True if connected and the requested permissions aer granted to the current user.
     */
    //bool authorizedForField(const QString& aFlags, const QString& aTable, const QString& aColumn = QString::null) const;

    int userid() const;

    QVariant userKey() const;

    QVariant actorKey() const;

    QVariant sessionId() const;

    QStringList users();

    QStringList roles();

    QStringList tablespaces();

    bool loadConnection(BpsSettings::Scopes aScopes = BpsSettings::LocalScopes);

    void saveConnection(BpsSettings::Scopes aScopes = BpsSettings::LocalUserScope);

    void dropConnection(BpsSettings::Scopes aScopes = BpsSettings::LocalUserScope);

    void renameConnection(const QString& aConnection, BpsSettings::Scopes aScopes = BpsSettings::LocalUserScope);

    bool hasPermission(const QString& aPermission);

    bool hasDivisionAccess(const QVariant& aDivisionKey);

    bool hasZoneAccess(const QVariant& aZoneKey);

    Bps::Access reportAccess(const QVariant& aReportKey);

    QDateTime currentTimestamp();

    QVariant setKeys(const QList<qulonglong>& aKeys);

    QVariant setKeys(const QList<qlonglong>& aKeys);

    QVariant setKeys(const QVariantList& aKeys);

    void clearKeys(QVariant aId);

    static QStringList connections();

    static QStringList tnsnames();

    static QString quote(const QString& aText);

    static QString quote(QChar aChar);

signals:

    void connected();

    void disconnected();

};

#endif // BPSDATASTORE_H