qgsdbquerylog.h

Go to the documentation of this file.

/***************************************************************************
  qgsdbquerylog.h
  ------------
  Date                 : October 2021
  Copyright            : (C) 2021 by Nyall Dawson
  Email                : nyall dot dawson at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSDBQUERYLOG_H
#define QGSDBQUERYLOG_H
 
#include "qgis.h"
#include "qgis_core.h"
 
#include <QDateTime>
#include <QString>

class CORE_EXPORT QgsDatabaseQueryLogEntry
{
  public:
    QgsDatabaseQueryLogEntry( const QString &query = QString() );

    int queryId = 0;

    QString uri;

    QString provider;

    QString query;

    quint64 startedTime = 0;

    quint64 finishedTime = 0;

    QString initiatorClass;

    QString origin;

    long long fetchedRows = -1;

    QString error;

    bool canceled = false;
 
  private:
    static QAtomicInt sQueryId;
};
 
Q_DECLARE_METATYPE( QgsDatabaseQueryLogEntry );

class CORE_EXPORT QgsDatabaseQueryLog : public QObject
{
    Q_OBJECT
 
  public:
    QgsDatabaseQueryLog( QObject *parent = nullptr );

    static void setEnabled( bool enabled ) SIP_SKIP { sEnabled = enabled; }

    static bool enabled() { return sEnabled; }

    static void log( const QgsDatabaseQueryLogEntry &query );

    static void finished( const QgsDatabaseQueryLogEntry &query );
 
  public slots:

    void queryStartedPrivate( const QgsDatabaseQueryLogEntry &query ) SIP_SKIP;

    void queryFinishedPrivate( const QgsDatabaseQueryLogEntry &query ) SIP_SKIP;
 
  signals:

    void queryStarted( const QgsDatabaseQueryLogEntry &query ) SIP_SKIP;

    void queryFinished( const QgsDatabaseQueryLogEntry &query ) SIP_SKIP;
 
  private:
    static bool sEnabled;
};
 
#ifndef SIP_RUN

class QgsDatabaseQueryLogWrapper
{
  public:
    QgsDatabaseQueryLogWrapper( const QString &query, const QString &uri, const QString &provider, const QString &initiatorClass, const QString &origin )
      : mEntry( query )
    {
      mEntry.uri = uri;
      mEntry.origin = origin;
      mEntry.initiatorClass = initiatorClass;
      mEntry.provider = provider;
      QgsDatabaseQueryLog::log( mEntry );
    }
 
    ~QgsDatabaseQueryLogWrapper() { QgsDatabaseQueryLog::finished( mEntry ); }
 
    void setFetchedRows( long long fetchedRows ) { mEntry.fetchedRows = fetchedRows; }
 
    void setQuery( const QString &query ) { mEntry.query = query; }
 
    void setError( const QString &error ) { mEntry.error = error; }
 
    void setCanceled() { mEntry.canceled = true; }
 
  private:
    QgsDatabaseQueryLogEntry mEntry;
};

#endif
 
#endif // QGSDBQUERYLOG_H