src/sql/kernel/qsqlquery.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the QtSql module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** GNU Lesser General Public License Usage
  11 ** This file may be used under the terms of the GNU Lesser General Public
  12 ** License version 2.1 as published by the Free Software Foundation and
  13 ** appearing in the file LICENSE.LGPL included in the packaging of this
  14 ** file. Please review the following information to ensure the GNU Lesser
  15 ** General Public License version 2.1 requirements will be met:
  16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  17 **
  18 ** In addition, as a special exception, Nokia gives you certain additional
  19 ** rights. These rights are described in the Nokia Qt LGPL Exception
  20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  21 **
  22 ** GNU General Public License Usage
  23 ** Alternatively, this file may be used under the terms of the GNU General
  24 ** Public License version 3.0 as published by the Free Software Foundation
  25 ** and appearing in the file LICENSE.GPL included in the packaging of this
  26 ** file. Please review the following information to ensure the GNU General
  27 ** Public License version 3.0 requirements will be met:
  28 ** http://www.gnu.org/copyleft/gpl.html.
  29 **
  30 ** Other Usage
  31 ** Alternatively, this file may be used in accordance with the terms and
  32 ** conditions contained in a signed written agreement between you and Nokia.
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QSQLQUERY_H
  43 #define QSQLQUERY_H
  44
  45 #include <QtSql/qsql.h>
  46 #include <QtSql/qsqldatabase.h>
  47 #include <QtCore/qstring.h>
  48
  49 QT_BEGIN_HEADER
  50
  51 QT_BEGIN_NAMESPACE
  52
  53 QT_MODULE(Sql)
  54
  55 class QVariant;
  56 class QSqlDriver;
  57 class QSqlError;
  58 class QSqlResult;
  59 class QSqlRecord;
  60 template <class Key, class T> class QMap;
  61 class QSqlQueryPrivate;
  62
  63 class Q_SQL_EXPORT QSqlQuery
  64 {
  65 public:
  66     QSqlQuery(QSqlResult *r);
  67     QSqlQuery(const QString& query = QString(), QSqlDatabase db = QSqlDatabase());
  68     explicit QSqlQuery(QSqlDatabase db);
  69     QSqlQuery(const QSqlQuery& other);
  70     QSqlQuery& operator=(const QSqlQuery& other);
  71     ~QSqlQuery();
  72
  73     bool isValid() const;
  74     bool isActive() const;
  75     bool isNull(int field) const;
  76     int at() const;
  77     QString lastQuery() const;
  78     int numRowsAffected() const;
  79     QSqlError lastError() const;
  80     bool isSelect() const;
  81     int size() const;
  82     const QSqlDriver* driver() const;
  83     const QSqlResult* result() const;
  84     bool isForwardOnly() const;
  85     QSqlRecord record() const;
  86
  87     void setForwardOnly(bool forward);
  88     bool exec(const QString& query);
  89     QVariant value(int i) const;
  90
  91     void setNumericalPrecisionPolicy(QSql::NumericalPrecisionPolicy precisionPolicy);
  92     QSql::NumericalPrecisionPolicy numericalPrecisionPolicy() const;
  93
  94     bool seek(int i, bool relative = false);
  95     bool next();
  96     bool previous();
  97     bool first();
  98     bool last();
  99
 100     void clear();
 101
 102     // prepared query support
 103     bool exec();
 104     enum BatchExecutionMode { ValuesAsRows, ValuesAsColumns };
 105     bool execBatch(BatchExecutionMode mode = ValuesAsRows);
 106     bool prepare(const QString& query);
 107     void bindValue(const QString& placeholder, const QVariant& val,
 108                    QSql::ParamType type = QSql::In);
 109     void bindValue(int pos, const QVariant& val, QSql::ParamType type = QSql::In);
 110     void addBindValue(const QVariant& val, QSql::ParamType type = QSql::In);
 111     QVariant boundValue(const QString& placeholder) const;
 112     QVariant boundValue(int pos) const;
 113     QMap<QString, QVariant> boundValues() const;
 114     QString executedQuery() const;
 115     QVariant lastInsertId() const;
 116     void finish();
 117     bool nextResult();
 118
 119 private:
 120     QSqlQueryPrivate* d;
 121 };
 122
 123 QT_END_NAMESPACE
 124
 125 QT_END_HEADER
 126
 127 #endif // QSQLQUERY_H